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' => 'MyAccount/login',
30 'logout' => 'MyAccount/logout',
31 'switch_acct' => 'MyAccount/switch_acct',
32 'customer_info' => 'MyAccount/customer_info',
33 'customer_info_short' => 'MyAccount/customer_info_short',
34 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
35 'invoice' => 'MyAccount/invoice',
36 'invoice_pdf' => 'MyAccount/invoice_pdf',
37 'legacy_invoice' => 'MyAccount/legacy_invoice',
38 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
39 'invoice_logo' => 'MyAccount/invoice_logo',
40 'list_invoices' => 'MyAccount/list_invoices', #?
41 'cancel' => 'MyAccount/cancel', #add to ss cgi!
42 'payment_info' => 'MyAccount/payment_info',
43 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
44 'process_payment' => 'MyAccount/process_payment',
45 'store_payment' => 'MyAccount/store_payment',
46 'process_stored_payment' => 'MyAccount/process_stored_payment',
47 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
48 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
49 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
50 'process_prepay' => 'MyAccount/process_prepay',
51 'realtime_collect' => 'MyAccount/realtime_collect',
52 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
53 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
54 'list_svc_usage' => 'MyAccount/list_svc_usage',
55 'svc_status_html' => 'MyAccount/svc_status_html',
56 'acct_forward_info' => 'MyAccount/acct_forward_info',
57 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
58 'add_dsl_device' => 'MyAccount/add_dsl_device',
59 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
60 'port_graph' => 'MyAccount/port_graph',
61 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
62 'list_support_usage' => 'MyAccount/list_support_usage',
63 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
64 'change_pkg' => 'MyAccount/change_pkg',
65 'order_recharge' => 'MyAccount/order_recharge',
66 'renew_info' => 'MyAccount/renew_info',
67 'order_renew' => 'MyAccount/order_renew',
68 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
69 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
70 'charge' => 'MyAccount/charge', #?
71 'part_svc_info' => 'MyAccount/part_svc_info',
72 'provision_acct' => 'MyAccount/provision_acct',
73 'provision_phone' => 'MyAccount/provision_phone',
74 'provision_external' => 'MyAccount/provision_external',
75 'unprovision_svc' => 'MyAccount/unprovision_svc',
76 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
77 'reset_passwd' => 'MyAccount/reset_passwd',
78 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
79 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
80 'create_ticket' => 'MyAccount/create_ticket',
81 'get_ticket' => 'MyAccount/get_ticket',
82 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
83 'did_report' => 'MyAccount/did_report',
84 'signup_info' => 'Signup/signup_info',
85 'skin_info' => 'MyAccount/skin_info',
86 'access_info' => 'MyAccount/access_info',
87 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
88 'new_customer' => 'Signup/new_customer',
89 'capture_payment' => 'Signup/capture_payment',
90 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
91 'new_agent' => 'Agent/new_agent',
92 'agent_login' => 'Agent/agent_login',
93 'agent_logout' => 'Agent/agent_logout',
94 'agent_info' => 'Agent/agent_info',
95 'agent_list_customers' => 'Agent/agent_list_customers',
96 'check_username' => 'Agent/check_username',
97 'suspend_username' => 'Agent/suspend_username',
98 'unsuspend_username' => 'Agent/unsuspend_username',
99 'mason_comp' => 'MasonComponent/mason_comp',
100 'call_time' => 'PrepaidPhone/call_time',
101 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
102 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
104 #'bulk_processrow' => 'Bulk/processrow',
105 #conflicts w/Agent one# 'check_username' => 'Bulk/check_username',
107 'ping' => 'SGNG/ping',
108 'decompify_pkgs' => 'SGNG/decompify_pkgs',
109 'previous_payment_info' => 'SGNG/previous_payment_info',
110 'previous_payment_info_renew_info'
111 => 'SGNG/previous_payment_info_renew_info',
112 'previous_process_payment' => 'SGNG/previous_process_payment',
113 'previous_process_payment_order_pkg'
114 => 'SGNG/previous_process_payment_order_pkg',
115 'previous_process_payment_change_pkg'
116 => 'SGNG/previous_process_payment_change_pkg',
117 'previous_process_payment_order_renew'
118 => 'SGNG/previous_process_payment_order_renew',
122 qw( regionselector regionselector_hashref location_form
123 expselect popselector domainselector didselector
127 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
128 $ENV{'SHELL'} = '/bin/sh';
129 $ENV{'IFS'} = " \t\n";
132 $ENV{'BASH_ENV'} = '';
134 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
135 #if you grant appropriate permissions to whatever user
136 my $freeside_uid = scalar(getpwnam('freeside'));
137 die "not running as the freeside user\n"
138 if $> != $freeside_uid && ! $skip_uid_check;
140 -e $dir or die "FATAL: $dir doesn't exist!";
141 -d $dir or die "FATAL: $dir isn't a directory!";
142 -r $dir or die "FATAL: Can't read $dir as freeside user!";
143 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
145 foreach my $autoload ( keys %autoload ) {
148 "sub $autoload { ". '
153 #warn scalar(@_). ": ". join(" / ", @_);
157 $param->{_packet} = \''. $autoload{$autoload}. '\';
159 simple_packet($param);
169 warn "sending ". $packet->{_packet}. " to server"
171 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
172 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
173 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
176 #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
178 #block until there is a message on socket
179 # my $w = new IO::Select;
181 # my @wait = $w->can_read;
183 warn "reading message from server"
186 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
187 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
189 warn "returning message to client"
197 FS::SelfService - Freeside self-service API
201 # password and shell account changes
202 use FS::SelfService qw(passwd chfn chsh);
204 # "my account" functionality
205 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
207 my $rv = login( { 'username' => $username,
209 'password' => $password,
213 if ( $rv->{'error'} ) {
214 #handle login error...
217 my $session_id = $rv->{'session_id'};
220 my $customer_info = customer_info( { 'session_id' => $session_id } );
222 #payment_info and process_payment are available in 1.5+ only
223 my $payment_info = payment_info( { 'session_id' => $session_id } );
225 #!!! process_payment example
227 #!!! list_pkgs example
229 #!!! order_pkg example
231 #!!! cancel_pkg example
233 # signup functionality
234 use FS::SelfService qw( signup_info new_customer );
236 my $signup_info = signup_info;
238 $rv = new_customer( {
241 'company' => $company,
242 'address1' => $address1,
243 'address2' => $address2,
247 'country' => $country,
248 'daytime' => $daytime,
252 'payinfo' => $payinfo,
254 'paystart_month' => $paystart_month
255 'paystart_year' => $paystart_year,
256 'payissue' => $payissue,
258 'paydate' => $paydate,
259 'payname' => $payname,
260 'invoicing_list' => $invoicing_list,
261 'referral_custnum' => $referral_custnum,
262 'agentnum' => $agentnum,
263 'pkgpart' => $pkgpart,
265 'username' => $username,
266 '_password' => $password,
270 'phonenum' => $phonenum,
275 my $error = $rv->{'error'};
276 if ( $error eq '_decline' ) {
286 Use this API to implement your own client "self-service" module.
288 If you just want to customize the look of the existing "self-service" module,
291 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
303 =head1 "MY ACCOUNT" FUNCTIONS
309 Creates a user session. Takes a hash reference as parameter with the
328 Returns a hash reference with the following keys:
334 Empty on success, or an error message on errors.
338 Session identifier for successful logins
342 =item customer_info HASHREF
344 Returns general customer information.
346 Takes a hash reference as parameter with a single key: B<session_id>
348 Returns a hash reference with the following keys:
362 Array reference of hash references of open inoices. Each hash reference has
363 the following keys: invnum, date, owed
367 An HTML fragment containing shipping and billing addresses.
369 =item The following fields are also returned
371 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
375 =item edit_info HASHREF
377 Takes a hash reference as parameter with any of the following keys:
379 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
381 If a field exists, the customer record is updated with the new value of that
382 field. If a field does not exist, that field is not changed on the customer
385 Returns a hash reference with a single key, B<error>, empty on success, or an
386 error message on errors
388 =item invoice HASHREF
390 Returns an invoice. Takes a hash reference as parameter with two keys:
391 session_id and invnum
393 Returns a hash reference with the following keys:
399 Empty on success, or an error message on errors
411 =item list_invoices HASHREF
413 Returns a list of all customer invoices. Takes a hash references with a single
416 Returns a hash reference with the following keys:
422 Empty on success, or an error message on errors
426 Reference to array of hash references with the following keys:
436 Invoice date, in UNIX epoch time
444 Cancels this customer.
446 Takes a hash reference as parameter with a single key: B<session_id>
448 Returns a hash reference with a single key, B<error>, which is empty on
449 success or an error message on errors.
451 =item payment_info HASHREF
453 Returns information that may be useful in displaying a payment page.
455 Takes a hash reference as parameter with a single key: B<session_id>.
457 Returns a hash reference with the following keys:
463 Empty on success, or an error message on errors
471 Exact name on credit card (CARD/DCRD)
495 Customer's current default payment type.
499 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
503 For CARD/DCRD payment types, the card number
507 For CARD/DCRD payment types, expiration month
511 For CARD/DCRD payment types, expiration year
513 =item cust_main_county
515 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.
519 Array reference of all states in the current default country.
523 Hash reference of card types; keys are card types, values are the exact strings
524 passed to the process_payment function
528 #this doesn't actually work yet
532 #Unique transaction identifier (prevents multiple charges), passed to the
533 #process_payment function
537 =item process_payment HASHREF
539 Processes a payment and possible change of address or payment type. Takes a
540 hash reference as parameter with the following keys:
554 If true, address and card information entered will be saved for subsequent
559 If true, future credit card payments will be done automatically (sets payby to
560 CARD). If false, future credit card payments will be done on-demand (sets
561 payby to DCRD). This option only has meaning if B<save> is set true.
589 Two-letter country code
597 Card expiration month
605 #this doesn't actually work yet
609 #Unique transaction identifier, returned from the payment_info function.
610 #Prevents multiple charges.
614 Returns a hash reference with a single key, B<error>, empty on success, or an
615 error message on errors.
617 =item process_payment_order_pkg
619 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
620 payment processes sucessfully, the package is ordered. Takes a hash reference
621 as parameter with the keys of both methods.
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_change_pkg
628 Combines the B<process_payment> and B<change_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.
636 =item process_payment_order_renew
638 Combines the B<process_payment> and B<order_renew> functions in one step. If
639 the payment processes sucessfully, the renewal is processed. Takes a hash
640 reference as parameter with the keys of both methods.
642 Returns a hash reference with a single key, B<error>, empty on success, or an
643 error message on errors.
647 Returns package information for this customer. For more detail on services,
650 Takes a hash reference as parameter with a single key: B<session_id>
652 Returns a hash reference containing customer package information. The hash reference contains the following keys:
662 Empty on success, or an error message on errors.
664 =item cust_pkg HASHREF
666 Array reference of hash references, each of which has the fields of a cust_pkg
667 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
668 the internal FS:: objects, but hash references of columns and values.
672 =item part_pkg fields
674 All fields of part_pkg for this specific cust_pkg (be careful with this
675 information - it may reveal more about your available packages than you would
676 like users to know in aggregate)
680 #XXX pare part_pkg fields down to a more secure subset
684 An array of hash references indicating information on unprovisioned services
685 available for provisioning for this specific cust_pkg. Each has the following
690 =item part_svc fields
692 All fields of part_svc (be careful with this information - it may reveal more
693 about your available packages than you would like users to know in aggregate)
697 #XXX pare part_svc fields down to a more secure subset
703 An array of hash references indicating information on the customer services
704 already provisioned for this specific cust_pkg. Each has the following keys:
710 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.
716 Primary key for this service
720 Service definition (see L<FS::part_svc>)
724 Customer package (see L<FS::cust_pkg>)
728 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
736 Returns service information for this customer.
738 Takes a hash reference as parameter with a single key: B<session_id>
740 Returns a hash reference containing customer package information. The hash reference contains the following keys:
750 An array of hash references indicating information on all of this customer's
751 services. Each has the following keys:
757 Primary key for this service
765 Meaningful user-specific identifier for the service (i.e. username, domain, or
770 Account (svc_acct) services also have the following keys:
788 Upload bytes remaining
792 Download bytes remaining
796 Total bytes remaining
798 =item recharge_amount
802 =item recharge_seconds
804 Number of seconds gained by recharge
806 =item recharge_upbytes
808 Number of upload bytes gained by recharge
810 =item recharge_downbytes
812 Number of download bytes gained by recharge
814 =item recharge_totalbytes
816 Number of total bytes gained by recharge
824 Orders a package for this customer.
826 Takes a hash reference as parameter with the following keys:
836 Package to order (see L<FS::part_pkg>).
840 Service to order (see L<FS::part_svc>).
842 Normally optional; required only to provision a non-svc_acct service, or if the
843 package definition does not contain one svc_acct service definition with
844 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
845 also be specified to indicate that no initial service should be provisioned.
849 Fields used when provisioning an svc_acct service:
863 Optional security phrase
867 Optional Access number number
871 Fields used when provisioning an svc_domain service:
881 Fields used when provisioning an svc_phone service:
899 Fields used when provisioning an svc_external service:
913 Fields used when provisioning an svc_pbx service:
927 Returns a hash reference with a single key, B<error>, empty on success, or an
928 error message on errors. The special error '_decline' is returned for
929 declined transactions.
933 Changes a package for this customer.
935 Takes a hash reference as parameter with the following keys:
945 Existing customer package.
949 New package to order (see L<FS::part_pkg>).
953 Returns a hash reference with the following keys:
959 Empty on success, or an error message on errors.
963 On success, the new pkgnum
970 Provides useful info for early renewals.
972 Takes a hash reference as parameter with the following keys:
982 Returns a hash reference. On errors, it contains a single key, B<error>, with
983 the error message. Otherwise, contains a single key, B<dates>, pointing to
984 an array refernce of hash references. Each hash reference contains the
991 (Future) Bill date. Indicates a future date for which billing could be run.
992 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
995 =item bill_date_pretty
997 (Future) Bill date as a human-readable string. (Convenience for display;
998 subject to change, so best not to parse for the date.)
1002 Base amount which will be charged if renewed early as of this date.
1006 Renewal date; i.e. even-futher future date at which the customer will be paid
1007 through if the early renewal is completed with the given B<bill-date>.
1008 Specified as a integer UNIX timestamp.
1010 =item renew_date_pretty
1012 Renewal date as a human-readable string. (Convenience for display;
1013 subject to change, so best not to parse for the date.)
1017 Package that will be renewed.
1021 Expiration date of the package that will be renewed.
1023 =item expire_date_pretty
1025 Expiration date of the package that will be renewed, as a human-readable
1026 string. (Convenience for display; subject to change, so best not to parse for
1033 Renews this customer early; i.e. runs billing for this customer in advance.
1035 Takes a hash reference as parameter with the following keys:
1045 Integer date as returned by the B<renew_info> function, indicating the advance
1046 date for which to run billing.
1050 Returns a hash reference with a single key, B<error>, empty on success, or an
1051 error message on errors.
1055 Cancels a package for this customer.
1057 Takes a hash reference as parameter with the following keys:
1067 pkgpart of package to cancel
1071 Returns a hash reference with a single key, B<error>, empty on success, or an
1072 error message on errors.
1076 =head1 SIGNUP FUNCTIONS
1080 =item signup_info HASHREF
1082 Takes a hash reference as parameter with the following keys:
1086 =item session_id - Optional agent/reseller interface session
1090 Returns a hash reference containing information that may be useful in
1091 displaying a signup page. The hash reference contains the following keys:
1095 =item cust_main_county
1097 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.
1101 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
1102 an agentnum specified explicitly via reseller interface session_id in the
1107 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.
1109 =item agentnum2part_pkg
1111 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.
1115 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.
1117 =item security_phrase
1119 True if the "security_phrase" feature is enabled
1123 Array reference of acceptable payment types for signup
1129 credit card - automatic
1133 credit card - on-demand - version 1.5+ only
1137 electronic check - automatic
1141 electronic check - on-demand - version 1.5+ only
1149 billing, not recommended for signups
1153 free, definitely not recommended for signups
1157 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1163 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1167 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".
1173 =item countrydefault
1179 =item new_customer HASHREF
1181 Creates a new customer. Takes a hash reference as parameter with the
1188 first name (required)
1192 last name (required)
1196 (not typically collected; mostly used for ACH transactions)
1202 =item address1 (required)
1210 =item city (required)
1218 =item state (required)
1222 =item zip (required)
1228 Daytime phone number
1232 Evening phone number
1240 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1244 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1248 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1252 Expiration date for CARD/DCRD
1256 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1258 =item invoicing_list
1260 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),
1262 =item referral_custnum
1264 referring customer number
1272 pkgpart of initial package
1288 Access number (index, not the literal number)
1292 Country code (to be provisioned as a service)
1296 Phone number (to be provisioned as a service)
1304 Returns a hash reference with the following keys:
1310 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)
1314 =item regionselector HASHREF | LIST
1316 Takes as input a hashref or list of key/value pairs with the following keys:
1320 =item selected_county
1322 Currently selected county
1324 =item selected_state
1326 Currently selected state
1328 =item selected_country
1330 Currently selected country
1334 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1338 Specify a javascript subroutine to call on changes
1344 =item default_country
1350 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>.
1354 Returns a list consisting of three HTML fragments for county selection,
1355 state selection and country selection, respectively.
1359 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1360 sub regionselector {
1367 $param->{'selected_country'} ||= $param->{'default_country'};
1368 $param->{'selected_state'} ||= $param->{'default_state'};
1370 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1374 my %cust_main_county;
1376 # unless ( @cust_main_county ) { #cache
1377 #@cust_main_county = qsearch('cust_main_county', {} );
1378 #foreach my $c ( @cust_main_county ) {
1379 foreach my $c ( @{ $param->{'locales'} } ) {
1380 #$countyflag=1 if $c->county;
1381 $countyflag=1 if $c->{county};
1382 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1383 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1384 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1387 $countyflag=1 if $param->{selected_county};
1389 my $script_html = <<END;
1391 function opt(what,value,text) {
1392 var optionName = new Option(text, value, false, false);
1393 var length = what.length;
1394 what.options[length] = optionName;
1396 function ${prefix}country_changed(what) {
1397 country = what.options[what.selectedIndex].text;
1398 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1399 what.form.${prefix}state.options[i] = null;
1401 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1403 foreach my $country ( sort keys %cust_main_county ) {
1404 $script_html .= "\nif ( country == \"$country\" ) {\n";
1405 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1406 my $text = $state || '(n/a)';
1407 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1409 $script_html .= "}\n";
1412 $script_html .= <<END;
1414 function ${prefix}state_changed(what) {
1417 if ( $countyflag ) {
1418 $script_html .= <<END;
1419 state = what.options[what.selectedIndex].text;
1420 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1421 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1422 what.form.${prefix}county.options[i] = null;
1425 foreach my $country ( sort keys %cust_main_county ) {
1426 $script_html .= "\nif ( country == \"$country\" ) {\n";
1427 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1428 $script_html .= "\nif ( state == \"$state\" ) {\n";
1429 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1430 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1431 my $text = $county || '(n/a)';
1433 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1435 $script_html .= "}\n";
1437 $script_html .= "}\n";
1441 $script_html .= <<END;
1446 my $county_html = $script_html;
1447 if ( $countyflag ) {
1448 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1449 foreach my $county (
1450 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1452 my $text = $county || '(n/a)';
1453 $county_html .= qq!<OPTION VALUE="$county"!.
1454 ($county eq $param->{'selected_county'} ?
1461 $county_html .= '</SELECT>';
1464 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1467 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1468 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1469 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1470 my $text = $state || '(n/a)';
1471 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1472 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1474 $state_html .= '</SELECT>';
1476 my $country_html = '';
1477 if ( scalar( keys %cust_main_county ) > 1 ) {
1479 $country_html = qq(<SELECT NAME="${prefix}country" ).
1480 qq(onChange="${prefix}country_changed(this); ).
1481 $param->{'onchange'}.
1484 my $countrydefault = $param->{default_country} || 'US';
1485 foreach my $country (
1486 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1487 keys %cust_main_county
1489 my $selected = $country eq $param->{'selected_country'}
1492 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1494 $country_html .= '</SELECT>';
1497 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1498 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1502 ($county_html, $state_html, $country_html);
1506 sub regionselector_hashref {
1507 my ($county_html, $state_html, $country_html) = regionselector(@_);
1509 'county_html' => $county_html,
1510 'state_html' => $state_html,
1511 'country_html' => $country_html,
1515 =item location_form HASHREF | LIST
1517 Takes as input a hashref or list of key/value pairs with the following keys:
1523 Current customer session_id
1527 Omit red asterisks from required fields.
1529 =item address1_label
1531 Label for first address line.
1535 Returns an HTML fragment for a location form (address, city, state, zip,
1548 my $session_id = delete $param->{'session_id'};
1550 my $rv = mason_comp( 'session_id' => $session_id,
1551 'comp' => '/elements/location.html',
1552 'args' => [ %$param ],
1556 $rv->{'error'} || $rv->{'output'};
1561 #=item expselect HASHREF | LIST
1563 #Takes as input a hashref or list of key/value pairs with the following keys:
1567 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1569 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1573 =item expselect PREFIX [ DATE ]
1575 Takes as input a unique prefix string and the current expiration date, in
1576 yyyy-mm-dd or m-d-yyyy format
1578 Returns an HTML fragments for expiration date selection.
1584 #if ( ref($_[0]) ) {
1588 #my $prefix = $param->{'prefix'};
1589 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1590 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1592 my $date = scalar(@_) ? shift : '';
1594 my( $m, $y ) = ( 0, 0 );
1595 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1596 ( $m, $y ) = ( $2, $1 );
1597 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1598 ( $m, $y ) = ( $1, $3 );
1600 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1602 $return .= qq!<OPTION VALUE="$_"!;
1603 $return .= " SELECTED" if $_ == $m;
1606 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1608 my $thisYear = $t[5] + 1900;
1609 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1610 $return .= qq!<OPTION VALUE="$_"!;
1611 $return .= " SELECTED" if $_ == $y;
1614 $return .= "</SELECT>";
1619 =item popselector HASHREF | LIST
1621 Takes as input a hashref or list of key/value pairs with the following keys:
1627 Access number number
1631 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>.
1635 Returns an HTML fragment for access number selection.
1639 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1647 my $popnum = $param->{'popnum'};
1648 my $pops = $param->{'pops'};
1650 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1651 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1652 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1653 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1654 if scalar(@$pops) == 1;
1657 my %popnum2pop = ();
1659 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1660 $popnum2pop{$_->{popnum}} = $_;
1665 function opt(what,href,text) {
1666 var optionName = new Option(text, href, false, false)
1667 var length = what.length;
1668 what.options[length] = optionName;
1672 my $init_popstate = $param->{'init_popstate'};
1673 if ( $init_popstate ) {
1674 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1675 $init_popstate. '">';
1678 function acstate_changed(what) {
1679 state = what.options[what.selectedIndex].text;
1680 what.form.popac.options.length = 0
1681 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1685 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1686 foreach my $state ( sort { $a cmp $b } @states ) {
1687 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1689 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1690 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1691 if ($ac eq $param->{'popac'}) {
1692 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1695 $text .= "}\n" unless $init_popstate;
1697 $text .= "popac_changed(what.form.popac)}\n";
1700 function popac_changed(what) {
1701 ac = what.options[what.selectedIndex].text;
1702 what.form.popnum.options.length = 0;
1703 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1707 foreach my $state ( @states ) {
1708 foreach my $popac ( keys %{ $pop{$state} } ) {
1709 $text .= "\nif ( ac == \"$popac\" ) {\n";
1711 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1712 my $o_popnum = $pop->{popnum};
1713 my $poptext = $pop->{city}. ', '. $pop->{state}.
1714 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1716 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1717 if ($popnum == $o_popnum) {
1718 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1726 $text .= "}\n</SCRIPT>\n";
1728 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1731 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1732 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1733 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1734 ">$_" foreach sort { $a cmp $b } @states;
1735 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1738 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1739 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1741 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1744 #comment this block to disable initial list polulation
1745 my @initial_select = ();
1746 if ( scalar( @$pops ) > 100 ) {
1747 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1749 @initial_select = @$pops;
1751 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1752 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1753 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1754 $pop->{city}. ', '. $pop->{state}.
1755 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1758 $text .= qq!</SELECT></TD></TR></TABLE>!;
1764 =item domainselector HASHREF | LIST
1766 Takes as input a hashref or list of key/value pairs with the following keys:
1776 Service number of the selected item.
1780 Returns an HTML fragment for domain selection.
1784 sub domainselector {
1791 my $domsvc= $param->{'domsvc'};
1793 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1794 my $domains = $rv->{'domains'};
1795 $domsvc = $rv->{'domsvc'} unless $domsvc;
1797 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1798 unless scalar(keys %$domains);
1800 if (scalar(keys %$domains) == 1) {
1802 foreach(keys %$domains) {
1805 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1806 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1809 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1812 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1813 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1814 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1815 $domains->{$domain};
1818 $text .= qq!</SELECT></TD></TR>!;
1824 =item didselector HASHREF | LIST
1826 Takes as input a hashref or list of key/value pairs with the following keys:
1832 Field name for the returned HTML fragment.
1836 Service definition (see L<FS::part_svc>)
1840 Returns an HTML fragment for DID selection.
1852 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1853 'args'=>[ %$param ],
1857 $rv->{'error'} || $rv->{'output'};
1863 =head1 RESELLER FUNCTIONS
1865 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1866 with their active session, and the B<customer_info> and B<order_pkg> functions
1867 with their active session and an additional I<custnum> parameter.
1869 For the most part, development of the reseller web interface has been
1870 superceded by agent-virtualized access to the backend.
1882 =item agent_list_customers
1884 List agent's customers.
1892 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>