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 'new_prospect' => 'Signup/new_prospect',
116 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
117 'new_agent' => 'Agent/new_agent',
118 'agent_login' => 'Agent/agent_login',
119 'agent_logout' => 'Agent/agent_logout',
120 'agent_info' => 'Agent/agent_info',
121 'agent_list_customers' => 'Agent/agent_list_customers',
122 'check_username' => 'Agent/check_username',
123 'suspend_username' => 'Agent/suspend_username',
124 'unsuspend_username' => 'Agent/unsuspend_username',
125 'mason_comp' => 'MasonComponent/mason_comp',
126 'call_time' => 'PrepaidPhone/call_time',
127 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
128 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
130 'start_thirdparty' => 'MyAccount/start_thirdparty',
131 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
133 'list_quotations' => 'MyAccount/quotation/list_quotations',
134 'quotation_new' => 'MyAccount/quotation/quotation_new',
135 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
136 'quotation_info' => 'MyAccount/quotation/quotation_info',
137 'quotation_print' => 'MyAccount/quotation/quotation_print',
138 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
139 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
140 'quotation_order' => 'MyAccount/quotation/quotation_order',
142 'freesideinc_service' => 'Freeside/freesideinc_service',
147 qw( regionselector regionselector_hashref location_form
148 expselect popselector domainselector didselector
152 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
153 $ENV{'SHELL'} = '/bin/sh';
154 $ENV{'IFS'} = " \t\n";
157 $ENV{'BASH_ENV'} = '';
159 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
160 #if you grant appropriate permissions to whatever user
161 my $freeside_uid = scalar(getpwnam('freeside'));
162 die "not running as the freeside user\n"
163 if $> != $freeside_uid && ! $skip_uid_check;
165 -e $dir or die "FATAL: $dir doesn't exist!";
166 -d $dir or die "FATAL: $dir isn't a directory!";
167 -r $dir or die "FATAL: Can't read $dir as freeside user!";
168 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
170 foreach my $autoload ( keys %autoload ) {
173 "sub $autoload { ". '
178 #warn scalar(@_). ": ". join(" / ", @_);
182 $param->{_packet} = \''. $autoload{$autoload}. '\';
184 simple_packet($param);
194 warn "sending ". $packet->{_packet}. " to server"
196 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
197 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
198 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
201 #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
203 #block until there is a message on socket
204 # my $w = new IO::Select;
206 # my @wait = $w->can_read;
208 warn "reading message from server"
211 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
212 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
214 warn "returning message to client"
222 FS::SelfService - Freeside self-service API
226 # password and shell account changes
227 use FS::SelfService qw(passwd chfn chsh);
229 # "my account" functionality
230 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
232 #new-style login with an email address and password
233 # can also be used for svc_acct login, set $emailaddress to username@domain
234 my $rv = login ( { 'email' => $emailaddress,
235 'password' => $password,
238 if ( $rv->{'error'} ) {
239 #handle login error...
242 $session_id = $rv->{'session_id'};
245 #classic svc_acct-based login with separate username and password
246 my $rv = login( { 'username' => $username,
248 'password' => $password,
251 if ( $rv->{'error'} ) {
252 #handle login error...
255 $session_id = $rv->{'session_id'};
258 #svc_phone login with phone number and PIN
259 my $rv = login( { 'username' => $phone_number,
260 'domain' => 'svc_phone',
264 if ( $rv->{'error'} ) {
265 #handle login error...
268 $session_id = $rv->{'session_id'};
271 my $customer_info = customer_info( { 'session_id' => $session_id } );
273 #payment_info and process_payment are available in 1.5+ only
274 my $payment_info = payment_info( { 'session_id' => $session_id } );
276 #!!! process_payment example
278 #!!! list_pkgs example
280 #ordering a package with an svc_acct service
281 my $rv = order_pkg( { 'session_id' => $session_id,
282 'pkgpart' => $pkgpart,
283 'svcpart' => $svcpart,
284 'username' => $username,
285 'domsvc' => $domsvc, #svcnum of svc_domain
286 '_password' => $password,
290 #!!! ordering a package with an svc_domain service example
292 #!!! ordering a package with an svc_phone service example
294 #!!! ordering a package with an svc_external service example
296 #!!! ordering a package with an svc_pbx service
298 #ordering a package with no service
299 my $rv = order_pkg( { 'session_id' => $session_id,
300 'pkgpart' => $pkgpart,
305 #quoting a package, then ordering after confirmation
307 my $rv = quotation_new({ 'session_id' => $session_id });
308 my $qnum = $rv->{quotationnum};
309 # add packages to the quotation
310 $rv = quotation_add_pkg({ 'session_id' => $session_id,
311 'quotationnum' => $qnum,
312 'pkgpart' => $pkgpart,
313 'quantity' => $quantity, # defaults to 1
315 # repeat until all packages are added
316 # view the pricing information
317 $rv = quotation_info({ 'session_id' => $session_id,
318 'quotationnum' => $qnum,
320 print "Total setup charges: ".$rv->{total_setup}."\n".
321 "Total recurring charges: ".$rv->{total_recur}."\n";
322 # quotation_info also provides a detailed breakdown of charges, in
325 # ask customer for confirmation, then:
326 $rv = quotation_order({ 'session_id' => $session_id,
327 'quotationnum' => $qnum,
330 #!!! cancel_pkg example
332 # signup functionality
333 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
335 my $signup_info = signup_info;
337 $rv = new_customer( {
340 'company' => $company,
341 'address1' => $address1,
342 'address2' => $address2,
346 'country' => $country,
347 'daytime' => $daytime,
351 'payinfo' => $payinfo,
353 'paystart_month' => $paystart_month
354 'paystart_year' => $paystart_year,
355 'payissue' => $payissue,
357 'paydate' => $paydate,
358 'payname' => $payname,
359 'invoicing_list' => $invoicing_list,
360 'referral_custnum' => $referral_custnum,
361 'agentnum' => $agentnum,
362 'pkgpart' => $pkgpart,
364 'username' => $username,
365 '_password' => $password,
369 'phonenum' => $phonenum,
374 my $error = $rv->{'error'};
375 if ( $error eq '_decline' ) {
385 Use this API to implement your own client "self-service" module.
387 If you just want to customize the look of the existing "self-service" module,
390 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
396 Changes the password for an existing user in svc_acct. Takes a hash
397 reference with the following keys:
403 Username of the account (required)
407 Domain of the account (required)
411 Old password (required)
415 New password (required)
433 =head1 "MY ACCOUNT" FUNCTIONS
439 Creates a user session. Takes a hash reference as parameter with the
446 Email address (username@domain), instead of username and domain. Required for
447 contact-based self-service login, can also be used for svc_acct-based login.
463 Returns a hash reference with the following keys:
469 Empty on success, or an error message on errors.
473 Session identifier for successful logins
477 =item customer_info HASHREF
479 Returns general customer information.
481 Takes a hash reference as parameter with a single key: B<session_id>
483 Returns a hash reference with the following keys:
497 Array reference of hash references of open inoices. Each hash reference has
498 the following keys: invnum, date, owed
502 An HTML fragment containing shipping and billing addresses.
504 =item The following fields are also returned
506 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
510 =item edit_info HASHREF
512 Takes a hash reference as parameter with any of the following keys:
514 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
516 If a field exists, the customer record is updated with the new value of that
517 field. If a field does not exist, that field is not changed on the customer
520 Returns a hash reference with a single key, B<error>, empty on success, or an
521 error message on errors
523 =item invoice HASHREF
525 Returns an invoice. Takes a hash reference as parameter with two keys:
526 session_id and invnum
528 Returns a hash reference with the following keys:
534 Empty on success, or an error message on errors
546 =item list_invoices HASHREF
548 Returns a list of all customer invoices. Takes a hash reference with a single
551 Returns a hash reference with the following keys:
557 Empty on success, or an error message on errors
561 Reference to array of hash references with the following keys:
571 Invoice date, in UNIX epoch time
577 =item list_payby HASHREF
579 Returns a list of all stored customer payment information (credit cards and
580 electronic check accounts). Takes a hash reference with a single key,
583 Returns a hash reference with the following keys:
589 Empty on success, or an error message on errors
593 Reference to array of hash references with the following keys:
601 Numeric weighting. Stored payment information with a lower weight is attempted
606 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
607 (on-demand credit card) or DCHK (on-demand electronic check).
611 Masked credit card number (or, masked account and routing numbers)
615 Credit card expiration date
619 Exact name on card (or bank name, for electronic checks)
623 For electronic checks, bank state
627 For electronic checks, account type (Personal/Business, Checking/Savings)
633 =item insert_payby HASHREF
635 Adds new stored payment information for this customer. Takes a hash reference
636 with the following keys:
644 Numeric weighting. Stored payment information with a lower weight is attempted
649 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
650 (on-demand credit card) or DCHK (on-demand electronic check).
654 Credit card number (or electronic check "account@routing")
658 CVV2 number / security code
662 Credit card expiration date
666 Exact name on card (or bank name, for electronic checks)
670 For electronic checks, bank state
674 For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A
678 Optional IP address from which payment was submitted
682 If there is an error, returns a hash reference with a single key, B<error>,
683 otherwise returns a hash reference with a single key, B<custpaybynum>.
685 =item delete_payby HASHREF
687 Removes stored payment information. Takes a hash reference with two keys,
688 B<session_id> and B<custpaybynum>. Returns a hash reference with a single key,
689 B<error>, which is an error message or empty for successful removal.
693 Cancels this customer.
695 Takes a hash reference as parameter with a single key: B<session_id>
697 Returns a hash reference with a single key, B<error>, which is empty on
698 success or an error message on errors.
700 =item payment_info HASHREF
702 Returns information that may be useful in displaying a payment page.
704 Takes a hash reference as parameter with a single key: B<session_id>.
706 Returns a hash reference with the following keys:
712 Empty on success, or an error message on errors
720 Exact name on credit card (CARD/DCRD)
744 Customer's current default payment type.
748 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
752 For CARD/DCRD payment types, the card number
756 For CARD/DCRD payment types, expiration month
760 For CARD/DCRD payment types, expiration year
762 =item cust_main_county
764 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.
768 Array reference of all states in the current default country.
772 Hash reference of card types; keys are card types, values are the exact strings
773 passed to the process_payment function
777 #this doesn't actually work yet
781 #Unique transaction identifier (prevents multiple charges), passed to the
782 #process_payment function
786 =item process_payment HASHREF
788 Processes a payment and possible change of address or payment type. Takes a
789 hash reference as parameter with the following keys:
803 If true, address and card information entered will be saved for subsequent
808 If true, future credit card payments will be done automatically (sets payby to
809 CARD). If false, future credit card payments will be done on-demand (sets
810 payby to DCRD). This option only has meaning if B<save> is set true.
838 Two-letter country code
846 Card expiration month
854 #this doesn't actually work yet
858 #Unique transaction identifier, returned from the payment_info function.
859 #Prevents multiple charges.
863 Returns a hash reference with a single key, B<error>, empty on success, or an
864 error message on errors.
866 =item process_payment_order_pkg
868 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
869 payment processes sucessfully, the package is ordered. Takes a hash reference
870 as parameter with the keys of both methods.
872 Returns a hash reference with a single key, B<error>, empty on success, or an
873 error message on errors.
875 =item process_payment_change_pkg
877 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
878 payment processes sucessfully, the package is ordered. Takes a hash reference
879 as parameter with the keys of both methods.
881 Returns a hash reference with a single key, B<error>, empty on success, or an
882 error message on errors.
885 =item process_payment_order_renew
887 Combines the B<process_payment> and B<order_renew> functions in one step. If
888 the payment processes sucessfully, the renewal is processed. Takes a hash
889 reference as parameter with the keys of both methods.
891 Returns a hash reference with a single key, B<error>, empty on success, or an
892 error message on errors.
896 Returns package information for this customer. For more detail on services,
899 Takes a hash reference as parameter with a single key: B<session_id>
901 Returns a hash reference containing customer package information. The hash reference contains the following keys:
911 Empty on success, or an error message on errors.
913 =item cust_pkg HASHREF
915 Array reference of hash references, each of which has the fields of a cust_pkg
916 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
917 the internal FS:: objects, but hash references of columns and values.
921 =item part_pkg fields
923 All fields of part_pkg for this specific cust_pkg (be careful with this
924 information - it may reveal more about your available packages than you would
925 like users to know in aggregate)
929 #XXX pare part_pkg fields down to a more secure subset
933 An array of hash references indicating information on unprovisioned services
934 available for provisioning for this specific cust_pkg. Each has the following
939 =item part_svc fields
941 All fields of part_svc (be careful with this information - it may reveal more
942 about your available packages than you would like users to know in aggregate)
946 #XXX pare part_svc fields down to a more secure subset
952 An array of hash references indicating information on the customer services
953 already provisioned for this specific cust_pkg. Each has the following keys:
959 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.
965 Primary key for this service
969 Service definition (see L<FS::part_svc>)
973 Customer package (see L<FS::cust_pkg>)
977 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
985 Returns service information for this customer.
987 Takes a hash reference as parameter with a single key: B<session_id>
989 Returns a hash reference containing customer package information. The hash reference contains the following keys:
999 An array of hash references indicating information on all of this customer's
1000 services. Each has the following keys:
1006 Primary key for this service
1010 Name of this service
1014 Meaningful user-specific identifier for the service (i.e. username, domain, or
1019 Account (svc_acct) services also have the following keys:
1037 Upload bytes remaining
1041 Download bytes remaining
1045 Total bytes remaining
1047 =item recharge_amount
1051 =item recharge_seconds
1053 Number of seconds gained by recharge
1055 =item recharge_upbytes
1057 Number of upload bytes gained by recharge
1059 =item recharge_downbytes
1061 Number of download bytes gained by recharge
1063 =item recharge_totalbytes
1065 Number of total bytes gained by recharge
1073 Orders a package for this customer.
1075 Takes a hash reference as parameter with the following keys:
1085 Package to order (see L<FS::part_pkg>).
1089 Quantity for this package order (default 1).
1093 Optional locationnum for this package order, for existing locations.
1095 Or, for new locations, pass the following fields: address1*, address2, city*,
1096 county, state*, zip*, country. (* = required in this case)
1098 (None of this is required at all if you are just ordering a package
1099 at the customer's existing default service location.)
1117 Service to order (see L<FS::part_svc>).
1119 Normally optional; required only to provision a non-svc_acct service, or if the
1120 package definition does not contain one svc_acct service definition with
1121 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1122 also be specified to indicate that no initial service should be provisioned.
1126 Fields used when provisioning an svc_acct service:
1140 Optional security phrase
1144 Optional Access number number
1148 Fields used when provisioning an svc_domain service:
1158 Fields used when provisioning an svc_phone service:
1176 Fields used when provisioning an svc_external service:
1182 External numeric ID.
1186 External text title.
1190 Fields used when provisioning an svc_pbx service:
1204 Returns a hash reference with a single key, B<error>, empty on success, or an
1205 error message on errors. The special error '_decline' is returned for
1206 declined transactions.
1210 Changes a package for this customer.
1212 Takes a hash reference as parameter with the following keys:
1222 Existing customer package.
1226 New package to order (see L<FS::part_pkg>).
1230 Quantity for this package order (default 1).
1234 Returns a hash reference with the following keys:
1240 Empty on success, or an error message on errors.
1244 On success, the new pkgnum
1251 Provides useful info for early renewals.
1253 Takes a hash reference as parameter with the following keys:
1263 Returns a hash reference. On errors, it contains a single key, B<error>, with
1264 the error message. Otherwise, contains a single key, B<dates>, pointing to
1265 an array refernce of hash references. Each hash reference contains the
1272 (Future) Bill date. Indicates a future date for which billing could be run.
1273 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1276 =item bill_date_pretty
1278 (Future) Bill date as a human-readable string. (Convenience for display;
1279 subject to change, so best not to parse for the date.)
1283 Base amount which will be charged if renewed early as of this date.
1287 Renewal date; i.e. even-futher future date at which the customer will be paid
1288 through if the early renewal is completed with the given B<bill-date>.
1289 Specified as an integer UNIX timestamp.
1291 =item renew_date_pretty
1293 Renewal date as a human-readable string. (Convenience for display;
1294 subject to change, so best not to parse for the date.)
1298 Package that will be renewed.
1302 Expiration date of the package that will be renewed.
1304 =item expire_date_pretty
1306 Expiration date of the package that will be renewed, as a human-readable
1307 string. (Convenience for display; subject to change, so best not to parse for
1314 Renews this customer early; i.e. runs billing for this customer in advance.
1316 Takes a hash reference as parameter with the following keys:
1326 Integer date as returned by the B<renew_info> function, indicating the advance
1327 date for which to run billing.
1331 Returns a hash reference with a single key, B<error>, empty on success, or an
1332 error message on errors.
1336 Cancels a package for this customer.
1338 Takes a hash reference as parameter with the following keys:
1348 pkgpart of package to cancel
1352 Optional date, for future cancellation (expiration) instead of immediate
1353 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1357 Returns a hash reference with a single key, B<error>, empty on success, or an
1358 error message on errors.
1360 =item provision_acct
1362 Provisions an account (svc_acct).
1364 Takes a hash reference as parameter with the following keys:
1374 pkgnum of package into which this service is provisioned
1378 svcpart or service definition to provision
1388 =item provision_phone
1390 Provisions a phone number (svc_phone).
1392 Takes a hash reference as parameter with the following keys:
1402 pkgnum of package into which this service is provisioned
1406 svcpart or service definition to provision
1426 E911 Address (optional)
1432 Provisions a customer PBX (svc_pbx).
1434 Takes a hash reference as parameter with the following keys:
1444 pkgnum of package into which this service is provisioned
1448 svcpart or service definition to provision
1454 =item max_extensions
1456 =item max_simultaneous
1462 =item provision_external
1464 Provisions an external service (svc_external).
1466 Takes a hash reference as parameter with the following keys:
1476 pkgnum of package into which this service is provisioned
1480 svcpart or service definition to provision
1490 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1494 =item contact_passwd
1496 Changes the password for the currently-logged in contact.
1498 Takes a hash reference as parameter with the following keys:
1508 Returns a hash reference with a single parameter, B<error>, which contains an
1509 error message, or empty on success.
1513 Takes a hash reference as parameter with a single key, B<session_id>.
1515 Returns a hash reference with two parameters: B<error>, which contains an error
1516 message, or empty on success, and B<contacts>, a list of contacts.
1518 B<contacts> is an array reference of hash references (i.e. an array of structs,
1519 in XML-RPC). Each hash reference (struct) has the following keys:
1527 Contact class name (contact type).
1539 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1543 Comma-separated list of email addresses
1547 =item selfservice_access
1555 Updates information for the currently-logged in contact, or (optionally) the
1558 Takes a hash reference as parameter with the following keys:
1566 If already logged in as a contact, this is optional.
1576 Returns a hash reference with a single parameter, B<error>, which contains an
1577 error message, or empty on success.
1581 Creates a new contact.
1583 Takes a hash reference as parameter with the following keys:
1597 Optional contact classnum (TODO: or name)
1601 =item selfservice_access
1603 Y to enable self-service access
1609 Returns a hash reference with a single parameter, B<error>, which contains an
1610 error message, or empty on success.
1612 =item delete_contact
1614 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1617 Takes a hash reference as parameter with the following keys:
1627 Returns a hash reference with a single parameter, B<error>, which contains an
1628 error message, or empty on success.
1632 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1634 All of these functions require the user to be logged in, and the 'session_id'
1635 key to be included in the argument hashref.`
1639 =item list_quotations HASHREF
1641 Returns a hashref listing this customer's active self-service quotations.
1648 an arrayref containing an element for each quotation.
1656 the date it was started
1660 the number of packages
1664 the sum of setup fees
1668 the sum of recurring charges
1672 =item quotation_new HASHREF
1674 Creates an empty quotation and returns a hashref containing 'quotationnum',
1675 the primary key of the new quotation.
1677 =item quotation_delete HASHREF
1679 Disables (does not really delete) a quotation. Takes the following arguments:
1685 =item quotationnum - the quotation to delete
1689 Returns 'error' => a string, which will be empty on success.
1691 =item quotation_info HASHREF
1693 Returns total and detailed pricing information on a quotation.
1695 Takes the following arguments:
1701 =item quotationnum - the quotation to return
1705 Returns a hashref containing:
1707 - total_setup, the total of setup fees (and their taxes)
1708 - total_recur, the total of all recurring charges (and their taxes)
1709 - sections, an arrayref containing an element for each quotation section.
1710 - description, a line of text describing the group of charges
1711 - subtotal, the total of charges in this group (if appropriate)
1712 - detail_items, an arrayref of line items
1713 - pkgnum, the reference number of the package
1714 - description, the package name (or tax name)
1716 - amount, the amount charged
1717 If the detail item represents a subtotal, it will instead contain:
1718 - total_item: description of the subtotal
1719 - total_amount: the subtotal amount
1722 =item quotation_print HASHREF
1724 Renders the quotation as HTML or PDF. Takes the following arguments:
1730 =item quotationnum - the quotation to return
1732 =item format - 'html' or 'pdf'
1736 Returns a hashref containing 'document', the contents of the file.
1738 =item quotation_add_pkg HASHREF
1740 Adds a package to a quotation. Takes the following arguments:
1746 =item pkgpart - the package to add
1748 =item quotationnum - the quotation to add it to
1750 =item quantity - the package quantity (defaults to 1)
1752 =item address1, address2, city, state, zip, country - address fields to set
1753 the service location
1757 Returns 'error' => a string, which will be empty on success.
1759 =item quotation_remove_pkg HASHREF
1761 Removes a package from a quotation. Takes the following arguments:
1767 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1769 =item quotationnum - the quotation to remove it from
1773 Returns 'error' => a string, which will be empty on success.
1775 =item quotation_order HASHREF
1777 Converts the packages in a quotation into real packages. Takes the following
1780 Takes the following arguments:
1786 =item quotationnum - the quotation to order
1792 =head1 SIGNUP FUNCTIONS
1796 =item signup_info HASHREF
1798 Takes a hash reference as parameter with the following keys:
1802 =item session_id - Optional agent/reseller interface session
1806 Returns a hash reference containing information that may be useful in
1807 displaying a signup page. The hash reference contains the following keys:
1811 =item cust_main_county
1813 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.
1817 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
1818 an agentnum specified explicitly via reseller interface session_id in the
1823 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.
1825 =item agentnum2part_pkg
1827 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.
1831 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.
1833 =item security_phrase
1835 True if the "security_phrase" feature is enabled
1839 Array reference of acceptable payment types for signup
1845 credit card - automatic
1849 credit card - on-demand - version 1.5+ only
1853 electronic check - automatic
1857 electronic check - on-demand - version 1.5+ only
1865 billing, not recommended for signups
1869 free, definitely not recommended for signups
1873 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1879 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1883 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".
1889 =item countrydefault
1895 =item new_customer_minimal HASHREF
1897 Creates a new customer.
1899 Current differences from new_customer: An address is not required. promo_code
1900 and reg_code are not supported. If invoicing_list and _password is passed, a
1901 contact will be created with self-service access (no pkgpart or username is
1902 necessary). No initial billing is run (this may change in a future version).
1904 Takes a hash reference as parameter with the following keys:
1910 first name (required)
1914 last name (required)
1918 (not typically collected; mostly used for ACH transactions)
1950 Daytime phone number
1954 Evening phone number
1962 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1966 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1970 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1974 Expiration date for CARD/DCRD
1978 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1980 =item invoicing_list
1982 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),
1984 =item referral_custnum
1986 referring customer number
1994 pkgpart of initial package
2010 Access number (index, not the literal number)
2014 Country code (to be provisioned as a service)
2018 Phone number (to be provisioned as a service)
2026 Returns a hash reference with the following keys:
2032 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)
2036 =item new_customer HASHREF
2038 Creates a new customer. Takes a hash reference as parameter with the
2045 first name (required)
2049 last name (required)
2053 (not typically collected; mostly used for ACH transactions)
2059 =item address1 (required)
2067 =item city (required)
2075 =item state (required)
2079 =item zip (required)
2085 Daytime phone number
2089 Evening phone number
2097 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2101 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2105 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2109 Expiration date for CARD/DCRD
2113 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2115 =item invoicing_list
2117 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),
2119 =item referral_custnum
2121 referring customer number
2129 pkgpart of initial package
2145 Access number (index, not the literal number)
2149 Country code (to be provisioned as a service)
2153 Phone number (to be provisioned as a service)
2161 Returns a hash reference with the following keys:
2167 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)
2171 =item regionselector HASHREF | LIST
2173 Takes as input a hashref or list of key/value pairs with the following keys:
2177 =item selected_county
2179 Currently selected county
2181 =item selected_state
2183 Currently selected state
2185 =item selected_country
2187 Currently selected country
2191 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2195 Specify a javascript subroutine to call on changes
2201 =item default_country
2207 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>.
2211 Returns a list consisting of three HTML fragments for county selection,
2212 state selection and country selection, respectively.
2216 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2217 sub regionselector {
2224 $param->{'selected_country'} ||= $param->{'default_country'};
2225 $param->{'selected_state'} ||= $param->{'default_state'};
2227 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2231 my %cust_main_county;
2233 # unless ( @cust_main_county ) { #cache
2234 #@cust_main_county = qsearch('cust_main_county', {} );
2235 #foreach my $c ( @cust_main_county ) {
2236 foreach my $c ( @{ $param->{'locales'} } ) {
2237 #$countyflag=1 if $c->county;
2238 $countyflag=1 if $c->{county};
2239 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2240 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2241 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2244 $countyflag=1 if $param->{selected_county};
2246 my $script_html = <<END;
2248 function opt(what,value,text) {
2249 var optionName = new Option(text, value, false, false);
2250 var length = what.length;
2251 what.options[length] = optionName;
2253 function ${prefix}country_changed(what) {
2254 country = what.options[what.selectedIndex].text;
2255 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2256 what.form.${prefix}state.options[i] = null;
2258 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2260 foreach my $country ( sort keys %cust_main_county ) {
2261 $script_html .= "\nif ( country == \"$country\" ) {\n";
2262 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2263 my $text = $state || '(n/a)';
2264 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2266 $script_html .= "}\n";
2269 $script_html .= <<END;
2271 function ${prefix}state_changed(what) {
2274 if ( $countyflag ) {
2275 $script_html .= <<END;
2276 state = what.options[what.selectedIndex].text;
2277 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2278 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2279 what.form.${prefix}county.options[i] = null;
2282 foreach my $country ( sort keys %cust_main_county ) {
2283 $script_html .= "\nif ( country == \"$country\" ) {\n";
2284 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2285 $script_html .= "\nif ( state == \"$state\" ) {\n";
2286 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2287 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2288 my $text = $county || '(n/a)';
2290 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2292 $script_html .= "}\n";
2294 $script_html .= "}\n";
2298 $script_html .= <<END;
2303 my $county_html = $script_html;
2304 if ( $countyflag ) {
2305 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2306 foreach my $county (
2307 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2309 my $text = $county || '(n/a)';
2310 $county_html .= qq!<OPTION VALUE="$county"!.
2311 ($county eq $param->{'selected_county'} ?
2318 $county_html .= '</SELECT>';
2321 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2324 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2325 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2326 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2327 my $text = $state || '(n/a)';
2328 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2329 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2331 $state_html .= '</SELECT>';
2333 my $country_html = '';
2334 if ( scalar( keys %cust_main_county ) > 1 ) {
2336 $country_html = qq(<SELECT NAME="${prefix}country" ).
2337 qq(onChange="${prefix}country_changed(this); ).
2338 $param->{'onchange'}.
2341 my $countrydefault = $param->{default_country} || 'US';
2342 foreach my $country (
2343 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2344 keys %cust_main_county
2346 my $selected = $country eq $param->{'selected_country'}
2349 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2351 $country_html .= '</SELECT>';
2354 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2355 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2359 ($county_html, $state_html, $country_html);
2363 sub regionselector_hashref {
2364 my ($county_html, $state_html, $country_html) = regionselector(@_);
2366 'county_html' => $county_html,
2367 'state_html' => $state_html,
2368 'country_html' => $country_html,
2372 =item location_form HASHREF | LIST
2374 Takes as input a hashref or list of key/value pairs with the following keys:
2380 Current customer session_id
2384 Omit red asterisks from required fields.
2386 =item address1_label
2388 Label for first address line.
2392 Returns an HTML fragment for a location form (address, city, state, zip,
2405 my $session_id = delete $param->{'session_id'};
2407 my $rv = mason_comp( 'session_id' => $session_id,
2408 'comp' => '/elements/location.html',
2409 'args' => [ %$param ],
2413 $rv->{'error'} || $rv->{'output'};
2418 #=item expselect HASHREF | LIST
2420 #Takes as input a hashref or list of key/value pairs with the following keys:
2424 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2426 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2430 =item expselect PREFIX [ DATE ]
2432 Takes as input a unique prefix string and the current expiration date, in
2433 yyyy-mm-dd or m-d-yyyy format
2435 Returns an HTML fragments for expiration date selection.
2441 #if ( ref($_[0]) ) {
2445 #my $prefix = $param->{'prefix'};
2446 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2447 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2449 my $date = scalar(@_) ? shift : '';
2451 my( $m, $y ) = ( 0, 0 );
2452 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2453 ( $m, $y ) = ( $2, $1 );
2454 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2455 ( $m, $y ) = ( $1, $3 );
2457 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2459 $return .= qq!<OPTION VALUE="$_"!;
2460 $return .= " SELECTED" if $_ == $m;
2463 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2465 my $thisYear = $t[5] + 1900;
2466 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2467 $return .= qq!<OPTION VALUE="$_"!;
2468 $return .= " SELECTED" if $_ == $y;
2471 $return .= "</SELECT>";
2476 =item popselector HASHREF | LIST
2478 Takes as input a hashref or list of key/value pairs with the following keys:
2484 Access number number
2488 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>.
2492 Returns an HTML fragment for access number selection.
2496 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2504 my $popnum = $param->{'popnum'};
2505 my $pops = $param->{'pops'};
2507 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2508 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2509 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2510 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2511 if scalar(@$pops) == 1;
2514 my %popnum2pop = ();
2516 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2517 $popnum2pop{$_->{popnum}} = $_;
2522 function opt(what,href,text) {
2523 var optionName = new Option(text, href, false, false)
2524 var length = what.length;
2525 what.options[length] = optionName;
2529 my $init_popstate = $param->{'init_popstate'};
2530 if ( $init_popstate ) {
2531 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2532 $init_popstate. '">';
2535 function acstate_changed(what) {
2536 state = what.options[what.selectedIndex].text;
2537 what.form.popac.options.length = 0
2538 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2542 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2543 foreach my $state ( sort { $a cmp $b } @states ) {
2544 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2546 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2547 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2548 if ($ac eq $param->{'popac'}) {
2549 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2552 $text .= "}\n" unless $init_popstate;
2554 $text .= "popac_changed(what.form.popac)}\n";
2557 function popac_changed(what) {
2558 ac = what.options[what.selectedIndex].text;
2559 what.form.popnum.options.length = 0;
2560 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2564 foreach my $state ( @states ) {
2565 foreach my $popac ( keys %{ $pop{$state} } ) {
2566 $text .= "\nif ( ac == \"$popac\" ) {\n";
2568 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2569 my $o_popnum = $pop->{popnum};
2570 my $poptext = $pop->{city}. ', '. $pop->{state}.
2571 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2573 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2574 if ($popnum == $o_popnum) {
2575 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2583 $text .= "}\n</SCRIPT>\n";
2585 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2588 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2589 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2590 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2591 ">$_" foreach sort { $a cmp $b } @states;
2592 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2595 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2596 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2598 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2601 #comment this block to disable initial list polulation
2602 my @initial_select = ();
2603 if ( scalar( @$pops ) > 100 ) {
2604 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2606 @initial_select = @$pops;
2608 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2609 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2610 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2611 $pop->{city}. ', '. $pop->{state}.
2612 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2615 $text .= qq!</SELECT></TD></TR></TABLE>!;
2621 =item domainselector HASHREF | LIST
2623 Takes as input a hashref or list of key/value pairs with the following keys:
2633 Service number of the selected item.
2637 Returns an HTML fragment for domain selection.
2641 sub domainselector {
2648 my $domsvc= $param->{'domsvc'};
2650 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2651 my $domains = $rv->{'domains'};
2652 $domsvc = $rv->{'domsvc'} unless $domsvc;
2654 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2655 unless scalar(keys %$domains);
2657 if (scalar(keys %$domains) == 1) {
2659 foreach(keys %$domains) {
2662 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2663 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2666 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2668 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2670 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2671 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2672 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2673 $domains->{$domain};
2676 $text .= qq!</SELECT></TD></TR>!;
2682 =item didselector HASHREF | LIST
2684 Takes as input a hashref or list of key/value pairs with the following keys:
2690 Field name for the returned HTML fragment.
2694 Service definition (see L<FS::part_svc>)
2698 Returns an HTML fragment for DID selection.
2710 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2711 'args'=>[ %$param ],
2715 $rv->{'error'} || $rv->{'output'};
2721 =head1 RESELLER FUNCTIONS
2723 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2724 with their active session, and the B<customer_info> and B<order_pkg> functions
2725 with their active session and an additional I<custnum> parameter.
2727 For the most part, development of the reseller web interface has been
2728 superceded by agent-virtualized access to the backend.
2740 =item agent_list_customers
2742 List agent's customers.
2750 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>