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 'port_graph' => 'MyAccount/port_graph',
49 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
50 'list_support_usage' => 'MyAccount/list_support_usage',
51 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
52 'change_pkg' => 'MyAccount/change_pkg',
53 'order_recharge' => 'MyAccount/order_recharge',
54 'renew_info' => 'MyAccount/renew_info',
55 'order_renew' => 'MyAccount/order_renew',
56 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
57 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
58 'charge' => 'MyAccount/charge', #?
59 'part_svc_info' => 'MyAccount/part_svc_info',
60 'provision_acct' => 'MyAccount/provision_acct',
61 'provision_phone' => 'MyAccount/provision_phone',
62 'provision_external' => 'MyAccount/provision_external',
63 'unprovision_svc' => 'MyAccount/unprovision_svc',
64 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
65 'create_ticket' => 'MyAccount/create_ticket',
66 'get_ticket' => 'MyAccount/get_ticket',
67 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
68 'did_report' => 'MyAccount/did_report',
69 'signup_info' => 'Signup/signup_info',
70 'skin_info' => 'MyAccount/skin_info',
71 'access_info' => 'MyAccount/access_info',
72 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
73 'new_customer' => 'Signup/new_customer',
74 'capture_payment' => 'Signup/capture_payment',
75 'agent_login' => 'Agent/agent_login',
76 'agent_logout' => 'Agent/agent_logout',
77 'agent_info' => 'Agent/agent_info',
78 'agent_list_customers' => 'Agent/agent_list_customers',
79 'check_username' => 'Agent/check_username',
80 'suspend_username' => 'Agent/suspend_username',
81 'unsuspend_username' => 'Agent/unsuspend_username',
82 'mason_comp' => 'MasonComponent/mason_comp',
83 'call_time' => 'PrepaidPhone/call_time',
84 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
85 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
87 #'bulk_processrow' => 'Bulk/processrow',
88 #conflicts w/Agent one# 'check_username' => 'Bulk/check_username',
90 'ping' => 'SGNG/ping',
91 'decompify_pkgs' => 'SGNG/decompify_pkgs',
92 'previous_payment_info' => 'SGNG/previous_payment_info',
93 'previous_payment_info_renew_info'
94 => 'SGNG/previous_payment_info_renew_info',
95 'previous_process_payment' => 'SGNG/previous_process_payment',
96 'previous_process_payment_order_pkg'
97 => 'SGNG/previous_process_payment_order_pkg',
98 'previous_process_payment_change_pkg'
99 => 'SGNG/previous_process_payment_change_pkg',
100 'previous_process_payment_order_renew'
101 => 'SGNG/previous_process_payment_order_renew',
105 qw( regionselector regionselector_hashref location_form
106 expselect popselector domainselector didselector
110 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
111 $ENV{'SHELL'} = '/bin/sh';
112 $ENV{'IFS'} = " \t\n";
115 $ENV{'BASH_ENV'} = '';
117 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
118 #if you grant appropriate permissions to whatever user
119 my $freeside_uid = scalar(getpwnam('freeside'));
120 die "not running as the freeside user\n"
121 if $> != $freeside_uid && ! $skip_uid_check;
123 -e $dir or die "FATAL: $dir doesn't exist!";
124 -d $dir or die "FATAL: $dir isn't a directory!";
125 -r $dir or die "FATAL: Can't read $dir as freeside user!";
126 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
128 foreach my $autoload ( keys %autoload ) {
131 "sub $autoload { ". '
136 #warn scalar(@_). ": ". join(" / ", @_);
140 $param->{_packet} = \''. $autoload{$autoload}. '\';
142 simple_packet($param);
152 warn "sending ". $packet->{_packet}. " to server"
154 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
155 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
156 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
159 #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
161 #block until there is a message on socket
162 # my $w = new IO::Select;
164 # my @wait = $w->can_read;
166 warn "reading message from server"
169 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
170 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
172 warn "returning message to client"
180 FS::SelfService - Freeside self-service API
184 # password and shell account changes
185 use FS::SelfService qw(passwd chfn chsh);
187 # "my account" functionality
188 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
190 my $rv = login( { 'username' => $username,
192 'password' => $password,
196 if ( $rv->{'error'} ) {
197 #handle login error...
200 my $session_id = $rv->{'session_id'};
203 my $customer_info = customer_info( { 'session_id' => $session_id } );
205 #payment_info and process_payment are available in 1.5+ only
206 my $payment_info = payment_info( { 'session_id' => $session_id } );
208 #!!! process_payment example
210 #!!! list_pkgs example
212 #!!! order_pkg example
214 #!!! cancel_pkg example
216 # signup functionality
217 use FS::SelfService qw( signup_info new_customer );
219 my $signup_info = signup_info;
221 $rv = new_customer( {
224 'company' => $company,
225 'address1' => $address1,
226 'address2' => $address2,
230 'country' => $country,
231 'daytime' => $daytime,
235 'payinfo' => $payinfo,
237 'paystart_month' => $paystart_month
238 'paystart_year' => $paystart_year,
239 'payissue' => $payissue,
241 'paydate' => $paydate,
242 'payname' => $payname,
243 'invoicing_list' => $invoicing_list,
244 'referral_custnum' => $referral_custnum,
245 'agentnum' => $agentnum,
246 'pkgpart' => $pkgpart,
248 'username' => $username,
249 '_password' => $password,
253 'phonenum' => $phonenum,
258 my $error = $rv->{'error'};
259 if ( $error eq '_decline' ) {
269 Use this API to implement your own client "self-service" module.
271 If you just want to customize the look of the existing "self-service" module,
274 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
286 =head1 "MY ACCOUNT" FUNCTIONS
292 Creates a user session. Takes a hash reference as parameter with the
311 Returns a hash reference with the following keys:
317 Empty on success, or an error message on errors.
321 Session identifier for successful logins
325 =item customer_info HASHREF
327 Returns general customer information.
329 Takes a hash reference as parameter with a single key: B<session_id>
331 Returns a hash reference with the following keys:
345 Array reference of hash references of open inoices. Each hash reference has
346 the following keys: invnum, date, owed
350 An HTML fragment containing shipping and billing addresses.
352 =item The following fields are also returned
354 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
358 =item edit_info HASHREF
360 Takes a hash reference as parameter with any of the following keys:
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 paycvv payname month year invoicing_list postal_invoicing
364 If a field exists, the customer record is updated with the new value of that
365 field. If a field does not exist, that field is not changed on the customer
368 Returns a hash reference with a single key, B<error>, empty on success, or an
369 error message on errors
371 =item invoice HASHREF
373 Returns an invoice. Takes a hash reference as parameter with two keys:
374 session_id and invnum
376 Returns a hash reference with the following keys:
382 Empty on success, or an error message on errors
394 =item list_invoices HASHREF
396 Returns a list of all customer invoices. Takes a hash references with a single
399 Returns a hash reference with the following keys:
405 Empty on success, or an error message on errors
409 Reference to array of hash references with the following keys:
419 Invoice date, in UNIX epoch time
427 Cancels this customer.
429 Takes a hash reference as parameter with a single key: B<session_id>
431 Returns a hash reference with a single key, B<error>, which is empty on
432 success or an error message on errors.
434 =item payment_info HASHREF
436 Returns information that may be useful in displaying a payment page.
438 Takes a hash reference as parameter with a single key: B<session_id>.
440 Returns a hash reference with the following keys:
446 Empty on success, or an error message on errors
454 Exact name on credit card (CARD/DCRD)
478 Customer's current default payment type.
482 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
486 For CARD/DCRD payment types, the card number
490 For CARD/DCRD payment types, expiration month
494 For CARD/DCRD payment types, expiration year
496 =item cust_main_county
498 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.
502 Array reference of all states in the current default country.
506 Hash reference of card types; keys are card types, values are the exact strings
507 passed to the process_payment function
511 #this doesn't actually work yet
515 #Unique transaction identifier (prevents multiple charges), passed to the
516 #process_payment function
520 =item process_payment HASHREF
522 Processes a payment and possible change of address or payment type. Takes a
523 hash reference as parameter with the following keys:
537 If true, address and card information entered will be saved for subsequent
542 If true, future credit card payments will be done automatically (sets payby to
543 CARD). If false, future credit card payments will be done on-demand (sets
544 payby to DCRD). This option only has meaning if B<save> is set true.
572 Two-letter country code
580 Card expiration month
588 #this doesn't actually work yet
592 #Unique transaction identifier, returned from the payment_info function.
593 #Prevents multiple charges.
597 Returns a hash reference with a single key, B<error>, empty on success, or an
598 error message on errors.
600 =item process_payment_order_pkg
602 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
603 payment processes sucessfully, the package is ordered. Takes a hash reference
604 as parameter with the keys of both methods.
606 Returns a hash reference with a single key, B<error>, empty on success, or an
607 error message on errors.
609 =item process_payment_change_pkg
611 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
612 payment processes sucessfully, the package is ordered. Takes a hash reference
613 as parameter with the keys of both methods.
615 Returns a hash reference with a single key, B<error>, empty on success, or an
616 error message on errors.
619 =item process_payment_order_renew
621 Combines the B<process_payment> and B<order_renew> functions in one step. If
622 the payment processes sucessfully, the renewal is processed. Takes a hash
623 reference as parameter with the keys of both methods.
625 Returns a hash reference with a single key, B<error>, empty on success, or an
626 error message on errors.
630 Returns package information for this customer. For more detail on services,
633 Takes a hash reference as parameter with a single key: B<session_id>
635 Returns a hash reference containing customer package information. The hash reference contains the following keys:
645 Empty on success, or an error message on errors.
647 =item cust_pkg HASHREF
649 Array reference of hash references, each of which has the fields of a cust_pkg
650 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
651 the internal FS:: objects, but hash references of columns and values.
655 =item part_pkg fields
657 All fields of part_pkg for this specific cust_pkg (be careful with this
658 information - it may reveal more about your available packages than you would
659 like users to know in aggregate)
663 #XXX pare part_pkg fields down to a more secure subset
667 An array of hash references indicating information on unprovisioned services
668 available for provisioning for this specific cust_pkg. Each has the following
673 =item part_svc fields
675 All fields of part_svc (be careful with this information - it may reveal more
676 about your available packages than you would like users to know in aggregate)
680 #XXX pare part_svc fields down to a more secure subset
686 An array of hash references indicating information on the customer services
687 already provisioned for this specific cust_pkg. Each has the following keys:
693 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.
699 Primary key for this service
703 Service definition (see L<FS::part_svc>)
707 Customer package (see L<FS::cust_pkg>)
711 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
719 Returns service information for this customer.
721 Takes a hash reference as parameter with a single key: B<session_id>
723 Returns a hash reference containing customer package information. The hash reference contains the following keys:
733 An array of hash references indicating information on all of this customer's
734 services. Each has the following keys:
740 Primary key for this service
748 Meaningful user-specific identifier for the service (i.e. username, domain, or
753 Account (svc_acct) services also have the following keys:
771 Upload bytes remaining
775 Download bytes remaining
779 Total bytes remaining
781 =item recharge_amount
785 =item recharge_seconds
787 Number of seconds gained by recharge
789 =item recharge_upbytes
791 Number of upload bytes gained by recharge
793 =item recharge_downbytes
795 Number of download bytes gained by recharge
797 =item recharge_totalbytes
799 Number of total bytes gained by recharge
807 Orders a package for this customer.
809 Takes a hash reference as parameter with the following keys:
819 Package to order (see L<FS::part_pkg>).
823 Service to order (see L<FS::part_svc>).
825 Normally optional; required only to provision a non-svc_acct service, or if the
826 package definition does not contain one svc_acct service definition with
827 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
828 also be specified to indicate that no initial service should be provisioned.
832 Fields used when provisioning an svc_acct service:
846 Optional security phrase
850 Optional Access number number
854 Fields used when provisioning an svc_domain service:
864 Fields used when provisioning an svc_phone service:
882 Fields used when provisioning an svc_external service:
896 Returns a hash reference with a single key, B<error>, empty on success, or an
897 error message on errors. The special error '_decline' is returned for
898 declined transactions.
902 Changes a package for this customer.
904 Takes a hash reference as parameter with the following keys:
914 Existing customer package.
918 New package to order (see L<FS::part_pkg>).
922 Returns a hash reference with a single key, B<error>, empty on success, or an
923 error message on errors.
927 Provides useful info for early renewals.
929 Takes a hash reference as parameter with the following keys:
939 Returns a hash reference. On errors, it contains a single key, B<error>, with
940 the error message. Otherwise, contains a single key, B<dates>, pointing to
941 an array refernce of hash references. Each hash reference contains the
948 (Future) Bill date. Indicates a future date for which billing could be run.
949 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
952 =item bill_date_pretty
954 (Future) Bill date as a human-readable string. (Convenience for display;
955 subject to change, so best not to parse for the date.)
959 Base amount which will be charged if renewed early as of this date.
963 Renewal date; i.e. even-futher future date at which the customer will be paid
964 through if the early renewal is completed with the given B<bill-date>.
965 Specified as a integer UNIX timestamp.
967 =item renew_date_pretty
969 Renewal date as a human-readable string. (Convenience for display;
970 subject to change, so best not to parse for the date.)
974 Package that will be renewed.
978 Expiration date of the package that will be renewed.
980 =item expire_date_pretty
982 Expiration date of the package that will be renewed, as a human-readable
983 string. (Convenience for display; subject to change, so best not to parse for
990 Renews this customer early; i.e. runs billing for this customer in advance.
992 Takes a hash reference as parameter with the following keys:
1002 Integer date as returned by the B<renew_info> function, indicating the advance
1003 date for which to run billing.
1007 Returns a hash reference with a single key, B<error>, empty on success, or an
1008 error message on errors.
1012 Cancels a package for this customer.
1014 Takes a hash reference as parameter with the following keys:
1024 pkgpart of package to cancel
1028 Returns a hash reference with a single key, B<error>, empty on success, or an
1029 error message on errors.
1033 =head1 SIGNUP FUNCTIONS
1037 =item signup_info HASHREF
1039 Takes a hash reference as parameter with the following keys:
1043 =item session_id - Optional agent/reseller interface session
1047 Returns a hash reference containing information that may be useful in
1048 displaying a signup page. The hash reference contains the following keys:
1052 =item cust_main_county
1054 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.
1058 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
1059 an agentnum specified explicitly via reseller interface session_id in the
1064 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.
1066 =item agentnum2part_pkg
1068 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.
1072 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.
1074 =item security_phrase
1076 True if the "security_phrase" feature is enabled
1080 Array reference of acceptable payment types for signup
1086 credit card - automatic
1090 credit card - on-demand - version 1.5+ only
1094 electronic check - automatic
1098 electronic check - on-demand - version 1.5+ only
1106 billing, not recommended for signups
1110 free, definitely not recommended for signups
1114 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1120 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1124 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".
1130 =item countrydefault
1136 =item new_customer HASHREF
1138 Creates a new customer. Takes a hash reference as parameter with the
1145 first name (required)
1149 last name (required)
1153 (not typically collected; mostly used for ACH transactions)
1159 =item address1 (required)
1167 =item city (required)
1175 =item state (required)
1179 =item zip (required)
1185 Daytime phone number
1189 Evening phone number
1197 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1201 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1205 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1209 Expiration date for CARD/DCRD
1213 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1215 =item invoicing_list
1217 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),
1219 =item referral_custnum
1221 referring customer number
1229 pkgpart of initial package
1245 Access number (index, not the literal number)
1249 Country code (to be provisioned as a service)
1253 Phone number (to be provisioned as a service)
1261 Returns a hash reference with the following keys:
1267 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)
1271 =item regionselector HASHREF | LIST
1273 Takes as input a hashref or list of key/value pairs with the following keys:
1277 =item selected_county
1279 Currently selected county
1281 =item selected_state
1283 Currently selected state
1285 =item selected_country
1287 Currently selected country
1291 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1295 Specify a javascript subroutine to call on changes
1301 =item default_country
1307 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>.
1311 Returns a list consisting of three HTML fragments for county selection,
1312 state selection and country selection, respectively.
1316 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1317 sub regionselector {
1324 $param->{'selected_country'} ||= $param->{'default_country'};
1325 $param->{'selected_state'} ||= $param->{'default_state'};
1327 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1331 my %cust_main_county;
1333 # unless ( @cust_main_county ) { #cache
1334 #@cust_main_county = qsearch('cust_main_county', {} );
1335 #foreach my $c ( @cust_main_county ) {
1336 foreach my $c ( @{ $param->{'locales'} } ) {
1337 #$countyflag=1 if $c->county;
1338 $countyflag=1 if $c->{county};
1339 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1340 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1341 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1344 $countyflag=1 if $param->{selected_county};
1346 my $script_html = <<END;
1348 function opt(what,value,text) {
1349 var optionName = new Option(text, value, false, false);
1350 var length = what.length;
1351 what.options[length] = optionName;
1353 function ${prefix}country_changed(what) {
1354 country = what.options[what.selectedIndex].text;
1355 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1356 what.form.${prefix}state.options[i] = null;
1358 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1360 foreach my $country ( sort keys %cust_main_county ) {
1361 $script_html .= "\nif ( country == \"$country\" ) {\n";
1362 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1363 my $text = $state || '(n/a)';
1364 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1366 $script_html .= "}\n";
1369 $script_html .= <<END;
1371 function ${prefix}state_changed(what) {
1374 if ( $countyflag ) {
1375 $script_html .= <<END;
1376 state = what.options[what.selectedIndex].text;
1377 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1378 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1379 what.form.${prefix}county.options[i] = null;
1382 foreach my $country ( sort keys %cust_main_county ) {
1383 $script_html .= "\nif ( country == \"$country\" ) {\n";
1384 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1385 $script_html .= "\nif ( state == \"$state\" ) {\n";
1386 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1387 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1388 my $text = $county || '(n/a)';
1390 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1392 $script_html .= "}\n";
1394 $script_html .= "}\n";
1398 $script_html .= <<END;
1403 my $county_html = $script_html;
1404 if ( $countyflag ) {
1405 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1406 foreach my $county (
1407 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1409 my $text = $county || '(n/a)';
1410 $county_html .= qq!<OPTION VALUE="$county"!.
1411 ($county eq $param->{'selected_county'} ?
1418 $county_html .= '</SELECT>';
1421 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1424 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1425 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1426 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1427 my $text = $state || '(n/a)';
1428 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1429 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1431 $state_html .= '</SELECT>';
1433 my $country_html = '';
1434 if ( scalar( keys %cust_main_county ) > 1 ) {
1436 $country_html = qq(<SELECT NAME="${prefix}country" ).
1437 qq(onChange="${prefix}country_changed(this); ).
1438 $param->{'onchange'}.
1441 my $countrydefault = $param->{default_country} || 'US';
1442 foreach my $country (
1443 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1444 keys %cust_main_county
1446 my $selected = $country eq $param->{'selected_country'}
1449 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1451 $country_html .= '</SELECT>';
1454 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1455 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1459 ($county_html, $state_html, $country_html);
1463 sub regionselector_hashref {
1464 my ($county_html, $state_html, $country_html) = regionselector(@_);
1466 'county_html' => $county_html,
1467 'state_html' => $state_html,
1468 'country_html' => $country_html,
1472 =item location_form HASHREF | LIST
1474 Takes as input a hashref or list of key/value pairs with the following keys:
1480 Current customer session_id
1484 Omit red asterisks from required fields.
1486 =item address1_label
1488 Label for first address line.
1492 Returns an HTML fragment for a location form (address, city, state, zip,
1505 my $session_id = delete $param->{'session_id'};
1507 my $rv = mason_comp( 'session_id' => $session_id,
1508 'comp' => '/elements/location.html',
1509 'args' => [ %$param ],
1513 $rv->{'error'} || $rv->{'output'};
1518 #=item expselect HASHREF | LIST
1520 #Takes as input a hashref or list of key/value pairs with the following keys:
1524 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1526 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1530 =item expselect PREFIX [ DATE ]
1532 Takes as input a unique prefix string and the current expiration date, in
1533 yyyy-mm-dd or m-d-yyyy format
1535 Returns an HTML fragments for expiration date selection.
1541 #if ( ref($_[0]) ) {
1545 #my $prefix = $param->{'prefix'};
1546 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1547 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1549 my $date = scalar(@_) ? shift : '';
1551 my( $m, $y ) = ( 0, 0 );
1552 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1553 ( $m, $y ) = ( $2, $1 );
1554 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1555 ( $m, $y ) = ( $1, $3 );
1557 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1559 $return .= qq!<OPTION VALUE="$_"!;
1560 $return .= " SELECTED" if $_ == $m;
1563 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1565 my $thisYear = $t[5] + 1900;
1566 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1567 $return .= qq!<OPTION VALUE="$_"!;
1568 $return .= " SELECTED" if $_ == $y;
1571 $return .= "</SELECT>";
1576 =item popselector HASHREF | LIST
1578 Takes as input a hashref or list of key/value pairs with the following keys:
1584 Access number number
1588 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>.
1592 Returns an HTML fragment for access number selection.
1596 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1604 my $popnum = $param->{'popnum'};
1605 my $pops = $param->{'pops'};
1607 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1608 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1609 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1610 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1611 if scalar(@$pops) == 1;
1614 my %popnum2pop = ();
1616 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1617 $popnum2pop{$_->{popnum}} = $_;
1622 function opt(what,href,text) {
1623 var optionName = new Option(text, href, false, false)
1624 var length = what.length;
1625 what.options[length] = optionName;
1629 my $init_popstate = $param->{'init_popstate'};
1630 if ( $init_popstate ) {
1631 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1632 $init_popstate. '">';
1635 function acstate_changed(what) {
1636 state = what.options[what.selectedIndex].text;
1637 what.form.popac.options.length = 0
1638 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1642 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1643 foreach my $state ( sort { $a cmp $b } @states ) {
1644 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1646 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1647 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1648 if ($ac eq $param->{'popac'}) {
1649 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1652 $text .= "}\n" unless $init_popstate;
1654 $text .= "popac_changed(what.form.popac)}\n";
1657 function popac_changed(what) {
1658 ac = what.options[what.selectedIndex].text;
1659 what.form.popnum.options.length = 0;
1660 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1664 foreach my $state ( @states ) {
1665 foreach my $popac ( keys %{ $pop{$state} } ) {
1666 $text .= "\nif ( ac == \"$popac\" ) {\n";
1668 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1669 my $o_popnum = $pop->{popnum};
1670 my $poptext = $pop->{city}. ', '. $pop->{state}.
1671 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1673 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1674 if ($popnum == $o_popnum) {
1675 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1683 $text .= "}\n</SCRIPT>\n";
1685 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1688 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1689 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1690 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1691 ">$_" foreach sort { $a cmp $b } @states;
1692 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1695 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1696 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1698 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1701 #comment this block to disable initial list polulation
1702 my @initial_select = ();
1703 if ( scalar( @$pops ) > 100 ) {
1704 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1706 @initial_select = @$pops;
1708 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1709 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1710 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1711 $pop->{city}. ', '. $pop->{state}.
1712 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1715 $text .= qq!</SELECT></TD></TR></TABLE>!;
1721 =item domainselector HASHREF | LIST
1723 Takes as input a hashref or list of key/value pairs with the following keys:
1733 Service number of the selected item.
1737 Returns an HTML fragment for domain selection.
1741 sub domainselector {
1748 my $domsvc= $param->{'domsvc'};
1750 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1751 my $domains = $rv->{'domains'};
1752 $domsvc = $rv->{'domsvc'} unless $domsvc;
1754 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1755 unless scalar(keys %$domains);
1757 if (scalar(keys %$domains) == 1) {
1759 foreach(keys %$domains) {
1762 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1763 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1766 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1769 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1770 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1771 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1772 $domains->{$domain};
1775 $text .= qq!</SELECT></TD></TR>!;
1781 =item didselector HASHREF | LIST
1783 Takes as input a hashref or list of key/value pairs with the following keys:
1789 Field name for the returned HTML fragment.
1793 Service definition (see L<FS::part_svc>)
1797 Returns an HTML fragment for DID selection.
1809 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1810 'args'=>[ %$param ],
1814 $rv->{'error'} || $rv->{'output'};
1820 =head1 RESELLER FUNCTIONS
1822 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1823 with their active session, and the B<customer_info> and B<order_pkg> functions
1824 with their active session and an additional I<custnum> parameter.
1826 For the most part, development of the reseller web interface has been
1827 superceded by agent-virtualized access to the backend.
1839 =item agent_list_customers
1841 List agent's customers.
1849 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>