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 'did_report' => 'MyAccount/did_report',
68 'signup_info' => 'Signup/signup_info',
69 'skin_info' => 'MyAccount/skin_info',
70 'access_info' => 'MyAccount/access_info',
71 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
72 'new_customer' => 'Signup/new_customer',
73 'capture_payment' => 'Signup/capture_payment',
74 'agent_login' => 'Agent/agent_login',
75 'agent_logout' => 'Agent/agent_logout',
76 'agent_info' => 'Agent/agent_info',
77 'agent_list_customers' => 'Agent/agent_list_customers',
78 'check_username' => 'Agent/check_username',
79 'suspend_username' => 'Agent/suspend_username',
80 'unsuspend_username' => 'Agent/unsuspend_username',
81 'mason_comp' => 'MasonComponent/mason_comp',
82 'call_time' => 'PrepaidPhone/call_time',
83 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
84 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
86 #'bulk_processrow' => 'Bulk/processrow',
87 #conflicts w/Agent one# 'check_username' => 'Bulk/check_username',
89 'ping' => 'SGNG/ping',
90 'decompify_pkgs' => 'SGNG/decompify_pkgs',
91 'previous_payment_info' => 'SGNG/previous_payment_info',
92 'previous_payment_info_renew_info'
93 => 'SGNG/previous_payment_info_renew_info',
94 'previous_process_payment' => 'SGNG/previous_process_payment',
95 'previous_process_payment_order_pkg'
96 => 'SGNG/previous_process_payment_order_pkg',
97 'previous_process_payment_change_pkg'
98 => 'SGNG/previous_process_payment_change_pkg',
99 'previous_process_payment_order_renew'
100 => 'SGNG/previous_process_payment_order_renew',
104 qw( regionselector regionselector_hashref location_form
105 expselect popselector domainselector didselector
109 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
110 $ENV{'SHELL'} = '/bin/sh';
111 $ENV{'IFS'} = " \t\n";
114 $ENV{'BASH_ENV'} = '';
116 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
117 #if you grant appropriate permissions to whatever user
118 my $freeside_uid = scalar(getpwnam('freeside'));
119 die "not running as the freeside user\n"
120 if $> != $freeside_uid && ! $skip_uid_check;
122 -e $dir or die "FATAL: $dir doesn't exist!";
123 -d $dir or die "FATAL: $dir isn't a directory!";
124 -r $dir or die "FATAL: Can't read $dir as freeside user!";
125 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
127 foreach my $autoload ( keys %autoload ) {
130 "sub $autoload { ". '
135 #warn scalar(@_). ": ". join(" / ", @_);
139 $param->{_packet} = \''. $autoload{$autoload}. '\';
141 simple_packet($param);
151 warn "sending ". $packet->{_packet}. " to server"
153 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
154 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
155 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
158 #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
160 #block until there is a message on socket
161 # my $w = new IO::Select;
163 # my @wait = $w->can_read;
165 warn "reading message from server"
168 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
169 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
171 warn "returning message to client"
179 FS::SelfService - Freeside self-service API
183 # password and shell account changes
184 use FS::SelfService qw(passwd chfn chsh);
186 # "my account" functionality
187 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
189 my $rv = login( { 'username' => $username,
191 'password' => $password,
195 if ( $rv->{'error'} ) {
196 #handle login error...
199 my $session_id = $rv->{'session_id'};
202 my $customer_info = customer_info( { 'session_id' => $session_id } );
204 #payment_info and process_payment are available in 1.5+ only
205 my $payment_info = payment_info( { 'session_id' => $session_id } );
207 #!!! process_payment example
209 #!!! list_pkgs example
211 #!!! order_pkg example
213 #!!! cancel_pkg example
215 # signup functionality
216 use FS::SelfService qw( signup_info new_customer );
218 my $signup_info = signup_info;
220 $rv = new_customer( {
223 'company' => $company,
224 'address1' => $address1,
225 'address2' => $address2,
229 'country' => $country,
230 'daytime' => $daytime,
234 'payinfo' => $payinfo,
236 'paystart_month' => $paystart_month
237 'paystart_year' => $paystart_year,
238 'payissue' => $payissue,
240 'paydate' => $paydate,
241 'payname' => $payname,
242 'invoicing_list' => $invoicing_list,
243 'referral_custnum' => $referral_custnum,
244 'agentnum' => $agentnum,
245 'pkgpart' => $pkgpart,
247 'username' => $username,
248 '_password' => $password,
252 'phonenum' => $phonenum,
257 my $error = $rv->{'error'};
258 if ( $error eq '_decline' ) {
268 Use this API to implement your own client "self-service" module.
270 If you just want to customize the look of the existing "self-service" module,
273 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
285 =head1 "MY ACCOUNT" FUNCTIONS
291 Creates a user session. Takes a hash reference as parameter with the
310 Returns a hash reference with the following keys:
316 Empty on success, or an error message on errors.
320 Session identifier for successful logins
324 =item customer_info HASHREF
326 Returns general customer information.
328 Takes a hash reference as parameter with a single key: B<session_id>
330 Returns a hash reference with the following keys:
344 Array reference of hash references of open inoices. Each hash reference has
345 the following keys: invnum, date, owed
349 An HTML fragment containing shipping and billing addresses.
351 =item The following fields are also returned
353 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
357 =item edit_info HASHREF
359 Takes a hash reference as parameter with any of the following keys:
361 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
363 If a field exists, the customer record is updated with the new value of that
364 field. If a field does not exist, that field is not changed on the customer
367 Returns a hash reference with a single key, B<error>, empty on success, or an
368 error message on errors
370 =item invoice HASHREF
372 Returns an invoice. Takes a hash reference as parameter with two keys:
373 session_id and invnum
375 Returns a hash reference with the following keys:
381 Empty on success, or an error message on errors
393 =item list_invoices HASHREF
395 Returns a list of all customer invoices. Takes a hash references with a single
398 Returns a hash reference with the following keys:
404 Empty on success, or an error message on errors
408 Reference to array of hash references with the following keys:
418 Invoice date, in UNIX epoch time
426 Cancels this customer.
428 Takes a hash reference as parameter with a single key: B<session_id>
430 Returns a hash reference with a single key, B<error>, which is empty on
431 success or an error message on errors.
433 =item payment_info HASHREF
435 Returns information that may be useful in displaying a payment page.
437 Takes a hash reference as parameter with a single key: B<session_id>.
439 Returns a hash reference with the following keys:
445 Empty on success, or an error message on errors
453 Exact name on credit card (CARD/DCRD)
477 Customer's current default payment type.
481 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
485 For CARD/DCRD payment types, the card number
489 For CARD/DCRD payment types, expiration month
493 For CARD/DCRD payment types, expiration year
495 =item cust_main_county
497 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.
501 Array reference of all states in the current default country.
505 Hash reference of card types; keys are card types, values are the exact strings
506 passed to the process_payment function
510 #this doesn't actually work yet
514 #Unique transaction identifier (prevents multiple charges), passed to the
515 #process_payment function
519 =item process_payment HASHREF
521 Processes a payment and possible change of address or payment type. Takes a
522 hash reference as parameter with the following keys:
536 If true, address and card information entered will be saved for subsequent
541 If true, future credit card payments will be done automatically (sets payby to
542 CARD). If false, future credit card payments will be done on-demand (sets
543 payby to DCRD). This option only has meaning if B<save> is set true.
571 Two-letter country code
579 Card expiration month
587 #this doesn't actually work yet
591 #Unique transaction identifier, returned from the payment_info function.
592 #Prevents multiple charges.
596 Returns a hash reference with a single key, B<error>, empty on success, or an
597 error message on errors.
599 =item process_payment_order_pkg
601 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
602 payment processes sucessfully, the package is ordered. Takes a hash reference
603 as parameter with the keys of both methods.
605 Returns a hash reference with a single key, B<error>, empty on success, or an
606 error message on errors.
608 =item process_payment_change_pkg
610 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
611 payment processes sucessfully, the package is ordered. Takes a hash reference
612 as parameter with the keys of both methods.
614 Returns a hash reference with a single key, B<error>, empty on success, or an
615 error message on errors.
618 =item process_payment_order_renew
620 Combines the B<process_payment> and B<order_renew> functions in one step. If
621 the payment processes sucessfully, the renewal is processed. Takes a hash
622 reference as parameter with the keys of both methods.
624 Returns a hash reference with a single key, B<error>, empty on success, or an
625 error message on errors.
629 Returns package information for this customer. For more detail on services,
632 Takes a hash reference as parameter with a single key: B<session_id>
634 Returns a hash reference containing customer package information. The hash reference contains the following keys:
644 Empty on success, or an error message on errors.
646 =item cust_pkg HASHREF
648 Array reference of hash references, each of which has the fields of a cust_pkg
649 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
650 the internal FS:: objects, but hash references of columns and values.
654 =item part_pkg fields
656 All fields of part_pkg for this specific cust_pkg (be careful with this
657 information - it may reveal more about your available packages than you would
658 like users to know in aggregate)
662 #XXX pare part_pkg fields down to a more secure subset
666 An array of hash references indicating information on unprovisioned services
667 available for provisioning for this specific cust_pkg. Each has the following
672 =item part_svc fields
674 All fields of part_svc (be careful with this information - it may reveal more
675 about your available packages than you would like users to know in aggregate)
679 #XXX pare part_svc fields down to a more secure subset
685 An array of hash references indicating information on the customer services
686 already provisioned for this specific cust_pkg. Each has the following keys:
692 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.
698 Primary key for this service
702 Service definition (see L<FS::part_svc>)
706 Customer package (see L<FS::cust_pkg>)
710 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
718 Returns service information for this customer.
720 Takes a hash reference as parameter with a single key: B<session_id>
722 Returns a hash reference containing customer package information. The hash reference contains the following keys:
732 An array of hash references indicating information on all of this customer's
733 services. Each has the following keys:
739 Primary key for this service
747 Meaningful user-specific identifier for the service (i.e. username, domain, or
752 Account (svc_acct) services also have the following keys:
770 Upload bytes remaining
774 Download bytes remaining
778 Total bytes remaining
780 =item recharge_amount
784 =item recharge_seconds
786 Number of seconds gained by recharge
788 =item recharge_upbytes
790 Number of upload bytes gained by recharge
792 =item recharge_downbytes
794 Number of download bytes gained by recharge
796 =item recharge_totalbytes
798 Number of total bytes gained by recharge
806 Orders a package for this customer.
808 Takes a hash reference as parameter with the following keys:
818 Package to order (see L<FS::part_pkg>).
822 Service to order (see L<FS::part_svc>).
824 Normally optional; required only to provision a non-svc_acct service, or if the
825 package definition does not contain one svc_acct service definition with
826 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
827 also be specified to indicate that no initial service should be provisioned.
831 Fields used when provisioning an svc_acct service:
845 Optional security phrase
849 Optional Access number number
853 Fields used when provisioning an svc_domain service:
863 Fields used when provisioning an svc_phone service:
881 Fields used when provisioning an svc_external service:
895 Returns a hash reference with a single key, B<error>, empty on success, or an
896 error message on errors. The special error '_decline' is returned for
897 declined transactions.
901 Changes a package for this customer.
903 Takes a hash reference as parameter with the following keys:
913 Existing customer package.
917 New package to order (see L<FS::part_pkg>).
921 Returns a hash reference with a single key, B<error>, empty on success, or an
922 error message on errors.
926 Provides useful info for early renewals.
928 Takes a hash reference as parameter with the following keys:
938 Returns a hash reference. On errors, it contains a single key, B<error>, with
939 the error message. Otherwise, contains a single key, B<dates>, pointing to
940 an array refernce of hash references. Each hash reference contains the
947 (Future) Bill date. Indicates a future date for which billing could be run.
948 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
951 =item bill_date_pretty
953 (Future) Bill date as a human-readable string. (Convenience for display;
954 subject to change, so best not to parse for the date.)
958 Base amount which will be charged if renewed early as of this date.
962 Renewal date; i.e. even-futher future date at which the customer will be paid
963 through if the early renewal is completed with the given B<bill-date>.
964 Specified as a integer UNIX timestamp.
966 =item renew_date_pretty
968 Renewal date as a human-readable string. (Convenience for display;
969 subject to change, so best not to parse for the date.)
973 Package that will be renewed.
977 Expiration date of the package that will be renewed.
979 =item expire_date_pretty
981 Expiration date of the package that will be renewed, as a human-readable
982 string. (Convenience for display; subject to change, so best not to parse for
989 Renews this customer early; i.e. runs billing for this customer in advance.
991 Takes a hash reference as parameter with the following keys:
1001 Integer date as returned by the B<renew_info> function, indicating the advance
1002 date for which to run billing.
1006 Returns a hash reference with a single key, B<error>, empty on success, or an
1007 error message on errors.
1011 Cancels a package for this customer.
1013 Takes a hash reference as parameter with the following keys:
1023 pkgpart of package to cancel
1027 Returns a hash reference with a single key, B<error>, empty on success, or an
1028 error message on errors.
1032 =head1 SIGNUP FUNCTIONS
1036 =item signup_info HASHREF
1038 Takes a hash reference as parameter with the following keys:
1042 =item session_id - Optional agent/reseller interface session
1046 Returns a hash reference containing information that may be useful in
1047 displaying a signup page. The hash reference contains the following keys:
1051 =item cust_main_county
1053 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.
1057 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
1058 an agentnum specified explicitly via reseller interface session_id in the
1063 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.
1065 =item agentnum2part_pkg
1067 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.
1071 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.
1073 =item security_phrase
1075 True if the "security_phrase" feature is enabled
1079 Array reference of acceptable payment types for signup
1085 credit card - automatic
1089 credit card - on-demand - version 1.5+ only
1093 electronic check - automatic
1097 electronic check - on-demand - version 1.5+ only
1105 billing, not recommended for signups
1109 free, definitely not recommended for signups
1113 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1119 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1123 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".
1129 =item countrydefault
1135 =item new_customer HASHREF
1137 Creates a new customer. Takes a hash reference as parameter with the
1144 first name (required)
1148 last name (required)
1152 (not typically collected; mostly used for ACH transactions)
1158 =item address1 (required)
1166 =item city (required)
1174 =item state (required)
1178 =item zip (required)
1184 Daytime phone number
1188 Evening phone number
1196 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1200 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1204 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1208 Expiration date for CARD/DCRD
1212 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1214 =item invoicing_list
1216 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),
1218 =item referral_custnum
1220 referring customer number
1228 pkgpart of initial package
1244 Access number (index, not the literal number)
1248 Country code (to be provisioned as a service)
1252 Phone number (to be provisioned as a service)
1260 Returns a hash reference with the following keys:
1266 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)
1270 =item regionselector HASHREF | LIST
1272 Takes as input a hashref or list of key/value pairs with the following keys:
1276 =item selected_county
1278 Currently selected county
1280 =item selected_state
1282 Currently selected state
1284 =item selected_country
1286 Currently selected country
1290 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1294 Specify a javascript subroutine to call on changes
1300 =item default_country
1306 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>.
1310 Returns a list consisting of three HTML fragments for county selection,
1311 state selection and country selection, respectively.
1315 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1316 sub regionselector {
1323 $param->{'selected_country'} ||= $param->{'default_country'};
1324 $param->{'selected_state'} ||= $param->{'default_state'};
1326 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1330 my %cust_main_county;
1332 # unless ( @cust_main_county ) { #cache
1333 #@cust_main_county = qsearch('cust_main_county', {} );
1334 #foreach my $c ( @cust_main_county ) {
1335 foreach my $c ( @{ $param->{'locales'} } ) {
1336 #$countyflag=1 if $c->county;
1337 $countyflag=1 if $c->{county};
1338 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1339 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1340 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1343 $countyflag=1 if $param->{selected_county};
1345 my $script_html = <<END;
1347 function opt(what,value,text) {
1348 var optionName = new Option(text, value, false, false);
1349 var length = what.length;
1350 what.options[length] = optionName;
1352 function ${prefix}country_changed(what) {
1353 country = what.options[what.selectedIndex].text;
1354 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1355 what.form.${prefix}state.options[i] = null;
1357 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1359 foreach my $country ( sort keys %cust_main_county ) {
1360 $script_html .= "\nif ( country == \"$country\" ) {\n";
1361 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1362 my $text = $state || '(n/a)';
1363 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1365 $script_html .= "}\n";
1368 $script_html .= <<END;
1370 function ${prefix}state_changed(what) {
1373 if ( $countyflag ) {
1374 $script_html .= <<END;
1375 state = what.options[what.selectedIndex].text;
1376 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1377 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1378 what.form.${prefix}county.options[i] = null;
1381 foreach my $country ( sort keys %cust_main_county ) {
1382 $script_html .= "\nif ( country == \"$country\" ) {\n";
1383 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1384 $script_html .= "\nif ( state == \"$state\" ) {\n";
1385 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1386 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1387 my $text = $county || '(n/a)';
1389 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1391 $script_html .= "}\n";
1393 $script_html .= "}\n";
1397 $script_html .= <<END;
1402 my $county_html = $script_html;
1403 if ( $countyflag ) {
1404 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1405 foreach my $county (
1406 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1408 my $text = $county || '(n/a)';
1409 $county_html .= qq!<OPTION VALUE="$county"!.
1410 ($county eq $param->{'selected_county'} ?
1417 $county_html .= '</SELECT>';
1420 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1423 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1424 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1425 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1426 my $text = $state || '(n/a)';
1427 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1428 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
1430 $state_html .= '</SELECT>';
1432 my $country_html = '';
1433 if ( scalar( keys %cust_main_county ) > 1 ) {
1435 $country_html = qq(<SELECT NAME="${prefix}country" ).
1436 qq(onChange="${prefix}country_changed(this); ).
1437 $param->{'onchange'}.
1440 my $countrydefault = $param->{default_country} || 'US';
1441 foreach my $country (
1442 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1443 keys %cust_main_county
1445 my $selected = $country eq $param->{'selected_country'}
1448 $country_html .= "\n<OPTION$selected>$country</OPTION>"
1450 $country_html .= '</SELECT>';
1453 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1454 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1458 ($county_html, $state_html, $country_html);
1462 sub regionselector_hashref {
1463 my ($county_html, $state_html, $country_html) = regionselector(@_);
1465 'county_html' => $county_html,
1466 'state_html' => $state_html,
1467 'country_html' => $country_html,
1471 =item location_form HASHREF | LIST
1473 Takes as input a hashref or list of key/value pairs with the following keys:
1479 Current customer session_id
1483 Omit red asterisks from required fields.
1485 =item address1_label
1487 Label for first address line.
1491 Returns an HTML fragment for a location form (address, city, state, zip,
1504 my $session_id = delete $param->{'session_id'};
1506 my $rv = mason_comp( 'session_id' => $session_id,
1507 'comp' => '/elements/location.html',
1508 'args' => [ %$param ],
1512 $rv->{'error'} || $rv->{'output'};
1517 #=item expselect HASHREF | LIST
1519 #Takes as input a hashref or list of key/value pairs with the following keys:
1523 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1525 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1529 =item expselect PREFIX [ DATE ]
1531 Takes as input a unique prefix string and the current expiration date, in
1532 yyyy-mm-dd or m-d-yyyy format
1534 Returns an HTML fragments for expiration date selection.
1540 #if ( ref($_[0]) ) {
1544 #my $prefix = $param->{'prefix'};
1545 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1546 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1548 my $date = scalar(@_) ? shift : '';
1550 my( $m, $y ) = ( 0, 0 );
1551 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1552 ( $m, $y ) = ( $2, $1 );
1553 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1554 ( $m, $y ) = ( $1, $3 );
1556 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1558 $return .= qq!<OPTION VALUE="$_"!;
1559 $return .= " SELECTED" if $_ == $m;
1562 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1564 my $thisYear = $t[5] + 1900;
1565 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1566 $return .= qq!<OPTION VALUE="$_"!;
1567 $return .= " SELECTED" if $_ == $y;
1570 $return .= "</SELECT>";
1575 =item popselector HASHREF | LIST
1577 Takes as input a hashref or list of key/value pairs with the following keys:
1583 Access number number
1587 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>.
1591 Returns an HTML fragment for access number selection.
1595 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1603 my $popnum = $param->{'popnum'};
1604 my $pops = $param->{'pops'};
1606 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1607 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1608 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1609 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1610 if scalar(@$pops) == 1;
1613 my %popnum2pop = ();
1615 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1616 $popnum2pop{$_->{popnum}} = $_;
1621 function opt(what,href,text) {
1622 var optionName = new Option(text, href, false, false)
1623 var length = what.length;
1624 what.options[length] = optionName;
1628 my $init_popstate = $param->{'init_popstate'};
1629 if ( $init_popstate ) {
1630 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
1631 $init_popstate. '">';
1634 function acstate_changed(what) {
1635 state = what.options[what.selectedIndex].text;
1636 what.form.popac.options.length = 0
1637 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
1641 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
1642 foreach my $state ( sort { $a cmp $b } @states ) {
1643 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
1645 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
1646 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
1647 if ($ac eq $param->{'popac'}) {
1648 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
1651 $text .= "}\n" unless $init_popstate;
1653 $text .= "popac_changed(what.form.popac)}\n";
1656 function popac_changed(what) {
1657 ac = what.options[what.selectedIndex].text;
1658 what.form.popnum.options.length = 0;
1659 what.form.popnum.options[0] = new Option("City", "-1", false, true);
1663 foreach my $state ( @states ) {
1664 foreach my $popac ( keys %{ $pop{$state} } ) {
1665 $text .= "\nif ( ac == \"$popac\" ) {\n";
1667 foreach my $pop ( @{$pop{$state}->{$popac}}) {
1668 my $o_popnum = $pop->{popnum};
1669 my $poptext = $pop->{city}. ', '. $pop->{state}.
1670 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1672 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
1673 if ($popnum == $o_popnum) {
1674 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
1682 $text .= "}\n</SCRIPT>\n";
1684 $param->{'acstate'} = '' unless defined($param->{'acstate'});
1687 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
1688 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
1689 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
1690 ">$_" foreach sort { $a cmp $b } @states;
1691 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
1694 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
1695 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
1697 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
1700 #comment this block to disable initial list polulation
1701 my @initial_select = ();
1702 if ( scalar( @$pops ) > 100 ) {
1703 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
1705 @initial_select = @$pops;
1707 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
1708 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
1709 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
1710 $pop->{city}. ', '. $pop->{state}.
1711 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
1714 $text .= qq!</SELECT></TD></TR></TABLE>!;
1720 =item domainselector HASHREF | LIST
1722 Takes as input a hashref or list of key/value pairs with the following keys:
1732 Service number of the selected item.
1736 Returns an HTML fragment for domain selection.
1740 sub domainselector {
1747 my $domsvc= $param->{'domsvc'};
1749 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
1750 my $domains = $rv->{'domains'};
1751 $domsvc = $rv->{'domsvc'} unless $domsvc;
1753 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
1754 unless scalar(keys %$domains);
1756 if (scalar(keys %$domains) == 1) {
1758 foreach(keys %$domains) {
1761 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
1762 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
1765 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em"><OPTION>(Choose Domain)!;
1768 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
1769 $text .= qq!<OPTION VALUE="!. $domain. '"'.
1770 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
1771 $domains->{$domain};
1774 $text .= qq!</SELECT></TD></TR>!;
1780 =item didselector HASHREF | LIST
1782 Takes as input a hashref or list of key/value pairs with the following keys:
1788 Field name for the returned HTML fragment.
1792 Service definition (see L<FS::part_svc>)
1796 Returns an HTML fragment for DID selection.
1808 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
1809 'args'=>[ %$param ],
1813 $rv->{'error'} || $rv->{'output'};
1819 =head1 RESELLER FUNCTIONS
1821 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
1822 with their active session, and the B<customer_info> and B<order_pkg> functions
1823 with their active session and an additional I<custnum> parameter.
1825 For the most part, development of the reseller web interface has been
1826 superceded by agent-virtualized access to the backend.
1838 =item agent_list_customers
1840 List agent's customers.
1848 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>