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 'customer_info' => 'MyAccount/customer_info',
32 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
33 'invoice' => 'MyAccount/invoice',
34 'invoice_logo' => 'MyAccount/invoice_logo',
35 'list_invoices' => 'MyAccount/list_invoices', #?
36 'cancel' => 'MyAccount/cancel', #add to ss cgi!
37 'payment_info' => 'MyAccount/payment_info',
38 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
39 'process_payment' => 'MyAccount/process_payment',
40 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
41 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
42 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
43 'process_prepay' => 'MyAccount/process_prepay',
44 'realtime_collect' => 'MyAccount/realtime_collect',
45 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
46 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
47 'list_svc_usage' => 'MyAccount/list_svc_usage',
48 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
49 'list_support_usage' => 'MyAccount/list_support_usage',
50 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
51 'change_pkg' => 'MyAccount/change_pkg',
52 'order_recharge' => 'MyAccount/order_recharge',
53 'renew_info' => 'MyAccount/renew_info',
54 'order_renew' => 'MyAccount/order_renew',
55 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
56 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
57 'charge' => 'MyAccount/charge', #?
58 'part_svc_info' => 'MyAccount/part_svc_info',
59 'provision_acct' => 'MyAccount/provision_acct',
60 'provision_external' => 'MyAccount/provision_external',
61 'unprovision_svc' => 'MyAccount/unprovision_svc',
62 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
63 'create_ticket' => 'MyAccount/create_ticket',
64 'get_ticket' => 'MyAccount/get_ticket',
65 'signup_info' => 'Signup/signup_info',
66 'skin_info' => 'MyAccount/skin_info',
67 'access_info' => 'MyAccount/access_info',
68 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
69 'new_customer' => 'Signup/new_customer',
70 'capture_payment' => 'Signup/capture_payment',
71 'agent_login' => 'Agent/agent_login',
72 'agent_logout' => 'Agent/agent_logout',
73 'agent_info' => 'Agent/agent_info',
74 'agent_list_customers' => 'Agent/agent_list_customers',
75 'check_username' => 'Agent/check_username',
76 'suspend_username' => 'Agent/suspend_username',
77 'unsuspend_username' => 'Agent/unsuspend_username',
78 'mason_comp' => 'MasonComponent/mason_comp',
79 'call_time' => 'PrepaidPhone/call_time',
80 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
81 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
83 #'bulk_processrow' => 'Bulk/processrow',
84 #conflicts w/Agent one# 'check_username' => 'Bulk/check_username',
86 'ping' => 'SGNG/ping',
87 'decompify_pkgs' => 'SGNG/decompify_pkgs',
88 'previous_payment_info' => 'SGNG/previous_payment_info',
89 'previous_payment_info_renew_info'
90 => 'SGNG/previous_payment_info_renew_info',
91 'previous_process_payment' => 'SGNG/previous_process_payment',
92 'previous_process_payment_order_pkg'
93 => 'SGNG/previous_process_payment_order_pkg',
94 'previous_process_payment_change_pkg'
95 => 'SGNG/previous_process_payment_change_pkg',
96 'previous_process_payment_order_renew'
97 => 'SGNG/previous_process_payment_order_renew',
101 qw( regionselector regionselector_hashref location_form
102 expselect popselector domainselector didselector
106 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
107 $ENV{'SHELL'} = '/bin/sh';
108 $ENV{'IFS'} = " \t\n";
111 $ENV{'BASH_ENV'} = '';
113 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
114 #if you grant appropriate permissions to whatever user
115 my $freeside_uid = scalar(getpwnam('freeside'));
116 die "not running as the freeside user\n"
117 if $> != $freeside_uid && ! $skip_uid_check;
119 -e $dir or die "FATAL: $dir doesn't exist!";
120 -d $dir or die "FATAL: $dir isn't a directory!";
121 -r $dir or die "FATAL: Can't read $dir as freeside user!";
122 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
124 foreach my $autoload ( keys %autoload ) {
127 "sub $autoload { ". '
132 #warn scalar(@_). ": ". join(" / ", @_);
136 $param->{_packet} = \''. $autoload{$autoload}. '\';
138 simple_packet($param);
148 warn "sending ". $packet->{_packet}. " to server"
150 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
151 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
152 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
155 #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
157 #block until there is a message on socket
158 # my $w = new IO::Select;
160 # my @wait = $w->can_read;
162 warn "reading message from server"
165 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
166 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
168 warn "returning message to client"
176 FS::SelfService - Freeside self-service API
180 # password and shell account changes
181 use FS::SelfService qw(passwd chfn chsh);
183 # "my account" functionality
184 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
186 my $rv = login( { 'username' => $username,
188 'password' => $password,
192 if ( $rv->{'error'} ) {
193 #handle login error...
196 my $session_id = $rv->{'session_id'};
199 my $customer_info = customer_info( { 'session_id' => $session_id } );
201 #payment_info and process_payment are available in 1.5+ only
202 my $payment_info = payment_info( { 'session_id' => $session_id } );
204 #!!! process_payment example
206 #!!! list_pkgs example
208 #!!! order_pkg example
210 #!!! cancel_pkg example
212 # signup functionality
213 use FS::SelfService qw( signup_info new_customer );
215 my $signup_info = signup_info;
217 $rv = new_customer( {
220 'company' => $company,
221 'address1' => $address1,
222 'address2' => $address2,
226 'country' => $country,
227 'daytime' => $daytime,
231 'payinfo' => $payinfo,
233 'paystart_month' => $paystart_month
234 'paystart_year' => $paystart_year,
235 'payissue' => $payissue,
237 'paydate' => $paydate,
238 'payname' => $payname,
239 'invoicing_list' => $invoicing_list,
240 'referral_custnum' => $referral_custnum,
241 'agentnum' => $agentnum,
242 'pkgpart' => $pkgpart,
244 'username' => $username,
245 '_password' => $password,
249 'phonenum' => $phonenum,
254 my $error = $rv->{'error'};
255 if ( $error eq '_decline' ) {
265 Use this API to implement your own client "self-service" module.
267 If you just want to customize the look of the existing "self-service" module,
270 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
282 =head1 "MY ACCOUNT" FUNCTIONS
288 Creates a user session. Takes a hash reference as parameter with the
307 Returns a hash reference with the following keys:
313 Empty on success, or an error message on errors.
317 Session identifier for successful logins
321 =item customer_info HASHREF
323 Returns general customer information.
325 Takes a hash reference as parameter with a single key: B<session_id>
327 Returns a hash reference with the following keys:
341 Array reference of hash references of open inoices. Each hash reference has
342 the following keys: invnum, date, owed
346 An HTML fragment containing shipping and billing addresses.
348 =item The following fields are also returned
350 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
354 =item edit_info HASHREF
356 Takes a hash reference as parameter with any of the following keys:
358 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
360 If a field exists, the customer record is updated with the new value of that
361 field. If a field does not exist, that field is not changed on the customer
364 Returns a hash reference with a single key, B<error>, empty on success, or an
365 error message on errors
367 =item invoice HASHREF
369 Returns an invoice. Takes a hash reference as parameter with two keys:
370 session_id and invnum
372 Returns a hash reference with the following keys:
378 Empty on success, or an error message on errors
390 =item list_invoices HASHREF
392 Returns a list of all customer invoices. Takes a hash references with a single
395 Returns a hash reference with the following keys:
401 Empty on success, or an error message on errors
405 Reference to array of hash references with the following keys:
415 Invoice date, in UNIX epoch time
423 Cancels this customer.
425 Takes a hash reference as parameter with a single key: B<session_id>
427 Returns a hash reference with a single key, B<error>, which is empty on
428 success or an error message on errors.
430 =item payment_info HASHREF
432 Returns information that may be useful in displaying a payment page.
434 Takes a hash reference as parameter with a single key: B<session_id>.
436 Returns a hash reference with the following keys:
442 Empty on success, or an error message on errors
450 Exact name on credit card (CARD/DCRD)
474 Customer's current default payment type.
478 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
482 For CARD/DCRD payment types, the card number
486 For CARD/DCRD payment types, expiration month
490 For CARD/DCRD payment types, expiration year
492 =item cust_main_county
494 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.
498 Array reference of all states in the current default country.
502 Hash reference of card types; keys are card types, values are the exact strings
503 passed to the process_payment function
507 #this doesn't actually work yet
511 #Unique transaction identifier (prevents multiple charges), passed to the
512 #process_payment function
516 =item process_payment HASHREF
518 Processes a payment and possible change of address or payment type. Takes a
519 hash reference as parameter with the following keys:
533 If true, address and card information entered will be saved for subsequent
538 If true, future credit card payments will be done automatically (sets payby to
539 CARD). If false, future credit card payments will be done on-demand (sets
540 payby to DCRD). This option only has meaning if B<save> is set true.
568 Two-letter country code
576 Card expiration month
584 #this doesn't actually work yet
588 #Unique transaction identifier, returned from the payment_info function.
589 #Prevents multiple charges.
593 Returns a hash reference with a single key, B<error>, empty on success, or an
594 error message on errors.
596 =item process_payment_order_pkg
598 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
599 payment processes sucessfully, the package is ordered. Takes a hash reference
600 as parameter with the keys of both methods.
602 Returns a hash reference with a single key, B<error>, empty on success, or an
603 error message on errors.
605 =item process_payment_change_pkg
607 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
608 payment processes sucessfully, the package is ordered. Takes a hash reference
609 as parameter with the keys of both methods.
611 Returns a hash reference with a single key, B<error>, empty on success, or an
612 error message on errors.
615 =item process_payment_order_renew
617 Combines the B<process_payment> and B<order_renew> functions in one step. If
618 the payment processes sucessfully, the renewal is processed. Takes a hash
619 reference as parameter with the keys of both methods.
621 Returns a hash reference with a single key, B<error>, empty on success, or an
622 error message on errors.
626 Returns package information for this customer. For more detail on services,
629 Takes a hash reference as parameter with a single key: B<session_id>
631 Returns a hash reference containing customer package information. The hash reference contains the following keys:
641 Empty on success, or an error message on errors.
643 =item cust_pkg HASHREF
645 Array reference of hash references, each of which has the fields of a cust_pkg
646 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
647 the internal FS:: objects, but hash references of columns and values.
651 =item part_pkg fields
653 All fields of part_pkg for this specific cust_pkg (be careful with this
654 information - it may reveal more about your available packages than you would
655 like users to know in aggregate)
659 #XXX pare part_pkg fields down to a more secure subset
663 An array of hash references indicating information on unprovisioned services
664 available for provisioning for this specific cust_pkg. Each has the following
669 =item part_svc fields
671 All fields of part_svc (be careful with this information - it may reveal more
672 about your available packages than you would like users to know in aggregate)
676 #XXX pare part_svc fields down to a more secure subset
682 An array of hash references indicating information on the customer services
683 already provisioned for this specific cust_pkg. Each has the following keys:
689 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.
695 Primary key for this service
699 Service definition (see L<FS::part_svc>)
703 Customer package (see L<FS::cust_pkg>)
707 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
715 Returns service information for this customer.
717 Takes a hash reference as parameter with a single key: B<session_id>
719 Returns a hash reference containing customer package information. The hash reference contains the following keys:
729 An array of hash references indicating information on all of this customer's
730 services. Each has the following keys:
736 Primary key for this service
744 Meaningful user-specific identifier for the service (i.e. username, domain, or
749 Account (svc_acct) services also have the following keys:
767 Upload bytes remaining
771 Download bytes remaining
775 Total bytes remaining
777 =item recharge_amount
781 =item recharge_seconds
783 Number of seconds gained by recharge
785 =item recharge_upbytes
787 Number of upload bytes gained by recharge
789 =item recharge_downbytes
791 Number of download bytes gained by recharge
793 =item recharge_totalbytes
795 Number of total bytes gained by recharge
803 Orders a package for this customer.
805 Takes a hash reference as parameter with the following keys:
815 Package to order (see L<FS::part_pkg>).
819 Service to order (see L<FS::part_svc>).
821 Normally optional; required only to provision a non-svc_acct service, or if the
822 package definition does not contain one svc_acct service definition with
823 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
824 also be specified to indicate that no initial service should be provisioned.
828 Fields used when provisioning an svc_acct service:
842 Optional security phrase
846 Optional Access number number
850 Fields used when provisioning an svc_domain service:
860 Fields used when provisioning an svc_phone service:
878 Fields used when provisioning an svc_external service:
892 Returns a hash reference with a single key, B<error>, empty on success, or an
893 error message on errors. The special error '_decline' is returned for
894 declined transactions.
898 Changes a package for this customer.
900 Takes a hash reference as parameter with the following keys:
910 Existing customer package.
914 New package to order (see L<FS::part_pkg>).
918 Returns a hash reference with a single key, B<error>, empty on success, or an
919 error message on errors.
923 Provides useful info for early renewals.
925 Takes a hash reference as parameter with the following keys:
935 Returns a hash reference. On errors, it contains a single key, B<error>, with
936 the error message. Otherwise, contains a single key, B<dates>, pointing to
937 an array refernce of hash references. Each hash reference contains the
944 (Future) Bill date. Indicates a future date for which billing could be run.
945 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
948 =item bill_date_pretty
950 (Future) Bill date as a human-readable string. (Convenience for display;
951 subject to change, so best not to parse for the date.)
955 Base amount which will be charged if renewed early as of this date.
959 Renewal date; i.e. even-futher future date at which the customer will be paid
960 through if the early renewal is completed with the given B<bill-date>.
961 Specified as a integer UNIX timestamp.
963 =item renew_date_pretty
965 Renewal date as a human-readable string. (Convenience for display;
966 subject to change, so best not to parse for the date.)
970 Package that will be renewed.
974 Expiration date of the package that will be renewed.
976 =item expire_date_pretty
978 Expiration date of the package that will be renewed, as a human-readable
979 string. (Convenience for display; subject to change, so best not to parse for
986 Renews this customer early; i.e. runs billing for this customer in advance.
988 Takes a hash reference as parameter with the following keys:
998 Integer date as returned by the B<renew_info> function, indicating the advance
999 date for which to run billing.
1003 Returns a hash reference with a single key, B<error>, empty on success, or an
1004 error message on errors.
1008 Cancels a package for this customer.
1010 Takes a hash reference as parameter with the following keys:
1020 pkgpart of package to cancel
1024 Returns a hash reference with a single key, B<error>, empty on success, or an
1025 error message on errors.
1029 =head1 SIGNUP FUNCTIONS
1033 =item signup_info HASHREF
1035 Takes a hash reference as parameter with the following keys:
1039 =item session_id - Optional agent/reseller interface session
1043 Returns a hash reference containing information that may be useful in
1044 displaying a signup page. The hash reference contains the following keys:
1048 =item cust_main_county
1050 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.
1054 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
1055 an agentnum specified explicitly via reseller interface session_id in the
1060 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.
1062 =item agentnum2part_pkg
1064 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.
1068 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.
1070 =item security_phrase
1072 True if the "security_phrase" feature is enabled
1076 Array reference of acceptable payment types for signup
1082 credit card - automatic
1086 credit card - on-demand - version 1.5+ only
1090 electronic check - automatic
1094 electronic check - on-demand - version 1.5+ only
1102 billing, not recommended for signups
1106 free, definitely not recommended for signups
1110 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1116 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1120 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".
1126 =item countrydefault
1132 =item new_customer HASHREF
1134 Creates a new customer. Takes a hash reference as parameter with the
1141 first name (required)
1145 last name (required)
1149 (not typically collected; mostly used for ACH transactions)
1155 =item address1 (required)
1163 =item city (required)
1171 =item state (required)
1175 =item zip (required)
1181 Daytime phone number
1185 Evening phone number
1193 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1197 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1201 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1205 Expiration date for CARD/DCRD
1209 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1211 =item invoicing_list
1213 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),
1215 =item referral_custnum
1217 referring customer number
1225 pkgpart of initial package
1241 Access number (index, not the literal number)
1245 Country code (to be provisioned as a service)
1249 Phone number (to be provisioned as a service)
1257 Returns a hash reference with the following keys:
1263 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)
1267 =item regionselector HASHREF | LIST
1269 Takes as input a hashref or list of key/value pairs with the following keys:
1273 =item selected_county
1275 Currently selected county
1277 =item selected_state
1279 Currently selected state
1281 =item selected_country
1283 Currently selected country
1287 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1291 Specify a javascript subroutine to call on changes
1297 =item default_country
1303 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>.
1307 Returns a list consisting of three HTML fragments for county selection,
1308 state selection and country selection, respectively.
1312 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1313 sub regionselector {
1320 $param->{'selected_country'} ||= $param->{'default_country'};
1321 $param->{'selected_state'} ||= $param->{'default_state'};
1323 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1327 my %cust_main_county;
1329 # unless ( @cust_main_county ) { #cache
1330 #@cust_main_county = qsearch('cust_main_county', {} );
1331 #foreach my $c ( @cust_main_county ) {
1332 foreach my $c ( @{ $param->{'locales'} } ) {
1333 #$countyflag=1 if $c->county;
1334 $countyflag=1 if $c->{county};
1335 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1336 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1337 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1340 $countyflag=1 if $param->{selected_county};
1342 my $script_html = <<END;
1344 function opt(what,value,text) {
1345 var optionName = new Option(text, value, false, false);
1346 var length = what.length;
1347 what.options[length] = optionName;
1349 function ${prefix}country_changed(what) {
1350 country = what.options[what.selectedIndex].text;
1351 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1352 what.form.${prefix}state.options[i] = null;
1354 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1356 foreach my $country ( sort keys %cust_main_county ) {
1357 $script_html .= "\nif ( country == \"$country\" ) {\n";
1358 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1359 my $text = $state || '(n/a)';
1360 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1362 $script_html .= "}\n";
1365 $script_html .= <<END;
1367 function ${prefix}state_changed(what) {
1370 if ( $countyflag ) {
1371 $script_html .= <<END;
1372 state = what.options[what.selectedIndex].text;
1373 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1374 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1375 what.form.${prefix}county.options[i] = null;
1378 foreach my $country ( sort keys %cust_main_county ) {
1379 $script_html .= "\nif ( country == \"$country\" ) {\n";
1380 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1381 $script_html .= "\nif ( state == \"$state\" ) {\n";
1382 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1383 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1384 my $text = $county || '(n/a)';
1386 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1388 $script_html .= "}\n";
1390 $script_html .= "}\n";
1394 $script_html .= <<END;
1399 my $county_html = $script_html;
1400 if ( $countyflag ) {
1401 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1402 foreach my $county (
1403 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1405 my $text = $county || '(n/a)';
1406 $county_html .= qq!<OPTION VALUE="$county"!.
1407 ($county eq $param->{'selected_county'} ?
1414 $county_html .= '</SELECT>';
1417 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1420 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1421 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1422 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1423 my $text = $state || '(n/a)';
1424 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1425 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1427 $state_html .= '</SELECT>';
1429 my $country_html = '';
1430 if ( scalar( keys %cust_main_county ) > 1 ) {
1432 $country_html = qq(<SELECT NAME="${prefix}country" ).
1433 qq(onChange="${prefix}country_changed(this); ).
1434 $param->{'onchange'}.
1437 my $countrydefault = $param->{default_country} || 'US';
1438 foreach my $country (
1439 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1440 keys %cust_main_county
1442 my $selected = $country eq $param->{'selected_country'}
1445 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1447 $country_html .= '</SELECT>';
1450 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1451 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1455 ($county_html, $state_html, $country_html);
1459 sub regionselector_hashref {
1460 my ($county_html, $state_html, $country_html) = regionselector(@_);
1462 'county_html' => $county_html,
1463 'state_html' => $state_html,
1464 'country_html' => $country_html,
1468 =item location_form HASHREF | LIST
1470 Takes as input a hashref or list of key/value pairs with the following keys:
1476 Current customer session_id
1480 Omit red asterisks from required fields.
1482 =item address1_label
1484 Label for first address line.
1488 Returns an HTML fragment for a location form (address, city, state, zip,
1501 my $session_id = delete $param->{'session_id'};
1503 my $rv = mason_comp( 'session_id' => $session_id,
1504 'comp' => '/elements/location.html',
1505 'args' => [ %$param ],
1509 $rv->{'error'} || $rv->{'output'};
1514 #=item expselect HASHREF | LIST
1516 #Takes as input a hashref or list of key/value pairs with the following keys:
1520 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1522 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1526 =item expselect PREFIX [ DATE ]
1528 Takes as input a unique prefix string and the current expiration date, in
1529 yyyy-mm-dd or m-d-yyyy format
1531 Returns an HTML fragments for expiration date selection.
1537 #if ( ref($_[0]) ) {
1541 #my $prefix = $param->{'prefix'};
1542 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1543 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1545 my $date = scalar(@_) ? shift : '';
1547 my( $m, $y ) = ( 0, 0 );
1548 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1549 ( $m, $y ) = ( $2, $1 );
1550 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1551 ( $m, $y ) = ( $1, $3 );
1553 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1555 $return .= qq!<OPTION VALUE="$_"!;
1556 $return .= " SELECTED" if $_ == $m;
1559 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1561 my $thisYear = $t[5] + 1900;
1562 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1563 $return .= qq!<OPTION VALUE="$_"!;
1564 $return .= " SELECTED" if $_ == $y;
1567 $return .= "</SELECT>";
1572 =item popselector HASHREF | LIST
1574 Takes as input a hashref or list of key/value pairs with the following keys:
1580 Access number number
1584 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>.
1588 Returns an HTML fragment for access number selection.
1592 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1600 my $popnum = $param->{'popnum'};
1601 my $pops = $param->{'pops'};
1603 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1604 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1605 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1606 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1607 if scalar(@$pops) == 1;
1610 my %popnum2pop = ();
1612 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1613 $popnum2pop{$_->{popnum}} = $_;
1618 function opt(what,href,text) {
1619 var optionName = new Option(text, href, false, false)
1620 var length = what.length;
1621 what.options[length] = optionName;
1625 my $init_popstate = $param->{'init_popstate'};
1626 if ( $init_popstate ) {
1627 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1628 $init_popstate. '">';
1631 function acstate_changed(what) {
1632 state = what.options[what.selectedIndex].text;
1633 what.form.popac.options.length = 0
1634 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1638 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1639 foreach my $state ( sort { $a cmp $b } @states ) {
1640 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1642 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1643 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1644 if ($ac eq $param->{'popac'}) {
1645 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1648 $text .= "}\n" unless $init_popstate;
1650 $text .= "popac_changed(what.form.popac)}\n";
1653 function popac_changed(what) {
1654 ac = what.options[what.selectedIndex].text;
1655 what.form.popnum.options.length = 0;
1656 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1660 foreach my $state ( @states ) {
1661 foreach my $popac ( keys %{ $pop{$state} } ) {
1662 $text .= "\nif ( ac == \"$popac\" ) {\n";
1664 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1665 my $o_popnum = $pop->{popnum};
1666 my $poptext = $pop->{city}. ', '. $pop->{state}.
1667 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1669 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1670 if ($popnum == $o_popnum) {
1671 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1679 $text .= "}\n</SCRIPT>\n";
1681 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1684 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1685 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1686 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1687 ">$_" foreach sort { $a cmp $b } @states;
1688 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1691 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1692 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1694 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1697 #comment this block to disable initial list polulation
1698 my @initial_select = ();
1699 if ( scalar( @$pops ) > 100 ) {
1700 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1702 @initial_select = @$pops;
1704 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1705 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1706 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1707 $pop->{city}. ', '. $pop->{state}.
1708 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1711 $text .= qq!</SELECT></TD></TR></TABLE>!;
1717 =item domainselector HASHREF | LIST
1719 Takes as input a hashref or list of key/value pairs with the following keys:
1729 Service number of the selected item.
1733 Returns an HTML fragment for domain selection.
1737 sub domainselector {
1744 my $domsvc= $param->{'domsvc'};
1746 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1747 my $domains = $rv->{'domains'};
1748 $domsvc = $rv->{'domsvc'} unless $domsvc;
1750 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1751 unless scalar(keys %$domains);
1753 if (scalar(keys %$domains) == 1) {
1755 foreach(keys %$domains) {
1758 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1759 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1762 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1765 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1766 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1767 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1768 $domains->{$domain};
1771 $text .= qq!</SELECT></TD></TR>!;
1777 =item didselector HASHREF | LIST
1779 Takes as input a hashref or list of key/value pairs with the following keys:
1785 Field name for the returned HTML fragment.
1789 Service definition (see L<FS::part_svc>)
1793 Returns an HTML fragment for DID selection.
1805 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1806 'args'=>[ %$param ],
1810 $rv->{'error'} || $rv->{'output'};
1816 =head1 RESELLER FUNCTIONS
1818 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1819 with their active session, and the B<customer_info> and B<order_pkg> functions
1820 with their active session and an additional I<custnum> parameter.
1822 For the most part, development of the reseller web interface has been
1823 superceded by agent-virtualized access to the backend.
1835 =item agent_list_customers
1837 List agent's customers.
1845 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>