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_banner_image' => 'MyAccount/login_banner_image',
30 'login' => 'MyAccount/login',
31 'logout' => 'MyAccount/logout',
32 'switch_acct' => 'MyAccount/switch_acct',
33 'switch_cust' => 'MyAccount/switch_cust',
34 'customer_info' => 'MyAccount/customer_info',
35 'customer_info_short' => 'MyAccount/customer_info_short',
36 'customer_recurring' => 'MyAccount/customer_recurring',
38 'contact_passwd' => 'MyAccount/contact/contact_passwd',
39 'list_contacts' => 'MyAccount/contact/list_contacts',
40 'edit_contact' => 'MyAccount/contact/edit_contact',
41 'delete_contact' => 'MyAccount/contact/delete_contact',
42 'new_contact' => 'MyAccount/contact/new_contact',
44 'billing_history' => 'MyAccount/billing_history',
45 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
46 'invoice' => 'MyAccount/invoice',
47 'invoice_pdf' => 'MyAccount/invoice_pdf',
48 'legacy_invoice' => 'MyAccount/legacy_invoice',
49 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
50 'invoice_logo' => 'MyAccount/invoice_logo',
51 'list_invoices' => 'MyAccount/list_invoices', #?
52 'list_payments' => 'MyAccount/list_payments',
53 'payment_receipt' => 'MyAccount/payment_receipt',
54 'list_payby' => 'MyAccount/list_payby',
55 'insert_payby' => 'MyAccount/insert_payby',
56 'update_payby' => 'MyAccount/update_payby',
57 'delete_payby' => 'MyAccount/delete_payby',
58 'cancel' => 'MyAccount/cancel', #add to ss cgi!
59 'payment_info' => 'MyAccount/payment_info',
60 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
61 'process_payment' => 'MyAccount/process_payment',
62 'store_payment' => 'MyAccount/store_payment',
63 'process_stored_payment' => 'MyAccount/process_stored_payment',
64 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
65 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
66 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
67 'process_prepay' => 'MyAccount/process_prepay',
68 'realtime_collect' => 'MyAccount/realtime_collect',
69 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
70 'pkg_info' => 'MyAccount/pkg_info',
71 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
72 'list_svc_usage' => 'MyAccount/list_svc_usage',
73 'svc_status_html' => 'MyAccount/svc_status_html',
74 'svc_status_hash' => 'MyAccount/svc_status_hash',
75 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
76 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
77 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
78 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
79 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
80 'acct_forward_info' => 'MyAccount/acct_forward_info',
81 'process_acct_forward' => 'MyAccount/process_acct_forward',
82 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
83 'add_dsl_device' => 'MyAccount/add_dsl_device',
84 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
85 'port_graph' => 'MyAccount/port_graph',
86 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
87 'list_support_usage' => 'MyAccount/list_support_usage',
88 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
89 'change_pkg' => 'MyAccount/change_pkg',
90 'order_recharge' => 'MyAccount/order_recharge',
91 'renew_info' => 'MyAccount/renew_info',
92 'order_renew' => 'MyAccount/order_renew',
93 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
94 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
95 'charge' => 'MyAccount/charge', #?
96 'part_svc_info' => 'MyAccount/part_svc_info',
97 'provision_acct' => 'MyAccount/provision_acct',
98 'provision_phone' => 'MyAccount/provision_phone',
99 'provision_pbx' => 'MyAccount/provision_pbx',
100 'provision_external' => 'MyAccount/provision_external',
101 'provision_forward' => 'MyAccount/provision_forward',
102 'unprovision_svc' => 'MyAccount/unprovision_svc',
103 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
104 'reset_passwd' => 'MyAccount/reset_passwd',
105 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
106 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
107 'validate_passwd' => 'MyAccount/validate_passwd',
108 'list_tickets' => 'MyAccount/list_tickets',
109 'create_ticket' => 'MyAccount/create_ticket',
110 'get_ticket' => 'MyAccount/get_ticket',
111 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
112 'did_report' => 'MyAccount/did_report',
113 'signup_info' => 'Signup/signup_info',
114 'skin_info' => 'MyAccount/skin_info',
115 'access_info' => 'MyAccount/access_info',
116 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
117 'new_customer' => 'Signup/new_customer',
118 'new_customer_minimal' => 'Signup/new_customer_minimal',
119 'capture_payment' => 'Signup/capture_payment',
120 'new_prospect' => 'Signup/new_prospect',
121 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
122 'new_agent' => 'Agent/new_agent',
123 'agent_login' => 'Agent/agent_login',
124 'agent_logout' => 'Agent/agent_logout',
125 'agent_info' => 'Agent/agent_info',
126 'agent_list_customers' => 'Agent/agent_list_customers',
127 'check_username' => 'Agent/check_username',
128 'suspend_username' => 'Agent/suspend_username',
129 'unsuspend_username' => 'Agent/unsuspend_username',
130 'mason_comp' => 'MasonComponent/mason_comp',
131 'call_time' => 'PrepaidPhone/call_time',
132 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
133 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
135 'start_thirdparty' => 'MyAccount/start_thirdparty',
136 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
138 'list_quotations' => 'MyAccount/quotation/list_quotations',
139 'quotation_new' => 'MyAccount/quotation/quotation_new',
140 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
141 'quotation_info' => 'MyAccount/quotation/quotation_info',
142 'quotation_print' => 'MyAccount/quotation/quotation_print',
143 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
144 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
145 'quotation_order' => 'MyAccount/quotation/quotation_order',
147 'freesideinc_service' => 'Freeside/freesideinc_service',
152 qw( regionselector regionselector_hashref location_form
153 expselect popselector domainselector didselector
157 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
158 $ENV{'SHELL'} = '/bin/sh';
159 $ENV{'IFS'} = " \t\n";
162 $ENV{'BASH_ENV'} = '';
164 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
165 #if you grant appropriate permissions to whatever user
166 my $freeside_uid = scalar(getpwnam('freeside'));
167 die "not running as the freeside user\n"
168 if $> != $freeside_uid && ! $skip_uid_check;
170 -e $dir or die "FATAL: $dir doesn't exist!";
171 -d $dir or die "FATAL: $dir isn't a directory!";
172 -r $dir or die "FATAL: Can't read $dir as freeside user!";
173 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
175 foreach my $autoload ( keys %autoload ) {
178 "sub $autoload { ". '
183 #warn scalar(@_). ": ". join(" / ", @_);
187 $param->{_packet} = \''. $autoload{$autoload}. '\';
189 simple_packet($param);
199 warn "sending ". $packet->{_packet}. " to server"
201 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
202 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
203 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
206 #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
208 #block until there is a message on socket
209 # my $w = new IO::Select;
211 # my @wait = $w->can_read;
213 warn "reading message from server"
216 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
217 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
219 warn "returning message to client"
227 FS::SelfService - Freeside self-service API
231 # password and shell account changes
232 use FS::SelfService qw(passwd chfn chsh);
234 # "my account" functionality
235 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
237 #new-style login with an email address and password
238 # can also be used for svc_acct login, set $emailaddress to username@domain
239 my $rv = login ( { 'email' => $emailaddress,
240 'password' => $password,
243 if ( $rv->{'error'} ) {
244 #handle login error...
247 $session_id = $rv->{'session_id'};
250 #classic svc_acct-based login with separate username and password
251 my $rv = login( { 'username' => $username,
253 'password' => $password,
256 if ( $rv->{'error'} ) {
257 #handle login error...
260 $session_id = $rv->{'session_id'};
263 #svc_phone login with phone number and PIN
264 my $rv = login( { 'username' => $phone_number,
265 'domain' => 'svc_phone',
269 if ( $rv->{'error'} ) {
270 #handle login error...
273 $session_id = $rv->{'session_id'};
276 my $customer_info = customer_info( { 'session_id' => $session_id } );
278 my $payment_info = payment_info( { 'session_id' => $session_id } );
280 #!!! process_payment example
282 #!!! list_pkgs example
284 #ordering a package with an svc_acct service
285 my $rv = order_pkg( { 'session_id' => $session_id,
286 'pkgpart' => $pkgpart,
287 'svcpart' => $svcpart,
288 'username' => $username,
289 'domsvc' => $domsvc, #svcnum of svc_domain
290 '_password' => $password,
294 #!!! ordering a package with an svc_domain service example
296 #!!! ordering a package with an svc_phone service example
298 #!!! ordering a package with an svc_external service example
300 #!!! ordering a package with an svc_pbx service
302 #ordering a package with no service
303 my $rv = order_pkg( { 'session_id' => $session_id,
304 'pkgpart' => $pkgpart,
309 #quoting a package, then ordering after confirmation
311 my $rv = quotation_new({ 'session_id' => $session_id });
312 my $qnum = $rv->{quotationnum};
313 # add packages to the quotation
314 $rv = quotation_add_pkg({ 'session_id' => $session_id,
315 'quotationnum' => $qnum,
316 'pkgpart' => $pkgpart,
317 'quantity' => $quantity, # defaults to 1
319 # repeat until all packages are added
320 # view the pricing information
321 $rv = quotation_info({ 'session_id' => $session_id,
322 'quotationnum' => $qnum,
324 print "Total setup charges: ".$rv->{total_setup}."\n".
325 "Total recurring charges: ".$rv->{total_recur}."\n";
326 # quotation_info also provides a detailed breakdown of charges, in
329 # ask customer for confirmation, then:
330 $rv = quotation_order({ 'session_id' => $session_id,
331 'quotationnum' => $qnum,
334 #!!! cancel_pkg example
336 # signup functionality
337 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
339 my $signup_info = signup_info;
341 $rv = new_customer( {
344 'company' => $company,
345 'address1' => $address1,
346 'address2' => $address2,
350 'country' => $country,
351 'daytime' => $daytime,
355 'payinfo' => $payinfo,
357 'paystart_month' => $paystart_month
358 'paystart_year' => $paystart_year,
359 'payissue' => $payissue,
361 'paydate' => $paydate,
362 'payname' => $payname,
363 'invoicing_list' => $invoicing_list,
364 'referral_custnum' => $referral_custnum,
365 'agentnum' => $agentnum,
366 'pkgpart' => $pkgpart,
368 'username' => $username,
369 '_password' => $password,
373 'phonenum' => $phonenum,
378 my $error = $rv->{'error'};
379 if ( $error eq '_decline' ) {
389 Use this API to implement your own client "self-service" module.
391 If you just want to customize the look of the existing "self-service" module,
394 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
400 Changes the password for an existing user in svc_acct. Takes a hash
401 reference with the following keys:
407 Username of the account (required)
411 Domain of the account (required)
415 Old password (required)
419 New password (required)
437 =head1 "MY ACCOUNT" FUNCTIONS
443 Creates a user session. Takes a hash reference as parameter with the
450 Email address (username@domain), instead of username and domain. Required for
451 contact-based self-service login, can also be used for svc_acct-based login.
467 Returns a hash reference with the following keys:
473 Empty on success, or an error message on errors.
477 Session identifier for successful logins
481 =item customer_info HASHREF
483 Returns general customer information.
485 Takes a hash reference as parameter with a single key: B<session_id>
487 Returns a hash reference with the following keys:
501 Array reference of hash references of open inoices. Each hash reference has
502 the following keys: invnum, date, owed
506 An HTML fragment containing shipping and billing addresses.
508 =item The following fields are also returned
510 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
514 =item customer_recurring HASHREF
516 Takes a hash reference as parameter with a single key B<session_id>
517 or keys B<agent_session_id> and B<custnum>.
519 Returns a hash reference with the keys error, custnum and display_recurring.
521 display_recurring is an arrayref of hashrefs with the following keys:
527 frequency of charge, in months unless units are specified
531 frequency of charge, suitable for display
535 amount charged at this frequency
539 =item edit_info HASHREF
541 Takes a hash reference as parameter with any of the following keys:
543 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
545 If a field exists, the customer record is updated with the new value of that
546 field. If a field does not exist, that field is not changed on the customer
549 Returns a hash reference with a single key, B<error>, empty on success, or an
550 error message on errors
552 =item invoice HASHREF
554 Returns an invoice. Takes a hash reference as parameter with two keys:
555 session_id and invnum
557 Returns a hash reference with the following keys:
563 Empty on success, or an error message on errors
575 =item list_invoices HASHREF
577 Returns a list of all customer invoices. Takes a hash reference with a single
580 Returns a hash reference with the following keys:
586 Empty on success, or an error message on errors
590 Reference to array of hash references with the following keys:
600 Invoice date, in UNIX epoch time
606 =item list_payments HASHREF
608 Returns a list of all customer payments. Takes a hash reference with a single
611 Returns a hash reference with the following keys:
617 Empty on success, or an error message on errors
621 Reference to array of hash references with the following keys:
631 Payument date, in UNIX epoch time
635 Payment date, in a human-readable format
639 Payment date, in a shorter human-readable format
647 Payment method: CARD, CHEK (electronic check), or BILL (physical check).
659 Processor for cards and electronic checks
673 =item list_payby HASHREF
675 Returns a list of all stored customer payment information (credit cards and
676 electronic check accounts). Takes a hash reference with a single key,
679 Returns a hash reference with the following keys:
685 Empty on success, or an error message on errors
689 Reference to array of hash references with the following keys:
697 Numeric weighting. Stored payment information with a lower weight is attempted
702 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
703 (on-demand credit card) or DCHK (on-demand electronic check).
707 Masked credit card number (or, masked account and routing numbers)
711 Credit card expiration date
715 Exact name on card (or bank name, for electronic checks)
719 For electronic checks, bank state
723 For electronic checks, account type (Personal/Business, Checking/Savings)
729 =item insert_payby HASHREF
731 Adds new stored payment information for this customer. Takes a hash reference
732 with the following keys:
740 Numeric weighting. Stored payment information with a lower weight is attempted
745 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
746 (on-demand credit card) or DCHK (on-demand electronic check).
750 Credit card number (or electronic check "account@routing")
754 CVV2 number / security code
758 Credit card expiration date
762 Exact name on card (or bank name, for electronic checks)
766 For electronic checks, bank state
770 For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A
774 Optional IP address from which payment was submitted
778 If there is an error, returns a hash reference with a single key, B<error>,
779 otherwise returns a hash reference with a single key, B<custpaybynum>.
781 =item update_payby HASHREF
783 Updates stored payment information. Takes a hash reference with the same
784 keys as insert_payby, as well as B<custpaybynum> to specify which record
785 to update. All keys except B<session_id> and B<custpaybynum> are optional;
786 if omitted, the previous values in the record will be preserved.
788 If there is an error, returns a hash reference with a single key, B<error>,
789 otherwise returns a hash reference with a single key, B<custpaybynum>.
791 =item delete_payby HASHREF
793 Removes stored payment information. Takes a hash reference with two keys,
794 B<session_id> and B<custpaybynum>. Returns a hash reference with a single key,
795 B<error>, which is an error message or empty for successful removal.
799 Cancels this customer.
801 Takes a hash reference as parameter with a single key: B<session_id>
803 Returns a hash reference with a single key, B<error>, which is empty on
804 success or an error message on errors.
806 =item payment_info HASHREF
808 Returns information that may be useful in displaying a payment page.
810 Takes a hash reference as parameter with the following keys:
820 =item omit_cust_main_county
822 Optional, pass a true value to omit cust_main_county data for performance.
826 Returns a hash reference with the following keys:
832 Empty on success, or an error message on errors
840 Exact name on credit card (CARD/DCRD)
864 Customer's current default payment type.
868 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
872 For CARD/DCRD payment types, the card number
876 For CARD/DCRD payment types, expiration month
880 For CARD/DCRD payment types, expiration year
882 =item cust_main_county
884 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.
888 Array reference of all states in the current default country.
892 Hash reference of card types; keys are card types, values are the exact strings
893 passed to the process_payment function
897 #this doesn't actually work yet
901 #Unique transaction identifier (prevents multiple charges), passed to the
902 #process_payment function
906 =item process_payment HASHREF
908 Processes a payment and possible change of address or payment type. Takes a
909 hash reference as parameter with the following keys:
923 If true, address and card information entered will be saved for subsequent
928 If true, future credit card payments will be done automatically (sets payby to
929 CARD). If false, future credit card payments will be done on-demand (sets
930 payby to DCRD). This option only has meaning if B<save> is set true.
958 Two-letter country code
966 Card expiration month
974 #this doesn't actually work yet
978 #Unique transaction identifier, returned from the payment_info function.
979 #Prevents multiple charges.
983 Returns a hash reference with a single key, B<error>, empty on success, or an
984 error message on errors.
986 =item process_payment_order_pkg
988 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
989 payment processes sucessfully, the package is ordered. Takes a hash reference
990 as parameter with the keys of both methods.
992 Returns a hash reference with a single key, B<error>, empty on success, or an
993 error message on errors.
995 =item process_payment_change_pkg
997 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
998 payment processes sucessfully, the package is ordered. Takes a hash reference
999 as parameter with the keys of both methods.
1001 Returns a hash reference with a single key, B<error>, empty on success, or an
1002 error message on errors.
1005 =item process_payment_order_renew
1007 Combines the B<process_payment> and B<order_renew> functions in one step. If
1008 the payment processes sucessfully, the renewal is processed. Takes a hash
1009 reference as parameter with the keys of both methods.
1011 Returns a hash reference with a single key, B<error>, empty on success, or an
1012 error message on errors.
1016 Returns package information for this customer. For more detail on services,
1019 Takes a hash reference as parameter with a single key: B<session_id>
1021 Returns a hash reference containing customer package information. The hash reference contains the following keys:
1031 Empty on success, or an error message on errors.
1033 =item cust_pkg HASHREF
1035 Array reference of hash references, each of which has the fields of a cust_pkg
1036 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
1037 the internal FS:: objects, but hash references of columns and values.
1041 =item part_pkg fields
1043 All fields of part_pkg for this specific cust_pkg (be careful with this
1044 information - it may reveal more about your available packages than you would
1045 like users to know in aggregate)
1049 #XXX pare part_pkg fields down to a more secure subset
1053 An array of hash references indicating information on unprovisioned services
1054 available for provisioning for this specific cust_pkg. Each has the following
1059 =item part_svc fields
1061 All fields of part_svc (be careful with this information - it may reveal more
1062 about your available packages than you would like users to know in aggregate)
1066 #XXX pare part_svc fields down to a more secure subset
1072 An array of hash references indicating information on the customer services
1073 already provisioned for this specific cust_pkg. Each has the following keys:
1079 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.
1085 Primary key for this service
1089 Service definition (see L<FS::part_svc>)
1093 Customer package (see L<FS::cust_pkg>)
1097 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
1105 Returns package information for package.
1107 Takes a hash reference as parameter with the following keys:
1121 Returns a hash reference containing customer package information. The hash reference contains the following keys:
1125 Name of this package
1129 Part package primary key
1133 Package class number
1137 error message if errror.
1145 Returns service information for this customer.
1147 Takes a hash reference as parameter with a single key: B<session_id>
1149 Returns a hash reference containing customer package information. The hash reference contains the following keys:
1159 An array of hash references indicating information on all of this customer's
1160 services. Each has the following keys:
1166 Primary key for this service
1170 Name of this service
1174 Meaningful user-specific identifier for the service (i.e. username, domain, or
1179 Account (svc_acct) services also have the following keys:
1197 Upload bytes remaining
1201 Download bytes remaining
1205 Total bytes remaining
1207 =item recharge_amount
1211 =item recharge_seconds
1213 Number of seconds gained by recharge
1215 =item recharge_upbytes
1217 Number of upload bytes gained by recharge
1219 =item recharge_downbytes
1221 Number of download bytes gained by recharge
1223 =item recharge_totalbytes
1225 Number of total bytes gained by recharge
1233 Orders a package for this customer.
1235 If signup_server-realtime is set, bills the new package, attemps to collect
1236 payment and (for auto-payment customers) cancels the package if the payment is
1239 Takes a hash reference as parameter with the following keys:
1249 Package to order (see L<FS::part_pkg>).
1253 Quantity for this package order (default 1).
1255 =item run_bill_events
1257 If true, runs billing events for the customer after ordering and billing the
1258 package (signup_server-realtime must be set).
1262 Optional locationnum for this package order, for existing locations.
1264 Or, for new locations, pass the following fields: address1*, address2, city*,
1265 county, state*, zip*, country. (* = required in this case)
1267 (None of this is required at all if you are just ordering a package
1268 at the customer's existing default service location.)
1286 Service to order (see L<FS::part_svc>).
1288 Normally optional; required only to provision a non-svc_acct service, or if the
1289 package definition does not contain one svc_acct service definition with
1290 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1291 also be specified to indicate that no initial service should be provisioned.
1295 Fields used when provisioning an svc_acct service:
1309 Optional security phrase
1313 Optional Access number number
1317 Fields used when provisioning an svc_domain service:
1327 Fields used when provisioning an svc_phone service:
1345 Fields used when provisioning an svc_external service:
1351 External numeric ID.
1355 External text title.
1359 Fields used when provisioning an svc_pbx service:
1373 Returns a hash reference with a single key, B<error>, empty on success, or an
1374 error message on errors. The special error '_decline' is returned for
1375 declined transactions.
1379 Changes a package for this customer.
1381 Takes a hash reference as parameter with the following keys:
1391 Existing customer package.
1395 New package to order (see L<FS::part_pkg>).
1399 Quantity for this package order (default 1).
1403 Returns a hash reference with the following keys:
1409 Empty on success, or an error message on errors.
1413 On success, the new pkgnum
1420 Provides useful info for early renewals.
1422 Takes a hash reference as parameter with the following keys:
1432 Returns a hash reference. On errors, it contains a single key, B<error>, with
1433 the error message. Otherwise, contains a single key, B<dates>, pointing to
1434 an array refernce of hash references. Each hash reference contains the
1441 (Future) Bill date. Indicates a future date for which billing could be run.
1442 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1445 =item bill_date_pretty
1447 (Future) Bill date as a human-readable string. (Convenience for display;
1448 subject to change, so best not to parse for the date.)
1452 Base amount which will be charged if renewed early as of this date.
1456 Renewal date; i.e. even-futher future date at which the customer will be paid
1457 through if the early renewal is completed with the given B<bill-date>.
1458 Specified as an integer UNIX timestamp.
1460 =item renew_date_pretty
1462 Renewal date as a human-readable string. (Convenience for display;
1463 subject to change, so best not to parse for the date.)
1467 Package that will be renewed.
1471 Expiration date of the package that will be renewed.
1473 =item expire_date_pretty
1475 Expiration date of the package that will be renewed, as a human-readable
1476 string. (Convenience for display; subject to change, so best not to parse for
1483 Renews this customer early; i.e. runs billing for this customer in advance.
1485 Takes a hash reference as parameter with the following keys:
1495 Integer date as returned by the B<renew_info> function, indicating the advance
1496 date for which to run billing.
1500 Returns a hash reference with a single key, B<error>, empty on success, or an
1501 error message on errors.
1505 Cancels a package for this customer.
1507 Takes a hash reference as parameter with the following keys:
1517 pkgpart of package to cancel
1521 Optional date, for future cancellation (expiration) instead of immediate
1522 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1526 Returns a hash reference with a single key, B<error>, empty on success, or an
1527 error message on errors.
1529 =item provision_acct
1531 Provisions an account (svc_acct).
1533 Takes a hash reference as parameter with the following keys:
1543 pkgnum of package into which this service is provisioned
1547 svcpart or service definition to provision
1557 =item provision_phone
1559 Provisions a phone number (svc_phone).
1561 Takes a hash reference as parameter with the following keys:
1571 pkgnum of package into which this service is provisioned
1575 svcpart or service definition to provision
1595 E911 Address (optional)
1601 Provisions a customer PBX (svc_pbx).
1603 Takes a hash reference as parameter with the following keys:
1613 pkgnum of package into which this service is provisioned
1617 svcpart or service definition to provision
1623 =item max_extensions
1625 =item max_simultaneous
1631 =item provision_external
1633 Provisions an external service (svc_external).
1635 Takes a hash reference as parameter with the following keys:
1645 pkgnum of package into which this service is provisioned
1649 svcpart or service definition to provision
1659 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1663 =item contact_passwd
1665 Changes the password for the currently-logged in contact.
1667 Takes a hash reference as parameter with the following keys:
1677 Returns a hash reference with a single parameter, B<error>, which contains an
1678 error message, or empty on success.
1682 Takes a hash reference as parameter with a single key, B<session_id>.
1684 Returns a hash reference with two parameters: B<error>, which contains an error
1685 message, or empty on success, and B<contacts>, a list of contacts.
1687 B<contacts> is an array reference of hash references (i.e. an array of structs,
1688 in XML-RPC). Each hash reference (struct) has the following keys:
1696 Contact class name (contact type).
1708 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1712 Comma-separated list of email addresses
1716 =item selfservice_access
1724 Updates information for the currently-logged in contact, or (optionally) the
1727 Takes a hash reference as parameter with the following keys:
1735 If already logged in as a contact, this is optional.
1745 Returns a hash reference with a single parameter, B<error>, which contains an
1746 error message, or empty on success.
1750 Creates a new contact.
1752 Takes a hash reference as parameter with the following keys:
1766 Optional contact classnum (TODO: or name)
1770 =item selfservice_access
1772 Y to enable self-service access
1778 Returns a hash reference with a single parameter, B<error>, which contains an
1779 error message, or empty on success.
1781 =item delete_contact
1783 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1786 Takes a hash reference as parameter with the following keys:
1796 Returns a hash reference with a single parameter, B<error>, which contains an
1797 error message, or empty on success.
1801 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1803 All of these functions require the user to be logged in, and the 'session_id'
1804 key to be included in the argument hashref.`
1808 =item list_quotations HASHREF
1810 Returns a hashref listing this customer's active self-service quotations.
1817 an arrayref containing an element for each quotation.
1825 the date it was started
1829 the number of packages
1833 the sum of setup fees
1837 the sum of recurring charges
1841 =item quotation_new HASHREF
1843 Creates an empty quotation and returns a hashref containing 'quotationnum',
1844 the primary key of the new quotation.
1846 =item quotation_delete HASHREF
1848 Disables (does not really delete) a quotation. Takes the following arguments:
1854 =item quotationnum - the quotation to delete
1858 Returns 'error' => a string, which will be empty on success.
1860 =item quotation_info HASHREF
1862 Returns total and detailed pricing information on a quotation.
1864 Takes the following arguments:
1870 =item quotationnum - the quotation to return
1874 Returns a hashref containing:
1876 - total_setup, the total of setup fees (and their taxes)
1877 - total_recur, the total of all recurring charges (and their taxes)
1878 - sections, an arrayref containing an element for each quotation section.
1879 - description, a line of text describing the group of charges
1880 - subtotal, the total of charges in this group (if appropriate)
1881 - detail_items, an arrayref of line items
1882 - pkgnum, the reference number of the package
1883 - description, the package name (or tax name)
1885 - amount, the amount charged
1886 If the detail item represents a subtotal, it will instead contain:
1887 - total_item: description of the subtotal
1888 - total_amount: the subtotal amount
1891 =item quotation_print HASHREF
1893 Renders the quotation as HTML or PDF. Takes the following arguments:
1899 =item quotationnum - the quotation to return
1901 =item format - 'html' or 'pdf'
1905 Returns a hashref containing 'document', the contents of the file.
1907 =item quotation_add_pkg HASHREF
1909 Adds a package to a quotation. Takes the following arguments:
1915 =item pkgpart - the package to add
1917 =item quotationnum - the quotation to add it to
1919 =item quantity - the package quantity (defaults to 1)
1921 =item address1, address2, city, state, zip, country - address fields to set
1922 the service location
1926 Returns 'error' => a string, which will be empty on success.
1928 =item quotation_remove_pkg HASHREF
1930 Removes a package from a quotation. Takes the following arguments:
1936 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1938 =item quotationnum - the quotation to remove it from
1942 Returns 'error' => a string, which will be empty on success.
1944 =item quotation_order HASHREF
1946 Converts the packages in a quotation into real packages. Takes the following
1949 Takes the following arguments:
1955 =item quotationnum - the quotation to order
1961 =head1 SIGNUP FUNCTIONS
1965 =item signup_info HASHREF
1967 Takes a hash reference as parameter with the following keys:
1971 =item session_id - Optional agent/reseller interface session
1975 Returns a hash reference containing information that may be useful in
1976 displaying a signup page. The hash reference contains the following keys:
1980 =item cust_main_county
1982 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.
1986 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
1987 an agentnum specified explicitly via reseller interface session_id in the
1992 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.
1994 =item agentnum2part_pkg
1996 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.
2000 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.
2002 =item security_phrase
2004 True if the "security_phrase" feature is enabled
2008 Array reference of acceptable payment types for signup
2014 credit card - automatic
2018 credit card - on-demand - version 1.5+ only
2022 electronic check - automatic
2026 electronic check - on-demand - version 1.5+ only
2034 billing, not recommended for signups
2038 free, definitely not recommended for signups
2042 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
2048 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
2052 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".
2058 =item countrydefault
2064 =item new_customer_minimal HASHREF
2066 Creates a new customer.
2068 Current differences from new_customer: An address is not required. promo_code
2069 and reg_code are not supported. If invoicing_list and _password is passed, a
2070 contact will be created with self-service access (no pkgpart or username is
2071 necessary). No initial billing is run (this may change in a future version).
2073 Takes a hash reference as parameter with the following keys:
2079 first name (required)
2083 last name (required)
2087 (not typically collected; mostly used for ACH transactions)
2119 Daytime phone number
2123 Evening phone number
2131 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2135 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2139 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2143 Expiration date for CARD/DCRD
2147 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2149 =item invoicing_list
2151 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),
2153 =item referral_custnum
2155 referring customer number
2163 pkgpart of initial package
2179 Access number (index, not the literal number)
2183 Country code (to be provisioned as a service)
2187 Phone number (to be provisioned as a service)
2195 Returns a hash reference with the following keys:
2201 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)
2205 =item new_customer HASHREF
2207 Creates a new customer. Takes a hash reference as parameter with the
2214 first name (required)
2218 last name (required)
2222 (not typically collected; mostly used for ACH transactions)
2228 =item address1 (required)
2236 =item city (required)
2244 =item state (required)
2248 =item zip (required)
2264 Optional shipping address fields. If sending an optional shipping address,
2265 ship_address1, ship_city, ship_state and ship_zip are required.
2269 Daytime phone number
2273 Evening phone number
2281 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2285 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2289 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2293 Expiration date for CARD/DCRD
2297 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2299 =item invoicing_list
2301 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),
2303 =item referral_custnum
2305 referring customer number
2313 pkgpart of initial package
2329 Access number (index, not the literal number)
2333 Country code (to be provisioned as a service)
2337 Phone number (to be provisioned as a service)
2345 Returns a hash reference with the following keys:
2351 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)
2355 =item regionselector HASHREF | LIST
2357 Takes as input a hashref or list of key/value pairs with the following keys:
2361 =item selected_county
2363 Currently selected county
2365 =item selected_state
2367 Currently selected state
2369 =item selected_country
2371 Currently selected country
2375 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2379 Specify a javascript subroutine to call on changes
2385 =item default_country
2391 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>.
2395 Returns a list consisting of three HTML fragments for county selection,
2396 state selection and country selection, respectively.
2400 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2401 sub regionselector {
2408 $param->{'selected_country'} ||= $param->{'default_country'};
2409 $param->{'selected_state'} ||= $param->{'default_state'};
2411 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2415 my %cust_main_county;
2417 # unless ( @cust_main_county ) { #cache
2418 #@cust_main_county = qsearch('cust_main_county', {} );
2419 #foreach my $c ( @cust_main_county ) {
2420 foreach my $c ( @{ $param->{'locales'} } ) {
2421 #$countyflag=1 if $c->county;
2422 $countyflag=1 if $c->{county};
2423 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2424 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2425 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2428 $countyflag=1 if $param->{selected_county};
2430 my $script_html = <<END;
2432 function opt(what,value,text) {
2433 var optionName = new Option(text, value, false, false);
2434 var length = what.length;
2435 what.options[length] = optionName;
2437 function ${prefix}country_changed(what) {
2438 country = what.options[what.selectedIndex].text;
2439 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2440 what.form.${prefix}state.options[i] = null;
2442 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2444 foreach my $country ( sort keys %cust_main_county ) {
2445 $script_html .= "\nif ( country == \"$country\" ) {\n";
2446 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2447 my $text = $state || '(n/a)';
2448 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2450 $script_html .= "}\n";
2453 $script_html .= <<END;
2455 function ${prefix}state_changed(what) {
2458 if ( $countyflag ) {
2459 $script_html .= <<END;
2460 state = what.options[what.selectedIndex].text;
2461 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2462 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2463 what.form.${prefix}county.options[i] = null;
2466 foreach my $country ( sort keys %cust_main_county ) {
2467 $script_html .= "\nif ( country == \"$country\" ) {\n";
2468 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2469 $script_html .= "\nif ( state == \"$state\" ) {\n";
2470 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2471 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2472 my $text = $county || '(n/a)';
2474 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2476 $script_html .= "}\n";
2478 $script_html .= "}\n";
2482 $script_html .= <<END;
2487 my $county_html = $script_html;
2488 if ( $countyflag ) {
2489 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2490 foreach my $county (
2491 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2493 my $text = $county || '(n/a)';
2494 $county_html .= qq!<OPTION VALUE="$county"!.
2495 ($county eq $param->{'selected_county'} ?
2502 $county_html .= '</SELECT>';
2505 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2508 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2509 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2510 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2511 my $text = $state || '(n/a)';
2512 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2513 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2515 $state_html .= '</SELECT>';
2517 my $country_html = '';
2518 if ( scalar( keys %cust_main_county ) > 1 ) {
2520 $country_html = qq(<SELECT NAME="${prefix}country" ).
2521 qq(onChange="${prefix}country_changed(this); ).
2522 $param->{'onchange'}.
2525 my $countrydefault = $param->{default_country} || 'US';
2526 foreach my $country (
2527 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2528 keys %cust_main_county
2530 my $selected = $country eq $param->{'selected_country'}
2533 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2535 $country_html .= '</SELECT>';
2538 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2539 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2543 ($county_html, $state_html, $country_html);
2547 sub regionselector_hashref {
2548 my ($county_html, $state_html, $country_html) = regionselector(@_);
2550 'county_html' => $county_html,
2551 'state_html' => $state_html,
2552 'country_html' => $country_html,
2556 =item location_form HASHREF | LIST
2558 Takes as input a hashref or list of key/value pairs with the following keys:
2564 Current customer session_id
2568 Omit red asterisks from required fields.
2570 =item address1_label
2572 Label for first address line.
2576 Returns an HTML fragment for a location form (address, city, state, zip,
2589 my $session_id = delete $param->{'session_id'};
2591 my $rv = mason_comp( 'session_id' => $session_id,
2592 'comp' => '/elements/location.html',
2593 'args' => [ %$param ],
2597 $rv->{'error'} || $rv->{'output'};
2602 #=item expselect HASHREF | LIST
2604 #Takes as input a hashref or list of key/value pairs with the following keys:
2608 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2610 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2614 =item expselect PREFIX [ DATE ]
2616 Takes as input a unique prefix string and the current expiration date, in
2617 yyyy-mm-dd or m-d-yyyy format
2619 Returns an HTML fragments for expiration date selection.
2625 #if ( ref($_[0]) ) {
2629 #my $prefix = $param->{'prefix'};
2630 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2631 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2633 my $date = scalar(@_) ? shift : '';
2635 my( $m, $y ) = ( 0, 0 );
2636 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2637 ( $m, $y ) = ( $2, $1 );
2638 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2639 ( $m, $y ) = ( $1, $3 );
2641 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2643 $return .= qq!<OPTION VALUE="$_"!;
2644 $return .= " SELECTED" if $_ == $m;
2647 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2649 my $thisYear = $t[5] + 1900;
2650 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2651 $return .= qq!<OPTION VALUE="$_"!;
2652 $return .= " SELECTED" if $_ == $y;
2655 $return .= "</SELECT>";
2660 =item popselector HASHREF | LIST
2662 Takes as input a hashref or list of key/value pairs with the following keys:
2668 Access number number
2672 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>.
2676 Returns an HTML fragment for access number selection.
2680 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2688 my $popnum = $param->{'popnum'};
2689 my $pops = $param->{'pops'};
2691 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2692 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2693 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2694 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2695 if scalar(@$pops) == 1;
2698 my %popnum2pop = ();
2700 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2701 $popnum2pop{$_->{popnum}} = $_;
2706 function opt(what,href,text) {
2707 var optionName = new Option(text, href, false, false)
2708 var length = what.length;
2709 what.options[length] = optionName;
2713 my $init_popstate = $param->{'init_popstate'};
2714 if ( $init_popstate ) {
2715 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2716 $init_popstate. '">';
2719 function acstate_changed(what) {
2720 state = what.options[what.selectedIndex].text;
2721 what.form.popac.options.length = 0
2722 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2726 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2727 foreach my $state ( sort { $a cmp $b } @states ) {
2728 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2730 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2731 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2732 if ($ac eq $param->{'popac'}) {
2733 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2736 $text .= "}\n" unless $init_popstate;
2738 $text .= "popac_changed(what.form.popac)}\n";
2741 function popac_changed(what) {
2742 ac = what.options[what.selectedIndex].text;
2743 what.form.popnum.options.length = 0;
2744 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2748 foreach my $state ( @states ) {
2749 foreach my $popac ( keys %{ $pop{$state} } ) {
2750 $text .= "\nif ( ac == \"$popac\" ) {\n";
2752 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2753 my $o_popnum = $pop->{popnum};
2754 my $poptext = $pop->{city}. ', '. $pop->{state}.
2755 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2757 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2758 if ($popnum == $o_popnum) {
2759 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2767 $text .= "}\n</SCRIPT>\n";
2769 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2772 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2773 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2774 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2775 ">$_" foreach sort { $a cmp $b } @states;
2776 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2779 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2780 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2782 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2785 #comment this block to disable initial list polulation
2786 my @initial_select = ();
2787 if ( scalar( @$pops ) > 100 ) {
2788 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2790 @initial_select = @$pops;
2792 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2793 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2794 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2795 $pop->{city}. ', '. $pop->{state}.
2796 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2799 $text .= qq!</SELECT></TD></TR></TABLE>!;
2805 =item domainselector HASHREF | LIST
2807 Takes as input a hashref or list of key/value pairs with the following keys:
2817 Service number of the selected item.
2821 Returns an HTML fragment for domain selection.
2825 sub domainselector {
2832 my $domsvc= $param->{'domsvc'};
2834 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2835 my $domains = $rv->{'domains'};
2836 $domsvc = $rv->{'domsvc'} unless $domsvc;
2838 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2839 unless scalar(keys %$domains);
2841 if (scalar(keys %$domains) == 1) {
2843 foreach(keys %$domains) {
2846 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2847 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2850 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2852 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2854 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2855 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2856 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2857 $domains->{$domain};
2860 $text .= qq!</SELECT></TD></TR>!;
2866 =item didselector HASHREF | LIST
2868 Takes as input a hashref or list of key/value pairs with the following keys:
2874 Field name for the returned HTML fragment.
2878 Service definition (see L<FS::part_svc>)
2882 Returns an HTML fragment for DID selection.
2894 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2895 'args'=>[ %$param ],
2899 $rv->{'error'} || $rv->{'output'};
2905 =head1 RESELLER FUNCTIONS
2907 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2908 with their active session, and the B<customer_info> and B<order_pkg> functions
2909 with their active session and an additional I<custnum> parameter.
2911 For the most part, development of the reseller web interface has been
2912 superceded by agent-virtualized access to the backend.
2924 =item agent_list_customers
2926 List agent's customers.
2934 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>