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 'delete_payby' => 'MyAccount/delete_payby',
54 'cancel' => 'MyAccount/cancel', #add to ss cgi!
55 'payment_info' => 'MyAccount/payment_info',
56 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
57 'process_payment' => 'MyAccount/process_payment',
58 'store_payment' => 'MyAccount/store_payment',
59 'process_stored_payment' => 'MyAccount/process_stored_payment',
60 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
61 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
62 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
63 'process_prepay' => 'MyAccount/process_prepay',
64 'realtime_collect' => 'MyAccount/realtime_collect',
65 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
66 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
67 'list_svc_usage' => 'MyAccount/list_svc_usage',
68 'svc_status_html' => 'MyAccount/svc_status_html',
69 'svc_status_hash' => 'MyAccount/svc_status_hash',
70 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
71 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
72 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
73 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
74 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
75 'acct_forward_info' => 'MyAccount/acct_forward_info',
76 'process_acct_forward' => 'MyAccount/process_acct_forward',
77 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
78 'add_dsl_device' => 'MyAccount/add_dsl_device',
79 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
80 'port_graph' => 'MyAccount/port_graph',
81 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
82 'list_support_usage' => 'MyAccount/list_support_usage',
83 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
84 'change_pkg' => 'MyAccount/change_pkg',
85 'order_recharge' => 'MyAccount/order_recharge',
86 'renew_info' => 'MyAccount/renew_info',
87 'order_renew' => 'MyAccount/order_renew',
88 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
89 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
90 'charge' => 'MyAccount/charge', #?
91 'part_svc_info' => 'MyAccount/part_svc_info',
92 'provision_acct' => 'MyAccount/provision_acct',
93 'provision_phone' => 'MyAccount/provision_phone',
94 'provision_pbx' => 'MyAccount/provision_pbx',
95 'provision_external' => 'MyAccount/provision_external',
96 'provision_forward' => 'MyAccount/provision_forward',
97 'unprovision_svc' => 'MyAccount/unprovision_svc',
98 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
99 'reset_passwd' => 'MyAccount/reset_passwd',
100 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
101 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
102 'validate_passwd' => 'MyAccount/validate_passwd',
103 'list_tickets' => 'MyAccount/list_tickets',
104 'create_ticket' => 'MyAccount/create_ticket',
105 'get_ticket' => 'MyAccount/get_ticket',
106 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
107 'did_report' => 'MyAccount/did_report',
108 'signup_info' => 'Signup/signup_info',
109 'skin_info' => 'MyAccount/skin_info',
110 'access_info' => 'MyAccount/access_info',
111 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
112 'new_customer' => 'Signup/new_customer',
113 'new_customer_minimal' => 'Signup/new_customer_minimal',
114 'capture_payment' => 'Signup/capture_payment',
115 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
116 'new_agent' => 'Agent/new_agent',
117 'agent_login' => 'Agent/agent_login',
118 'agent_logout' => 'Agent/agent_logout',
119 'agent_info' => 'Agent/agent_info',
120 'agent_list_customers' => 'Agent/agent_list_customers',
121 'check_username' => 'Agent/check_username',
122 'suspend_username' => 'Agent/suspend_username',
123 'unsuspend_username' => 'Agent/unsuspend_username',
124 'mason_comp' => 'MasonComponent/mason_comp',
125 'call_time' => 'PrepaidPhone/call_time',
126 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
127 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
129 'start_thirdparty' => 'MyAccount/start_thirdparty',
130 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
132 'list_quotations' => 'MyAccount/quotation/list_quotations',
133 'quotation_new' => 'MyAccount/quotation/quotation_new',
134 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
135 'quotation_info' => 'MyAccount/quotation/quotation_info',
136 'quotation_print' => 'MyAccount/quotation/quotation_print',
137 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
138 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
139 'quotation_order' => 'MyAccount/quotation/quotation_order',
144 qw( regionselector regionselector_hashref location_form
145 expselect popselector domainselector didselector
149 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
150 $ENV{'SHELL'} = '/bin/sh';
151 $ENV{'IFS'} = " \t\n";
154 $ENV{'BASH_ENV'} = '';
156 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
157 #if you grant appropriate permissions to whatever user
158 my $freeside_uid = scalar(getpwnam('freeside'));
159 die "not running as the freeside user\n"
160 if $> != $freeside_uid && ! $skip_uid_check;
162 -e $dir or die "FATAL: $dir doesn't exist!";
163 -d $dir or die "FATAL: $dir isn't a directory!";
164 -r $dir or die "FATAL: Can't read $dir as freeside user!";
165 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
167 foreach my $autoload ( keys %autoload ) {
170 "sub $autoload { ". '
175 #warn scalar(@_). ": ". join(" / ", @_);
179 $param->{_packet} = \''. $autoload{$autoload}. '\';
181 simple_packet($param);
191 warn "sending ". $packet->{_packet}. " to server"
193 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
194 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
195 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
198 #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
200 #block until there is a message on socket
201 # my $w = new IO::Select;
203 # my @wait = $w->can_read;
205 warn "reading message from server"
208 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
209 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
211 warn "returning message to client"
219 FS::SelfService - Freeside self-service API
223 # password and shell account changes
224 use FS::SelfService qw(passwd chfn chsh);
226 # "my account" functionality
227 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
229 #new-style login with an email address and password
230 # can also be used for svc_acct login, set $emailaddress to username@domain
231 my $rv = login ( { 'email' => $emailaddress,
232 'password' => $password,
235 if ( $rv->{'error'} ) {
236 #handle login error...
239 $session_id = $rv->{'session_id'};
242 #classic svc_acct-based login with separate username and password
243 my $rv = login( { 'username' => $username,
245 'password' => $password,
248 if ( $rv->{'error'} ) {
249 #handle login error...
252 $session_id = $rv->{'session_id'};
255 #svc_phone login with phone number and PIN
256 my $rv = login( { 'username' => $phone_number,
257 'domain' => 'svc_phone',
261 if ( $rv->{'error'} ) {
262 #handle login error...
265 $session_id = $rv->{'session_id'};
268 my $customer_info = customer_info( { 'session_id' => $session_id } );
270 #payment_info and process_payment are available in 1.5+ only
271 my $payment_info = payment_info( { 'session_id' => $session_id } );
273 #!!! process_payment example
275 #!!! list_pkgs example
277 #ordering a package with an svc_acct service
278 my $rv = order_pkg( { 'session_id' => $session_id,
279 'pkgpart' => $pkgpart,
280 'svcpart' => $svcpart,
281 'username' => $username,
282 'domsvc' => $domsvc, #svcnum of svc_domain
283 '_password' => $password,
287 #!!! ordering a package with an svc_domain service example
289 #!!! ordering a package with an svc_phone service example
291 #!!! ordering a package with an svc_external service example
293 #!!! ordering a package with an svc_pbx service
295 #ordering a package with no service
296 my $rv = order_pkg( { 'session_id' => $session_id,
297 'pkgpart' => $pkgpart,
302 #quoting a package, then ordering after confirmation
304 my $rv = quotation_new({ 'session_id' => $session_id });
305 my $qnum = $rv->{quotationnum};
306 # add packages to the quotation
307 $rv = quotation_add_pkg({ 'session_id' => $session_id,
308 'quotationnum' => $qnum,
309 'pkgpart' => $pkgpart,
310 'quantity' => $quantity, # defaults to 1
312 # repeat until all packages are added
313 # view the pricing information
314 $rv = quotation_info({ 'session_id' => $session_id,
315 'quotationnum' => $qnum,
317 print "Total setup charges: ".$rv->{total_setup}."\n".
318 "Total recurring charges: ".$rv->{total_recur}."\n";
319 # quotation_info also provides a detailed breakdown of charges, in
322 # ask customer for confirmation, then:
323 $rv = quotation_order({ 'session_id' => $session_id,
324 'quotationnum' => $qnum,
327 #!!! cancel_pkg example
329 # signup functionality
330 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
332 my $signup_info = signup_info;
334 $rv = new_customer( {
337 'company' => $company,
338 'address1' => $address1,
339 'address2' => $address2,
343 'country' => $country,
344 'daytime' => $daytime,
348 'payinfo' => $payinfo,
350 'paystart_month' => $paystart_month
351 'paystart_year' => $paystart_year,
352 'payissue' => $payissue,
354 'paydate' => $paydate,
355 'payname' => $payname,
356 'invoicing_list' => $invoicing_list,
357 'referral_custnum' => $referral_custnum,
358 'agentnum' => $agentnum,
359 'pkgpart' => $pkgpart,
361 'username' => $username,
362 '_password' => $password,
366 'phonenum' => $phonenum,
371 my $error = $rv->{'error'};
372 if ( $error eq '_decline' ) {
382 Use this API to implement your own client "self-service" module.
384 If you just want to customize the look of the existing "self-service" module,
387 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
393 Changes the password for an existing user in svc_acct. Takes a hash
394 reference with the following keys:
400 Username of the account (required)
404 Domain of the account (required)
408 Old password (required)
412 New password (required)
430 =head1 "MY ACCOUNT" FUNCTIONS
436 Creates a user session. Takes a hash reference as parameter with the
443 Email address (username@domain), instead of username and domain. Required for
444 contact-based self-service login, can also be used for svc_acct-based login.
460 Returns a hash reference with the following keys:
466 Empty on success, or an error message on errors.
470 Session identifier for successful logins
474 =item customer_info HASHREF
476 Returns general customer information.
478 Takes a hash reference as parameter with a single key: B<session_id>
480 Returns a hash reference with the following keys:
494 Array reference of hash references of open inoices. Each hash reference has
495 the following keys: invnum, date, owed
499 An HTML fragment containing shipping and billing addresses.
501 =item The following fields are also returned
503 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
507 =item edit_info HASHREF
509 Takes a hash reference as parameter with any of the following keys:
511 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
513 If a field exists, the customer record is updated with the new value of that
514 field. If a field does not exist, that field is not changed on the customer
517 Returns a hash reference with a single key, B<error>, empty on success, or an
518 error message on errors
520 =item invoice HASHREF
522 Returns an invoice. Takes a hash reference as parameter with two keys:
523 session_id and invnum
525 Returns a hash reference with the following keys:
531 Empty on success, or an error message on errors
543 =item list_invoices HASHREF
545 Returns a list of all customer invoices. Takes a hash reference with a single
548 Returns a hash reference with the following keys:
554 Empty on success, or an error message on errors
558 Reference to array of hash references with the following keys:
568 Invoice date, in UNIX epoch time
574 =item list_payby HASHREF
576 Returns a list of all stored customer payment information (credit cards and
577 electronic check accounts). Takes a hash reference with a single key,
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:
598 Numeric weighting. Stored payment information with a lower weight is attempted
603 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
604 (on-demand credit card) or DCHK (on-demand electronic check).
608 Masked credit card number (or, masked account and routing numbers)
612 Credit card expiration date
616 Exact name on card (or bank name, for electronic checks)
620 For electronic checks, bank state
624 For electronic checks, account type (Personal/Business, Checking/Savings)
630 =item insert_payby HASHREF
632 Adds new stored payment information for this customer. Takes a hash reference
633 with the following keys:
641 Numeric weighting. Stored payment information with a lower weight is attempted
646 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
647 (on-demand credit card) or DCHK (on-demand electronic check).
651 Credit card number (or electronic check "account@routing")
655 CVV2 number / security code
659 Credit card expiration date
663 Exact name on card (or bank name, for electronic checks)
667 For electronic checks, bank state
671 For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A
675 Optional IP address from which payment was submitted
679 If there is an error, returns a hash reference with a single key, B<error>,
680 otherwise returns a hash reference with a single key, B<custpaybynum>.
682 =item delete_payby HASHREF
684 Removes stored payment information. Takes a hash reference with two keys,
685 B<session_id> and B<custpaybynum>. Returns a hash reference with a single key,
686 B<error>, which is an error message or empty for successful removal.
690 Cancels this customer.
692 Takes a hash reference as parameter with a single key: B<session_id>
694 Returns a hash reference with a single key, B<error>, which is empty on
695 success or an error message on errors.
697 =item payment_info HASHREF
699 Returns information that may be useful in displaying a payment page.
701 Takes a hash reference as parameter with a single key: B<session_id>.
703 Returns a hash reference with the following keys:
709 Empty on success, or an error message on errors
717 Exact name on credit card (CARD/DCRD)
741 Customer's current default payment type.
745 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
749 For CARD/DCRD payment types, the card number
753 For CARD/DCRD payment types, expiration month
757 For CARD/DCRD payment types, expiration year
759 =item cust_main_county
761 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.
765 Array reference of all states in the current default country.
769 Hash reference of card types; keys are card types, values are the exact strings
770 passed to the process_payment function
774 #this doesn't actually work yet
778 #Unique transaction identifier (prevents multiple charges), passed to the
779 #process_payment function
783 =item process_payment HASHREF
785 Processes a payment and possible change of address or payment type. Takes a
786 hash reference as parameter with the following keys:
800 If true, address and card information entered will be saved for subsequent
805 If true, future credit card payments will be done automatically (sets payby to
806 CARD). If false, future credit card payments will be done on-demand (sets
807 payby to DCRD). This option only has meaning if B<save> is set true.
835 Two-letter country code
843 Card expiration month
851 #this doesn't actually work yet
855 #Unique transaction identifier, returned from the payment_info function.
856 #Prevents multiple charges.
860 Returns a hash reference with a single key, B<error>, empty on success, or an
861 error message on errors.
863 =item process_payment_order_pkg
865 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
866 payment processes sucessfully, the package is ordered. Takes a hash reference
867 as parameter with the keys of both methods.
869 Returns a hash reference with a single key, B<error>, empty on success, or an
870 error message on errors.
872 =item process_payment_change_pkg
874 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
875 payment processes sucessfully, the package is ordered. Takes a hash reference
876 as parameter with the keys of both methods.
878 Returns a hash reference with a single key, B<error>, empty on success, or an
879 error message on errors.
882 =item process_payment_order_renew
884 Combines the B<process_payment> and B<order_renew> functions in one step. If
885 the payment processes sucessfully, the renewal is processed. Takes a hash
886 reference as parameter with the keys of both methods.
888 Returns a hash reference with a single key, B<error>, empty on success, or an
889 error message on errors.
893 Returns package information for this customer. For more detail on services,
896 Takes a hash reference as parameter with a single key: B<session_id>
898 Returns a hash reference containing customer package information. The hash reference contains the following keys:
908 Empty on success, or an error message on errors.
910 =item cust_pkg HASHREF
912 Array reference of hash references, each of which has the fields of a cust_pkg
913 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
914 the internal FS:: objects, but hash references of columns and values.
918 =item part_pkg fields
920 All fields of part_pkg for this specific cust_pkg (be careful with this
921 information - it may reveal more about your available packages than you would
922 like users to know in aggregate)
926 #XXX pare part_pkg fields down to a more secure subset
930 An array of hash references indicating information on unprovisioned services
931 available for provisioning for this specific cust_pkg. Each has the following
936 =item part_svc fields
938 All fields of part_svc (be careful with this information - it may reveal more
939 about your available packages than you would like users to know in aggregate)
943 #XXX pare part_svc fields down to a more secure subset
949 An array of hash references indicating information on the customer services
950 already provisioned for this specific cust_pkg. Each has the following keys:
956 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.
962 Primary key for this service
966 Service definition (see L<FS::part_svc>)
970 Customer package (see L<FS::cust_pkg>)
974 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
982 Returns service information for this customer.
984 Takes a hash reference as parameter with a single key: B<session_id>
986 Returns a hash reference containing customer package information. The hash reference contains the following keys:
996 An array of hash references indicating information on all of this customer's
997 services. Each has the following keys:
1003 Primary key for this service
1007 Name of this service
1011 Meaningful user-specific identifier for the service (i.e. username, domain, or
1016 Account (svc_acct) services also have the following keys:
1034 Upload bytes remaining
1038 Download bytes remaining
1042 Total bytes remaining
1044 =item recharge_amount
1048 =item recharge_seconds
1050 Number of seconds gained by recharge
1052 =item recharge_upbytes
1054 Number of upload bytes gained by recharge
1056 =item recharge_downbytes
1058 Number of download bytes gained by recharge
1060 =item recharge_totalbytes
1062 Number of total bytes gained by recharge
1070 Orders a package for this customer.
1072 Takes a hash reference as parameter with the following keys:
1082 Package to order (see L<FS::part_pkg>).
1086 Quantity for this package order (default 1).
1090 Optional locationnum for this package order, for existing locations.
1092 Or, for new locations, pass the following fields: address1*, address2, city*,
1093 county, state*, zip*, country. (* = required in this case)
1105 Service to order (see L<FS::part_svc>).
1107 Normally optional; required only to provision a non-svc_acct service, or if the
1108 package definition does not contain one svc_acct service definition with
1109 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1110 also be specified to indicate that no initial service should be provisioned.
1114 Fields used when provisioning an svc_acct service:
1128 Optional security phrase
1132 Optional Access number number
1136 Fields used when provisioning an svc_domain service:
1146 Fields used when provisioning an svc_phone service:
1164 Fields used when provisioning an svc_external service:
1170 External numeric ID.
1174 External text title.
1178 Fields used when provisioning an svc_pbx service:
1192 Returns a hash reference with a single key, B<error>, empty on success, or an
1193 error message on errors. The special error '_decline' is returned for
1194 declined transactions.
1198 Changes a package for this customer.
1200 Takes a hash reference as parameter with the following keys:
1210 Existing customer package.
1214 New package to order (see L<FS::part_pkg>).
1218 Quantity for this package order (default 1).
1222 Returns a hash reference with the following keys:
1228 Empty on success, or an error message on errors.
1232 On success, the new pkgnum
1239 Provides useful info for early renewals.
1241 Takes a hash reference as parameter with the following keys:
1251 Returns a hash reference. On errors, it contains a single key, B<error>, with
1252 the error message. Otherwise, contains a single key, B<dates>, pointing to
1253 an array refernce of hash references. Each hash reference contains the
1260 (Future) Bill date. Indicates a future date for which billing could be run.
1261 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1264 =item bill_date_pretty
1266 (Future) Bill date as a human-readable string. (Convenience for display;
1267 subject to change, so best not to parse for the date.)
1271 Base amount which will be charged if renewed early as of this date.
1275 Renewal date; i.e. even-futher future date at which the customer will be paid
1276 through if the early renewal is completed with the given B<bill-date>.
1277 Specified as a integer UNIX timestamp.
1279 =item renew_date_pretty
1281 Renewal date as a human-readable string. (Convenience for display;
1282 subject to change, so best not to parse for the date.)
1286 Package that will be renewed.
1290 Expiration date of the package that will be renewed.
1292 =item expire_date_pretty
1294 Expiration date of the package that will be renewed, as a human-readable
1295 string. (Convenience for display; subject to change, so best not to parse for
1302 Renews this customer early; i.e. runs billing for this customer in advance.
1304 Takes a hash reference as parameter with the following keys:
1314 Integer date as returned by the B<renew_info> function, indicating the advance
1315 date for which to run billing.
1319 Returns a hash reference with a single key, B<error>, empty on success, or an
1320 error message on errors.
1324 Cancels a package for this customer.
1326 Takes a hash reference as parameter with the following keys:
1336 pkgpart of package to cancel
1340 Returns a hash reference with a single key, B<error>, empty on success, or an
1341 error message on errors.
1343 =item provision_acct
1345 Provisions an account (svc_acct).
1347 Takes a hash reference as parameter with the following keys:
1357 pkgnum of package into which this service is provisioned
1361 svcpart or service definition to provision
1371 =item provision_phone
1373 Provisions a phone number (svc_phone).
1375 Takes a hash reference as parameter with the following keys:
1385 pkgnum of package into which this service is provisioned
1389 svcpart or service definition to provision
1409 E911 Address (optional)
1415 Provisions a customer PBX (svc_pbx).
1417 Takes a hash reference as parameter with the following keys:
1427 pkgnum of package into which this service is provisioned
1431 svcpart or service definition to provision
1437 =item max_extensions
1439 =item max_simultaneous
1445 =item provision_external
1447 Provisions an external service (svc_external).
1449 Takes a hash reference as parameter with the following keys:
1459 pkgnum of package into which this service is provisioned
1463 svcpart or service definition to provision
1473 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1477 =item contact_passwd
1479 Changes the password for the currently-logged in contact.
1481 Takes a hash reference as parameter with the following keys:
1491 Returns a hash reference with a single parameter, B<error>, which contains an
1492 error message, or empty on success.
1496 Takes a hash reference as parameter with a single key, B<session_id>.
1498 Returns a hash reference with two parameters: B<error>, which contains an error
1499 message, or empty on success, and B<contacts>, a list of contacts.
1501 B<contacts> is an array reference of hash references (i.e. an array of structs,
1502 in XML-RPC). Each hash reference (struct) has the following keys:
1510 Contact class name (contact type).
1522 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1526 Comma-separated list of email addresses
1530 =item selfservice_access
1538 Updates information for the currently-logged in contact, or (optionally) the
1541 Takes a hash reference as parameter with the following keys:
1549 If already logged in as a contact, this is optional.
1559 Returns a hash reference with a single parameter, B<error>, which contains an
1560 error message, or empty on success.
1564 Creates a new contact.
1566 Takes a hash reference as parameter with the following keys:
1580 Optional contact classnum (TODO: or name)
1584 =item selfservice_access
1586 Y to enable self-service access
1592 Returns a hash reference with a single parameter, B<error>, which contains an
1593 error message, or empty on success.
1595 =item delete_contact
1597 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1600 Takes a hash reference as parameter with the following keys:
1610 Returns a hash reference with a single parameter, B<error>, which contains an
1611 error message, or empty on success.
1613 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1615 All of these functions require the user to be logged in, and the 'session_id'
1616 key to be included in the argument hashref.`
1620 =item list_quotations HASHREF
1622 Returns a hashref listing this customer's active self-service quotations.
1629 an arrayref containing an element for each quotation.
1637 the date it was started
1641 the number of packages
1645 the sum of setup fees
1649 the sum of recurring charges
1653 =item quotation_new HASHREF
1655 Creates an empty quotation and returns a hashref containing 'quotationnum',
1656 the primary key of the new quotation.
1658 =item quotation_delete HASHREF
1660 Disables (does not really delete) a quotation. Takes the following arguments:
1666 =item quotationnum - the quotation to delete
1670 Returns 'error' => a string, which will be empty on success.
1672 =item quotation_info HASHREF
1674 Returns total and detailed pricing information on a quotation.
1676 Takes the following arguments:
1682 =item quotationnum - the quotation to return
1686 Returns a hashref containing:
1688 - total_setup, the total of setup fees (and their taxes)
1689 - total_recur, the total of all recurring charges (and their taxes)
1690 - sections, an arrayref containing an element for each quotation section.
1691 - description, a line of text describing the group of charges
1692 - subtotal, the total of charges in this group (if appropriate)
1693 - detail_items, an arrayref of line items
1694 - pkgnum, the reference number of the package
1695 - description, the package name (or tax name)
1697 - amount, the amount charged
1698 If the detail item represents a subtotal, it will instead contain:
1699 - total_item: description of the subtotal
1700 - total_amount: the subtotal amount
1703 =item quotation_print HASHREF
1705 Renders the quotation as HTML or PDF. Takes the following arguments:
1711 =item quotationnum - the quotation to return
1713 =item format - 'html' or 'pdf'
1717 Returns a hashref containing 'document', the contents of the file.
1719 =item quotation_add_pkg HASHREF
1721 Adds a package to a quotation. Takes the following arguments:
1727 =item pkgpart - the package to add
1729 =item quotationnum - the quotation to add it to
1731 =item quantity - the package quantity (defaults to 1)
1733 =item address1, address2, city, state, zip, country - address fields to set
1734 the service location
1738 Returns 'error' => a string, which will be empty on success.
1740 =item quotation_remove_pkg HASHREF
1742 Removes a package from a quotation. Takes the following arguments:
1748 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1750 =item quotationnum - the quotation to remove it from
1754 Returns 'error' => a string, which will be empty on success.
1758 =item quotation_order HASHREF
1760 Converts the packages in a quotation into real packages. Takes the following
1763 Takes the following arguments:
1769 =item quotationnum - the quotation to order
1775 =head1 SIGNUP FUNCTIONS
1779 =item signup_info HASHREF
1781 Takes a hash reference as parameter with the following keys:
1785 =item session_id - Optional agent/reseller interface session
1789 Returns a hash reference containing information that may be useful in
1790 displaying a signup page. The hash reference contains the following keys:
1794 =item cust_main_county
1796 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.
1800 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
1801 an agentnum specified explicitly via reseller interface session_id in the
1806 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.
1808 =item agentnum2part_pkg
1810 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.
1814 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.
1816 =item security_phrase
1818 True if the "security_phrase" feature is enabled
1822 Array reference of acceptable payment types for signup
1828 credit card - automatic
1832 credit card - on-demand - version 1.5+ only
1836 electronic check - automatic
1840 electronic check - on-demand - version 1.5+ only
1848 billing, not recommended for signups
1852 free, definitely not recommended for signups
1856 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1862 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1866 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".
1872 =item countrydefault
1878 =item new_customer_minimal HASHREF
1880 Creates a new customer.
1882 Current differences from new_customer: An address is not required. promo_code
1883 and reg_code are not supported. If invoicing_list and _password is passed, a
1884 contact will be created with self-service access (no pkgpart or username is
1885 necessary). No initial billing is run (this may change in a future version).
1887 Takes a hash reference as parameter with the following keys:
1893 first name (required)
1897 last name (required)
1901 (not typically collected; mostly used for ACH transactions)
1933 Daytime phone number
1937 Evening phone number
1945 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1949 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1953 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1957 Expiration date for CARD/DCRD
1961 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1963 =item invoicing_list
1965 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),
1967 =item referral_custnum
1969 referring customer number
1977 pkgpart of initial package
1993 Access number (index, not the literal number)
1997 Country code (to be provisioned as a service)
2001 Phone number (to be provisioned as a service)
2009 Returns a hash reference with the following keys:
2015 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)
2019 =item new_customer HASHREF
2021 Creates a new customer. Takes a hash reference as parameter with the
2028 first name (required)
2032 last name (required)
2036 (not typically collected; mostly used for ACH transactions)
2042 =item address1 (required)
2050 =item city (required)
2058 =item state (required)
2062 =item zip (required)
2068 Daytime phone number
2072 Evening phone number
2080 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2084 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2088 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2092 Expiration date for CARD/DCRD
2096 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2098 =item invoicing_list
2100 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),
2102 =item referral_custnum
2104 referring customer number
2112 pkgpart of initial package
2128 Access number (index, not the literal number)
2132 Country code (to be provisioned as a service)
2136 Phone number (to be provisioned as a service)
2144 Returns a hash reference with the following keys:
2150 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)
2154 =item regionselector HASHREF | LIST
2156 Takes as input a hashref or list of key/value pairs with the following keys:
2160 =item selected_county
2162 Currently selected county
2164 =item selected_state
2166 Currently selected state
2168 =item selected_country
2170 Currently selected country
2174 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2178 Specify a javascript subroutine to call on changes
2184 =item default_country
2190 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>.
2194 Returns a list consisting of three HTML fragments for county selection,
2195 state selection and country selection, respectively.
2199 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2200 sub regionselector {
2207 $param->{'selected_country'} ||= $param->{'default_country'};
2208 $param->{'selected_state'} ||= $param->{'default_state'};
2210 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2214 my %cust_main_county;
2216 # unless ( @cust_main_county ) { #cache
2217 #@cust_main_county = qsearch('cust_main_county', {} );
2218 #foreach my $c ( @cust_main_county ) {
2219 foreach my $c ( @{ $param->{'locales'} } ) {
2220 #$countyflag=1 if $c->county;
2221 $countyflag=1 if $c->{county};
2222 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2223 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2224 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2227 $countyflag=1 if $param->{selected_county};
2229 my $script_html = <<END;
2231 function opt(what,value,text) {
2232 var optionName = new Option(text, value, false, false);
2233 var length = what.length;
2234 what.options[length] = optionName;
2236 function ${prefix}country_changed(what) {
2237 country = what.options[what.selectedIndex].text;
2238 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2239 what.form.${prefix}state.options[i] = null;
2241 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2243 foreach my $country ( sort keys %cust_main_county ) {
2244 $script_html .= "\nif ( country == \"$country\" ) {\n";
2245 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2246 my $text = $state || '(n/a)';
2247 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2249 $script_html .= "}\n";
2252 $script_html .= <<END;
2254 function ${prefix}state_changed(what) {
2257 if ( $countyflag ) {
2258 $script_html .= <<END;
2259 state = what.options[what.selectedIndex].text;
2260 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2261 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2262 what.form.${prefix}county.options[i] = null;
2265 foreach my $country ( sort keys %cust_main_county ) {
2266 $script_html .= "\nif ( country == \"$country\" ) {\n";
2267 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2268 $script_html .= "\nif ( state == \"$state\" ) {\n";
2269 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2270 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2271 my $text = $county || '(n/a)';
2273 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2275 $script_html .= "}\n";
2277 $script_html .= "}\n";
2281 $script_html .= <<END;
2286 my $county_html = $script_html;
2287 if ( $countyflag ) {
2288 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2289 foreach my $county (
2290 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2292 my $text = $county || '(n/a)';
2293 $county_html .= qq!<OPTION VALUE="$county"!.
2294 ($county eq $param->{'selected_county'} ?
2301 $county_html .= '</SELECT>';
2304 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2307 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2308 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2309 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2310 my $text = $state || '(n/a)';
2311 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2312 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2314 $state_html .= '</SELECT>';
2316 my $country_html = '';
2317 if ( scalar( keys %cust_main_county ) > 1 ) {
2319 $country_html = qq(<SELECT NAME="${prefix}country" ).
2320 qq(onChange="${prefix}country_changed(this); ).
2321 $param->{'onchange'}.
2324 my $countrydefault = $param->{default_country} || 'US';
2325 foreach my $country (
2326 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2327 keys %cust_main_county
2329 my $selected = $country eq $param->{'selected_country'}
2332 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2334 $country_html .= '</SELECT>';
2337 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2338 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2342 ($county_html, $state_html, $country_html);
2346 sub regionselector_hashref {
2347 my ($county_html, $state_html, $country_html) = regionselector(@_);
2349 'county_html' => $county_html,
2350 'state_html' => $state_html,
2351 'country_html' => $country_html,
2355 =item location_form HASHREF | LIST
2357 Takes as input a hashref or list of key/value pairs with the following keys:
2363 Current customer session_id
2367 Omit red asterisks from required fields.
2369 =item address1_label
2371 Label for first address line.
2375 Returns an HTML fragment for a location form (address, city, state, zip,
2388 my $session_id = delete $param->{'session_id'};
2390 my $rv = mason_comp( 'session_id' => $session_id,
2391 'comp' => '/elements/location.html',
2392 'args' => [ %$param ],
2396 $rv->{'error'} || $rv->{'output'};
2401 #=item expselect HASHREF | LIST
2403 #Takes as input a hashref or list of key/value pairs with the following keys:
2407 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2409 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2413 =item expselect PREFIX [ DATE ]
2415 Takes as input a unique prefix string and the current expiration date, in
2416 yyyy-mm-dd or m-d-yyyy format
2418 Returns an HTML fragments for expiration date selection.
2424 #if ( ref($_[0]) ) {
2428 #my $prefix = $param->{'prefix'};
2429 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2430 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2432 my $date = scalar(@_) ? shift : '';
2434 my( $m, $y ) = ( 0, 0 );
2435 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2436 ( $m, $y ) = ( $2, $1 );
2437 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2438 ( $m, $y ) = ( $1, $3 );
2440 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2442 $return .= qq!<OPTION VALUE="$_"!;
2443 $return .= " SELECTED" if $_ == $m;
2446 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2448 my $thisYear = $t[5] + 1900;
2449 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2450 $return .= qq!<OPTION VALUE="$_"!;
2451 $return .= " SELECTED" if $_ == $y;
2454 $return .= "</SELECT>";
2459 =item popselector HASHREF | LIST
2461 Takes as input a hashref or list of key/value pairs with the following keys:
2467 Access number number
2471 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>.
2475 Returns an HTML fragment for access number selection.
2479 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2487 my $popnum = $param->{'popnum'};
2488 my $pops = $param->{'pops'};
2490 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2491 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2492 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2493 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2494 if scalar(@$pops) == 1;
2497 my %popnum2pop = ();
2499 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2500 $popnum2pop{$_->{popnum}} = $_;
2505 function opt(what,href,text) {
2506 var optionName = new Option(text, href, false, false)
2507 var length = what.length;
2508 what.options[length] = optionName;
2512 my $init_popstate = $param->{'init_popstate'};
2513 if ( $init_popstate ) {
2514 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2515 $init_popstate. '">';
2518 function acstate_changed(what) {
2519 state = what.options[what.selectedIndex].text;
2520 what.form.popac.options.length = 0
2521 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2525 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2526 foreach my $state ( sort { $a cmp $b } @states ) {
2527 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2529 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2530 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2531 if ($ac eq $param->{'popac'}) {
2532 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2535 $text .= "}\n" unless $init_popstate;
2537 $text .= "popac_changed(what.form.popac)}\n";
2540 function popac_changed(what) {
2541 ac = what.options[what.selectedIndex].text;
2542 what.form.popnum.options.length = 0;
2543 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2547 foreach my $state ( @states ) {
2548 foreach my $popac ( keys %{ $pop{$state} } ) {
2549 $text .= "\nif ( ac == \"$popac\" ) {\n";
2551 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2552 my $o_popnum = $pop->{popnum};
2553 my $poptext = $pop->{city}. ', '. $pop->{state}.
2554 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2556 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2557 if ($popnum == $o_popnum) {
2558 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2566 $text .= "}\n</SCRIPT>\n";
2568 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2571 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2572 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2573 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2574 ">$_" foreach sort { $a cmp $b } @states;
2575 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2578 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2579 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2581 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2584 #comment this block to disable initial list polulation
2585 my @initial_select = ();
2586 if ( scalar( @$pops ) > 100 ) {
2587 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2589 @initial_select = @$pops;
2591 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2592 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2593 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2594 $pop->{city}. ', '. $pop->{state}.
2595 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2598 $text .= qq!</SELECT></TD></TR></TABLE>!;
2604 =item domainselector HASHREF | LIST
2606 Takes as input a hashref or list of key/value pairs with the following keys:
2616 Service number of the selected item.
2620 Returns an HTML fragment for domain selection.
2624 sub domainselector {
2631 my $domsvc= $param->{'domsvc'};
2633 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2634 my $domains = $rv->{'domains'};
2635 $domsvc = $rv->{'domsvc'} unless $domsvc;
2637 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2638 unless scalar(keys %$domains);
2640 if (scalar(keys %$domains) == 1) {
2642 foreach(keys %$domains) {
2645 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2646 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2649 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2651 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2653 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2654 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2655 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2656 $domains->{$domain};
2659 $text .= qq!</SELECT></TD></TR>!;
2665 =item didselector HASHREF | LIST
2667 Takes as input a hashref or list of key/value pairs with the following keys:
2673 Field name for the returned HTML fragment.
2677 Service definition (see L<FS::part_svc>)
2681 Returns an HTML fragment for DID selection.
2693 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2694 'args'=>[ %$param ],
2698 $rv->{'error'} || $rv->{'output'};
2704 =head1 RESELLER FUNCTIONS
2706 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2707 with their active session, and the B<customer_info> and B<order_pkg> functions
2708 with their active session and an additional I<custnum> parameter.
2710 For the most part, development of the reseller web interface has been
2711 superceded by agent-virtualized access to the backend.
2723 =item agent_list_customers
2725 List agent's customers.
2733 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>