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);
16 @ISA = qw( Exporter );
20 $dir = "/usr/local/freeside";
21 $socket = "$dir/selfservice_socket";
22 $socket .= '.'.$tag if defined $tag && length($tag);
24 #maybe should ask ClientAPI for this list
26 'passwd' => 'passwd/passwd',
27 'chfn' => 'passwd/passwd',
28 'chsh' => 'passwd/passwd',
29 'login_info' => 'MyAccount/login_info',
30 'login_banner_image' => 'MyAccount/login_banner_image',
31 'login' => 'MyAccount/login',
32 'logout' => 'MyAccount/logout',
33 'switch_acct' => 'MyAccount/switch_acct',
34 'switch_cust' => 'MyAccount/switch_cust',
35 'customer_info' => 'MyAccount/customer_info',
36 'customer_info_short' => 'MyAccount/customer_info_short',
37 'customer_recurring' => 'MyAccount/customer_recurring',
39 'contact_passwd' => 'MyAccount/contact/contact_passwd',
40 'list_contacts' => 'MyAccount/contact/list_contacts',
41 'edit_contact' => 'MyAccount/contact/edit_contact',
42 'delete_contact' => 'MyAccount/contact/delete_contact',
43 'new_contact' => 'MyAccount/contact/new_contact',
45 'billing_history' => 'MyAccount/billing_history',
46 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
47 'invoice' => 'MyAccount/invoice',
48 'invoice_pdf' => 'MyAccount/invoice_pdf',
49 'legacy_invoice' => 'MyAccount/legacy_invoice',
50 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
51 'invoice_logo' => 'MyAccount/invoice_logo',
52 'list_invoices' => 'MyAccount/list_invoices', #?
53 'list_payments' => 'MyAccount/list_payments',
54 'payment_receipt' => 'MyAccount/payment_receipt',
55 'list_payby' => 'MyAccount/list_payby',
56 'insert_payby' => 'MyAccount/insert_payby',
57 'update_payby' => 'MyAccount/update_payby',
58 'delete_payby' => 'MyAccount/delete_payby',
59 'cancel' => 'MyAccount/cancel', #add to ss cgi!
60 'payment_info' => 'MyAccount/payment_info',
61 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
62 'process_payment' => 'MyAccount/process_payment',
63 'store_payment' => 'MyAccount/store_payment',
64 'process_stored_payment' => 'MyAccount/process_stored_payment',
65 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
66 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
67 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
68 'process_prepay' => 'MyAccount/process_prepay',
69 'realtime_collect' => 'MyAccount/realtime_collect',
70 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
71 'pkg_info' => 'MyAccount/pkg_info',
72 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
73 'list_svc_usage' => 'MyAccount/list_svc_usage',
74 'svc_status_html' => 'MyAccount/svc_status_html',
75 'svc_status_hash' => 'MyAccount/svc_status_hash',
76 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
77 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
78 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
79 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
80 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
81 'acct_forward_info' => 'MyAccount/acct_forward_info',
82 'process_acct_forward' => 'MyAccount/process_acct_forward',
83 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
84 'add_dsl_device' => 'MyAccount/add_dsl_device',
85 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
86 'port_graph' => 'MyAccount/port_graph',
87 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
88 'list_support_usage' => 'MyAccount/list_support_usage',
89 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
90 'change_pkg' => 'MyAccount/change_pkg',
91 'order_recharge' => 'MyAccount/order_recharge',
92 'renew_info' => 'MyAccount/renew_info',
93 'order_renew' => 'MyAccount/order_renew',
94 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
95 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
96 'charge' => 'MyAccount/charge', #?
97 'part_svc_info' => 'MyAccount/part_svc_info',
98 'provision_acct' => 'MyAccount/provision_acct',
99 'provision_phone' => 'MyAccount/provision_phone',
100 'provision_pbx' => 'MyAccount/provision_pbx',
101 'provision_external' => 'MyAccount/provision_external',
102 'provision_forward' => 'MyAccount/provision_forward',
103 'unprovision_svc' => 'MyAccount/unprovision_svc',
104 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
105 'reset_passwd' => 'MyAccount/reset_passwd',
106 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
107 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
108 'validate_passwd' => 'MyAccount/validate_passwd',
109 'list_tickets' => 'MyAccount/list_tickets',
110 'create_ticket' => 'MyAccount/create_ticket',
111 'get_ticket' => 'MyAccount/get_ticket',
112 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
113 'did_report' => 'MyAccount/did_report',
114 'signup_info' => 'Signup/signup_info',
115 'skin_info' => 'MyAccount/skin_info',
116 'access_info' => 'MyAccount/access_info',
117 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
118 'new_customer' => 'Signup/new_customer',
119 'new_customer_minimal' => 'Signup/new_customer_minimal',
120 'capture_payment' => 'Signup/capture_payment',
121 'new_prospect' => 'Signup/new_prospect',
122 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
123 'new_agent' => 'Agent/new_agent',
124 'agent_login' => 'Agent/agent_login',
125 'agent_logout' => 'Agent/agent_logout',
126 'agent_info' => 'Agent/agent_info',
127 'agent_list_customers' => 'Agent/agent_list_customers',
128 'check_username' => 'Agent/check_username',
129 'suspend_username' => 'Agent/suspend_username',
130 'unsuspend_username' => 'Agent/unsuspend_username',
131 'mason_comp' => 'MasonComponent/mason_comp',
132 'call_time' => 'PrepaidPhone/call_time',
133 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
134 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
136 'start_thirdparty' => 'MyAccount/start_thirdparty',
137 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
139 'list_quotations' => 'MyAccount/quotation/list_quotations',
140 'quotation_new' => 'MyAccount/quotation/quotation_new',
141 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
142 'quotation_info' => 'MyAccount/quotation/quotation_info',
143 'quotation_print' => 'MyAccount/quotation/quotation_print',
144 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
145 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
146 'quotation_order' => 'MyAccount/quotation/quotation_order',
148 'freesideinc_service' => 'Freeside/freesideinc_service',
153 qw( regionselector regionselector_hashref location_form
154 expselect popselector domainselector didselector
158 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
159 $ENV{'SHELL'} = '/bin/sh';
160 $ENV{'IFS'} = " \t\n";
163 $ENV{'BASH_ENV'} = '';
165 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
166 #if you grant appropriate permissions to whatever user
167 my $freeside_uid = scalar(getpwnam('freeside'));
168 die "not running as the freeside user\n"
169 if $> != $freeside_uid && ! $skip_uid_check;
171 -e $dir or die "FATAL: $dir doesn't exist!";
172 -d $dir or die "FATAL: $dir isn't a directory!";
173 -r $dir or die "FATAL: Can't read $dir as freeside user!";
174 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
176 foreach my $autoload ( keys %autoload ) {
179 "sub $autoload { ". '
184 #warn scalar(@_). ": ". join(" / ", @_);
188 $param->{_packet} = \''. $autoload{$autoload}. '\';
190 simple_packet($param);
200 warn "sending ". $packet->{_packet}. " to server"
203 # Retry socket operation 5 times per second
204 # until successful or $max_retry
206 my $sock_timeout = 5;
207 my $enable_sock_timeout = 0;
209 for my $try ( 1..$max_retry ) {
215 local $SIG{ALRM} = sub{die "socket $socket: timeout ${sock_timeout}s"};
217 if $enable_sock_timeout;
219 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
220 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
221 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
224 # 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
225 # block until there is a message on socket
226 # my $w = new IO::Select;
228 # my @wait = $w->can_read;
230 warn "reading message from server"
233 $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
234 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
236 warn "returning message to client"
245 die "(Attempt $try) $@"
246 if $try == $max_retry;
248 warn "(Attempt $try) $@"
251 Time::HiRes::sleep(0.2);
257 FS::SelfService - Freeside self-service API
261 # password and shell account changes
262 use FS::SelfService qw(passwd chfn chsh);
264 # "my account" functionality
265 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
267 #new-style login with an email address and password
268 # can also be used for svc_acct login, set $emailaddress to username@domain
269 my $rv = login ( { 'email' => $emailaddress,
270 'password' => $password,
273 if ( $rv->{'error'} ) {
274 #handle login error...
277 $session_id = $rv->{'session_id'};
280 #classic svc_acct-based login with separate username and password
281 my $rv = login( { 'username' => $username,
283 'password' => $password,
286 if ( $rv->{'error'} ) {
287 #handle login error...
290 $session_id = $rv->{'session_id'};
293 #svc_phone login with phone number and PIN
294 my $rv = login( { 'username' => $phone_number,
295 'domain' => 'svc_phone',
299 if ( $rv->{'error'} ) {
300 #handle login error...
303 $session_id = $rv->{'session_id'};
306 my $customer_info = customer_info( { 'session_id' => $session_id } );
308 my $payment_info = payment_info( { 'session_id' => $session_id } );
310 #!!! process_payment example
312 #!!! list_pkgs example
314 #ordering a package with an svc_acct service
315 my $rv = order_pkg( { 'session_id' => $session_id,
316 'pkgpart' => $pkgpart,
317 'svcpart' => $svcpart,
318 'username' => $username,
319 'domsvc' => $domsvc, #svcnum of svc_domain
320 '_password' => $password,
324 #!!! ordering a package with an svc_domain service example
326 #!!! ordering a package with an svc_phone service example
328 #!!! ordering a package with an svc_external service example
330 #!!! ordering a package with an svc_pbx service
332 #ordering a package with no service
333 my $rv = order_pkg( { 'session_id' => $session_id,
334 'pkgpart' => $pkgpart,
339 #quoting a package, then ordering after confirmation
341 my $rv = quotation_new({ 'session_id' => $session_id });
342 my $qnum = $rv->{quotationnum};
343 # add packages to the quotation
344 $rv = quotation_add_pkg({ 'session_id' => $session_id,
345 'quotationnum' => $qnum,
346 'pkgpart' => $pkgpart,
347 'quantity' => $quantity, # defaults to 1
349 # repeat until all packages are added
350 # view the pricing information
351 $rv = quotation_info({ 'session_id' => $session_id,
352 'quotationnum' => $qnum,
354 print "Total setup charges: ".$rv->{total_setup}."\n".
355 "Total recurring charges: ".$rv->{total_recur}."\n";
356 # quotation_info also provides a detailed breakdown of charges, in
359 # ask customer for confirmation, then:
360 $rv = quotation_order({ 'session_id' => $session_id,
361 'quotationnum' => $qnum,
364 #!!! cancel_pkg example
366 # signup functionality
367 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
369 my $signup_info = signup_info;
371 $rv = new_customer( {
374 'company' => $company,
375 'address1' => $address1,
376 'address2' => $address2,
380 'country' => $country,
381 'daytime' => $daytime,
385 'payinfo' => $payinfo,
387 'paystart_month' => $paystart_month
388 'paystart_year' => $paystart_year,
389 'payissue' => $payissue,
391 'paydate' => $paydate,
392 'payname' => $payname,
393 'invoicing_list' => $invoicing_list,
394 'referral_custnum' => $referral_custnum,
395 'agentnum' => $agentnum,
396 'pkgpart' => $pkgpart,
398 'username' => $username,
399 '_password' => $password,
403 'phonenum' => $phonenum,
408 my $error = $rv->{'error'};
409 if ( $error eq '_decline' ) {
419 Use this API to implement your own client "self-service" module.
421 If you just want to customize the look of the existing "self-service" module,
424 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
430 Changes the password for an existing user in svc_acct. Takes a hash
431 reference with the following keys:
437 Username of the account (required)
441 Domain of the account (required)
445 Old password (required)
449 New password (required)
467 =head1 "MY ACCOUNT" FUNCTIONS
473 Creates a user session. Takes a hash reference as parameter with the
480 Email address (username@domain), instead of username and domain. Required for
481 contact-based self-service login, can also be used for svc_acct-based login.
497 Returns a hash reference with the following keys:
503 Empty on success, or an error message on errors.
507 Session identifier for successful logins
511 =item customer_info HASHREF
513 Returns general customer information.
515 Takes a hash reference as parameter with a single key: B<session_id>
517 Returns a hash reference with the following keys:
531 Array reference of hash references of open inoices. Each hash reference has
532 the following keys: invnum, date, owed
536 An HTML fragment containing shipping and billing addresses.
538 =item The following fields are also returned
540 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
544 =item customer_recurring HASHREF
546 Takes a hash reference as parameter with a single key B<session_id>
547 or keys B<agent_session_id> and B<custnum>.
549 Returns a hash reference with the keys error, custnum and display_recurring.
551 display_recurring is an arrayref of hashrefs with the following keys:
557 frequency of charge, in months unless units are specified
561 frequency of charge, suitable for display
565 amount charged at this frequency
569 =item edit_info HASHREF
571 Takes a hash reference as parameter with any of the following keys:
573 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
575 If a field exists, the customer record is updated with the new value of that
576 field. If a field does not exist, that field is not changed on the customer
579 Returns a hash reference with a single key, B<error>, empty on success, or an
580 error message on errors
582 =item invoice HASHREF
584 Returns an invoice. Takes a hash reference as parameter with two keys:
585 session_id and invnum
587 Returns a hash reference with the following keys:
593 Empty on success, or an error message on errors
605 =item list_invoices HASHREF
607 Returns a list of all customer invoices. Takes a hash reference with a single
610 Returns a hash reference with the following keys:
616 Empty on success, or an error message on errors
620 Reference to array of hash references with the following keys:
630 Invoice date, in UNIX epoch time
636 =item list_payments HASHREF
638 Returns a list of all customer payments. Takes a hash reference with a single
641 Returns a hash reference with the following keys:
647 Empty on success, or an error message on errors
651 Reference to array of hash references with the following keys:
661 Payument date, in UNIX epoch time
665 Payment date, in a human-readable format
669 Payment date, in a shorter human-readable format
677 Payment method: CARD, CHEK (electronic check), or BILL (physical check).
689 Processor for cards and electronic checks
703 =item list_payby HASHREF
705 Returns a list of all stored customer payment information (credit cards and
706 electronic check accounts). Takes a hash reference with a single key,
709 Returns a hash reference with the following keys:
715 Empty on success, or an error message on errors
719 Reference to array of hash references with the following keys:
727 Numeric weighting. Stored payment information with a lower weight is attempted
732 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
733 (on-demand credit card) or DCHK (on-demand electronic check).
737 Masked credit card number (or, masked account and routing numbers)
741 Credit card expiration date
745 Exact name on card (or bank name, for electronic checks)
749 For electronic checks, bank state
753 For electronic checks, account type (Personal/Business, Checking/Savings)
759 =item insert_payby HASHREF
761 Adds new stored payment information for this customer. Takes a hash reference
762 with the following keys:
770 Numeric weighting. Stored payment information with a lower weight is attempted
775 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
776 (on-demand credit card) or DCHK (on-demand electronic check).
780 Credit card number (or electronic check "account@routing")
784 CVV2 number / security code
788 Credit card expiration date
792 Exact name on card (or bank name, for electronic checks)
796 For electronic checks, bank state
800 For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A
804 Optional IP address from which payment was submitted
808 If there is an error, returns a hash reference with a single key, B<error>,
809 otherwise returns a hash reference with a single key, B<custpaybynum>.
811 =item update_payby HASHREF
813 Updates stored payment information. Takes a hash reference with the same
814 keys as insert_payby, as well as B<custpaybynum> to specify which record
815 to update. All keys except B<session_id> and B<custpaybynum> are optional;
816 if omitted, the previous values in the record will be preserved.
818 If there is an error, returns a hash reference with a single key, B<error>,
819 otherwise returns a hash reference with a single key, B<custpaybynum>.
821 =item delete_payby HASHREF
823 Removes stored payment information. Takes a hash reference with two keys,
824 B<session_id> and B<custpaybynum>. Returns a hash reference with a single key,
825 B<error>, which is an error message or empty for successful removal.
829 Cancels this customer.
831 Takes a hash reference as parameter with a single key: B<session_id>
833 Returns a hash reference with a single key, B<error>, which is empty on
834 success or an error message on errors.
836 =item payment_info HASHREF
838 Returns information that may be useful in displaying a payment page.
840 Takes a hash reference as parameter with the following keys:
850 =item omit_cust_main_county
852 Optional, pass a true value to omit cust_main_county data for performance.
856 Returns a hash reference with the following keys:
862 Empty on success, or an error message on errors
870 Exact name on credit card (CARD/DCRD)
894 Customer's current default payment type.
898 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
902 For CARD/DCRD payment types, the card number
906 For CARD/DCRD payment types, expiration month
910 For CARD/DCRD payment types, expiration year
912 =item cust_main_county
914 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.
918 Array reference of all states in the current default country.
922 Hash reference of card types; keys are card types, values are the exact strings
923 passed to the process_payment function
927 #this doesn't actually work yet
931 #Unique transaction identifier (prevents multiple charges), passed to the
932 #process_payment function
936 =item process_payment HASHREF
938 Processes a payment and possible change of address or payment type. Takes a
939 hash reference as parameter with the following keys:
953 If true, address and card information entered will be saved for subsequent
958 If true, future credit card payments will be done automatically (sets payby to
959 CARD). If false, future credit card payments will be done on-demand (sets
960 payby to DCRD). This option only has meaning if B<save> is set true.
988 Two-letter country code
996 Card expiration month
1000 Card expiration year
1004 #this doesn't actually work yet
1008 #Unique transaction identifier, returned from the payment_info function.
1009 #Prevents multiple charges.
1013 Returns a hash reference with a single key, B<error>, empty on success, or an
1014 error message on errors.
1016 =item process_payment_order_pkg
1018 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
1019 payment processes sucessfully, the package is ordered. Takes a hash reference
1020 as parameter with the keys of both methods.
1022 Returns a hash reference with a single key, B<error>, empty on success, or an
1023 error message on errors.
1025 =item process_payment_change_pkg
1027 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
1028 payment processes sucessfully, the package is ordered. Takes a hash reference
1029 as parameter with the keys of both methods.
1031 Returns a hash reference with a single key, B<error>, empty on success, or an
1032 error message on errors.
1035 =item process_payment_order_renew
1037 Combines the B<process_payment> and B<order_renew> functions in one step. If
1038 the payment processes sucessfully, the renewal is processed. Takes a hash
1039 reference as parameter with the keys of both methods.
1041 Returns a hash reference with a single key, B<error>, empty on success, or an
1042 error message on errors.
1046 Returns package information for this customer. For more detail on services,
1049 Takes a hash reference as parameter with a single key: B<session_id>
1051 Returns a hash reference containing customer package information. The hash reference contains the following keys:
1061 Empty on success, or an error message on errors.
1063 =item cust_pkg HASHREF
1065 Array reference of hash references, each of which has the fields of a cust_pkg
1066 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
1067 the internal FS:: objects, but hash references of columns and values.
1071 =item part_pkg fields
1073 All fields of part_pkg for this specific cust_pkg (be careful with this
1074 information - it may reveal more about your available packages than you would
1075 like users to know in aggregate)
1079 #XXX pare part_pkg fields down to a more secure subset
1083 An array of hash references indicating information on unprovisioned services
1084 available for provisioning for this specific cust_pkg. Each has the following
1089 =item part_svc fields
1091 All fields of part_svc (be careful with this information - it may reveal more
1092 about your available packages than you would like users to know in aggregate)
1096 #XXX pare part_svc fields down to a more secure subset
1102 An array of hash references indicating information on the customer services
1103 already provisioned for this specific cust_pkg. Each has the following keys:
1109 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.
1115 Primary key for this service
1119 Service definition (see L<FS::part_svc>)
1123 Customer package (see L<FS::cust_pkg>)
1127 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
1135 Returns package information for package.
1137 Takes a hash reference as parameter with the following keys:
1151 Returns a hash reference containing customer package information. The hash reference contains the following keys:
1157 Name of this package
1161 Part package primary key
1165 Package class number
1169 error message if errror.
1175 Returns service information for this customer.
1177 Takes a hash reference as parameter with a single key: B<session_id>
1179 Returns a hash reference containing customer package information. The hash reference contains the following keys:
1189 An array of hash references indicating information on all of this customer's
1190 services. Each has the following keys:
1196 Primary key for this service
1200 Name of this service
1204 Meaningful user-specific identifier for the service (i.e. username, domain, or
1209 Account (svc_acct) services also have the following keys:
1227 Upload bytes remaining
1231 Download bytes remaining
1235 Total bytes remaining
1237 =item recharge_amount
1241 =item recharge_seconds
1243 Number of seconds gained by recharge
1245 =item recharge_upbytes
1247 Number of upload bytes gained by recharge
1249 =item recharge_downbytes
1251 Number of download bytes gained by recharge
1253 =item recharge_totalbytes
1255 Number of total bytes gained by recharge
1263 Orders a package for this customer.
1265 If signup_server-realtime is set, bills the new package, attemps to collect
1266 payment and (for auto-payment customers) cancels the package if the payment is
1269 Takes a hash reference as parameter with the following keys:
1279 Package to order (see L<FS::part_pkg>).
1283 Quantity for this package order (default 1).
1285 =item run_bill_events
1287 If true, runs billing events for the customer after ordering and billing the
1288 package (signup_server-realtime must be set).
1292 Optional locationnum for this package order, for existing locations.
1294 Or, for new locations, pass the following fields: address1*, address2, city*,
1295 county, state*, zip*, country. (* = required in this case)
1297 (None of this is required at all if you are just ordering a package
1298 at the customer's existing default service location.)
1316 Service to order (see L<FS::part_svc>).
1318 Normally optional; required only to provision a non-svc_acct service, or if the
1319 package definition does not contain one svc_acct service definition with
1320 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1321 also be specified to indicate that no initial service should be provisioned.
1325 Fields used when provisioning an svc_acct service:
1339 Optional security phrase
1343 Optional Access number number
1347 Fields used when provisioning an svc_domain service:
1357 Fields used when provisioning an svc_phone service:
1375 Fields used when provisioning an svc_external service:
1381 External numeric ID.
1385 External text title.
1389 Fields used when provisioning an svc_pbx service:
1403 Returns a hash reference with a single key, B<error>, empty on success, or an
1404 error message on errors. The special error '_decline' is returned for
1405 declined transactions.
1409 Changes a package for this customer.
1411 Takes a hash reference as parameter with the following keys:
1421 Existing customer package.
1425 New package to order (see L<FS::part_pkg>).
1429 Quantity for this package order (default 1).
1433 Returns a hash reference with the following keys:
1439 Empty on success, or an error message on errors.
1443 On success, the new pkgnum
1450 Provides useful info for early renewals.
1452 Takes a hash reference as parameter with the following keys:
1462 Returns a hash reference. On errors, it contains a single key, B<error>, with
1463 the error message. Otherwise, contains a single key, B<dates>, pointing to
1464 an array refernce of hash references. Each hash reference contains the
1471 (Future) Bill date. Indicates a future date for which billing could be run.
1472 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1475 =item bill_date_pretty
1477 (Future) Bill date as a human-readable string. (Convenience for display;
1478 subject to change, so best not to parse for the date.)
1482 Base amount which will be charged if renewed early as of this date.
1486 Renewal date; i.e. even-futher future date at which the customer will be paid
1487 through if the early renewal is completed with the given B<bill-date>.
1488 Specified as an integer UNIX timestamp.
1490 =item renew_date_pretty
1492 Renewal date as a human-readable string. (Convenience for display;
1493 subject to change, so best not to parse for the date.)
1497 Package that will be renewed.
1501 Expiration date of the package that will be renewed.
1503 =item expire_date_pretty
1505 Expiration date of the package that will be renewed, as a human-readable
1506 string. (Convenience for display; subject to change, so best not to parse for
1513 Renews this customer early; i.e. runs billing for this customer in advance.
1515 Takes a hash reference as parameter with the following keys:
1525 Integer date as returned by the B<renew_info> function, indicating the advance
1526 date for which to run billing.
1530 Returns a hash reference with a single key, B<error>, empty on success, or an
1531 error message on errors.
1535 Cancels a package for this customer.
1537 Takes a hash reference as parameter with the following keys:
1547 pkgpart of package to cancel
1551 Optional date, for future cancellation (expiration) instead of immediate
1552 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1556 Returns a hash reference with a single key, B<error>, empty on success, or an
1557 error message on errors.
1559 =item provision_acct
1561 Provisions an account (svc_acct).
1563 Takes a hash reference as parameter with the following keys:
1573 pkgnum of package into which this service is provisioned
1577 svcpart or service definition to provision
1587 =item provision_phone
1589 Provisions a phone number (svc_phone).
1591 Takes a hash reference as parameter with the following keys:
1601 pkgnum of package into which this service is provisioned
1605 svcpart or service definition to provision
1625 E911 Address (optional)
1631 Provisions a customer PBX (svc_pbx).
1633 Takes a hash reference as parameter with the following keys:
1643 pkgnum of package into which this service is provisioned
1647 svcpart or service definition to provision
1653 =item max_extensions
1655 =item max_simultaneous
1661 =item provision_external
1663 Provisions an external service (svc_external).
1665 Takes a hash reference as parameter with the following keys:
1675 pkgnum of package into which this service is provisioned
1679 svcpart or service definition to provision
1689 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1693 =item contact_passwd
1695 Changes the password for the currently-logged in contact.
1697 Takes a hash reference as parameter with the following keys:
1707 Returns a hash reference with a single parameter, B<error>, which contains an
1708 error message, or empty on success.
1712 Takes a hash reference as parameter with a single key, B<session_id>.
1714 Returns a hash reference with two parameters: B<error>, which contains an error
1715 message, or empty on success, and B<contacts>, a list of contacts.
1717 B<contacts> is an array reference of hash references (i.e. an array of structs,
1718 in XML-RPC). Each hash reference (struct) has the following keys:
1726 Contact class name (contact type).
1738 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1742 Comma-separated list of email addresses
1746 =item selfservice_access
1754 Updates information for the currently-logged in contact, or (optionally) the
1757 Takes a hash reference as parameter with the following keys:
1765 If already logged in as a contact, this is optional.
1775 Returns a hash reference with a single parameter, B<error>, which contains an
1776 error message, or empty on success.
1780 Creates a new contact.
1782 Takes a hash reference as parameter with the following keys:
1796 Optional contact classnum (TODO: or name)
1800 =item selfservice_access
1802 Y to enable self-service access
1808 Returns a hash reference with a single parameter, B<error>, which contains an
1809 error message, or empty on success.
1811 =item delete_contact
1813 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1816 Takes a hash reference as parameter with the following keys:
1826 Returns a hash reference with a single parameter, B<error>, which contains an
1827 error message, or empty on success.
1831 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1833 All of these functions require the user to be logged in, and the 'session_id'
1834 key to be included in the argument hashref.`
1838 =item list_quotations HASHREF
1840 Returns a hashref listing this customer's active self-service quotations.
1847 an arrayref containing an element for each quotation.
1855 the date it was started
1859 the number of packages
1863 the sum of setup fees
1867 the sum of recurring charges
1871 =item quotation_new HASHREF
1873 Creates an empty quotation and returns a hashref containing 'quotationnum',
1874 the primary key of the new quotation.
1876 =item quotation_delete HASHREF
1878 Disables (does not really delete) a quotation. Takes the following arguments:
1884 =item quotationnum - the quotation to delete
1888 Returns 'error' => a string, which will be empty on success.
1890 =item quotation_info HASHREF
1892 Returns total and detailed pricing information on a quotation.
1894 Takes the following arguments:
1900 =item quotationnum - the quotation to return
1904 Returns a hashref containing:
1906 - total_setup, the total of setup fees (and their taxes)
1907 - total_recur, the total of all recurring charges (and their taxes)
1908 - sections, an arrayref containing an element for each quotation section.
1909 - description, a line of text describing the group of charges
1910 - subtotal, the total of charges in this group (if appropriate)
1911 - detail_items, an arrayref of line items
1912 - pkgnum, the reference number of the package
1913 - description, the package name (or tax name)
1915 - amount, the amount charged
1916 If the detail item represents a subtotal, it will instead contain:
1917 - total_item: description of the subtotal
1918 - total_amount: the subtotal amount
1921 =item quotation_print HASHREF
1923 Renders the quotation as HTML or PDF. Takes the following arguments:
1929 =item quotationnum - the quotation to return
1931 =item format - 'html' or 'pdf'
1935 Returns a hashref containing 'document', the contents of the file.
1937 =item quotation_add_pkg HASHREF
1939 Adds a package to a quotation. Takes the following arguments:
1945 =item pkgpart - the package to add
1947 =item quotationnum - the quotation to add it to
1949 =item quantity - the package quantity (defaults to 1)
1951 =item address1, address2, city, state, zip, country - address fields to set
1952 the service location
1956 Returns 'error' => a string, which will be empty on success.
1958 =item quotation_remove_pkg HASHREF
1960 Removes a package from a quotation. Takes the following arguments:
1966 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1968 =item quotationnum - the quotation to remove it from
1972 Returns 'error' => a string, which will be empty on success.
1974 =item quotation_order HASHREF
1976 Converts the packages in a quotation into real packages. Takes the following
1979 Takes the following arguments:
1985 =item quotationnum - the quotation to order
1991 =head1 SIGNUP FUNCTIONS
1995 =item signup_info HASHREF
1997 Takes a hash reference as parameter with the following keys:
2001 =item session_id - Optional agent/reseller interface session
2005 Returns a hash reference containing information that may be useful in
2006 displaying a signup page. The hash reference contains the following keys:
2010 =item cust_main_county
2012 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.
2016 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
2017 an agentnum specified explicitly via reseller interface session_id in the
2022 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.
2024 =item agentnum2part_pkg
2026 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.
2030 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.
2032 =item security_phrase
2034 True if the "security_phrase" feature is enabled
2038 Array reference of acceptable payment types for signup
2044 credit card - automatic
2048 credit card - on-demand - version 1.5+ only
2052 electronic check - automatic
2056 electronic check - on-demand - version 1.5+ only
2064 billing, not recommended for signups
2068 free, definitely not recommended for signups
2072 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
2078 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
2082 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".
2088 =item countrydefault
2094 =item new_customer_minimal HASHREF
2096 Creates a new customer.
2098 Current differences from new_customer: An address is not required. promo_code
2099 and reg_code are not supported. If invoicing_list and _password is passed, a
2100 contact will be created with self-service access (no pkgpart or username is
2101 necessary). No initial billing is run (this may change in a future version).
2103 Takes a hash reference as parameter with the following keys:
2109 first name (required)
2113 last name (required)
2117 (not typically collected; mostly used for ACH transactions)
2149 Daytime phone number
2153 Evening phone number
2161 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2165 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2169 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2173 Expiration date for CARD/DCRD
2177 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2179 =item invoicing_list
2181 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),
2183 =item referral_custnum
2185 referring customer number
2193 pkgpart of initial package
2209 Access number (index, not the literal number)
2213 Country code (to be provisioned as a service)
2217 Phone number (to be provisioned as a service)
2225 Returns a hash reference with the following keys:
2231 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)
2235 =item new_customer HASHREF
2237 Creates a new customer. Takes a hash reference as parameter with the
2244 first name (required)
2248 last name (required)
2252 (not typically collected; mostly used for ACH transactions)
2258 =item address1 (required)
2266 =item city (required)
2274 =item state (required)
2278 =item zip (required)
2294 Optional shipping address fields. If sending an optional shipping address,
2295 ship_address1, ship_city, ship_state and ship_zip are required.
2299 Daytime phone number
2303 Evening phone number
2311 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2315 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2319 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2323 Expiration date for CARD/DCRD
2327 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2329 =item invoicing_list
2331 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),
2333 =item referral_custnum
2335 referring customer number
2343 pkgpart of initial package
2359 Access number (index, not the literal number)
2363 Country code (to be provisioned as a service)
2367 Phone number (to be provisioned as a service)
2375 Returns a hash reference with the following keys:
2381 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)
2385 =item regionselector HASHREF | LIST
2387 Takes as input a hashref or list of key/value pairs with the following keys:
2391 =item selected_county
2393 Currently selected county
2395 =item selected_state
2397 Currently selected state
2399 =item selected_country
2401 Currently selected country
2405 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2409 Specify a javascript subroutine to call on changes
2415 =item default_country
2421 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>.
2425 Returns a list consisting of three HTML fragments for county selection,
2426 state selection and country selection, respectively.
2430 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2431 sub regionselector {
2438 $param->{'selected_country'} ||= $param->{'default_country'};
2439 $param->{'selected_state'} ||= $param->{'default_state'};
2441 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2443 my $disabled = $param->{'disabled'};
2445 my $countyflag = $param->{selected_county} ? 1 : 0;
2446 my $cityflag = $param->{selected_city} ? 1 : 0;
2448 my %cust_main_county;
2450 # unless ( @cust_main_county ) { #cache
2451 #@cust_main_county = qsearch('cust_main_county', {} );
2452 #foreach my $c ( @cust_main_county ) {
2453 foreach my $c ( @{ $param->{'locales'} } ) {
2454 #$countyflag=1 if $c->county;
2455 $countyflag=1 if $c->{county};
2456 $cityflag=1 if ($c->{city} && $cityflag);
2457 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2458 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2459 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}}{$c->{city}} = 1;
2463 my $script_html = <<END;
2465 function opt(what,value,text,selected) {
2466 var optionName = new Option(text, value, false, selected);
2467 var length = what.length;
2468 what.options[length] = optionName;
2470 function ${prefix}country_changed(what) {
2471 country = what.options[what.selectedIndex].text;
2472 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2473 what.form.${prefix}state.options[i] = null;
2475 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2477 foreach my $country ( sort keys %cust_main_county ) {
2478 $script_html .= "\nif ( country == \"$country\" ) {\n";
2479 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2480 my $text = $state || '(n/a)';
2481 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2483 $script_html .= "}\n";
2486 $script_html .= <<END;
2488 function ${prefix}state_changed(what) {
2491 if ( $countyflag ) {
2492 $script_html .= <<END;
2493 state = what.options[what.selectedIndex].text;
2494 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2495 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2496 what.form.${prefix}county.options[i] = null;
2499 foreach my $country ( sort keys %cust_main_county ) {
2500 $script_html .= "\nif ( country == \"$country\" ) {\n";
2501 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2502 $script_html .= "\nif ( state == \"$state\" ) {\n";
2503 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2504 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2505 my $text = $county || '(n/a)';
2508 $script_html .= qq!what.form.${prefix}city.style.display='';\n
2509 what.form.${prefix}city_select.style.display='none';\n!
2511 $script_html .= qq!opt(what.form.${prefix}county, "$county", "$text");\n!
2512 #$script_html .= qq!what.form.${prefix}county.style.display='none';\n!
2515 $script_html .= qq!var countySelected = false; if ("$param->{selected_county}" == "$text") { countySelected = true; }\n
2516 opt(what.form.${prefix}county, "$county", "$text", countySelected);\n
2517 what.form.${prefix}county.style.display='';\n
2518 county = what.form.${prefix}county.options[what.form.${prefix}county.selectedIndex].text;\n!;
2520 $script_html .= qq!\nif ( county == \"$county\" ) {\n!;
2521 foreach my $city ( sort keys %{$cust_main_county{$country}{$state}{$county}} ) {
2522 my $text = $city || '(n/a)';
2524 $script_html .= qq!what.form.${prefix}city.style.display='';\n
2525 what.form.${prefix}city_select.style.display='none';\n!
2528 $script_html .= qq!var citySelected = false; if ("$param->{selected_city}" == "$text") { citySelected = true; }\n
2529 opt(what.form.${prefix}city_select, "$city", "$text", citySelected);\n
2530 what.form.${prefix}city.style.display='none';\n
2531 what.form.${prefix}city_select.style.display='';\n!
2534 $script_html .= "}\n";
2538 $script_html .= "}\n";
2540 $script_html .= "}\n";
2544 $script_html .= <<END;
2546 function ${prefix}county_changed(what) {
2550 $script_html .= <<END;
2551 saved_city = "$param->{selected_city}";
2552 county = what.options[what.selectedIndex].text;
2553 state = what.form.${prefix}state.options[what.form.${prefix}state.selectedIndex].text;
2554 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2555 for ( var i = what.form.${prefix}city_select.length; i >= 0; i-- )
2556 what.form.${prefix}city_select.options[i] = null;
2559 foreach my $country ( sort keys %cust_main_county ) {
2560 $script_html .= "\nif ( country == \"$country\" ) {\n";
2561 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2562 $script_html .= "\nif ( state == \"$state\" ) {\n";
2563 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2564 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2565 $script_html .= "\nif ( county == \"$county\" ) {\n";
2566 foreach my $city ( sort keys %{$cust_main_county{$country}{$state}{$county}} ) {
2567 my $text = $city || '(n/a)';
2569 $script_html .= qq!what.form.${prefix}city.style.display='';\n
2570 what.form.${prefix}city_select.style.display='none';\n!
2573 $script_html .= qq!var citySelected = false; if (saved_city == "$text") { citySelected = true; }\n
2574 opt(what.form.${prefix}city_select, "$city", "$text", citySelected);\n
2575 what.form.${prefix}city.style.display='none';\n
2576 what.form.${prefix}city_select.style.display='';\n!
2579 $script_html .= "}\n";
2581 $script_html .= "}\n";
2583 $script_html .= "}\n";
2587 $script_html .= <<END;
2589 function ${prefix}city_select_changed(what) {
2593 $script_html .= <<END;
2594 what.form.${prefix}city.value = what.options[what.selectedIndex].value;
2598 $script_html .= <<END;
2605 if ( scalar (keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}}{$param->{'selected_county'}} }) > 1 ) {
2606 $city_html .= qq!<SELECT NAME="${prefix}city_select" onChange="${prefix}city_select_changed(this); $param->{'onchange'}">!;
2608 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}}{$param->{'selected_county'}} }
2610 my $text = $city || '(n/a)';
2611 $city_html .= qq!<OPTION VALUE="$city"!.
2612 ($city eq $param->{'selected_city'} ?
2618 $city_html .= qq!</OPTION><INPUT TYPE="text" ID="${prefix}city" NAME="${prefix}city" VALUE="$param->{'selected_city'}" style="display:none">!;
2620 $city_html .= qq!<SELECT NAME="${prefix}city_select" onChange="${prefix}city_select_changed(this); $param->{'onchange'}" style="display:none"></SELECT>
2621 <INPUT TYPE="text" ID="${prefix}city" NAME="${prefix}city" VALUE="$param->{'selected_city'}" style="display:''">!;
2625 my $county_html = $script_html;
2626 if ( $countyflag ) {
2627 $county_html .= qq!<SELECT NAME="${prefix}county" !.
2628 qq!onChange="${prefix}county_changed(this); $param->{'onchange'}">!;
2629 foreach my $county (
2630 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2632 my $text = $county || '(n/a)';
2633 $county_html .= qq!<OPTION VALUE="$county"!.
2634 ($county eq $param->{'selected_county'} ?
2641 $county_html .= '</SELECT>';
2644 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2647 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2648 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2649 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2650 my $text = $state || '(n/a)';
2651 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2652 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2654 $state_html .= '</SELECT>';
2656 my $country_html = '';
2657 if ( scalar( keys %cust_main_county ) > 1 ) {
2659 $country_html = qq(<SELECT NAME="${prefix}country" ).
2660 qq(onChange="${prefix}country_changed(this); ).
2661 $param->{'onchange'}.
2664 my $countrydefault = $param->{default_country} || 'US';
2665 foreach my $country (
2666 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2667 keys %cust_main_county
2669 my $selected = $country eq $param->{'selected_country'}
2672 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2674 $country_html .= '</SELECT>';
2677 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2678 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2682 ($county_html, $state_html, $country_html, $city_html);
2686 sub regionselector_hashref {
2687 my ($county_html, $state_html, $country_html) = regionselector(@_);
2689 'county_html' => $county_html,
2690 'state_html' => $state_html,
2691 'country_html' => $country_html,
2695 =item location_form HASHREF | LIST
2697 Takes as input a hashref or list of key/value pairs with the following keys:
2703 Current customer session_id
2707 Omit red asterisks from required fields.
2709 =item address1_label
2711 Label for first address line.
2715 Returns an HTML fragment for a location form (address, city, state, zip,
2728 my $session_id = delete $param->{'session_id'};
2730 my $rv = mason_comp( 'session_id' => $session_id,
2731 'comp' => '/elements/location.html',
2732 'args' => [ %$param ],
2736 $rv->{'error'} || $rv->{'output'};
2741 #=item expselect HASHREF | LIST
2743 #Takes as input a hashref or list of key/value pairs with the following keys:
2747 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2749 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2753 =item expselect PREFIX [ DATE ]
2755 Takes as input a unique prefix string and the current expiration date, in
2756 yyyy-mm-dd or m-d-yyyy format
2758 Returns an HTML fragments for expiration date selection.
2764 #if ( ref($_[0]) ) {
2768 #my $prefix = $param->{'prefix'};
2769 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2770 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2772 my $date = scalar(@_) ? shift : '';
2774 my( $m, $y ) = ( 0, 0 );
2775 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2776 ( $m, $y ) = ( $2, $1 );
2777 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2778 ( $m, $y ) = ( $1, $3 );
2780 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2782 $return .= qq!<OPTION VALUE="$_"!;
2783 $return .= " SELECTED" if $_ == $m;
2786 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2788 my $thisYear = $t[5] + 1900;
2789 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2790 $return .= qq!<OPTION VALUE="$_"!;
2791 $return .= " SELECTED" if $_ == $y;
2794 $return .= "</SELECT>";
2799 =item popselector HASHREF | LIST
2801 Takes as input a hashref or list of key/value pairs with the following keys:
2807 Access number number
2811 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>.
2815 Returns an HTML fragment for access number selection.
2819 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2827 my $popnum = $param->{'popnum'};
2828 my $pops = $param->{'pops'};
2830 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2831 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2832 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2833 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2834 if scalar(@$pops) == 1;
2837 my %popnum2pop = ();
2839 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2840 $popnum2pop{$_->{popnum}} = $_;
2845 function opt(what,href,text) {
2846 var optionName = new Option(text, href, false, false)
2847 var length = what.length;
2848 what.options[length] = optionName;
2852 my $init_popstate = $param->{'init_popstate'};
2853 if ( $init_popstate ) {
2854 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2855 $init_popstate. '">';
2858 function acstate_changed(what) {
2859 state = what.options[what.selectedIndex].text;
2860 what.form.popac.options.length = 0
2861 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2865 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2866 foreach my $state ( sort { $a cmp $b } @states ) {
2867 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2869 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2870 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2871 if ($ac eq $param->{'popac'}) {
2872 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2875 $text .= "}\n" unless $init_popstate;
2877 $text .= "popac_changed(what.form.popac)}\n";
2880 function popac_changed(what) {
2881 ac = what.options[what.selectedIndex].text;
2882 what.form.popnum.options.length = 0;
2883 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2887 foreach my $state ( @states ) {
2888 foreach my $popac ( keys %{ $pop{$state} } ) {
2889 $text .= "\nif ( ac == \"$popac\" ) {\n";
2891 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2892 my $o_popnum = $pop->{popnum};
2893 my $poptext = $pop->{city}. ', '. $pop->{state}.
2894 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2896 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2897 if ($popnum == $o_popnum) {
2898 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2906 $text .= "}\n</SCRIPT>\n";
2908 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2911 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2912 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2913 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2914 ">$_" foreach sort { $a cmp $b } @states;
2915 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2918 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2919 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2921 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2924 #comment this block to disable initial list polulation
2925 my @initial_select = ();
2926 if ( scalar( @$pops ) > 100 ) {
2927 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2929 @initial_select = @$pops;
2931 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2932 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2933 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2934 $pop->{city}. ', '. $pop->{state}.
2935 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2938 $text .= qq!</SELECT></TD></TR></TABLE>!;
2944 =item domainselector HASHREF | LIST
2946 Takes as input a hashref or list of key/value pairs with the following keys:
2956 Service number of the selected item.
2960 Returns an HTML fragment for domain selection.
2964 sub domainselector {
2971 my $domsvc= $param->{'domsvc'};
2973 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2974 my $domains = $rv->{'domains'};
2975 $domsvc = $rv->{'domsvc'} unless $domsvc;
2977 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2978 unless scalar(keys %$domains);
2980 if (scalar(keys %$domains) == 1) {
2982 foreach(keys %$domains) {
2985 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2986 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2989 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2991 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2993 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2994 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2995 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2996 $domains->{$domain};
2999 $text .= qq!</SELECT></TD></TR>!;
3005 =item didselector HASHREF | LIST
3007 Takes as input a hashref or list of key/value pairs with the following keys:
3013 Field name for the returned HTML fragment.
3017 Service definition (see L<FS::part_svc>)
3021 Returns an HTML fragment for DID selection.
3033 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
3034 'args'=>[ %$param ],
3038 $rv->{'error'} || $rv->{'output'};
3044 =head1 RESELLER FUNCTIONS
3046 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
3047 with their active session, and the B<customer_info> and B<order_pkg> functions
3048 with their active session and an additional I<custnum> parameter.
3050 For the most part, development of the reseller web interface has been
3051 superceded by agent-virtualized access to the backend.
3063 =item agent_list_customers
3065 List agent's customers.
3073 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>