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 'acct_forward_info' => 'MyAccount/acct_forward_info',
63 'process_acct_forward' => 'MyAccount/process_acct_forward',
64 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
65 'add_dsl_device' => 'MyAccount/add_dsl_device',
66 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
67 'port_graph' => 'MyAccount/port_graph',
68 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
69 'list_support_usage' => 'MyAccount/list_support_usage',
70 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
71 'change_pkg' => 'MyAccount/change_pkg',
72 'order_recharge' => 'MyAccount/order_recharge',
73 'renew_info' => 'MyAccount/renew_info',
74 'order_renew' => 'MyAccount/order_renew',
75 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
76 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
77 'charge' => 'MyAccount/charge', #?
78 'part_svc_info' => 'MyAccount/part_svc_info',
79 'provision_acct' => 'MyAccount/provision_acct',
80 'provision_phone' => 'MyAccount/provision_phone',
81 'provision_external' => 'MyAccount/provision_external',
82 'unprovision_svc' => 'MyAccount/unprovision_svc',
83 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
84 'reset_passwd' => 'MyAccount/reset_passwd',
85 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
86 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
87 'create_ticket' => 'MyAccount/create_ticket',
88 'get_ticket' => 'MyAccount/get_ticket',
89 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
90 'did_report' => 'MyAccount/did_report',
91 'signup_info' => 'Signup/signup_info',
92 'skin_info' => 'MyAccount/skin_info',
93 'access_info' => 'MyAccount/access_info',
94 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
95 'new_customer' => 'Signup/new_customer',
96 'capture_payment' => 'Signup/capture_payment',
97 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
98 'new_agent' => 'Agent/new_agent',
99 'agent_login' => 'Agent/agent_login',
100 'agent_logout' => 'Agent/agent_logout',
101 'agent_info' => 'Agent/agent_info',
102 'agent_list_customers' => 'Agent/agent_list_customers',
103 'check_username' => 'Agent/check_username',
104 'suspend_username' => 'Agent/suspend_username',
105 'unsuspend_username' => 'Agent/unsuspend_username',
106 'mason_comp' => 'MasonComponent/mason_comp',
107 'call_time' => 'PrepaidPhone/call_time',
108 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
109 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
113 qw( regionselector regionselector_hashref location_form
114 expselect popselector domainselector didselector
118 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
119 $ENV{'SHELL'} = '/bin/sh';
120 $ENV{'IFS'} = " \t\n";
123 $ENV{'BASH_ENV'} = '';
125 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
126 #if you grant appropriate permissions to whatever user
127 my $freeside_uid = scalar(getpwnam('freeside'));
128 die "not running as the freeside user\n"
129 if $> != $freeside_uid && ! $skip_uid_check;
131 -e $dir or die "FATAL: $dir doesn't exist!";
132 -d $dir or die "FATAL: $dir isn't a directory!";
133 -r $dir or die "FATAL: Can't read $dir as freeside user!";
134 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
136 foreach my $autoload ( keys %autoload ) {
139 "sub $autoload { ". '
144 #warn scalar(@_). ": ". join(" / ", @_);
148 $param->{_packet} = \''. $autoload{$autoload}. '\';
150 simple_packet($param);
160 warn "sending ". $packet->{_packet}. " to server"
162 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
163 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
164 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
167 #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
169 #block until there is a message on socket
170 # my $w = new IO::Select;
172 # my @wait = $w->can_read;
174 warn "reading message from server"
177 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
178 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
180 warn "returning message to client"
188 FS::SelfService - Freeside self-service API
192 # password and shell account changes
193 use FS::SelfService qw(passwd chfn chsh);
195 # "my account" functionality
196 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
198 my $rv = login( { 'username' => $username,
200 'password' => $password,
204 if ( $rv->{'error'} ) {
205 #handle login error...
208 my $session_id = $rv->{'session_id'};
211 my $customer_info = customer_info( { 'session_id' => $session_id } );
213 #payment_info and process_payment are available in 1.5+ only
214 my $payment_info = payment_info( { 'session_id' => $session_id } );
216 #!!! process_payment example
218 #!!! list_pkgs example
220 #!!! order_pkg example
222 #!!! cancel_pkg example
224 # signup functionality
225 use FS::SelfService qw( signup_info new_customer );
227 my $signup_info = signup_info;
229 $rv = new_customer( {
232 'company' => $company,
233 'address1' => $address1,
234 'address2' => $address2,
238 'country' => $country,
239 'daytime' => $daytime,
243 'payinfo' => $payinfo,
245 'paystart_month' => $paystart_month
246 'paystart_year' => $paystart_year,
247 'payissue' => $payissue,
249 'paydate' => $paydate,
250 'payname' => $payname,
251 'invoicing_list' => $invoicing_list,
252 'referral_custnum' => $referral_custnum,
253 'agentnum' => $agentnum,
254 'pkgpart' => $pkgpart,
256 'username' => $username,
257 '_password' => $password,
261 'phonenum' => $phonenum,
266 my $error = $rv->{'error'};
267 if ( $error eq '_decline' ) {
277 Use this API to implement your own client "self-service" module.
279 If you just want to customize the look of the existing "self-service" module,
282 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
294 =head1 "MY ACCOUNT" FUNCTIONS
300 Creates a user session. Takes a hash reference as parameter with the
319 Returns a hash reference with the following keys:
325 Empty on success, or an error message on errors.
329 Session identifier for successful logins
333 =item customer_info HASHREF
335 Returns general customer information.
337 Takes a hash reference as parameter with a single key: B<session_id>
339 Returns a hash reference with the following keys:
353 Array reference of hash references of open inoices. Each hash reference has
354 the following keys: invnum, date, owed
358 An HTML fragment containing shipping and billing addresses.
360 =item The following fields are also returned
362 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
366 =item edit_info HASHREF
368 Takes a hash reference as parameter with any of the following keys:
370 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
372 If a field exists, the customer record is updated with the new value of that
373 field. If a field does not exist, that field is not changed on the customer
376 Returns a hash reference with a single key, B<error>, empty on success, or an
377 error message on errors
379 =item invoice HASHREF
381 Returns an invoice. Takes a hash reference as parameter with two keys:
382 session_id and invnum
384 Returns a hash reference with the following keys:
390 Empty on success, or an error message on errors
402 =item list_invoices HASHREF
404 Returns a list of all customer invoices. Takes a hash references with a single
407 Returns a hash reference with the following keys:
413 Empty on success, or an error message on errors
417 Reference to array of hash references with the following keys:
427 Invoice date, in UNIX epoch time
435 Cancels this customer.
437 Takes a hash reference as parameter with a single key: B<session_id>
439 Returns a hash reference with a single key, B<error>, which is empty on
440 success or an error message on errors.
442 =item payment_info HASHREF
444 Returns information that may be useful in displaying a payment page.
446 Takes a hash reference as parameter with a single key: B<session_id>.
448 Returns a hash reference with the following keys:
454 Empty on success, or an error message on errors
462 Exact name on credit card (CARD/DCRD)
486 Customer's current default payment type.
490 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
494 For CARD/DCRD payment types, the card number
498 For CARD/DCRD payment types, expiration month
502 For CARD/DCRD payment types, expiration year
504 =item cust_main_county
506 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.
510 Array reference of all states in the current default country.
514 Hash reference of card types; keys are card types, values are the exact strings
515 passed to the process_payment function
519 #this doesn't actually work yet
523 #Unique transaction identifier (prevents multiple charges), passed to the
524 #process_payment function
528 =item process_payment HASHREF
530 Processes a payment and possible change of address or payment type. Takes a
531 hash reference as parameter with the following keys:
545 If true, address and card information entered will be saved for subsequent
550 If true, future credit card payments will be done automatically (sets payby to
551 CARD). If false, future credit card payments will be done on-demand (sets
552 payby to DCRD). This option only has meaning if B<save> is set true.
580 Two-letter country code
588 Card expiration month
596 #this doesn't actually work yet
600 #Unique transaction identifier, returned from the payment_info function.
601 #Prevents multiple charges.
605 Returns a hash reference with a single key, B<error>, empty on success, or an
606 error message on errors.
608 =item process_payment_order_pkg
610 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
611 payment processes sucessfully, the package is ordered. Takes a hash reference
612 as parameter with the keys of both methods.
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_change_pkg
619 Combines the B<process_payment> and B<change_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.
627 =item process_payment_order_renew
629 Combines the B<process_payment> and B<order_renew> functions in one step. If
630 the payment processes sucessfully, the renewal is processed. Takes a hash
631 reference as parameter with the keys of both methods.
633 Returns a hash reference with a single key, B<error>, empty on success, or an
634 error message on errors.
638 Returns package information for this customer. For more detail on services,
641 Takes a hash reference as parameter with a single key: B<session_id>
643 Returns a hash reference containing customer package information. The hash reference contains the following keys:
653 Empty on success, or an error message on errors.
655 =item cust_pkg HASHREF
657 Array reference of hash references, each of which has the fields of a cust_pkg
658 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
659 the internal FS:: objects, but hash references of columns and values.
663 =item part_pkg fields
665 All fields of part_pkg for this specific cust_pkg (be careful with this
666 information - it may reveal more about your available packages than you would
667 like users to know in aggregate)
671 #XXX pare part_pkg fields down to a more secure subset
675 An array of hash references indicating information on unprovisioned services
676 available for provisioning for this specific cust_pkg. Each has the following
681 =item part_svc fields
683 All fields of part_svc (be careful with this information - it may reveal more
684 about your available packages than you would like users to know in aggregate)
688 #XXX pare part_svc fields down to a more secure subset
694 An array of hash references indicating information on the customer services
695 already provisioned for this specific cust_pkg. Each has the following keys:
701 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.
707 Primary key for this service
711 Service definition (see L<FS::part_svc>)
715 Customer package (see L<FS::cust_pkg>)
719 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
727 Returns service information for this customer.
729 Takes a hash reference as parameter with a single key: B<session_id>
731 Returns a hash reference containing customer package information. The hash reference contains the following keys:
741 An array of hash references indicating information on all of this customer's
742 services. Each has the following keys:
748 Primary key for this service
756 Meaningful user-specific identifier for the service (i.e. username, domain, or
761 Account (svc_acct) services also have the following keys:
779 Upload bytes remaining
783 Download bytes remaining
787 Total bytes remaining
789 =item recharge_amount
793 =item recharge_seconds
795 Number of seconds gained by recharge
797 =item recharge_upbytes
799 Number of upload bytes gained by recharge
801 =item recharge_downbytes
803 Number of download bytes gained by recharge
805 =item recharge_totalbytes
807 Number of total bytes gained by recharge
815 Orders a package for this customer.
817 Takes a hash reference as parameter with the following keys:
827 Package to order (see L<FS::part_pkg>).
831 Service to order (see L<FS::part_svc>).
833 Normally optional; required only to provision a non-svc_acct service, or if the
834 package definition does not contain one svc_acct service definition with
835 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
836 also be specified to indicate that no initial service should be provisioned.
840 Fields used when provisioning an svc_acct service:
854 Optional security phrase
858 Optional Access number number
862 Fields used when provisioning an svc_domain service:
872 Fields used when provisioning an svc_phone service:
890 Fields used when provisioning an svc_external service:
904 Fields used when provisioning an svc_pbx service:
918 Returns a hash reference with a single key, B<error>, empty on success, or an
919 error message on errors. The special error '_decline' is returned for
920 declined transactions.
924 Changes a package for this customer.
926 Takes a hash reference as parameter with the following keys:
936 Existing customer package.
940 New package to order (see L<FS::part_pkg>).
944 Returns a hash reference with the following keys:
950 Empty on success, or an error message on errors.
954 On success, the new pkgnum
961 Provides useful info for early renewals.
963 Takes a hash reference as parameter with the following keys:
973 Returns a hash reference. On errors, it contains a single key, B<error>, with
974 the error message. Otherwise, contains a single key, B<dates>, pointing to
975 an array refernce of hash references. Each hash reference contains the
982 (Future) Bill date. Indicates a future date for which billing could be run.
983 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
986 =item bill_date_pretty
988 (Future) Bill date as a human-readable string. (Convenience for display;
989 subject to change, so best not to parse for the date.)
993 Base amount which will be charged if renewed early as of this date.
997 Renewal date; i.e. even-futher future date at which the customer will be paid
998 through if the early renewal is completed with the given B<bill-date>.
999 Specified as a integer UNIX timestamp.
1001 =item renew_date_pretty
1003 Renewal date as a human-readable string. (Convenience for display;
1004 subject to change, so best not to parse for the date.)
1008 Package that will be renewed.
1012 Expiration date of the package that will be renewed.
1014 =item expire_date_pretty
1016 Expiration date of the package that will be renewed, as a human-readable
1017 string. (Convenience for display; subject to change, so best not to parse for
1024 Renews this customer early; i.e. runs billing for this customer in advance.
1026 Takes a hash reference as parameter with the following keys:
1036 Integer date as returned by the B<renew_info> function, indicating the advance
1037 date for which to run billing.
1041 Returns a hash reference with a single key, B<error>, empty on success, or an
1042 error message on errors.
1046 Cancels a package for this customer.
1048 Takes a hash reference as parameter with the following keys:
1058 pkgpart of package to cancel
1062 Returns a hash reference with a single key, B<error>, empty on success, or an
1063 error message on errors.
1067 =head1 SIGNUP FUNCTIONS
1071 =item signup_info HASHREF
1073 Takes a hash reference as parameter with the following keys:
1077 =item session_id - Optional agent/reseller interface session
1081 Returns a hash reference containing information that may be useful in
1082 displaying a signup page. The hash reference contains the following keys:
1086 =item cust_main_county
1088 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.
1092 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
1093 an agentnum specified explicitly via reseller interface session_id in the
1098 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.
1100 =item agentnum2part_pkg
1102 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.
1106 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.
1108 =item security_phrase
1110 True if the "security_phrase" feature is enabled
1114 Array reference of acceptable payment types for signup
1120 credit card - automatic
1124 credit card - on-demand - version 1.5+ only
1128 electronic check - automatic
1132 electronic check - on-demand - version 1.5+ only
1140 billing, not recommended for signups
1144 free, definitely not recommended for signups
1148 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1154 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1158 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".
1164 =item countrydefault
1170 =item new_customer HASHREF
1172 Creates a new customer. Takes a hash reference as parameter with the
1179 first name (required)
1183 last name (required)
1187 (not typically collected; mostly used for ACH transactions)
1193 =item address1 (required)
1201 =item city (required)
1209 =item state (required)
1213 =item zip (required)
1219 Daytime phone number
1223 Evening phone number
1231 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1235 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1239 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1243 Expiration date for CARD/DCRD
1247 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1249 =item invoicing_list
1251 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),
1253 =item referral_custnum
1255 referring customer number
1263 pkgpart of initial package
1279 Access number (index, not the literal number)
1283 Country code (to be provisioned as a service)
1287 Phone number (to be provisioned as a service)
1295 Returns a hash reference with the following keys:
1301 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)
1305 =item regionselector HASHREF | LIST
1307 Takes as input a hashref or list of key/value pairs with the following keys:
1311 =item selected_county
1313 Currently selected county
1315 =item selected_state
1317 Currently selected state
1319 =item selected_country
1321 Currently selected country
1325 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1329 Specify a javascript subroutine to call on changes
1335 =item default_country
1341 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>.
1345 Returns a list consisting of three HTML fragments for county selection,
1346 state selection and country selection, respectively.
1350 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1351 sub regionselector {
1358 $param->{'selected_country'} ||= $param->{'default_country'};
1359 $param->{'selected_state'} ||= $param->{'default_state'};
1361 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1365 my %cust_main_county;
1367 # unless ( @cust_main_county ) { #cache
1368 #@cust_main_county = qsearch('cust_main_county', {} );
1369 #foreach my $c ( @cust_main_county ) {
1370 foreach my $c ( @{ $param->{'locales'} } ) {
1371 #$countyflag=1 if $c->county;
1372 $countyflag=1 if $c->{county};
1373 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1374 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1375 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1378 $countyflag=1 if $param->{selected_county};
1380 my $script_html = <<END;
1382 function opt(what,value,text) {
1383 var optionName = new Option(text, value, false, false);
1384 var length = what.length;
1385 what.options[length] = optionName;
1387 function ${prefix}country_changed(what) {
1388 country = what.options[what.selectedIndex].text;
1389 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1390 what.form.${prefix}state.options[i] = null;
1392 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1394 foreach my $country ( sort keys %cust_main_county ) {
1395 $script_html .= "\nif ( country == \"$country\" ) {\n";
1396 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1397 my $text = $state || '(n/a)';
1398 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1400 $script_html .= "}\n";
1403 $script_html .= <<END;
1405 function ${prefix}state_changed(what) {
1408 if ( $countyflag ) {
1409 $script_html .= <<END;
1410 state = what.options[what.selectedIndex].text;
1411 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1412 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1413 what.form.${prefix}county.options[i] = null;
1416 foreach my $country ( sort keys %cust_main_county ) {
1417 $script_html .= "\nif ( country == \"$country\" ) {\n";
1418 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1419 $script_html .= "\nif ( state == \"$state\" ) {\n";
1420 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1421 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1422 my $text = $county || '(n/a)';
1424 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1426 $script_html .= "}\n";
1428 $script_html .= "}\n";
1432 $script_html .= <<END;
1437 my $county_html = $script_html;
1438 if ( $countyflag ) {
1439 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1440 foreach my $county (
1441 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1443 my $text = $county || '(n/a)';
1444 $county_html .= qq!<OPTION VALUE="$county"!.
1445 ($county eq $param->{'selected_county'} ?
1452 $county_html .= '</SELECT>';
1455 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1458 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1459 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1460 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1461 my $text = $state || '(n/a)';
1462 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1463 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1465 $state_html .= '</SELECT>';
1467 my $country_html = '';
1468 if ( scalar( keys %cust_main_county ) > 1 ) {
1470 $country_html = qq(<SELECT NAME="${prefix}country" ).
1471 qq(onChange="${prefix}country_changed(this); ).
1472 $param->{'onchange'}.
1475 my $countrydefault = $param->{default_country} || 'US';
1476 foreach my $country (
1477 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1478 keys %cust_main_county
1480 my $selected = $country eq $param->{'selected_country'}
1483 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1485 $country_html .= '</SELECT>';
1488 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1489 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1493 ($county_html, $state_html, $country_html);
1497 sub regionselector_hashref {
1498 my ($county_html, $state_html, $country_html) = regionselector(@_);
1500 'county_html' => $county_html,
1501 'state_html' => $state_html,
1502 'country_html' => $country_html,
1506 =item location_form HASHREF | LIST
1508 Takes as input a hashref or list of key/value pairs with the following keys:
1514 Current customer session_id
1518 Omit red asterisks from required fields.
1520 =item address1_label
1522 Label for first address line.
1526 Returns an HTML fragment for a location form (address, city, state, zip,
1539 my $session_id = delete $param->{'session_id'};
1541 my $rv = mason_comp( 'session_id' => $session_id,
1542 'comp' => '/elements/location.html',
1543 'args' => [ %$param ],
1547 $rv->{'error'} || $rv->{'output'};
1552 #=item expselect HASHREF | LIST
1554 #Takes as input a hashref or list of key/value pairs with the following keys:
1558 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1560 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1564 =item expselect PREFIX [ DATE ]
1566 Takes as input a unique prefix string and the current expiration date, in
1567 yyyy-mm-dd or m-d-yyyy format
1569 Returns an HTML fragments for expiration date selection.
1575 #if ( ref($_[0]) ) {
1579 #my $prefix = $param->{'prefix'};
1580 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1581 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1583 my $date = scalar(@_) ? shift : '';
1585 my( $m, $y ) = ( 0, 0 );
1586 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1587 ( $m, $y ) = ( $2, $1 );
1588 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1589 ( $m, $y ) = ( $1, $3 );
1591 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1593 $return .= qq!<OPTION VALUE="$_"!;
1594 $return .= " SELECTED" if $_ == $m;
1597 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1599 my $thisYear = $t[5] + 1900;
1600 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1601 $return .= qq!<OPTION VALUE="$_"!;
1602 $return .= " SELECTED" if $_ == $y;
1605 $return .= "</SELECT>";
1610 =item popselector HASHREF | LIST
1612 Takes as input a hashref or list of key/value pairs with the following keys:
1618 Access number number
1622 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>.
1626 Returns an HTML fragment for access number selection.
1630 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1638 my $popnum = $param->{'popnum'};
1639 my $pops = $param->{'pops'};
1641 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1642 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1643 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1644 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1645 if scalar(@$pops) == 1;
1648 my %popnum2pop = ();
1650 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1651 $popnum2pop{$_->{popnum}} = $_;
1656 function opt(what,href,text) {
1657 var optionName = new Option(text, href, false, false)
1658 var length = what.length;
1659 what.options[length] = optionName;
1663 my $init_popstate = $param->{'init_popstate'};
1664 if ( $init_popstate ) {
1665 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1666 $init_popstate. '">';
1669 function acstate_changed(what) {
1670 state = what.options[what.selectedIndex].text;
1671 what.form.popac.options.length = 0
1672 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1676 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1677 foreach my $state ( sort { $a cmp $b } @states ) {
1678 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1680 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1681 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1682 if ($ac eq $param->{'popac'}) {
1683 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1686 $text .= "}\n" unless $init_popstate;
1688 $text .= "popac_changed(what.form.popac)}\n";
1691 function popac_changed(what) {
1692 ac = what.options[what.selectedIndex].text;
1693 what.form.popnum.options.length = 0;
1694 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1698 foreach my $state ( @states ) {
1699 foreach my $popac ( keys %{ $pop{$state} } ) {
1700 $text .= "\nif ( ac == \"$popac\" ) {\n";
1702 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1703 my $o_popnum = $pop->{popnum};
1704 my $poptext = $pop->{city}. ', '. $pop->{state}.
1705 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1707 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1708 if ($popnum == $o_popnum) {
1709 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1717 $text .= "}\n</SCRIPT>\n";
1719 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1722 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1723 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1724 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1725 ">$_" foreach sort { $a cmp $b } @states;
1726 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1729 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1730 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1732 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1735 #comment this block to disable initial list polulation
1736 my @initial_select = ();
1737 if ( scalar( @$pops ) > 100 ) {
1738 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1740 @initial_select = @$pops;
1742 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1743 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1744 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1745 $pop->{city}. ', '. $pop->{state}.
1746 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1749 $text .= qq!</SELECT></TD></TR></TABLE>!;
1755 =item domainselector HASHREF | LIST
1757 Takes as input a hashref or list of key/value pairs with the following keys:
1767 Service number of the selected item.
1771 Returns an HTML fragment for domain selection.
1775 sub domainselector {
1782 my $domsvc= $param->{'domsvc'};
1784 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1785 my $domains = $rv->{'domains'};
1786 $domsvc = $rv->{'domsvc'} unless $domsvc;
1788 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1789 unless scalar(keys %$domains);
1791 if (scalar(keys %$domains) == 1) {
1793 foreach(keys %$domains) {
1796 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1797 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1800 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1803 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1804 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1805 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1806 $domains->{$domain};
1809 $text .= qq!</SELECT></TD></TR>!;
1815 =item didselector HASHREF | LIST
1817 Takes as input a hashref or list of key/value pairs with the following keys:
1823 Field name for the returned HTML fragment.
1827 Service definition (see L<FS::part_svc>)
1831 Returns an HTML fragment for DID selection.
1843 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1844 'args'=>[ %$param ],
1848 $rv->{'error'} || $rv->{'output'};
1854 =head1 RESELLER FUNCTIONS
1856 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1857 with their active session, and the B<customer_info> and B<order_pkg> functions
1858 with their active session and an additional I<custnum> parameter.
1860 For the most part, development of the reseller web interface has been
1861 superceded by agent-virtualized access to the backend.
1873 =item agent_list_customers
1875 List agent's customers.
1883 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>