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',
37 'contact_passwd' => 'MyAccount/contact/contact_passwd',
38 'list_contacts' => 'MyAccount/contact/list_contacts',
39 'edit_contact' => 'MyAccount/contact/edit_contact',
40 'delete_contact' => 'MyAccount/contact/delete_contact',
41 'new_contact' => 'MyAccount/contact/new_contact',
43 'billing_history' => 'MyAccount/billing_history',
44 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
45 'invoice' => 'MyAccount/invoice',
46 'invoice_pdf' => 'MyAccount/invoice_pdf',
47 'legacy_invoice' => 'MyAccount/legacy_invoice',
48 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
49 'invoice_logo' => 'MyAccount/invoice_logo',
50 'list_invoices' => 'MyAccount/list_invoices', #?
51 'list_payby' => 'MyAccount/list_payby',
52 'insert_payby' => 'MyAccount/insert_payby',
53 'update_payby' => 'MyAccount/update_payby',
54 'delete_payby' => 'MyAccount/delete_payby',
55 'cancel' => 'MyAccount/cancel', #add to ss cgi!
56 'payment_info' => 'MyAccount/payment_info',
57 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
58 'process_payment' => 'MyAccount/process_payment',
59 'store_payment' => 'MyAccount/store_payment',
60 'process_stored_payment' => 'MyAccount/process_stored_payment',
61 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
62 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
63 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
64 'process_prepay' => 'MyAccount/process_prepay',
65 'realtime_collect' => 'MyAccount/realtime_collect',
66 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
67 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
68 'list_svc_usage' => 'MyAccount/list_svc_usage',
69 'svc_status_html' => 'MyAccount/svc_status_html',
70 'svc_status_hash' => 'MyAccount/svc_status_hash',
71 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
72 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
73 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
74 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
75 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
76 'acct_forward_info' => 'MyAccount/acct_forward_info',
77 'process_acct_forward' => 'MyAccount/process_acct_forward',
78 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
79 'add_dsl_device' => 'MyAccount/add_dsl_device',
80 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
81 'port_graph' => 'MyAccount/port_graph',
82 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
83 'list_support_usage' => 'MyAccount/list_support_usage',
84 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
85 'change_pkg' => 'MyAccount/change_pkg',
86 'order_recharge' => 'MyAccount/order_recharge',
87 'renew_info' => 'MyAccount/renew_info',
88 'order_renew' => 'MyAccount/order_renew',
89 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
90 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
91 'charge' => 'MyAccount/charge', #?
92 'part_svc_info' => 'MyAccount/part_svc_info',
93 'provision_acct' => 'MyAccount/provision_acct',
94 'provision_phone' => 'MyAccount/provision_phone',
95 'provision_pbx' => 'MyAccount/provision_pbx',
96 'provision_external' => 'MyAccount/provision_external',
97 'provision_forward' => 'MyAccount/provision_forward',
98 'unprovision_svc' => 'MyAccount/unprovision_svc',
99 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
100 'reset_passwd' => 'MyAccount/reset_passwd',
101 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
102 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
103 'validate_passwd' => 'MyAccount/validate_passwd',
104 'list_tickets' => 'MyAccount/list_tickets',
105 'create_ticket' => 'MyAccount/create_ticket',
106 'get_ticket' => 'MyAccount/get_ticket',
107 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
108 'did_report' => 'MyAccount/did_report',
109 'signup_info' => 'Signup/signup_info',
110 'skin_info' => 'MyAccount/skin_info',
111 'access_info' => 'MyAccount/access_info',
112 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
113 'new_customer' => 'Signup/new_customer',
114 'new_customer_minimal' => 'Signup/new_customer_minimal',
115 'capture_payment' => 'Signup/capture_payment',
116 'new_prospect' => 'Signup/new_prospect',
117 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
118 'new_agent' => 'Agent/new_agent',
119 'agent_login' => 'Agent/agent_login',
120 'agent_logout' => 'Agent/agent_logout',
121 'agent_info' => 'Agent/agent_info',
122 'agent_list_customers' => 'Agent/agent_list_customers',
123 'check_username' => 'Agent/check_username',
124 'suspend_username' => 'Agent/suspend_username',
125 'unsuspend_username' => 'Agent/unsuspend_username',
126 'mason_comp' => 'MasonComponent/mason_comp',
127 'call_time' => 'PrepaidPhone/call_time',
128 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
129 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
131 'start_thirdparty' => 'MyAccount/start_thirdparty',
132 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
134 'list_quotations' => 'MyAccount/quotation/list_quotations',
135 'quotation_new' => 'MyAccount/quotation/quotation_new',
136 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
137 'quotation_info' => 'MyAccount/quotation/quotation_info',
138 'quotation_print' => 'MyAccount/quotation/quotation_print',
139 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
140 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
141 'quotation_order' => 'MyAccount/quotation/quotation_order',
143 'freesideinc_service' => 'Freeside/freesideinc_service',
148 qw( regionselector regionselector_hashref location_form
149 expselect popselector domainselector didselector
153 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
154 $ENV{'SHELL'} = '/bin/sh';
155 $ENV{'IFS'} = " \t\n";
158 $ENV{'BASH_ENV'} = '';
160 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
161 #if you grant appropriate permissions to whatever user
162 my $freeside_uid = scalar(getpwnam('freeside'));
163 die "not running as the freeside user\n"
164 if $> != $freeside_uid && ! $skip_uid_check;
166 -e $dir or die "FATAL: $dir doesn't exist!";
167 -d $dir or die "FATAL: $dir isn't a directory!";
168 -r $dir or die "FATAL: Can't read $dir as freeside user!";
169 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
171 foreach my $autoload ( keys %autoload ) {
174 "sub $autoload { ". '
179 #warn scalar(@_). ": ". join(" / ", @_);
183 $param->{_packet} = \''. $autoload{$autoload}. '\';
185 simple_packet($param);
195 warn "sending ". $packet->{_packet}. " to server"
197 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
198 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
199 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
202 #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
204 #block until there is a message on socket
205 # my $w = new IO::Select;
207 # my @wait = $w->can_read;
209 warn "reading message from server"
212 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
213 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
215 warn "returning message to client"
223 FS::SelfService - Freeside self-service API
227 # password and shell account changes
228 use FS::SelfService qw(passwd chfn chsh);
230 # "my account" functionality
231 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
233 #new-style login with an email address and password
234 # can also be used for svc_acct login, set $emailaddress to username@domain
235 my $rv = login ( { 'email' => $emailaddress,
236 'password' => $password,
239 if ( $rv->{'error'} ) {
240 #handle login error...
243 $session_id = $rv->{'session_id'};
246 #classic svc_acct-based login with separate username and password
247 my $rv = login( { 'username' => $username,
249 'password' => $password,
252 if ( $rv->{'error'} ) {
253 #handle login error...
256 $session_id = $rv->{'session_id'};
259 #svc_phone login with phone number and PIN
260 my $rv = login( { 'username' => $phone_number,
261 'domain' => 'svc_phone',
265 if ( $rv->{'error'} ) {
266 #handle login error...
269 $session_id = $rv->{'session_id'};
272 my $customer_info = customer_info( { 'session_id' => $session_id } );
274 #payment_info and process_payment are available in 1.5+ only
275 my $payment_info = payment_info( { 'session_id' => $session_id } );
277 #!!! process_payment example
279 #!!! list_pkgs example
281 #ordering a package with an svc_acct service
282 my $rv = order_pkg( { 'session_id' => $session_id,
283 'pkgpart' => $pkgpart,
284 'svcpart' => $svcpart,
285 'username' => $username,
286 'domsvc' => $domsvc, #svcnum of svc_domain
287 '_password' => $password,
291 #!!! ordering a package with an svc_domain service example
293 #!!! ordering a package with an svc_phone service example
295 #!!! ordering a package with an svc_external service example
297 #!!! ordering a package with an svc_pbx service
299 #ordering a package with no service
300 my $rv = order_pkg( { 'session_id' => $session_id,
301 'pkgpart' => $pkgpart,
306 #quoting a package, then ordering after confirmation
308 my $rv = quotation_new({ 'session_id' => $session_id });
309 my $qnum = $rv->{quotationnum};
310 # add packages to the quotation
311 $rv = quotation_add_pkg({ 'session_id' => $session_id,
312 'quotationnum' => $qnum,
313 'pkgpart' => $pkgpart,
314 'quantity' => $quantity, # defaults to 1
316 # repeat until all packages are added
317 # view the pricing information
318 $rv = quotation_info({ 'session_id' => $session_id,
319 'quotationnum' => $qnum,
321 print "Total setup charges: ".$rv->{total_setup}."\n".
322 "Total recurring charges: ".$rv->{total_recur}."\n";
323 # quotation_info also provides a detailed breakdown of charges, in
326 # ask customer for confirmation, then:
327 $rv = quotation_order({ 'session_id' => $session_id,
328 'quotationnum' => $qnum,
331 #!!! cancel_pkg example
333 # signup functionality
334 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
336 my $signup_info = signup_info;
338 $rv = new_customer( {
341 'company' => $company,
342 'address1' => $address1,
343 'address2' => $address2,
347 'country' => $country,
348 'daytime' => $daytime,
352 'payinfo' => $payinfo,
354 'paystart_month' => $paystart_month
355 'paystart_year' => $paystart_year,
356 'payissue' => $payissue,
358 'paydate' => $paydate,
359 'payname' => $payname,
360 'invoicing_list' => $invoicing_list,
361 'referral_custnum' => $referral_custnum,
362 'agentnum' => $agentnum,
363 'pkgpart' => $pkgpart,
365 'username' => $username,
366 '_password' => $password,
370 'phonenum' => $phonenum,
375 my $error = $rv->{'error'};
376 if ( $error eq '_decline' ) {
386 Use this API to implement your own client "self-service" module.
388 If you just want to customize the look of the existing "self-service" module,
391 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
397 Changes the password for an existing user in svc_acct. Takes a hash
398 reference with the following keys:
404 Username of the account (required)
408 Domain of the account (required)
412 Old password (required)
416 New password (required)
434 =head1 "MY ACCOUNT" FUNCTIONS
440 Creates a user session. Takes a hash reference as parameter with the
447 Email address (username@domain), instead of username and domain. Required for
448 contact-based self-service login, can also be used for svc_acct-based login.
464 Returns a hash reference with the following keys:
470 Empty on success, or an error message on errors.
474 Session identifier for successful logins
478 =item customer_info HASHREF
480 Returns general customer information.
482 Takes a hash reference as parameter with a single key: B<session_id>
484 Returns a hash reference with the following keys:
498 Array reference of hash references of open inoices. Each hash reference has
499 the following keys: invnum, date, owed
503 An HTML fragment containing shipping and billing addresses.
505 =item The following fields are also returned
507 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
511 =item edit_info HASHREF
513 Takes a hash reference as parameter with any of the following keys:
515 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
517 If a field exists, the customer record is updated with the new value of that
518 field. If a field does not exist, that field is not changed on the customer
521 Returns a hash reference with a single key, B<error>, empty on success, or an
522 error message on errors
524 =item invoice HASHREF
526 Returns an invoice. Takes a hash reference as parameter with two keys:
527 session_id and invnum
529 Returns a hash reference with the following keys:
535 Empty on success, or an error message on errors
547 =item list_invoices HASHREF
549 Returns a list of all customer invoices. Takes a hash reference with a single
552 Returns a hash reference with the following keys:
558 Empty on success, or an error message on errors
562 Reference to array of hash references with the following keys:
572 Invoice date, in UNIX epoch time
578 =item list_payby HASHREF
580 Returns a list of all stored customer payment information (credit cards and
581 electronic check accounts). Takes a hash reference with a single key,
584 Returns a hash reference with the following keys:
590 Empty on success, or an error message on errors
594 Reference to array of hash references with the following keys:
602 Numeric weighting. Stored payment information with a lower weight is attempted
607 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
608 (on-demand credit card) or DCHK (on-demand electronic check).
612 Masked credit card number (or, masked account and routing numbers)
616 Credit card expiration date
620 Exact name on card (or bank name, for electronic checks)
624 For electronic checks, bank state
628 For electronic checks, account type (Personal/Business, Checking/Savings)
634 =item insert_payby HASHREF
636 Adds new stored payment information for this customer. Takes a hash reference
637 with the following keys:
645 Numeric weighting. Stored payment information with a lower weight is attempted
650 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
651 (on-demand credit card) or DCHK (on-demand electronic check).
655 Credit card number (or electronic check "account@routing")
659 CVV2 number / security code
663 Credit card expiration date
667 Exact name on card (or bank name, for electronic checks)
671 For electronic checks, bank state
675 For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A
679 Optional IP address from which payment was submitted
683 If there is an error, returns a hash reference with a single key, B<error>,
684 otherwise returns a hash reference with a single key, B<custpaybynum>.
686 =item update_payby HASHREF
688 Updates stored payment information. Takes a hash reference with the same
689 keys as insert_payby, as well as B<custpaybynum> to specify which record
690 to update. All keys except B<session_id> and B<custpaybynum> are optional;
691 if omitted, the previous values in the record will be preserved.
693 If there is an error, returns a hash reference with a single key, B<error>,
694 otherwise returns a hash reference with a single key, B<custpaybynum>.
696 =item delete_payby HASHREF
698 Removes stored payment information. Takes a hash reference with two keys,
699 B<session_id> and B<custpaybynum>. Returns a hash reference with a single key,
700 B<error>, which is an error message or empty for successful removal.
704 Cancels this customer.
706 Takes a hash reference as parameter with a single key: B<session_id>
708 Returns a hash reference with a single key, B<error>, which is empty on
709 success or an error message on errors.
711 =item payment_info HASHREF
713 Returns information that may be useful in displaying a payment page.
715 Takes a hash reference as parameter with a single key: B<session_id>.
717 Returns a hash reference with the following keys:
723 Empty on success, or an error message on errors
731 Exact name on credit card (CARD/DCRD)
755 Customer's current default payment type.
759 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
763 For CARD/DCRD payment types, the card number
767 For CARD/DCRD payment types, expiration month
771 For CARD/DCRD payment types, expiration year
773 =item cust_main_county
775 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.
779 Array reference of all states in the current default country.
783 Hash reference of card types; keys are card types, values are the exact strings
784 passed to the process_payment function
788 #this doesn't actually work yet
792 #Unique transaction identifier (prevents multiple charges), passed to the
793 #process_payment function
797 =item process_payment HASHREF
799 Processes a payment and possible change of address or payment type. Takes a
800 hash reference as parameter with the following keys:
814 If true, address and card information entered will be saved for subsequent
819 If true, future credit card payments will be done automatically (sets payby to
820 CARD). If false, future credit card payments will be done on-demand (sets
821 payby to DCRD). This option only has meaning if B<save> is set true.
849 Two-letter country code
857 Card expiration month
865 #this doesn't actually work yet
869 #Unique transaction identifier, returned from the payment_info function.
870 #Prevents multiple charges.
874 Returns a hash reference with a single key, B<error>, empty on success, or an
875 error message on errors.
877 =item process_payment_order_pkg
879 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
880 payment processes sucessfully, the package is ordered. Takes a hash reference
881 as parameter with the keys of both methods.
883 Returns a hash reference with a single key, B<error>, empty on success, or an
884 error message on errors.
886 =item process_payment_change_pkg
888 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
889 payment processes sucessfully, the package is ordered. Takes a hash reference
890 as parameter with the keys of both methods.
892 Returns a hash reference with a single key, B<error>, empty on success, or an
893 error message on errors.
896 =item process_payment_order_renew
898 Combines the B<process_payment> and B<order_renew> functions in one step. If
899 the payment processes sucessfully, the renewal is processed. Takes a hash
900 reference as parameter with the keys of both methods.
902 Returns a hash reference with a single key, B<error>, empty on success, or an
903 error message on errors.
907 Returns package information for this customer. For more detail on services,
910 Takes a hash reference as parameter with a single key: B<session_id>
912 Returns a hash reference containing customer package information. The hash reference contains the following keys:
922 Empty on success, or an error message on errors.
924 =item cust_pkg HASHREF
926 Array reference of hash references, each of which has the fields of a cust_pkg
927 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
928 the internal FS:: objects, but hash references of columns and values.
932 =item part_pkg fields
934 All fields of part_pkg for this specific cust_pkg (be careful with this
935 information - it may reveal more about your available packages than you would
936 like users to know in aggregate)
940 #XXX pare part_pkg fields down to a more secure subset
944 An array of hash references indicating information on unprovisioned services
945 available for provisioning for this specific cust_pkg. Each has the following
950 =item part_svc fields
952 All fields of part_svc (be careful with this information - it may reveal more
953 about your available packages than you would like users to know in aggregate)
957 #XXX pare part_svc fields down to a more secure subset
963 An array of hash references indicating information on the customer services
964 already provisioned for this specific cust_pkg. Each has the following keys:
970 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.
976 Primary key for this service
980 Service definition (see L<FS::part_svc>)
984 Customer package (see L<FS::cust_pkg>)
988 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
996 Returns service information for this customer.
998 Takes a hash reference as parameter with a single key: B<session_id>
1000 Returns a hash reference containing customer package information. The hash reference contains the following keys:
1010 An array of hash references indicating information on all of this customer's
1011 services. Each has the following keys:
1017 Primary key for this service
1021 Name of this service
1025 Meaningful user-specific identifier for the service (i.e. username, domain, or
1030 Account (svc_acct) services also have the following keys:
1048 Upload bytes remaining
1052 Download bytes remaining
1056 Total bytes remaining
1058 =item recharge_amount
1062 =item recharge_seconds
1064 Number of seconds gained by recharge
1066 =item recharge_upbytes
1068 Number of upload bytes gained by recharge
1070 =item recharge_downbytes
1072 Number of download bytes gained by recharge
1074 =item recharge_totalbytes
1076 Number of total bytes gained by recharge
1084 Orders a package for this customer.
1086 If signup_server-realtime is set, bills the new package, attemps to collect
1087 payment and (for auto-payment customers) cancels the package if the payment is
1090 Takes a hash reference as parameter with the following keys:
1100 Package to order (see L<FS::part_pkg>).
1104 Quantity for this package order (default 1).
1106 =item run_bill_events
1108 If true, runs billing events for the customer after ordering and billing the
1109 package (signup_server-realtime must be set).
1113 Optional locationnum for this package order, for existing locations.
1115 Or, for new locations, pass the following fields: address1*, address2, city*,
1116 county, state*, zip*, country. (* = required in this case)
1118 (None of this is required at all if you are just ordering a package
1119 at the customer's existing default service location.)
1137 Service to order (see L<FS::part_svc>).
1139 Normally optional; required only to provision a non-svc_acct service, or if the
1140 package definition does not contain one svc_acct service definition with
1141 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1142 also be specified to indicate that no initial service should be provisioned.
1146 Fields used when provisioning an svc_acct service:
1160 Optional security phrase
1164 Optional Access number number
1168 Fields used when provisioning an svc_domain service:
1178 Fields used when provisioning an svc_phone service:
1196 Fields used when provisioning an svc_external service:
1202 External numeric ID.
1206 External text title.
1210 Fields used when provisioning an svc_pbx service:
1224 Returns a hash reference with a single key, B<error>, empty on success, or an
1225 error message on errors. The special error '_decline' is returned for
1226 declined transactions.
1230 Changes a package for this customer.
1232 Takes a hash reference as parameter with the following keys:
1242 Existing customer package.
1246 New package to order (see L<FS::part_pkg>).
1250 Quantity for this package order (default 1).
1254 Returns a hash reference with the following keys:
1260 Empty on success, or an error message on errors.
1264 On success, the new pkgnum
1271 Provides useful info for early renewals.
1273 Takes a hash reference as parameter with the following keys:
1283 Returns a hash reference. On errors, it contains a single key, B<error>, with
1284 the error message. Otherwise, contains a single key, B<dates>, pointing to
1285 an array refernce of hash references. Each hash reference contains the
1292 (Future) Bill date. Indicates a future date for which billing could be run.
1293 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1296 =item bill_date_pretty
1298 (Future) Bill date as a human-readable string. (Convenience for display;
1299 subject to change, so best not to parse for the date.)
1303 Base amount which will be charged if renewed early as of this date.
1307 Renewal date; i.e. even-futher future date at which the customer will be paid
1308 through if the early renewal is completed with the given B<bill-date>.
1309 Specified as an integer UNIX timestamp.
1311 =item renew_date_pretty
1313 Renewal date as a human-readable string. (Convenience for display;
1314 subject to change, so best not to parse for the date.)
1318 Package that will be renewed.
1322 Expiration date of the package that will be renewed.
1324 =item expire_date_pretty
1326 Expiration date of the package that will be renewed, as a human-readable
1327 string. (Convenience for display; subject to change, so best not to parse for
1334 Renews this customer early; i.e. runs billing for this customer in advance.
1336 Takes a hash reference as parameter with the following keys:
1346 Integer date as returned by the B<renew_info> function, indicating the advance
1347 date for which to run billing.
1351 Returns a hash reference with a single key, B<error>, empty on success, or an
1352 error message on errors.
1356 Cancels a package for this customer.
1358 Takes a hash reference as parameter with the following keys:
1368 pkgpart of package to cancel
1372 Optional date, for future cancellation (expiration) instead of immediate
1373 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1377 Returns a hash reference with a single key, B<error>, empty on success, or an
1378 error message on errors.
1380 =item provision_acct
1382 Provisions an account (svc_acct).
1384 Takes a hash reference as parameter with the following keys:
1394 pkgnum of package into which this service is provisioned
1398 svcpart or service definition to provision
1408 =item provision_phone
1410 Provisions a phone number (svc_phone).
1412 Takes a hash reference as parameter with the following keys:
1422 pkgnum of package into which this service is provisioned
1426 svcpart or service definition to provision
1446 E911 Address (optional)
1452 Provisions a customer PBX (svc_pbx).
1454 Takes a hash reference as parameter with the following keys:
1464 pkgnum of package into which this service is provisioned
1468 svcpart or service definition to provision
1474 =item max_extensions
1476 =item max_simultaneous
1482 =item provision_external
1484 Provisions an external service (svc_external).
1486 Takes a hash reference as parameter with the following keys:
1496 pkgnum of package into which this service is provisioned
1500 svcpart or service definition to provision
1510 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1514 =item contact_passwd
1516 Changes the password for the currently-logged in contact.
1518 Takes a hash reference as parameter with the following keys:
1528 Returns a hash reference with a single parameter, B<error>, which contains an
1529 error message, or empty on success.
1533 Takes a hash reference as parameter with a single key, B<session_id>.
1535 Returns a hash reference with two parameters: B<error>, which contains an error
1536 message, or empty on success, and B<contacts>, a list of contacts.
1538 B<contacts> is an array reference of hash references (i.e. an array of structs,
1539 in XML-RPC). Each hash reference (struct) has the following keys:
1547 Contact class name (contact type).
1559 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1563 Comma-separated list of email addresses
1567 =item selfservice_access
1575 Updates information for the currently-logged in contact, or (optionally) the
1578 Takes a hash reference as parameter with the following keys:
1586 If already logged in as a contact, this is optional.
1596 Returns a hash reference with a single parameter, B<error>, which contains an
1597 error message, or empty on success.
1601 Creates a new contact.
1603 Takes a hash reference as parameter with the following keys:
1617 Optional contact classnum (TODO: or name)
1621 =item selfservice_access
1623 Y to enable self-service access
1629 Returns a hash reference with a single parameter, B<error>, which contains an
1630 error message, or empty on success.
1632 =item delete_contact
1634 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1637 Takes a hash reference as parameter with the following keys:
1647 Returns a hash reference with a single parameter, B<error>, which contains an
1648 error message, or empty on success.
1652 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1654 All of these functions require the user to be logged in, and the 'session_id'
1655 key to be included in the argument hashref.`
1659 =item list_quotations HASHREF
1661 Returns a hashref listing this customer's active self-service quotations.
1668 an arrayref containing an element for each quotation.
1676 the date it was started
1680 the number of packages
1684 the sum of setup fees
1688 the sum of recurring charges
1692 =item quotation_new HASHREF
1694 Creates an empty quotation and returns a hashref containing 'quotationnum',
1695 the primary key of the new quotation.
1697 =item quotation_delete HASHREF
1699 Disables (does not really delete) a quotation. Takes the following arguments:
1705 =item quotationnum - the quotation to delete
1709 Returns 'error' => a string, which will be empty on success.
1711 =item quotation_info HASHREF
1713 Returns total and detailed pricing information on a quotation.
1715 Takes the following arguments:
1721 =item quotationnum - the quotation to return
1725 Returns a hashref containing:
1727 - total_setup, the total of setup fees (and their taxes)
1728 - total_recur, the total of all recurring charges (and their taxes)
1729 - sections, an arrayref containing an element for each quotation section.
1730 - description, a line of text describing the group of charges
1731 - subtotal, the total of charges in this group (if appropriate)
1732 - detail_items, an arrayref of line items
1733 - pkgnum, the reference number of the package
1734 - description, the package name (or tax name)
1736 - amount, the amount charged
1737 If the detail item represents a subtotal, it will instead contain:
1738 - total_item: description of the subtotal
1739 - total_amount: the subtotal amount
1742 =item quotation_print HASHREF
1744 Renders the quotation as HTML or PDF. Takes the following arguments:
1750 =item quotationnum - the quotation to return
1752 =item format - 'html' or 'pdf'
1756 Returns a hashref containing 'document', the contents of the file.
1758 =item quotation_add_pkg HASHREF
1760 Adds a package to a quotation. Takes the following arguments:
1766 =item pkgpart - the package to add
1768 =item quotationnum - the quotation to add it to
1770 =item quantity - the package quantity (defaults to 1)
1772 =item address1, address2, city, state, zip, country - address fields to set
1773 the service location
1777 Returns 'error' => a string, which will be empty on success.
1779 =item quotation_remove_pkg HASHREF
1781 Removes a package from a quotation. Takes the following arguments:
1787 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1789 =item quotationnum - the quotation to remove it from
1793 Returns 'error' => a string, which will be empty on success.
1795 =item quotation_order HASHREF
1797 Converts the packages in a quotation into real packages. Takes the following
1800 Takes the following arguments:
1806 =item quotationnum - the quotation to order
1812 =head1 SIGNUP FUNCTIONS
1816 =item signup_info HASHREF
1818 Takes a hash reference as parameter with the following keys:
1822 =item session_id - Optional agent/reseller interface session
1826 Returns a hash reference containing information that may be useful in
1827 displaying a signup page. The hash reference contains the following keys:
1831 =item cust_main_county
1833 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.
1837 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
1838 an agentnum specified explicitly via reseller interface session_id in the
1843 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.
1845 =item agentnum2part_pkg
1847 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.
1851 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.
1853 =item security_phrase
1855 True if the "security_phrase" feature is enabled
1859 Array reference of acceptable payment types for signup
1865 credit card - automatic
1869 credit card - on-demand - version 1.5+ only
1873 electronic check - automatic
1877 electronic check - on-demand - version 1.5+ only
1885 billing, not recommended for signups
1889 free, definitely not recommended for signups
1893 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1899 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1903 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".
1909 =item countrydefault
1915 =item new_customer_minimal HASHREF
1917 Creates a new customer.
1919 Current differences from new_customer: An address is not required. promo_code
1920 and reg_code are not supported. If invoicing_list and _password is passed, a
1921 contact will be created with self-service access (no pkgpart or username is
1922 necessary). No initial billing is run (this may change in a future version).
1924 Takes a hash reference as parameter with the following keys:
1930 first name (required)
1934 last name (required)
1938 (not typically collected; mostly used for ACH transactions)
1970 Daytime phone number
1974 Evening phone number
1982 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1986 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1990 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1994 Expiration date for CARD/DCRD
1998 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2000 =item invoicing_list
2002 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),
2004 =item referral_custnum
2006 referring customer number
2014 pkgpart of initial package
2030 Access number (index, not the literal number)
2034 Country code (to be provisioned as a service)
2038 Phone number (to be provisioned as a service)
2046 Returns a hash reference with the following keys:
2052 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)
2056 =item new_customer HASHREF
2058 Creates a new customer. Takes a hash reference as parameter with the
2065 first name (required)
2069 last name (required)
2073 (not typically collected; mostly used for ACH transactions)
2079 =item address1 (required)
2087 =item city (required)
2095 =item state (required)
2099 =item zip (required)
2105 Daytime phone number
2109 Evening phone number
2117 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2121 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2125 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2129 Expiration date for CARD/DCRD
2133 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2135 =item invoicing_list
2137 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),
2139 =item referral_custnum
2141 referring customer number
2149 pkgpart of initial package
2165 Access number (index, not the literal number)
2169 Country code (to be provisioned as a service)
2173 Phone number (to be provisioned as a service)
2181 Returns a hash reference with the following keys:
2187 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)
2191 =item regionselector HASHREF | LIST
2193 Takes as input a hashref or list of key/value pairs with the following keys:
2197 =item selected_county
2199 Currently selected county
2201 =item selected_state
2203 Currently selected state
2205 =item selected_country
2207 Currently selected country
2211 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2215 Specify a javascript subroutine to call on changes
2221 =item default_country
2227 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>.
2231 Returns a list consisting of three HTML fragments for county selection,
2232 state selection and country selection, respectively.
2236 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2237 sub regionselector {
2244 $param->{'selected_country'} ||= $param->{'default_country'};
2245 $param->{'selected_state'} ||= $param->{'default_state'};
2247 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2251 my %cust_main_county;
2253 # unless ( @cust_main_county ) { #cache
2254 #@cust_main_county = qsearch('cust_main_county', {} );
2255 #foreach my $c ( @cust_main_county ) {
2256 foreach my $c ( @{ $param->{'locales'} } ) {
2257 #$countyflag=1 if $c->county;
2258 $countyflag=1 if $c->{county};
2259 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2260 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2261 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2264 $countyflag=1 if $param->{selected_county};
2266 my $script_html = <<END;
2268 function opt(what,value,text) {
2269 var optionName = new Option(text, value, false, false);
2270 var length = what.length;
2271 what.options[length] = optionName;
2273 function ${prefix}country_changed(what) {
2274 country = what.options[what.selectedIndex].text;
2275 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2276 what.form.${prefix}state.options[i] = null;
2278 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2280 foreach my $country ( sort keys %cust_main_county ) {
2281 $script_html .= "\nif ( country == \"$country\" ) {\n";
2282 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2283 my $text = $state || '(n/a)';
2284 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2286 $script_html .= "}\n";
2289 $script_html .= <<END;
2291 function ${prefix}state_changed(what) {
2294 if ( $countyflag ) {
2295 $script_html .= <<END;
2296 state = what.options[what.selectedIndex].text;
2297 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2298 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2299 what.form.${prefix}county.options[i] = null;
2302 foreach my $country ( sort keys %cust_main_county ) {
2303 $script_html .= "\nif ( country == \"$country\" ) {\n";
2304 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2305 $script_html .= "\nif ( state == \"$state\" ) {\n";
2306 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2307 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2308 my $text = $county || '(n/a)';
2310 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2312 $script_html .= "}\n";
2314 $script_html .= "}\n";
2318 $script_html .= <<END;
2323 my $county_html = $script_html;
2324 if ( $countyflag ) {
2325 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2326 foreach my $county (
2327 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2329 my $text = $county || '(n/a)';
2330 $county_html .= qq!<OPTION VALUE="$county"!.
2331 ($county eq $param->{'selected_county'} ?
2338 $county_html .= '</SELECT>';
2341 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2344 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2345 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2346 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2347 my $text = $state || '(n/a)';
2348 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2349 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2351 $state_html .= '</SELECT>';
2353 my $country_html = '';
2354 if ( scalar( keys %cust_main_county ) > 1 ) {
2356 $country_html = qq(<SELECT NAME="${prefix}country" ).
2357 qq(onChange="${prefix}country_changed(this); ).
2358 $param->{'onchange'}.
2361 my $countrydefault = $param->{default_country} || 'US';
2362 foreach my $country (
2363 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2364 keys %cust_main_county
2366 my $selected = $country eq $param->{'selected_country'}
2369 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2371 $country_html .= '</SELECT>';
2374 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2375 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2379 ($county_html, $state_html, $country_html);
2383 sub regionselector_hashref {
2384 my ($county_html, $state_html, $country_html) = regionselector(@_);
2386 'county_html' => $county_html,
2387 'state_html' => $state_html,
2388 'country_html' => $country_html,
2392 =item location_form HASHREF | LIST
2394 Takes as input a hashref or list of key/value pairs with the following keys:
2400 Current customer session_id
2404 Omit red asterisks from required fields.
2406 =item address1_label
2408 Label for first address line.
2412 Returns an HTML fragment for a location form (address, city, state, zip,
2425 my $session_id = delete $param->{'session_id'};
2427 my $rv = mason_comp( 'session_id' => $session_id,
2428 'comp' => '/elements/location.html',
2429 'args' => [ %$param ],
2433 $rv->{'error'} || $rv->{'output'};
2438 #=item expselect HASHREF | LIST
2440 #Takes as input a hashref or list of key/value pairs with the following keys:
2444 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2446 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2450 =item expselect PREFIX [ DATE ]
2452 Takes as input a unique prefix string and the current expiration date, in
2453 yyyy-mm-dd or m-d-yyyy format
2455 Returns an HTML fragments for expiration date selection.
2461 #if ( ref($_[0]) ) {
2465 #my $prefix = $param->{'prefix'};
2466 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2467 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2469 my $date = scalar(@_) ? shift : '';
2471 my( $m, $y ) = ( 0, 0 );
2472 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2473 ( $m, $y ) = ( $2, $1 );
2474 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2475 ( $m, $y ) = ( $1, $3 );
2477 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2479 $return .= qq!<OPTION VALUE="$_"!;
2480 $return .= " SELECTED" if $_ == $m;
2483 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2485 my $thisYear = $t[5] + 1900;
2486 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2487 $return .= qq!<OPTION VALUE="$_"!;
2488 $return .= " SELECTED" if $_ == $y;
2491 $return .= "</SELECT>";
2496 =item popselector HASHREF | LIST
2498 Takes as input a hashref or list of key/value pairs with the following keys:
2504 Access number number
2508 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>.
2512 Returns an HTML fragment for access number selection.
2516 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2524 my $popnum = $param->{'popnum'};
2525 my $pops = $param->{'pops'};
2527 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2528 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2529 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2530 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2531 if scalar(@$pops) == 1;
2534 my %popnum2pop = ();
2536 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2537 $popnum2pop{$_->{popnum}} = $_;
2542 function opt(what,href,text) {
2543 var optionName = new Option(text, href, false, false)
2544 var length = what.length;
2545 what.options[length] = optionName;
2549 my $init_popstate = $param->{'init_popstate'};
2550 if ( $init_popstate ) {
2551 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2552 $init_popstate. '">';
2555 function acstate_changed(what) {
2556 state = what.options[what.selectedIndex].text;
2557 what.form.popac.options.length = 0
2558 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2562 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2563 foreach my $state ( sort { $a cmp $b } @states ) {
2564 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2566 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2567 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2568 if ($ac eq $param->{'popac'}) {
2569 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2572 $text .= "}\n" unless $init_popstate;
2574 $text .= "popac_changed(what.form.popac)}\n";
2577 function popac_changed(what) {
2578 ac = what.options[what.selectedIndex].text;
2579 what.form.popnum.options.length = 0;
2580 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2584 foreach my $state ( @states ) {
2585 foreach my $popac ( keys %{ $pop{$state} } ) {
2586 $text .= "\nif ( ac == \"$popac\" ) {\n";
2588 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2589 my $o_popnum = $pop->{popnum};
2590 my $poptext = $pop->{city}. ', '. $pop->{state}.
2591 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2593 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2594 if ($popnum == $o_popnum) {
2595 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2603 $text .= "}\n</SCRIPT>\n";
2605 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2608 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2609 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2610 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2611 ">$_" foreach sort { $a cmp $b } @states;
2612 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2615 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2616 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2618 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2621 #comment this block to disable initial list polulation
2622 my @initial_select = ();
2623 if ( scalar( @$pops ) > 100 ) {
2624 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2626 @initial_select = @$pops;
2628 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2629 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2630 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2631 $pop->{city}. ', '. $pop->{state}.
2632 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2635 $text .= qq!</SELECT></TD></TR></TABLE>!;
2641 =item domainselector HASHREF | LIST
2643 Takes as input a hashref or list of key/value pairs with the following keys:
2653 Service number of the selected item.
2657 Returns an HTML fragment for domain selection.
2661 sub domainselector {
2668 my $domsvc= $param->{'domsvc'};
2670 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2671 my $domains = $rv->{'domains'};
2672 $domsvc = $rv->{'domsvc'} unless $domsvc;
2674 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2675 unless scalar(keys %$domains);
2677 if (scalar(keys %$domains) == 1) {
2679 foreach(keys %$domains) {
2682 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2683 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2686 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2688 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2690 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2691 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2692 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2693 $domains->{$domain};
2696 $text .= qq!</SELECT></TD></TR>!;
2702 =item didselector HASHREF | LIST
2704 Takes as input a hashref or list of key/value pairs with the following keys:
2710 Field name for the returned HTML fragment.
2714 Service definition (see L<FS::part_svc>)
2718 Returns an HTML fragment for DID selection.
2730 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2731 'args'=>[ %$param ],
2735 $rv->{'error'} || $rv->{'output'};
2741 =head1 RESELLER FUNCTIONS
2743 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2744 with their active session, and the B<customer_info> and B<order_pkg> functions
2745 with their active session and an additional I<custnum> parameter.
2747 For the most part, development of the reseller web interface has been
2748 superceded by agent-virtualized access to the backend.
2760 =item agent_list_customers
2762 List agent's customers.
2770 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>