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 'acct_forward_info' => 'MyAccount/acct_forward_info',
61 'process_acct_forward' => 'MyAccount/process_acct_forward',
62 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
63 'add_dsl_device' => 'MyAccount/add_dsl_device',
64 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
65 'port_graph' => 'MyAccount/port_graph',
66 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
67 'list_support_usage' => 'MyAccount/list_support_usage',
68 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
69 'change_pkg' => 'MyAccount/change_pkg',
70 'order_recharge' => 'MyAccount/order_recharge',
71 'renew_info' => 'MyAccount/renew_info',
72 'order_renew' => 'MyAccount/order_renew',
73 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
74 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
75 'charge' => 'MyAccount/charge', #?
76 'part_svc_info' => 'MyAccount/part_svc_info',
77 'provision_acct' => 'MyAccount/provision_acct',
78 'provision_phone' => 'MyAccount/provision_phone',
79 'provision_external' => 'MyAccount/provision_external',
80 'unprovision_svc' => 'MyAccount/unprovision_svc',
81 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
82 'reset_passwd' => 'MyAccount/reset_passwd',
83 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
84 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
85 'create_ticket' => 'MyAccount/create_ticket',
86 'get_ticket' => 'MyAccount/get_ticket',
87 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
88 'did_report' => 'MyAccount/did_report',
89 'signup_info' => 'Signup/signup_info',
90 'skin_info' => 'MyAccount/skin_info',
91 'access_info' => 'MyAccount/access_info',
92 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
93 'new_customer' => 'Signup/new_customer',
94 'capture_payment' => 'Signup/capture_payment',
95 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
96 'new_agent' => 'Agent/new_agent',
97 'agent_login' => 'Agent/agent_login',
98 'agent_logout' => 'Agent/agent_logout',
99 'agent_info' => 'Agent/agent_info',
100 'agent_list_customers' => 'Agent/agent_list_customers',
101 'check_username' => 'Agent/check_username',
102 'suspend_username' => 'Agent/suspend_username',
103 'unsuspend_username' => 'Agent/unsuspend_username',
104 'mason_comp' => 'MasonComponent/mason_comp',
105 'call_time' => 'PrepaidPhone/call_time',
106 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
107 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
109 #'bulk_processrow' => 'Bulk/processrow',
110 #conflicts w/Agent one# 'check_username' => 'Bulk/check_username',
112 'ping' => 'SGNG/ping',
113 'decompify_pkgs' => 'SGNG/decompify_pkgs',
114 'previous_payment_info' => 'SGNG/previous_payment_info',
115 'previous_payment_info_renew_info'
116 => 'SGNG/previous_payment_info_renew_info',
117 'previous_process_payment' => 'SGNG/previous_process_payment',
118 'previous_process_payment_order_pkg'
119 => 'SGNG/previous_process_payment_order_pkg',
120 'previous_process_payment_change_pkg'
121 => 'SGNG/previous_process_payment_change_pkg',
122 'previous_process_payment_order_renew'
123 => 'SGNG/previous_process_payment_order_renew',
127 qw( regionselector regionselector_hashref location_form
128 expselect popselector domainselector didselector
132 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
133 $ENV{'SHELL'} = '/bin/sh';
134 $ENV{'IFS'} = " \t\n";
137 $ENV{'BASH_ENV'} = '';
139 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
140 #if you grant appropriate permissions to whatever user
141 my $freeside_uid = scalar(getpwnam('freeside'));
142 die "not running as the freeside user\n"
143 if $> != $freeside_uid && ! $skip_uid_check;
145 -e $dir or die "FATAL: $dir doesn't exist!";
146 -d $dir or die "FATAL: $dir isn't a directory!";
147 -r $dir or die "FATAL: Can't read $dir as freeside user!";
148 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
150 foreach my $autoload ( keys %autoload ) {
153 "sub $autoload { ". '
158 #warn scalar(@_). ": ". join(" / ", @_);
162 $param->{_packet} = \''. $autoload{$autoload}. '\';
164 simple_packet($param);
174 warn "sending ". $packet->{_packet}. " to server"
176 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
177 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
178 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
181 #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
183 #block until there is a message on socket
184 # my $w = new IO::Select;
186 # my @wait = $w->can_read;
188 warn "reading message from server"
191 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
192 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
194 warn "returning message to client"
202 FS::SelfService - Freeside self-service API
206 # password and shell account changes
207 use FS::SelfService qw(passwd chfn chsh);
209 # "my account" functionality
210 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
212 my $rv = login( { 'username' => $username,
214 'password' => $password,
218 if ( $rv->{'error'} ) {
219 #handle login error...
222 my $session_id = $rv->{'session_id'};
225 my $customer_info = customer_info( { 'session_id' => $session_id } );
227 #payment_info and process_payment are available in 1.5+ only
228 my $payment_info = payment_info( { 'session_id' => $session_id } );
230 #!!! process_payment example
232 #!!! list_pkgs example
234 #!!! order_pkg example
236 #!!! cancel_pkg example
238 # signup functionality
239 use FS::SelfService qw( signup_info new_customer );
241 my $signup_info = signup_info;
243 $rv = new_customer( {
246 'company' => $company,
247 'address1' => $address1,
248 'address2' => $address2,
252 'country' => $country,
253 'daytime' => $daytime,
257 'payinfo' => $payinfo,
259 'paystart_month' => $paystart_month
260 'paystart_year' => $paystart_year,
261 'payissue' => $payissue,
263 'paydate' => $paydate,
264 'payname' => $payname,
265 'invoicing_list' => $invoicing_list,
266 'referral_custnum' => $referral_custnum,
267 'agentnum' => $agentnum,
268 'pkgpart' => $pkgpart,
270 'username' => $username,
271 '_password' => $password,
275 'phonenum' => $phonenum,
280 my $error = $rv->{'error'};
281 if ( $error eq '_decline' ) {
291 Use this API to implement your own client "self-service" module.
293 If you just want to customize the look of the existing "self-service" module,
296 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
308 =head1 "MY ACCOUNT" FUNCTIONS
314 Creates a user session. Takes a hash reference as parameter with the
333 Returns a hash reference with the following keys:
339 Empty on success, or an error message on errors.
343 Session identifier for successful logins
347 =item customer_info HASHREF
349 Returns general customer information.
351 Takes a hash reference as parameter with a single key: B<session_id>
353 Returns a hash reference with the following keys:
367 Array reference of hash references of open inoices. Each hash reference has
368 the following keys: invnum, date, owed
372 An HTML fragment containing shipping and billing addresses.
374 =item The following fields are also returned
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 payname month year invoicing_list postal_invoicing
380 =item edit_info HASHREF
382 Takes a hash reference as parameter with any of the following keys:
384 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
386 If a field exists, the customer record is updated with the new value of that
387 field. If a field does not exist, that field is not changed on the customer
390 Returns a hash reference with a single key, B<error>, empty on success, or an
391 error message on errors
393 =item invoice HASHREF
395 Returns an invoice. Takes a hash reference as parameter with two keys:
396 session_id and invnum
398 Returns a hash reference with the following keys:
404 Empty on success, or an error message on errors
416 =item list_invoices HASHREF
418 Returns a list of all customer invoices. Takes a hash references with a single
421 Returns a hash reference with the following keys:
427 Empty on success, or an error message on errors
431 Reference to array of hash references with the following keys:
441 Invoice date, in UNIX epoch time
449 Cancels this customer.
451 Takes a hash reference as parameter with a single key: B<session_id>
453 Returns a hash reference with a single key, B<error>, which is empty on
454 success or an error message on errors.
456 =item payment_info HASHREF
458 Returns information that may be useful in displaying a payment page.
460 Takes a hash reference as parameter with a single key: B<session_id>.
462 Returns a hash reference with the following keys:
468 Empty on success, or an error message on errors
476 Exact name on credit card (CARD/DCRD)
500 Customer's current default payment type.
504 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
508 For CARD/DCRD payment types, the card number
512 For CARD/DCRD payment types, expiration month
516 For CARD/DCRD payment types, expiration year
518 =item cust_main_county
520 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.
524 Array reference of all states in the current default country.
528 Hash reference of card types; keys are card types, values are the exact strings
529 passed to the process_payment function
533 #this doesn't actually work yet
537 #Unique transaction identifier (prevents multiple charges), passed to the
538 #process_payment function
542 =item process_payment HASHREF
544 Processes a payment and possible change of address or payment type. Takes a
545 hash reference as parameter with the following keys:
559 If true, address and card information entered will be saved for subsequent
564 If true, future credit card payments will be done automatically (sets payby to
565 CARD). If false, future credit card payments will be done on-demand (sets
566 payby to DCRD). This option only has meaning if B<save> is set true.
594 Two-letter country code
602 Card expiration month
610 #this doesn't actually work yet
614 #Unique transaction identifier, returned from the payment_info function.
615 #Prevents multiple charges.
619 Returns a hash reference with a single key, B<error>, empty on success, or an
620 error message on errors.
622 =item process_payment_order_pkg
624 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
625 payment processes sucessfully, the package is ordered. Takes a hash reference
626 as parameter with the keys of both methods.
628 Returns a hash reference with a single key, B<error>, empty on success, or an
629 error message on errors.
631 =item process_payment_change_pkg
633 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
634 payment processes sucessfully, the package is ordered. Takes a hash reference
635 as parameter with the keys of both methods.
637 Returns a hash reference with a single key, B<error>, empty on success, or an
638 error message on errors.
641 =item process_payment_order_renew
643 Combines the B<process_payment> and B<order_renew> functions in one step. If
644 the payment processes sucessfully, the renewal is processed. Takes a hash
645 reference as parameter with the keys of both methods.
647 Returns a hash reference with a single key, B<error>, empty on success, or an
648 error message on errors.
652 Returns package information for this customer. For more detail on services,
655 Takes a hash reference as parameter with a single key: B<session_id>
657 Returns a hash reference containing customer package information. The hash reference contains the following keys:
667 Empty on success, or an error message on errors.
669 =item cust_pkg HASHREF
671 Array reference of hash references, each of which has the fields of a cust_pkg
672 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
673 the internal FS:: objects, but hash references of columns and values.
677 =item part_pkg fields
679 All fields of part_pkg for this specific cust_pkg (be careful with this
680 information - it may reveal more about your available packages than you would
681 like users to know in aggregate)
685 #XXX pare part_pkg fields down to a more secure subset
689 An array of hash references indicating information on unprovisioned services
690 available for provisioning for this specific cust_pkg. Each has the following
695 =item part_svc fields
697 All fields of part_svc (be careful with this information - it may reveal more
698 about your available packages than you would like users to know in aggregate)
702 #XXX pare part_svc fields down to a more secure subset
708 An array of hash references indicating information on the customer services
709 already provisioned for this specific cust_pkg. Each has the following keys:
715 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.
721 Primary key for this service
725 Service definition (see L<FS::part_svc>)
729 Customer package (see L<FS::cust_pkg>)
733 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
741 Returns service information for this customer.
743 Takes a hash reference as parameter with a single key: B<session_id>
745 Returns a hash reference containing customer package information. The hash reference contains the following keys:
755 An array of hash references indicating information on all of this customer's
756 services. Each has the following keys:
762 Primary key for this service
770 Meaningful user-specific identifier for the service (i.e. username, domain, or
775 Account (svc_acct) services also have the following keys:
793 Upload bytes remaining
797 Download bytes remaining
801 Total bytes remaining
803 =item recharge_amount
807 =item recharge_seconds
809 Number of seconds gained by recharge
811 =item recharge_upbytes
813 Number of upload bytes gained by recharge
815 =item recharge_downbytes
817 Number of download bytes gained by recharge
819 =item recharge_totalbytes
821 Number of total bytes gained by recharge
829 Orders a package for this customer.
831 Takes a hash reference as parameter with the following keys:
841 Package to order (see L<FS::part_pkg>).
845 Service to order (see L<FS::part_svc>).
847 Normally optional; required only to provision a non-svc_acct service, or if the
848 package definition does not contain one svc_acct service definition with
849 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
850 also be specified to indicate that no initial service should be provisioned.
854 Fields used when provisioning an svc_acct service:
868 Optional security phrase
872 Optional Access number number
876 Fields used when provisioning an svc_domain service:
886 Fields used when provisioning an svc_phone service:
904 Fields used when provisioning an svc_external service:
918 Fields used when provisioning an svc_pbx service:
932 Returns a hash reference with a single key, B<error>, empty on success, or an
933 error message on errors. The special error '_decline' is returned for
934 declined transactions.
938 Changes a package for this customer.
940 Takes a hash reference as parameter with the following keys:
950 Existing customer package.
954 New package to order (see L<FS::part_pkg>).
958 Returns a hash reference with the following keys:
964 Empty on success, or an error message on errors.
968 On success, the new pkgnum
975 Provides useful info for early renewals.
977 Takes a hash reference as parameter with the following keys:
987 Returns a hash reference. On errors, it contains a single key, B<error>, with
988 the error message. Otherwise, contains a single key, B<dates>, pointing to
989 an array refernce of hash references. Each hash reference contains the
996 (Future) Bill date. Indicates a future date for which billing could be run.
997 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1000 =item bill_date_pretty
1002 (Future) Bill date as a human-readable string. (Convenience for display;
1003 subject to change, so best not to parse for the date.)
1007 Base amount which will be charged if renewed early as of this date.
1011 Renewal date; i.e. even-futher future date at which the customer will be paid
1012 through if the early renewal is completed with the given B<bill-date>.
1013 Specified as a integer UNIX timestamp.
1015 =item renew_date_pretty
1017 Renewal date as a human-readable string. (Convenience for display;
1018 subject to change, so best not to parse for the date.)
1022 Package that will be renewed.
1026 Expiration date of the package that will be renewed.
1028 =item expire_date_pretty
1030 Expiration date of the package that will be renewed, as a human-readable
1031 string. (Convenience for display; subject to change, so best not to parse for
1038 Renews this customer early; i.e. runs billing for this customer in advance.
1040 Takes a hash reference as parameter with the following keys:
1050 Integer date as returned by the B<renew_info> function, indicating the advance
1051 date for which to run billing.
1055 Returns a hash reference with a single key, B<error>, empty on success, or an
1056 error message on errors.
1060 Cancels a package for this customer.
1062 Takes a hash reference as parameter with the following keys:
1072 pkgpart of package to cancel
1076 Returns a hash reference with a single key, B<error>, empty on success, or an
1077 error message on errors.
1081 =head1 SIGNUP FUNCTIONS
1085 =item signup_info HASHREF
1087 Takes a hash reference as parameter with the following keys:
1091 =item session_id - Optional agent/reseller interface session
1095 Returns a hash reference containing information that may be useful in
1096 displaying a signup page. The hash reference contains the following keys:
1100 =item cust_main_county
1102 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.
1106 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
1107 an agentnum specified explicitly via reseller interface session_id in the
1112 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.
1114 =item agentnum2part_pkg
1116 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.
1120 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.
1122 =item security_phrase
1124 True if the "security_phrase" feature is enabled
1128 Array reference of acceptable payment types for signup
1134 credit card - automatic
1138 credit card - on-demand - version 1.5+ only
1142 electronic check - automatic
1146 electronic check - on-demand - version 1.5+ only
1154 billing, not recommended for signups
1158 free, definitely not recommended for signups
1162 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1168 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1172 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".
1178 =item countrydefault
1184 =item new_customer HASHREF
1186 Creates a new customer. Takes a hash reference as parameter with the
1193 first name (required)
1197 last name (required)
1201 (not typically collected; mostly used for ACH transactions)
1207 =item address1 (required)
1215 =item city (required)
1223 =item state (required)
1227 =item zip (required)
1233 Daytime phone number
1237 Evening phone number
1245 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1249 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1253 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1257 Expiration date for CARD/DCRD
1261 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1263 =item invoicing_list
1265 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),
1267 =item referral_custnum
1269 referring customer number
1277 pkgpart of initial package
1293 Access number (index, not the literal number)
1297 Country code (to be provisioned as a service)
1301 Phone number (to be provisioned as a service)
1309 Returns a hash reference with the following keys:
1315 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)
1319 =item regionselector HASHREF | LIST
1321 Takes as input a hashref or list of key/value pairs with the following keys:
1325 =item selected_county
1327 Currently selected county
1329 =item selected_state
1331 Currently selected state
1333 =item selected_country
1335 Currently selected country
1339 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1343 Specify a javascript subroutine to call on changes
1349 =item default_country
1355 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>.
1359 Returns a list consisting of three HTML fragments for county selection,
1360 state selection and country selection, respectively.
1364 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1365 sub regionselector {
1372 $param->{'selected_country'} ||= $param->{'default_country'};
1373 $param->{'selected_state'} ||= $param->{'default_state'};
1375 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1379 my %cust_main_county;
1381 # unless ( @cust_main_county ) { #cache
1382 #@cust_main_county = qsearch('cust_main_county', {} );
1383 #foreach my $c ( @cust_main_county ) {
1384 foreach my $c ( @{ $param->{'locales'} } ) {
1385 #$countyflag=1 if $c->county;
1386 $countyflag=1 if $c->{county};
1387 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1388 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1389 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1392 $countyflag=1 if $param->{selected_county};
1394 my $script_html = <<END;
1396 function opt(what,value,text) {
1397 var optionName = new Option(text, value, false, false);
1398 var length = what.length;
1399 what.options[length] = optionName;
1401 function ${prefix}country_changed(what) {
1402 country = what.options[what.selectedIndex].text;
1403 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1404 what.form.${prefix}state.options[i] = null;
1406 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1408 foreach my $country ( sort keys %cust_main_county ) {
1409 $script_html .= "\nif ( country == \"$country\" ) {\n";
1410 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1411 my $text = $state || '(n/a)';
1412 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1414 $script_html .= "}\n";
1417 $script_html .= <<END;
1419 function ${prefix}state_changed(what) {
1422 if ( $countyflag ) {
1423 $script_html .= <<END;
1424 state = what.options[what.selectedIndex].text;
1425 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1426 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1427 what.form.${prefix}county.options[i] = null;
1430 foreach my $country ( sort keys %cust_main_county ) {
1431 $script_html .= "\nif ( country == \"$country\" ) {\n";
1432 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1433 $script_html .= "\nif ( state == \"$state\" ) {\n";
1434 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1435 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1436 my $text = $county || '(n/a)';
1438 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1440 $script_html .= "}\n";
1442 $script_html .= "}\n";
1446 $script_html .= <<END;
1451 my $county_html = $script_html;
1452 if ( $countyflag ) {
1453 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1454 foreach my $county (
1455 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1457 my $text = $county || '(n/a)';
1458 $county_html .= qq!<OPTION VALUE="$county"!.
1459 ($county eq $param->{'selected_county'} ?
1466 $county_html .= '</SELECT>';
1469 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1472 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1473 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1474 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1475 my $text = $state || '(n/a)';
1476 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1477 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1479 $state_html .= '</SELECT>';
1481 my $country_html = '';
1482 if ( scalar( keys %cust_main_county ) > 1 ) {
1484 $country_html = qq(<SELECT NAME="${prefix}country" ).
1485 qq(onChange="${prefix}country_changed(this); ).
1486 $param->{'onchange'}.
1489 my $countrydefault = $param->{default_country} || 'US';
1490 foreach my $country (
1491 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1492 keys %cust_main_county
1494 my $selected = $country eq $param->{'selected_country'}
1497 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1499 $country_html .= '</SELECT>';
1502 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1503 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1507 ($county_html, $state_html, $country_html);
1511 sub regionselector_hashref {
1512 my ($county_html, $state_html, $country_html) = regionselector(@_);
1514 'county_html' => $county_html,
1515 'state_html' => $state_html,
1516 'country_html' => $country_html,
1520 =item location_form HASHREF | LIST
1522 Takes as input a hashref or list of key/value pairs with the following keys:
1528 Current customer session_id
1532 Omit red asterisks from required fields.
1534 =item address1_label
1536 Label for first address line.
1540 Returns an HTML fragment for a location form (address, city, state, zip,
1553 my $session_id = delete $param->{'session_id'};
1555 my $rv = mason_comp( 'session_id' => $session_id,
1556 'comp' => '/elements/location.html',
1557 'args' => [ %$param ],
1561 $rv->{'error'} || $rv->{'output'};
1566 #=item expselect HASHREF | LIST
1568 #Takes as input a hashref or list of key/value pairs with the following keys:
1572 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1574 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1578 =item expselect PREFIX [ DATE ]
1580 Takes as input a unique prefix string and the current expiration date, in
1581 yyyy-mm-dd or m-d-yyyy format
1583 Returns an HTML fragments for expiration date selection.
1589 #if ( ref($_[0]) ) {
1593 #my $prefix = $param->{'prefix'};
1594 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1595 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1597 my $date = scalar(@_) ? shift : '';
1599 my( $m, $y ) = ( 0, 0 );
1600 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1601 ( $m, $y ) = ( $2, $1 );
1602 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1603 ( $m, $y ) = ( $1, $3 );
1605 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1607 $return .= qq!<OPTION VALUE="$_"!;
1608 $return .= " SELECTED" if $_ == $m;
1611 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1613 my $thisYear = $t[5] + 1900;
1614 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1615 $return .= qq!<OPTION VALUE="$_"!;
1616 $return .= " SELECTED" if $_ == $y;
1619 $return .= "</SELECT>";
1624 =item popselector HASHREF | LIST
1626 Takes as input a hashref or list of key/value pairs with the following keys:
1632 Access number number
1636 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>.
1640 Returns an HTML fragment for access number selection.
1644 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1652 my $popnum = $param->{'popnum'};
1653 my $pops = $param->{'pops'};
1655 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1656 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1657 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1658 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1659 if scalar(@$pops) == 1;
1662 my %popnum2pop = ();
1664 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1665 $popnum2pop{$_->{popnum}} = $_;
1670 function opt(what,href,text) {
1671 var optionName = new Option(text, href, false, false)
1672 var length = what.length;
1673 what.options[length] = optionName;
1677 my $init_popstate = $param->{'init_popstate'};
1678 if ( $init_popstate ) {
1679 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1680 $init_popstate. '">';
1683 function acstate_changed(what) {
1684 state = what.options[what.selectedIndex].text;
1685 what.form.popac.options.length = 0
1686 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1690 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1691 foreach my $state ( sort { $a cmp $b } @states ) {
1692 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1694 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1695 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1696 if ($ac eq $param->{'popac'}) {
1697 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1700 $text .= "}\n" unless $init_popstate;
1702 $text .= "popac_changed(what.form.popac)}\n";
1705 function popac_changed(what) {
1706 ac = what.options[what.selectedIndex].text;
1707 what.form.popnum.options.length = 0;
1708 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1712 foreach my $state ( @states ) {
1713 foreach my $popac ( keys %{ $pop{$state} } ) {
1714 $text .= "\nif ( ac == \"$popac\" ) {\n";
1716 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1717 my $o_popnum = $pop->{popnum};
1718 my $poptext = $pop->{city}. ', '. $pop->{state}.
1719 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1721 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1722 if ($popnum == $o_popnum) {
1723 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1731 $text .= "}\n</SCRIPT>\n";
1733 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1736 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1737 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1738 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1739 ">$_" foreach sort { $a cmp $b } @states;
1740 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1743 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1744 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1746 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1749 #comment this block to disable initial list polulation
1750 my @initial_select = ();
1751 if ( scalar( @$pops ) > 100 ) {
1752 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1754 @initial_select = @$pops;
1756 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1757 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1758 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1759 $pop->{city}. ', '. $pop->{state}.
1760 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1763 $text .= qq!</SELECT></TD></TR></TABLE>!;
1769 =item domainselector HASHREF | LIST
1771 Takes as input a hashref or list of key/value pairs with the following keys:
1781 Service number of the selected item.
1785 Returns an HTML fragment for domain selection.
1789 sub domainselector {
1796 my $domsvc= $param->{'domsvc'};
1798 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1799 my $domains = $rv->{'domains'};
1800 $domsvc = $rv->{'domsvc'} unless $domsvc;
1802 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1803 unless scalar(keys %$domains);
1805 if (scalar(keys %$domains) == 1) {
1807 foreach(keys %$domains) {
1810 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1811 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1814 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1817 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1818 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1819 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1820 $domains->{$domain};
1823 $text .= qq!</SELECT></TD></TR>!;
1829 =item didselector HASHREF | LIST
1831 Takes as input a hashref or list of key/value pairs with the following keys:
1837 Field name for the returned HTML fragment.
1841 Service definition (see L<FS::part_svc>)
1845 Returns an HTML fragment for DID selection.
1857 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1858 'args'=>[ %$param ],
1862 $rv->{'error'} || $rv->{'output'};
1868 =head1 RESELLER FUNCTIONS
1870 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1871 with their active session, and the B<customer_info> and B<order_pkg> functions
1872 with their active session and an additional I<custnum> parameter.
1874 For the most part, development of the reseller web interface has been
1875 superceded by agent-virtualized access to the backend.
1887 =item agent_list_customers
1889 List agent's customers.
1897 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>