1 package FS::SelfService;
4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
5 $skip_uid_check $dir $socket %autoload $tag );
11 use Storable 2.09 qw(nstore_fd fd_retrieve);
15 @ISA = qw( Exporter );
19 $dir = "/usr/local/freeside";
20 $socket = "$dir/selfservice_socket";
21 $socket .= '.'.$tag if defined $tag && length($tag);
23 #maybe should ask ClientAPI for this list
25 'passwd' => 'passwd/passwd',
26 'chfn' => 'passwd/passwd',
27 'chsh' => 'passwd/passwd',
28 'login_info' => 'MyAccount/login_info',
29 'login_banner_image' => 'MyAccount/login_banner_image',
30 'login' => 'MyAccount/login',
31 'logout' => 'MyAccount/logout',
32 'switch_acct' => 'MyAccount/switch_acct',
33 'customer_info' => 'MyAccount/customer_info',
34 'customer_info_short' => 'MyAccount/customer_info_short',
35 'billing_history' => 'MyAccount/billing_history',
36 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
37 'invoice' => 'MyAccount/invoice',
38 'invoice_pdf' => 'MyAccount/invoice_pdf',
39 'legacy_invoice' => 'MyAccount/legacy_invoice',
40 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
41 'invoice_logo' => 'MyAccount/invoice_logo',
42 'list_invoices' => 'MyAccount/list_invoices', #?
43 'cancel' => 'MyAccount/cancel', #add to ss cgi!
44 'payment_info' => 'MyAccount/payment_info',
45 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
46 'process_payment' => 'MyAccount/process_payment',
47 'store_payment' => 'MyAccount/store_payment',
48 'process_stored_payment' => 'MyAccount/process_stored_payment',
49 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
50 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
51 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
52 'process_prepay' => 'MyAccount/process_prepay',
53 'realtime_collect' => 'MyAccount/realtime_collect',
54 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
55 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
56 'list_svc_usage' => 'MyAccount/list_svc_usage',
57 'svc_status_html' => 'MyAccount/svc_status_html',
58 'svc_status_hash' => 'MyAccount/svc_status_hash',
59 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
60 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
61 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
62 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
63 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
64 'acct_forward_info' => 'MyAccount/acct_forward_info',
65 'process_acct_forward' => 'MyAccount/process_acct_forward',
66 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
67 'add_dsl_device' => 'MyAccount/add_dsl_device',
68 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
69 'port_graph' => 'MyAccount/port_graph',
70 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
71 'list_support_usage' => 'MyAccount/list_support_usage',
72 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
73 'change_pkg' => 'MyAccount/change_pkg',
74 'order_recharge' => 'MyAccount/order_recharge',
75 'renew_info' => 'MyAccount/renew_info',
76 'order_renew' => 'MyAccount/order_renew',
77 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
78 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
79 'charge' => 'MyAccount/charge', #?
80 'part_svc_info' => 'MyAccount/part_svc_info',
81 'provision_acct' => 'MyAccount/provision_acct',
82 'provision_phone' => 'MyAccount/provision_phone',
83 'provision_external' => 'MyAccount/provision_external',
84 'unprovision_svc' => 'MyAccount/unprovision_svc',
85 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
86 'reset_passwd' => 'MyAccount/reset_passwd',
87 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
88 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
89 'create_ticket' => 'MyAccount/create_ticket',
90 'get_ticket' => 'MyAccount/get_ticket',
91 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
92 'did_report' => 'MyAccount/did_report',
93 'signup_info' => 'Signup/signup_info',
94 'skin_info' => 'MyAccount/skin_info',
95 'access_info' => 'MyAccount/access_info',
96 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
97 'new_customer' => 'Signup/new_customer',
98 'capture_payment' => 'Signup/capture_payment',
99 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
100 'new_agent' => 'Agent/new_agent',
101 'agent_login' => 'Agent/agent_login',
102 'agent_logout' => 'Agent/agent_logout',
103 'agent_info' => 'Agent/agent_info',
104 'agent_list_customers' => 'Agent/agent_list_customers',
105 'check_username' => 'Agent/check_username',
106 'suspend_username' => 'Agent/suspend_username',
107 'unsuspend_username' => 'Agent/unsuspend_username',
108 'mason_comp' => 'MasonComponent/mason_comp',
109 'call_time' => 'PrepaidPhone/call_time',
110 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
111 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
115 qw( regionselector regionselector_hashref location_form
116 expselect popselector domainselector didselector
120 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
121 $ENV{'SHELL'} = '/bin/sh';
122 $ENV{'IFS'} = " \t\n";
125 $ENV{'BASH_ENV'} = '';
127 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
128 #if you grant appropriate permissions to whatever user
129 my $freeside_uid = scalar(getpwnam('freeside'));
130 die "not running as the freeside user\n"
131 if $> != $freeside_uid && ! $skip_uid_check;
133 -e $dir or die "FATAL: $dir doesn't exist!";
134 -d $dir or die "FATAL: $dir isn't a directory!";
135 -r $dir or die "FATAL: Can't read $dir as freeside user!";
136 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
138 foreach my $autoload ( keys %autoload ) {
141 "sub $autoload { ". '
146 #warn scalar(@_). ": ". join(" / ", @_);
150 $param->{_packet} = \''. $autoload{$autoload}. '\';
152 simple_packet($param);
162 warn "sending ". $packet->{_packet}. " to server"
164 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
165 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
166 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
169 #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
171 #block until there is a message on socket
172 # my $w = new IO::Select;
174 # my @wait = $w->can_read;
176 warn "reading message from server"
179 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
180 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
182 warn "returning message to client"
190 FS::SelfService - Freeside self-service API
194 # password and shell account changes
195 use FS::SelfService qw(passwd chfn chsh);
197 # "my account" functionality
198 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
200 my $rv = login( { 'username' => $username,
202 'password' => $password,
206 if ( $rv->{'error'} ) {
207 #handle login error...
210 my $session_id = $rv->{'session_id'};
213 my $customer_info = customer_info( { 'session_id' => $session_id } );
215 #payment_info and process_payment are available in 1.5+ only
216 my $payment_info = payment_info( { 'session_id' => $session_id } );
218 #!!! process_payment example
220 #!!! list_pkgs example
222 #!!! order_pkg example
224 #!!! cancel_pkg example
226 # signup functionality
227 use FS::SelfService qw( signup_info new_customer );
229 my $signup_info = signup_info;
231 $rv = new_customer( {
234 'company' => $company,
235 'address1' => $address1,
236 'address2' => $address2,
240 'country' => $country,
241 'daytime' => $daytime,
245 'payinfo' => $payinfo,
247 'paystart_month' => $paystart_month
248 'paystart_year' => $paystart_year,
249 'payissue' => $payissue,
251 'paydate' => $paydate,
252 'payname' => $payname,
253 'invoicing_list' => $invoicing_list,
254 'referral_custnum' => $referral_custnum,
255 'agentnum' => $agentnum,
256 'pkgpart' => $pkgpart,
258 'username' => $username,
259 '_password' => $password,
263 'phonenum' => $phonenum,
268 my $error = $rv->{'error'};
269 if ( $error eq '_decline' ) {
279 Use this API to implement your own client "self-service" module.
281 If you just want to customize the look of the existing "self-service" module,
284 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
296 =head1 "MY ACCOUNT" FUNCTIONS
302 Creates a user session. Takes a hash reference as parameter with the
321 Returns a hash reference with the following keys:
327 Empty on success, or an error message on errors.
331 Session identifier for successful logins
335 =item customer_info HASHREF
337 Returns general customer information.
339 Takes a hash reference as parameter with a single key: B<session_id>
341 Returns a hash reference with the following keys:
355 Array reference of hash references of open inoices. Each hash reference has
356 the following keys: invnum, date, owed
360 An HTML fragment containing shipping and billing addresses.
362 =item The following fields are also returned
364 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
368 =item edit_info HASHREF
370 Takes a hash reference as parameter with any of the following keys:
372 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
374 If a field exists, the customer record is updated with the new value of that
375 field. If a field does not exist, that field is not changed on the customer
378 Returns a hash reference with a single key, B<error>, empty on success, or an
379 error message on errors
381 =item invoice HASHREF
383 Returns an invoice. Takes a hash reference as parameter with two keys:
384 session_id and invnum
386 Returns a hash reference with the following keys:
392 Empty on success, or an error message on errors
404 =item list_invoices HASHREF
406 Returns a list of all customer invoices. Takes a hash references with a single
409 Returns a hash reference with the following keys:
415 Empty on success, or an error message on errors
419 Reference to array of hash references with the following keys:
429 Invoice date, in UNIX epoch time
437 Cancels this customer.
439 Takes a hash reference as parameter with a single key: B<session_id>
441 Returns a hash reference with a single key, B<error>, which is empty on
442 success or an error message on errors.
444 =item payment_info HASHREF
446 Returns information that may be useful in displaying a payment page.
448 Takes a hash reference as parameter with a single key: B<session_id>.
450 Returns a hash reference with the following keys:
456 Empty on success, or an error message on errors
464 Exact name on credit card (CARD/DCRD)
488 Customer's current default payment type.
492 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
496 For CARD/DCRD payment types, the card number
500 For CARD/DCRD payment types, expiration month
504 For CARD/DCRD payment types, expiration year
506 =item cust_main_county
508 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.
512 Array reference of all states in the current default country.
516 Hash reference of card types; keys are card types, values are the exact strings
517 passed to the process_payment function
521 #this doesn't actually work yet
525 #Unique transaction identifier (prevents multiple charges), passed to the
526 #process_payment function
530 =item process_payment HASHREF
532 Processes a payment and possible change of address or payment type. Takes a
533 hash reference as parameter with the following keys:
547 If true, address and card information entered will be saved for subsequent
552 If true, future credit card payments will be done automatically (sets payby to
553 CARD). If false, future credit card payments will be done on-demand (sets
554 payby to DCRD). This option only has meaning if B<save> is set true.
582 Two-letter country code
590 Card expiration month
598 #this doesn't actually work yet
602 #Unique transaction identifier, returned from the payment_info function.
603 #Prevents multiple charges.
607 Returns a hash reference with a single key, B<error>, empty on success, or an
608 error message on errors.
610 =item process_payment_order_pkg
612 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
613 payment processes sucessfully, the package is ordered. Takes a hash reference
614 as parameter with the keys of both methods.
616 Returns a hash reference with a single key, B<error>, empty on success, or an
617 error message on errors.
619 =item process_payment_change_pkg
621 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
622 payment processes sucessfully, the package is ordered. Takes a hash reference
623 as parameter with the keys of both methods.
625 Returns a hash reference with a single key, B<error>, empty on success, or an
626 error message on errors.
629 =item process_payment_order_renew
631 Combines the B<process_payment> and B<order_renew> functions in one step. If
632 the payment processes sucessfully, the renewal is processed. Takes a hash
633 reference as parameter with the keys of both methods.
635 Returns a hash reference with a single key, B<error>, empty on success, or an
636 error message on errors.
640 Returns package information for this customer. For more detail on services,
643 Takes a hash reference as parameter with a single key: B<session_id>
645 Returns a hash reference containing customer package information. The hash reference contains the following keys:
655 Empty on success, or an error message on errors.
657 =item cust_pkg HASHREF
659 Array reference of hash references, each of which has the fields of a cust_pkg
660 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
661 the internal FS:: objects, but hash references of columns and values.
665 =item part_pkg fields
667 All fields of part_pkg for this specific cust_pkg (be careful with this
668 information - it may reveal more about your available packages than you would
669 like users to know in aggregate)
673 #XXX pare part_pkg fields down to a more secure subset
677 An array of hash references indicating information on unprovisioned services
678 available for provisioning for this specific cust_pkg. Each has the following
683 =item part_svc fields
685 All fields of part_svc (be careful with this information - it may reveal more
686 about your available packages than you would like users to know in aggregate)
690 #XXX pare part_svc fields down to a more secure subset
696 An array of hash references indicating information on the customer services
697 already provisioned for this specific cust_pkg. Each has the following keys:
703 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.
709 Primary key for this service
713 Service definition (see L<FS::part_svc>)
717 Customer package (see L<FS::cust_pkg>)
721 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
729 Returns service information for this customer.
731 Takes a hash reference as parameter with a single key: B<session_id>
733 Returns a hash reference containing customer package information. The hash reference contains the following keys:
743 An array of hash references indicating information on all of this customer's
744 services. Each has the following keys:
750 Primary key for this service
758 Meaningful user-specific identifier for the service (i.e. username, domain, or
763 Account (svc_acct) services also have the following keys:
781 Upload bytes remaining
785 Download bytes remaining
789 Total bytes remaining
791 =item recharge_amount
795 =item recharge_seconds
797 Number of seconds gained by recharge
799 =item recharge_upbytes
801 Number of upload bytes gained by recharge
803 =item recharge_downbytes
805 Number of download bytes gained by recharge
807 =item recharge_totalbytes
809 Number of total bytes gained by recharge
817 Orders a package for this customer.
819 Takes a hash reference as parameter with the following keys:
829 Package to order (see L<FS::part_pkg>).
833 Service to order (see L<FS::part_svc>).
835 Normally optional; required only to provision a non-svc_acct service, or if the
836 package definition does not contain one svc_acct service definition with
837 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
838 also be specified to indicate that no initial service should be provisioned.
842 Fields used when provisioning an svc_acct service:
856 Optional security phrase
860 Optional Access number number
864 Fields used when provisioning an svc_domain service:
874 Fields used when provisioning an svc_phone service:
892 Fields used when provisioning an svc_external service:
906 Fields used when provisioning an svc_pbx service:
920 Returns a hash reference with a single key, B<error>, empty on success, or an
921 error message on errors. The special error '_decline' is returned for
922 declined transactions.
926 Changes a package for this customer.
928 Takes a hash reference as parameter with the following keys:
938 Existing customer package.
942 New package to order (see L<FS::part_pkg>).
946 Returns a hash reference with the following keys:
952 Empty on success, or an error message on errors.
956 On success, the new pkgnum
963 Provides useful info for early renewals.
965 Takes a hash reference as parameter with the following keys:
975 Returns a hash reference. On errors, it contains a single key, B<error>, with
976 the error message. Otherwise, contains a single key, B<dates>, pointing to
977 an array refernce of hash references. Each hash reference contains the
984 (Future) Bill date. Indicates a future date for which billing could be run.
985 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
988 =item bill_date_pretty
990 (Future) Bill date as a human-readable string. (Convenience for display;
991 subject to change, so best not to parse for the date.)
995 Base amount which will be charged if renewed early as of this date.
999 Renewal date; i.e. even-futher future date at which the customer will be paid
1000 through if the early renewal is completed with the given B<bill-date>.
1001 Specified as a integer UNIX timestamp.
1003 =item renew_date_pretty
1005 Renewal date as a human-readable string. (Convenience for display;
1006 subject to change, so best not to parse for the date.)
1010 Package that will be renewed.
1014 Expiration date of the package that will be renewed.
1016 =item expire_date_pretty
1018 Expiration date of the package that will be renewed, as a human-readable
1019 string. (Convenience for display; subject to change, so best not to parse for
1026 Renews this customer early; i.e. runs billing for this customer in advance.
1028 Takes a hash reference as parameter with the following keys:
1038 Integer date as returned by the B<renew_info> function, indicating the advance
1039 date for which to run billing.
1043 Returns a hash reference with a single key, B<error>, empty on success, or an
1044 error message on errors.
1048 Cancels a package for this customer.
1050 Takes a hash reference as parameter with the following keys:
1060 pkgpart of package to cancel
1064 Returns a hash reference with a single key, B<error>, empty on success, or an
1065 error message on errors.
1069 =head1 SIGNUP FUNCTIONS
1073 =item signup_info HASHREF
1075 Takes a hash reference as parameter with the following keys:
1079 =item session_id - Optional agent/reseller interface session
1083 Returns a hash reference containing information that may be useful in
1084 displaying a signup page. The hash reference contains the following keys:
1088 =item cust_main_county
1090 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.
1094 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
1095 an agentnum specified explicitly via reseller interface session_id in the
1100 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.
1102 =item agentnum2part_pkg
1104 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.
1108 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.
1110 =item security_phrase
1112 True if the "security_phrase" feature is enabled
1116 Array reference of acceptable payment types for signup
1122 credit card - automatic
1126 credit card - on-demand - version 1.5+ only
1130 electronic check - automatic
1134 electronic check - on-demand - version 1.5+ only
1142 billing, not recommended for signups
1146 free, definitely not recommended for signups
1150 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1156 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1160 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".
1166 =item countrydefault
1172 =item new_customer HASHREF
1174 Creates a new customer. Takes a hash reference as parameter with the
1181 first name (required)
1185 last name (required)
1189 (not typically collected; mostly used for ACH transactions)
1195 =item address1 (required)
1203 =item city (required)
1211 =item state (required)
1215 =item zip (required)
1221 Daytime phone number
1225 Evening phone number
1233 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1237 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1241 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1245 Expiration date for CARD/DCRD
1249 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1251 =item invoicing_list
1253 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),
1255 =item referral_custnum
1257 referring customer number
1265 pkgpart of initial package
1281 Access number (index, not the literal number)
1285 Country code (to be provisioned as a service)
1289 Phone number (to be provisioned as a service)
1297 Returns a hash reference with the following keys:
1303 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)
1307 =item regionselector HASHREF | LIST
1309 Takes as input a hashref or list of key/value pairs with the following keys:
1313 =item selected_county
1315 Currently selected county
1317 =item selected_state
1319 Currently selected state
1321 =item selected_country
1323 Currently selected country
1327 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1331 Specify a javascript subroutine to call on changes
1337 =item default_country
1343 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>.
1347 Returns a list consisting of three HTML fragments for county selection,
1348 state selection and country selection, respectively.
1352 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1353 sub regionselector {
1360 $param->{'selected_country'} ||= $param->{'default_country'};
1361 $param->{'selected_state'} ||= $param->{'default_state'};
1363 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1367 my %cust_main_county;
1369 # unless ( @cust_main_county ) { #cache
1370 #@cust_main_county = qsearch('cust_main_county', {} );
1371 #foreach my $c ( @cust_main_county ) {
1372 foreach my $c ( @{ $param->{'locales'} } ) {
1373 #$countyflag=1 if $c->county;
1374 $countyflag=1 if $c->{county};
1375 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1376 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1377 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1380 $countyflag=1 if $param->{selected_county};
1382 my $script_html = <<END;
1384 function opt(what,value,text) {
1385 var optionName = new Option(text, value, false, false);
1386 var length = what.length;
1387 what.options[length] = optionName;
1389 function ${prefix}country_changed(what) {
1390 country = what.options[what.selectedIndex].text;
1391 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1392 what.form.${prefix}state.options[i] = null;
1394 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1396 foreach my $country ( sort keys %cust_main_county ) {
1397 $script_html .= "\nif ( country == \"$country\" ) {\n";
1398 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1399 my $text = $state || '(n/a)';
1400 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1402 $script_html .= "}\n";
1405 $script_html .= <<END;
1407 function ${prefix}state_changed(what) {
1410 if ( $countyflag ) {
1411 $script_html .= <<END;
1412 state = what.options[what.selectedIndex].text;
1413 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1414 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1415 what.form.${prefix}county.options[i] = null;
1418 foreach my $country ( sort keys %cust_main_county ) {
1419 $script_html .= "\nif ( country == \"$country\" ) {\n";
1420 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1421 $script_html .= "\nif ( state == \"$state\" ) {\n";
1422 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1423 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1424 my $text = $county || '(n/a)';
1426 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1428 $script_html .= "}\n";
1430 $script_html .= "}\n";
1434 $script_html .= <<END;
1439 my $county_html = $script_html;
1440 if ( $countyflag ) {
1441 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1442 foreach my $county (
1443 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1445 my $text = $county || '(n/a)';
1446 $county_html .= qq!<OPTION VALUE="$county"!.
1447 ($county eq $param->{'selected_county'} ?
1454 $county_html .= '</SELECT>';
1457 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1460 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1461 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1462 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1463 my $text = $state || '(n/a)';
1464 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1465 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1467 $state_html .= '</SELECT>';
1469 my $country_html = '';
1470 if ( scalar( keys %cust_main_county ) > 1 ) {
1472 $country_html = qq(<SELECT NAME="${prefix}country" ).
1473 qq(onChange="${prefix}country_changed(this); ).
1474 $param->{'onchange'}.
1477 my $countrydefault = $param->{default_country} || 'US';
1478 foreach my $country (
1479 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1480 keys %cust_main_county
1482 my $selected = $country eq $param->{'selected_country'}
1485 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1487 $country_html .= '</SELECT>';
1490 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1491 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1495 ($county_html, $state_html, $country_html);
1499 sub regionselector_hashref {
1500 my ($county_html, $state_html, $country_html) = regionselector(@_);
1502 'county_html' => $county_html,
1503 'state_html' => $state_html,
1504 'country_html' => $country_html,
1508 =item location_form HASHREF | LIST
1510 Takes as input a hashref or list of key/value pairs with the following keys:
1516 Current customer session_id
1520 Omit red asterisks from required fields.
1522 =item address1_label
1524 Label for first address line.
1528 Returns an HTML fragment for a location form (address, city, state, zip,
1541 my $session_id = delete $param->{'session_id'};
1543 my $rv = mason_comp( 'session_id' => $session_id,
1544 'comp' => '/elements/location.html',
1545 'args' => [ %$param ],
1549 $rv->{'error'} || $rv->{'output'};
1554 #=item expselect HASHREF | LIST
1556 #Takes as input a hashref or list of key/value pairs with the following keys:
1560 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1562 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1566 =item expselect PREFIX [ DATE ]
1568 Takes as input a unique prefix string and the current expiration date, in
1569 yyyy-mm-dd or m-d-yyyy format
1571 Returns an HTML fragments for expiration date selection.
1577 #if ( ref($_[0]) ) {
1581 #my $prefix = $param->{'prefix'};
1582 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1583 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1585 my $date = scalar(@_) ? shift : '';
1587 my( $m, $y ) = ( 0, 0 );
1588 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1589 ( $m, $y ) = ( $2, $1 );
1590 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1591 ( $m, $y ) = ( $1, $3 );
1593 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1595 $return .= qq!<OPTION VALUE="$_"!;
1596 $return .= " SELECTED" if $_ == $m;
1599 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1601 my $thisYear = $t[5] + 1900;
1602 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1603 $return .= qq!<OPTION VALUE="$_"!;
1604 $return .= " SELECTED" if $_ == $y;
1607 $return .= "</SELECT>";
1612 =item popselector HASHREF | LIST
1614 Takes as input a hashref or list of key/value pairs with the following keys:
1620 Access number number
1624 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>.
1628 Returns an HTML fragment for access number selection.
1632 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1640 my $popnum = $param->{'popnum'};
1641 my $pops = $param->{'pops'};
1643 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1644 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1645 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1646 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1647 if scalar(@$pops) == 1;
1650 my %popnum2pop = ();
1652 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1653 $popnum2pop{$_->{popnum}} = $_;
1658 function opt(what,href,text) {
1659 var optionName = new Option(text, href, false, false)
1660 var length = what.length;
1661 what.options[length] = optionName;
1665 my $init_popstate = $param->{'init_popstate'};
1666 if ( $init_popstate ) {
1667 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1668 $init_popstate. '">';
1671 function acstate_changed(what) {
1672 state = what.options[what.selectedIndex].text;
1673 what.form.popac.options.length = 0
1674 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1678 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1679 foreach my $state ( sort { $a cmp $b } @states ) {
1680 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1682 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1683 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1684 if ($ac eq $param->{'popac'}) {
1685 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1688 $text .= "}\n" unless $init_popstate;
1690 $text .= "popac_changed(what.form.popac)}\n";
1693 function popac_changed(what) {
1694 ac = what.options[what.selectedIndex].text;
1695 what.form.popnum.options.length = 0;
1696 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1700 foreach my $state ( @states ) {
1701 foreach my $popac ( keys %{ $pop{$state} } ) {
1702 $text .= "\nif ( ac == \"$popac\" ) {\n";
1704 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1705 my $o_popnum = $pop->{popnum};
1706 my $poptext = $pop->{city}. ', '. $pop->{state}.
1707 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1709 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1710 if ($popnum == $o_popnum) {
1711 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1719 $text .= "}\n</SCRIPT>\n";
1721 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1724 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1725 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1726 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1727 ">$_" foreach sort { $a cmp $b } @states;
1728 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1731 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1732 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1734 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1737 #comment this block to disable initial list polulation
1738 my @initial_select = ();
1739 if ( scalar( @$pops ) > 100 ) {
1740 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1742 @initial_select = @$pops;
1744 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1745 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1746 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1747 $pop->{city}. ', '. $pop->{state}.
1748 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1751 $text .= qq!</SELECT></TD></TR></TABLE>!;
1757 =item domainselector HASHREF | LIST
1759 Takes as input a hashref or list of key/value pairs with the following keys:
1769 Service number of the selected item.
1773 Returns an HTML fragment for domain selection.
1777 sub domainselector {
1784 my $domsvc= $param->{'domsvc'};
1786 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1787 my $domains = $rv->{'domains'};
1788 $domsvc = $rv->{'domsvc'} unless $domsvc;
1790 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1791 unless scalar(keys %$domains);
1793 if (scalar(keys %$domains) == 1) {
1795 foreach(keys %$domains) {
1798 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1799 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1802 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1805 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1806 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1807 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1808 $domains->{$domain};
1811 $text .= qq!</SELECT></TD></TR>!;
1817 =item didselector HASHREF | LIST
1819 Takes as input a hashref or list of key/value pairs with the following keys:
1825 Field name for the returned HTML fragment.
1829 Service definition (see L<FS::part_svc>)
1833 Returns an HTML fragment for DID selection.
1845 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1846 'args'=>[ %$param ],
1850 $rv->{'error'} || $rv->{'output'};
1856 =head1 RESELLER FUNCTIONS
1858 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1859 with their active session, and the B<customer_info> and B<order_pkg> functions
1860 with their active session and an additional I<custnum> parameter.
1862 For the most part, development of the reseller web interface has been
1863 superceded by agent-virtualized access to the backend.
1875 =item agent_list_customers
1877 List agent's customers.
1885 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>