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 'signup_info' => 'Signup/signup_info',
65 'skin_info' => 'MyAccount/skin_info',
66 'access_info' => 'MyAccount/access_info',
67 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
68 'new_customer' => 'Signup/new_customer',
69 'capture_payment' => 'Signup/capture_payment',
70 'agent_login' => 'Agent/agent_login',
71 'agent_logout' => 'Agent/agent_logout',
72 'agent_info' => 'Agent/agent_info',
73 'agent_list_customers' => 'Agent/agent_list_customers',
74 'check_username' => 'Agent/check_username',
75 'suspend_username' => 'Agent/suspend_username',
76 'unsuspend_username' => 'Agent/unsuspend_username',
77 'mason_comp' => 'MasonComponent/mason_comp',
78 'call_time' => 'PrepaidPhone/call_time',
79 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
80 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
82 #'bulk_processrow' => 'Bulk/processrow',
83 #conflicts w/Agent one# 'check_username' => 'Bulk/check_username',
85 'ping' => 'SGNG/ping',
86 'decompify_pkgs' => 'SGNG/decompify_pkgs',
87 'previous_payment_info' => 'SGNG/previous_payment_info',
88 'previous_payment_info_renew_info'
89 => 'SGNG/previous_payment_info_renew_info',
90 'previous_process_payment' => 'SGNG/previous_process_payment',
91 'previous_process_payment_order_pkg'
92 => 'SGNG/previous_process_payment_order_pkg',
93 'previous_process_payment_change_pkg'
94 => 'SGNG/previous_process_payment_change_pkg',
95 'previous_process_payment_order_renew'
96 => 'SGNG/previous_process_payment_order_renew',
100 qw( regionselector regionselector_hashref location_form
101 expselect popselector domainselector didselector
105 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
106 $ENV{'SHELL'} = '/bin/sh';
107 $ENV{'IFS'} = " \t\n";
110 $ENV{'BASH_ENV'} = '';
112 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
113 #if you grant appropriate permissions to whatever user
114 my $freeside_uid = scalar(getpwnam('freeside'));
115 die "not running as the freeside user\n"
116 if $> != $freeside_uid && ! $skip_uid_check;
118 -e $dir or die "FATAL: $dir doesn't exist!";
119 -d $dir or die "FATAL: $dir isn't a directory!";
120 -r $dir or die "FATAL: Can't read $dir as freeside user!";
121 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
123 foreach my $autoload ( keys %autoload ) {
126 "sub $autoload { ". '
131 #warn scalar(@_). ": ". join(" / ", @_);
135 $param->{_packet} = \''. $autoload{$autoload}. '\';
137 simple_packet($param);
147 warn "sending ". $packet->{_packet}. " to server"
149 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
150 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
151 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
154 #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
156 #block until there is a message on socket
157 # my $w = new IO::Select;
159 # my @wait = $w->can_read;
161 warn "reading message from server"
164 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
165 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
167 warn "returning message to client"
175 FS::SelfService - Freeside self-service API
179 # password and shell account changes
180 use FS::SelfService qw(passwd chfn chsh);
182 # "my account" functionality
183 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
185 my $rv = login( { 'username' => $username,
187 'password' => $password,
191 if ( $rv->{'error'} ) {
192 #handle login error...
195 my $session_id = $rv->{'session_id'};
198 my $customer_info = customer_info( { 'session_id' => $session_id } );
200 #payment_info and process_payment are available in 1.5+ only
201 my $payment_info = payment_info( { 'session_id' => $session_id } );
203 #!!! process_payment example
205 #!!! list_pkgs example
207 #!!! order_pkg example
209 #!!! cancel_pkg example
211 # signup functionality
212 use FS::SelfService qw( signup_info new_customer );
214 my $signup_info = signup_info;
216 $rv = new_customer( {
219 'company' => $company,
220 'address1' => $address1,
221 'address2' => $address2,
225 'country' => $country,
226 'daytime' => $daytime,
230 'payinfo' => $payinfo,
232 'paystart_month' => $paystart_month
233 'paystart_year' => $paystart_year,
234 'payissue' => $payissue,
236 'paydate' => $paydate,
237 'payname' => $payname,
238 'invoicing_list' => $invoicing_list,
239 'referral_custnum' => $referral_custnum,
240 'agentnum' => $agentnum,
241 'pkgpart' => $pkgpart,
243 'username' => $username,
244 '_password' => $password,
248 'phonenum' => $phonenum,
253 my $error = $rv->{'error'};
254 if ( $error eq '_decline' ) {
264 Use this API to implement your own client "self-service" module.
266 If you just want to customize the look of the existing "self-service" module,
269 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
281 =head1 "MY ACCOUNT" FUNCTIONS
287 Creates a user session. Takes a hash reference as parameter with the
306 Returns a hash reference with the following keys:
312 Empty on success, or an error message on errors.
316 Session identifier for successful logins
320 =item customer_info HASHREF
322 Returns general customer information.
324 Takes a hash reference as parameter with a single key: B<session_id>
326 Returns a hash reference with the following keys:
340 Array reference of hash references of open inoices. Each hash reference has
341 the following keys: invnum, date, owed
345 An HTML fragment containing shipping and billing addresses.
347 =item The following fields are also returned
349 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
353 =item edit_info HASHREF
355 Takes a hash reference as parameter with any of the following keys:
357 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
359 If a field exists, the customer record is updated with the new value of that
360 field. If a field does not exist, that field is not changed on the customer
363 Returns a hash reference with a single key, B<error>, empty on success, or an
364 error message on errors
366 =item invoice HASHREF
368 Returns an invoice. Takes a hash reference as parameter with two keys:
369 session_id and invnum
371 Returns a hash reference with the following keys:
377 Empty on success, or an error message on errors
389 =item list_invoices HASHREF
391 Returns a list of all customer invoices. Takes a hash references with a single
394 Returns a hash reference with the following keys:
400 Empty on success, or an error message on errors
404 Reference to array of hash references with the following keys:
414 Invoice date, in UNIX epoch time
422 Cancels this customer.
424 Takes a hash reference as parameter with a single key: B<session_id>
426 Returns a hash reference with a single key, B<error>, which is empty on
427 success or an error message on errors.
429 =item payment_info HASHREF
431 Returns information that may be useful in displaying a payment page.
433 Takes a hash reference as parameter with a single key: B<session_id>.
435 Returns a hash reference with the following keys:
441 Empty on success, or an error message on errors
449 Exact name on credit card (CARD/DCRD)
473 Customer's current default payment type.
477 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
481 For CARD/DCRD payment types, the card number
485 For CARD/DCRD payment types, expiration month
489 For CARD/DCRD payment types, expiration year
491 =item cust_main_county
493 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.
497 Array reference of all states in the current default country.
501 Hash reference of card types; keys are card types, values are the exact strings
502 passed to the process_payment function
506 #this doesn't actually work yet
510 #Unique transaction identifier (prevents multiple charges), passed to the
511 #process_payment function
515 =item process_payment HASHREF
517 Processes a payment and possible change of address or payment type. Takes a
518 hash reference as parameter with the following keys:
532 If true, address and card information entered will be saved for subsequent
537 If true, future credit card payments will be done automatically (sets payby to
538 CARD). If false, future credit card payments will be done on-demand (sets
539 payby to DCRD). This option only has meaning if B<save> is set true.
567 Two-letter country code
575 Card expiration month
583 #this doesn't actually work yet
587 #Unique transaction identifier, returned from the payment_info function.
588 #Prevents multiple charges.
592 Returns a hash reference with a single key, B<error>, empty on success, or an
593 error message on errors.
595 =item process_payment_order_pkg
597 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
598 payment processes sucessfully, the package is ordered. Takes a hash reference
599 as parameter with the keys of both methods.
601 Returns a hash reference with a single key, B<error>, empty on success, or an
602 error message on errors.
604 =item process_payment_change_pkg
606 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
607 payment processes sucessfully, the package is ordered. Takes a hash reference
608 as parameter with the keys of both methods.
610 Returns a hash reference with a single key, B<error>, empty on success, or an
611 error message on errors.
614 =item process_payment_order_renew
616 Combines the B<process_payment> and B<order_renew> functions in one step. If
617 the payment processes sucessfully, the renewal is processed. Takes a hash
618 reference as parameter with the keys of both methods.
620 Returns a hash reference with a single key, B<error>, empty on success, or an
621 error message on errors.
625 Returns package information for this customer. For more detail on services,
628 Takes a hash reference as parameter with a single key: B<session_id>
630 Returns a hash reference containing customer package information. The hash reference contains the following keys:
640 Empty on success, or an error message on errors.
642 =item cust_pkg HASHREF
644 Array reference of hash references, each of which has the fields of a cust_pkg
645 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
646 the internal FS:: objects, but hash references of columns and values.
650 =item part_pkg fields
652 All fields of part_pkg for this specific cust_pkg (be careful with this
653 information - it may reveal more about your available packages than you would
654 like users to know in aggregate)
658 #XXX pare part_pkg fields down to a more secure subset
662 An array of hash references indicating information on unprovisioned services
663 available for provisioning for this specific cust_pkg. Each has the following
668 =item part_svc fields
670 All fields of part_svc (be careful with this information - it may reveal more
671 about your available packages than you would like users to know in aggregate)
675 #XXX pare part_svc fields down to a more secure subset
681 An array of hash references indicating information on the customer services
682 already provisioned for this specific cust_pkg. Each has the following keys:
688 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.
694 Primary key for this service
698 Service definition (see L<FS::part_svc>)
702 Customer package (see L<FS::cust_pkg>)
706 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
714 Returns service information for this customer.
716 Takes a hash reference as parameter with a single key: B<session_id>
718 Returns a hash reference containing customer package information. The hash reference contains the following keys:
728 An array of hash references indicating information on all of this customer's
729 services. Each has the following keys:
735 Primary key for this service
743 Meaningful user-specific identifier for the service (i.e. username, domain, or
748 Account (svc_acct) services also have the following keys:
766 Upload bytes remaining
770 Download bytes remaining
774 Total bytes remaining
776 =item recharge_amount
780 =item recharge_seconds
782 Number of seconds gained by recharge
784 =item recharge_upbytes
786 Number of upload bytes gained by recharge
788 =item recharge_downbytes
790 Number of download bytes gained by recharge
792 =item recharge_totalbytes
794 Number of total bytes gained by recharge
802 Orders a package for this customer.
804 Takes a hash reference as parameter with the following keys:
814 Package to order (see L<FS::part_pkg>).
818 Service to order (see L<FS::part_svc>).
820 Normally optional; required only to provision a non-svc_acct service, or if the
821 package definition does not contain one svc_acct service definition with
822 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
823 also be specified to indicate that no initial service should be provisioned.
827 Fields used when provisioning an svc_acct service:
841 Optional security phrase
845 Optional Access number number
849 Fields used when provisioning an svc_domain service:
859 Fields used when provisioning an svc_phone service:
877 Fields used when provisioning an svc_external service:
891 Returns a hash reference with a single key, B<error>, empty on success, or an
892 error message on errors. The special error '_decline' is returned for
893 declined transactions.
897 Changes a package for this customer.
899 Takes a hash reference as parameter with the following keys:
909 Existing customer package.
913 New package to order (see L<FS::part_pkg>).
917 Returns a hash reference with a single key, B<error>, empty on success, or an
918 error message on errors.
922 Provides useful info for early renewals.
924 Takes a hash reference as parameter with the following keys:
934 Returns a hash reference. On errors, it contains a single key, B<error>, with
935 the error message. Otherwise, contains a single key, B<dates>, pointing to
936 an array refernce of hash references. Each hash reference contains the
943 (Future) Bill date. Indicates a future date for which billing could be run.
944 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
947 =item bill_date_pretty
949 (Future) Bill date as a human-readable string. (Convenience for display;
950 subject to change, so best not to parse for the date.)
954 Base amount which will be charged if renewed early as of this date.
958 Renewal date; i.e. even-futher future date at which the customer will be paid
959 through if the early renewal is completed with the given B<bill-date>.
960 Specified as a integer UNIX timestamp.
962 =item renew_date_pretty
964 Renewal date as a human-readable string. (Convenience for display;
965 subject to change, so best not to parse for the date.)
969 Package that will be renewed.
973 Expiration date of the package that will be renewed.
975 =item expire_date_pretty
977 Expiration date of the package that will be renewed, as a human-readable
978 string. (Convenience for display; subject to change, so best not to parse for
985 Renews this customer early; i.e. runs billing for this customer in advance.
987 Takes a hash reference as parameter with the following keys:
997 Integer date as returned by the B<renew_info> function, indicating the advance
998 date for which to run billing.
1002 Returns a hash reference with a single key, B<error>, empty on success, or an
1003 error message on errors.
1007 Cancels a package for this customer.
1009 Takes a hash reference as parameter with the following keys:
1019 pkgpart of package to cancel
1023 Returns a hash reference with a single key, B<error>, empty on success, or an
1024 error message on errors.
1028 =head1 SIGNUP FUNCTIONS
1032 =item signup_info HASHREF
1034 Takes a hash reference as parameter with the following keys:
1038 =item session_id - Optional agent/reseller interface session
1042 Returns a hash reference containing information that may be useful in
1043 displaying a signup page. The hash reference contains the following keys:
1047 =item cust_main_county
1049 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.
1053 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
1054 an agentnum specified explicitly via reseller interface session_id in the
1059 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.
1061 =item agentnum2part_pkg
1063 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.
1067 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.
1069 =item security_phrase
1071 True if the "security_phrase" feature is enabled
1075 Array reference of acceptable payment types for signup
1081 credit card - automatic
1085 credit card - on-demand - version 1.5+ only
1089 electronic check - automatic
1093 electronic check - on-demand - version 1.5+ only
1101 billing, not recommended for signups
1105 free, definitely not recommended for signups
1109 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1115 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1119 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".
1125 =item countrydefault
1131 =item new_customer HASHREF
1133 Creates a new customer. Takes a hash reference as parameter with the
1140 first name (required)
1144 last name (required)
1148 (not typically collected; mostly used for ACH transactions)
1154 =item address1 (required)
1162 =item city (required)
1170 =item state (required)
1174 =item zip (required)
1180 Daytime phone number
1184 Evening phone number
1192 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1196 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1200 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1204 Expiration date for CARD/DCRD
1208 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1210 =item invoicing_list
1212 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),
1214 =item referral_custnum
1216 referring customer number
1224 pkgpart of initial package
1240 Access number (index, not the literal number)
1244 Country code (to be provisioned as a service)
1248 Phone number (to be provisioned as a service)
1256 Returns a hash reference with the following keys:
1262 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)
1266 =item regionselector HASHREF | LIST
1268 Takes as input a hashref or list of key/value pairs with the following keys:
1272 =item selected_county
1274 Currently selected county
1276 =item selected_state
1278 Currently selected state
1280 =item selected_country
1282 Currently selected country
1286 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1290 Specify a javascript subroutine to call on changes
1296 =item default_country
1302 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>.
1306 Returns a list consisting of three HTML fragments for county selection,
1307 state selection and country selection, respectively.
1311 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1312 sub regionselector {
1319 $param->{'selected_country'} ||= $param->{'default_country'};
1320 $param->{'selected_state'} ||= $param->{'default_state'};
1322 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1326 my %cust_main_county;
1328 # unless ( @cust_main_county ) { #cache
1329 #@cust_main_county = qsearch('cust_main_county', {} );
1330 #foreach my $c ( @cust_main_county ) {
1331 foreach my $c ( @{ $param->{'locales'} } ) {
1332 #$countyflag=1 if $c->county;
1333 $countyflag=1 if $c->{county};
1334 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1335 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1336 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1339 $countyflag=1 if $param->{selected_county};
1341 my $script_html = <<END;
1343 function opt(what,value,text) {
1344 var optionName = new Option(text, value, false, false);
1345 var length = what.length;
1346 what.options[length] = optionName;
1348 function ${prefix}country_changed(what) {
1349 country = what.options[what.selectedIndex].text;
1350 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1351 what.form.${prefix}state.options[i] = null;
1353 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1355 foreach my $country ( sort keys %cust_main_county ) {
1356 $script_html .= "\nif ( country == \"$country\" ) {\n";
1357 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1358 my $text = $state || '(n/a)';
1359 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1361 $script_html .= "}\n";
1364 $script_html .= <<END;
1366 function ${prefix}state_changed(what) {
1369 if ( $countyflag ) {
1370 $script_html .= <<END;
1371 state = what.options[what.selectedIndex].text;
1372 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1373 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1374 what.form.${prefix}county.options[i] = null;
1377 foreach my $country ( sort keys %cust_main_county ) {
1378 $script_html .= "\nif ( country == \"$country\" ) {\n";
1379 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1380 $script_html .= "\nif ( state == \"$state\" ) {\n";
1381 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1382 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1383 my $text = $county || '(n/a)';
1385 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1387 $script_html .= "}\n";
1389 $script_html .= "}\n";
1393 $script_html .= <<END;
1398 my $county_html = $script_html;
1399 if ( $countyflag ) {
1400 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1401 foreach my $county (
1402 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1404 my $text = $county || '(n/a)';
1405 $county_html .= qq!<OPTION VALUE="$county"!.
1406 ($county eq $param->{'selected_county'} ?
1413 $county_html .= '</SELECT>';
1416 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1419 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1420 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1421 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1422 my $text = $state || '(n/a)';
1423 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1424 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1426 $state_html .= '</SELECT>';
1428 my $country_html = '';
1429 if ( scalar( keys %cust_main_county ) > 1 ) {
1431 $country_html = qq(<SELECT NAME="${prefix}country" ).
1432 qq(onChange="${prefix}country_changed(this); ).
1433 $param->{'onchange'}.
1436 my $countrydefault = $param->{default_country} || 'US';
1437 foreach my $country (
1438 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1439 keys %cust_main_county
1441 my $selected = $country eq $param->{'selected_country'}
1444 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1446 $country_html .= '</SELECT>';
1449 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1450 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1454 ($county_html, $state_html, $country_html);
1458 sub regionselector_hashref {
1459 my ($county_html, $state_html, $country_html) = regionselector(@_);
1461 'county_html' => $county_html,
1462 'state_html' => $state_html,
1463 'country_html' => $country_html,
1467 =item location_form HASHREF | LIST
1469 Takes as input a hashref or list of key/value pairs with the following keys:
1475 Current customer session_id
1479 Omit red asterisks from required fields.
1481 =item address1_label
1483 Label for first address line.
1487 Returns an HTML fragment for a location form (address, city, state, zip,
1500 my $session_id = delete $param->{'session_id'};
1502 my $rv = mason_comp( 'session_id' => $session_id,
1503 'comp' => '/elements/location.html',
1504 'args' => [ %$param ],
1508 $rv->{'error'} || $rv->{'output'};
1513 #=item expselect HASHREF | LIST
1515 #Takes as input a hashref or list of key/value pairs with the following keys:
1519 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1521 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1525 =item expselect PREFIX [ DATE ]
1527 Takes as input a unique prefix string and the current expiration date, in
1528 yyyy-mm-dd or m-d-yyyy format
1530 Returns an HTML fragments for expiration date selection.
1536 #if ( ref($_[0]) ) {
1540 #my $prefix = $param->{'prefix'};
1541 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1542 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1544 my $date = scalar(@_) ? shift : '';
1546 my( $m, $y ) = ( 0, 0 );
1547 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1548 ( $m, $y ) = ( $2, $1 );
1549 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1550 ( $m, $y ) = ( $1, $3 );
1552 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1554 $return .= qq!<OPTION VALUE="$_"!;
1555 $return .= " SELECTED" if $_ == $m;
1558 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1560 my $thisYear = $t[5] + 1900;
1561 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1562 $return .= qq!<OPTION VALUE="$_"!;
1563 $return .= " SELECTED" if $_ == $y;
1566 $return .= "</SELECT>";
1571 =item popselector HASHREF | LIST
1573 Takes as input a hashref or list of key/value pairs with the following keys:
1579 Access number number
1583 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>.
1587 Returns an HTML fragment for access number selection.
1591 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1599 my $popnum = $param->{'popnum'};
1600 my $pops = $param->{'pops'};
1602 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1603 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1604 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1605 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1606 if scalar(@$pops) == 1;
1609 my %popnum2pop = ();
1611 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1612 $popnum2pop{$_->{popnum}} = $_;
1617 function opt(what,href,text) {
1618 var optionName = new Option(text, href, false, false)
1619 var length = what.length;
1620 what.options[length] = optionName;
1624 my $init_popstate = $param->{'init_popstate'};
1625 if ( $init_popstate ) {
1626 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1627 $init_popstate. '">';
1630 function acstate_changed(what) {
1631 state = what.options[what.selectedIndex].text;
1632 what.form.popac.options.length = 0
1633 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1637 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1638 foreach my $state ( sort { $a cmp $b } @states ) {
1639 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1641 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1642 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1643 if ($ac eq $param->{'popac'}) {
1644 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1647 $text .= "}\n" unless $init_popstate;
1649 $text .= "popac_changed(what.form.popac)}\n";
1652 function popac_changed(what) {
1653 ac = what.options[what.selectedIndex].text;
1654 what.form.popnum.options.length = 0;
1655 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1659 foreach my $state ( @states ) {
1660 foreach my $popac ( keys %{ $pop{$state} } ) {
1661 $text .= "\nif ( ac == \"$popac\" ) {\n";
1663 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1664 my $o_popnum = $pop->{popnum};
1665 my $poptext = $pop->{city}. ', '. $pop->{state}.
1666 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1668 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1669 if ($popnum == $o_popnum) {
1670 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1678 $text .= "}\n</SCRIPT>\n";
1680 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1683 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1684 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1685 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1686 ">$_" foreach sort { $a cmp $b } @states;
1687 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1690 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1691 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1693 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1696 #comment this block to disable initial list polulation
1697 my @initial_select = ();
1698 if ( scalar( @$pops ) > 100 ) {
1699 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1701 @initial_select = @$pops;
1703 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1704 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1705 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1706 $pop->{city}. ', '. $pop->{state}.
1707 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1710 $text .= qq!</SELECT></TD></TR></TABLE>!;
1716 =item domainselector HASHREF | LIST
1718 Takes as input a hashref or list of key/value pairs with the following keys:
1728 Service number of the selected item.
1732 Returns an HTML fragment for domain selection.
1736 sub domainselector {
1743 my $domsvc= $param->{'domsvc'};
1745 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1746 my $domains = $rv->{'domains'};
1747 $domsvc = $rv->{'domsvc'} unless $domsvc;
1749 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1750 unless scalar(keys %$domains);
1752 if (scalar(keys %$domains) == 1) {
1754 foreach(keys %$domains) {
1757 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1758 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1761 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1764 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1765 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1766 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1767 $domains->{$domain};
1770 $text .= qq!</SELECT></TD></TR>!;
1776 =item didselector HASHREF | LIST
1778 Takes as input a hashref or list of key/value pairs with the following keys:
1784 Field name for the returned HTML fragment.
1788 Service definition (see L<FS::part_svc>)
1792 Returns an HTML fragment for DID selection.
1804 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1805 'args'=>[ %$param ],
1809 $rv->{'error'} || $rv->{'output'};
1815 =head1 RESELLER FUNCTIONS
1817 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1818 with their active session, and the B<customer_info> and B<order_pkg> functions
1819 with their active session and an additional I<custnum> parameter.
1821 For the most part, development of the reseller web interface has been
1822 superceded by agent-virtualized access to the backend.
1834 =item agent_list_customers
1836 List agent's customers.
1844 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>