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',
141 'freesideinc_service' => 'Freeside/freesideinc_service',
146 qw( regionselector regionselector_hashref location_form
147 expselect popselector domainselector didselector
151 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
152 $ENV{'SHELL'} = '/bin/sh';
153 $ENV{'IFS'} = " \t\n";
156 $ENV{'BASH_ENV'} = '';
158 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
159 #if you grant appropriate permissions to whatever user
160 my $freeside_uid = scalar(getpwnam('freeside'));
161 die "not running as the freeside user\n"
162 if $> != $freeside_uid && ! $skip_uid_check;
164 -e $dir or die "FATAL: $dir doesn't exist!";
165 -d $dir or die "FATAL: $dir isn't a directory!";
166 -r $dir or die "FATAL: Can't read $dir as freeside user!";
167 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
169 foreach my $autoload ( keys %autoload ) {
172 "sub $autoload { ". '
177 #warn scalar(@_). ": ". join(" / ", @_);
181 $param->{_packet} = \''. $autoload{$autoload}. '\';
183 simple_packet($param);
193 warn "sending ". $packet->{_packet}. " to server"
195 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
196 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
197 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
200 #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
202 #block until there is a message on socket
203 # my $w = new IO::Select;
205 # my @wait = $w->can_read;
207 warn "reading message from server"
210 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
211 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
213 warn "returning message to client"
221 FS::SelfService - Freeside self-service API
225 # password and shell account changes
226 use FS::SelfService qw(passwd chfn chsh);
228 # "my account" functionality
229 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
231 #new-style login with an email address and password
232 # can also be used for svc_acct login, set $emailaddress to username@domain
233 my $rv = login ( { 'email' => $emailaddress,
234 'password' => $password,
237 if ( $rv->{'error'} ) {
238 #handle login error...
241 $session_id = $rv->{'session_id'};
244 #classic svc_acct-based login with separate username and password
245 my $rv = login( { 'username' => $username,
247 'password' => $password,
250 if ( $rv->{'error'} ) {
251 #handle login error...
254 $session_id = $rv->{'session_id'};
257 #svc_phone login with phone number and PIN
258 my $rv = login( { 'username' => $phone_number,
259 'domain' => 'svc_phone',
263 if ( $rv->{'error'} ) {
264 #handle login error...
267 $session_id = $rv->{'session_id'};
270 my $customer_info = customer_info( { 'session_id' => $session_id } );
272 #payment_info and process_payment are available in 1.5+ only
273 my $payment_info = payment_info( { 'session_id' => $session_id } );
275 #!!! process_payment example
277 #!!! list_pkgs example
279 #ordering a package with an svc_acct service
280 my $rv = order_pkg( { 'session_id' => $session_id,
281 'pkgpart' => $pkgpart,
282 'svcpart' => $svcpart,
283 'username' => $username,
284 'domsvc' => $domsvc, #svcnum of svc_domain
285 '_password' => $password,
289 #!!! ordering a package with an svc_domain service example
291 #!!! ordering a package with an svc_phone service example
293 #!!! ordering a package with an svc_external service example
295 #!!! ordering a package with an svc_pbx service
297 #ordering a package with no service
298 my $rv = order_pkg( { 'session_id' => $session_id,
299 'pkgpart' => $pkgpart,
304 #quoting a package, then ordering after confirmation
306 my $rv = quotation_new({ 'session_id' => $session_id });
307 my $qnum = $rv->{quotationnum};
308 # add packages to the quotation
309 $rv = quotation_add_pkg({ 'session_id' => $session_id,
310 'quotationnum' => $qnum,
311 'pkgpart' => $pkgpart,
312 'quantity' => $quantity, # defaults to 1
314 # repeat until all packages are added
315 # view the pricing information
316 $rv = quotation_info({ 'session_id' => $session_id,
317 'quotationnum' => $qnum,
319 print "Total setup charges: ".$rv->{total_setup}."\n".
320 "Total recurring charges: ".$rv->{total_recur}."\n";
321 # quotation_info also provides a detailed breakdown of charges, in
324 # ask customer for confirmation, then:
325 $rv = quotation_order({ 'session_id' => $session_id,
326 'quotationnum' => $qnum,
329 #!!! cancel_pkg example
331 # signup functionality
332 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
334 my $signup_info = signup_info;
336 $rv = new_customer( {
339 'company' => $company,
340 'address1' => $address1,
341 'address2' => $address2,
345 'country' => $country,
346 'daytime' => $daytime,
350 'payinfo' => $payinfo,
352 'paystart_month' => $paystart_month
353 'paystart_year' => $paystart_year,
354 'payissue' => $payissue,
356 'paydate' => $paydate,
357 'payname' => $payname,
358 'invoicing_list' => $invoicing_list,
359 'referral_custnum' => $referral_custnum,
360 'agentnum' => $agentnum,
361 'pkgpart' => $pkgpart,
363 'username' => $username,
364 '_password' => $password,
368 'phonenum' => $phonenum,
373 my $error = $rv->{'error'};
374 if ( $error eq '_decline' ) {
384 Use this API to implement your own client "self-service" module.
386 If you just want to customize the look of the existing "self-service" module,
389 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
395 Changes the password for an existing user in svc_acct. Takes a hash
396 reference with the following keys:
402 Username of the account (required)
406 Domain of the account (required)
410 Old password (required)
414 New password (required)
432 =head1 "MY ACCOUNT" FUNCTIONS
438 Creates a user session. Takes a hash reference as parameter with the
445 Email address (username@domain), instead of username and domain. Required for
446 contact-based self-service login, can also be used for svc_acct-based login.
462 Returns a hash reference with the following keys:
468 Empty on success, or an error message on errors.
472 Session identifier for successful logins
476 =item customer_info HASHREF
478 Returns general customer information.
480 Takes a hash reference as parameter with a single key: B<session_id>
482 Returns a hash reference with the following keys:
496 Array reference of hash references of open inoices. Each hash reference has
497 the following keys: invnum, date, owed
501 An HTML fragment containing shipping and billing addresses.
503 =item The following fields are also returned
505 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
509 =item edit_info HASHREF
511 Takes a hash reference as parameter with any of the following keys:
513 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
515 If a field exists, the customer record is updated with the new value of that
516 field. If a field does not exist, that field is not changed on the customer
519 Returns a hash reference with a single key, B<error>, empty on success, or an
520 error message on errors
522 =item invoice HASHREF
524 Returns an invoice. Takes a hash reference as parameter with two keys:
525 session_id and invnum
527 Returns a hash reference with the following keys:
533 Empty on success, or an error message on errors
545 =item list_invoices HASHREF
547 Returns a list of all customer invoices. Takes a hash reference with a single
550 Returns a hash reference with the following keys:
556 Empty on success, or an error message on errors
560 Reference to array of hash references with the following keys:
570 Invoice date, in UNIX epoch time
576 =item list_payby HASHREF
578 Returns a list of all stored customer payment information (credit cards and
579 electronic check accounts). Takes a hash reference with a single key,
582 Returns a hash reference with the following keys:
588 Empty on success, or an error message on errors
592 Reference to array of hash references with the following keys:
600 Numeric weighting. Stored payment information with a lower weight is attempted
605 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
606 (on-demand credit card) or DCHK (on-demand electronic check).
610 Masked credit card number (or, masked account and routing numbers)
614 Credit card expiration date
618 Exact name on card (or bank name, for electronic checks)
622 For electronic checks, bank state
626 For electronic checks, account type (Personal/Business, Checking/Savings)
632 =item insert_payby HASHREF
634 Adds new stored payment information for this customer. Takes a hash reference
635 with the following keys:
643 Numeric weighting. Stored payment information with a lower weight is attempted
648 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
649 (on-demand credit card) or DCHK (on-demand electronic check).
653 Credit card number (or electronic check "account@routing")
657 CVV2 number / security code
661 Credit card expiration date
665 Exact name on card (or bank name, for electronic checks)
669 For electronic checks, bank state
673 For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A
677 Optional IP address from which payment was submitted
681 If there is an error, returns a hash reference with a single key, B<error>,
682 otherwise returns a hash reference with a single key, B<custpaybynum>.
684 =item delete_payby HASHREF
686 Removes stored payment information. Takes a hash reference with two keys,
687 B<session_id> and B<custpaybynum>. Returns a hash reference with a single key,
688 B<error>, which is an error message or empty for successful removal.
692 Cancels this customer.
694 Takes a hash reference as parameter with a single key: B<session_id>
696 Returns a hash reference with a single key, B<error>, which is empty on
697 success or an error message on errors.
699 =item payment_info HASHREF
701 Returns information that may be useful in displaying a payment page.
703 Takes a hash reference as parameter with a single key: B<session_id>.
705 Returns a hash reference with the following keys:
711 Empty on success, or an error message on errors
719 Exact name on credit card (CARD/DCRD)
743 Customer's current default payment type.
747 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
751 For CARD/DCRD payment types, the card number
755 For CARD/DCRD payment types, expiration month
759 For CARD/DCRD payment types, expiration year
761 =item cust_main_county
763 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.
767 Array reference of all states in the current default country.
771 Hash reference of card types; keys are card types, values are the exact strings
772 passed to the process_payment function
776 #this doesn't actually work yet
780 #Unique transaction identifier (prevents multiple charges), passed to the
781 #process_payment function
785 =item process_payment HASHREF
787 Processes a payment and possible change of address or payment type. Takes a
788 hash reference as parameter with the following keys:
802 If true, address and card information entered will be saved for subsequent
807 If true, future credit card payments will be done automatically (sets payby to
808 CARD). If false, future credit card payments will be done on-demand (sets
809 payby to DCRD). This option only has meaning if B<save> is set true.
837 Two-letter country code
845 Card expiration month
853 #this doesn't actually work yet
857 #Unique transaction identifier, returned from the payment_info function.
858 #Prevents multiple charges.
862 Returns a hash reference with a single key, B<error>, empty on success, or an
863 error message on errors.
865 =item process_payment_order_pkg
867 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
868 payment processes sucessfully, the package is ordered. Takes a hash reference
869 as parameter with the keys of both methods.
871 Returns a hash reference with a single key, B<error>, empty on success, or an
872 error message on errors.
874 =item process_payment_change_pkg
876 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
877 payment processes sucessfully, the package is ordered. Takes a hash reference
878 as parameter with the keys of both methods.
880 Returns a hash reference with a single key, B<error>, empty on success, or an
881 error message on errors.
884 =item process_payment_order_renew
886 Combines the B<process_payment> and B<order_renew> functions in one step. If
887 the payment processes sucessfully, the renewal is processed. Takes a hash
888 reference as parameter with the keys of both methods.
890 Returns a hash reference with a single key, B<error>, empty on success, or an
891 error message on errors.
895 Returns package information for this customer. For more detail on services,
898 Takes a hash reference as parameter with a single key: B<session_id>
900 Returns a hash reference containing customer package information. The hash reference contains the following keys:
910 Empty on success, or an error message on errors.
912 =item cust_pkg HASHREF
914 Array reference of hash references, each of which has the fields of a cust_pkg
915 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
916 the internal FS:: objects, but hash references of columns and values.
920 =item part_pkg fields
922 All fields of part_pkg for this specific cust_pkg (be careful with this
923 information - it may reveal more about your available packages than you would
924 like users to know in aggregate)
928 #XXX pare part_pkg fields down to a more secure subset
932 An array of hash references indicating information on unprovisioned services
933 available for provisioning for this specific cust_pkg. Each has the following
938 =item part_svc fields
940 All fields of part_svc (be careful with this information - it may reveal more
941 about your available packages than you would like users to know in aggregate)
945 #XXX pare part_svc fields down to a more secure subset
951 An array of hash references indicating information on the customer services
952 already provisioned for this specific cust_pkg. Each has the following keys:
958 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.
964 Primary key for this service
968 Service definition (see L<FS::part_svc>)
972 Customer package (see L<FS::cust_pkg>)
976 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
984 Returns service information for this customer.
986 Takes a hash reference as parameter with a single key: B<session_id>
988 Returns a hash reference containing customer package information. The hash reference contains the following keys:
998 An array of hash references indicating information on all of this customer's
999 services. Each has the following keys:
1005 Primary key for this service
1009 Name of this service
1013 Meaningful user-specific identifier for the service (i.e. username, domain, or
1018 Account (svc_acct) services also have the following keys:
1036 Upload bytes remaining
1040 Download bytes remaining
1044 Total bytes remaining
1046 =item recharge_amount
1050 =item recharge_seconds
1052 Number of seconds gained by recharge
1054 =item recharge_upbytes
1056 Number of upload bytes gained by recharge
1058 =item recharge_downbytes
1060 Number of download bytes gained by recharge
1062 =item recharge_totalbytes
1064 Number of total bytes gained by recharge
1072 Orders a package for this customer.
1074 Takes a hash reference as parameter with the following keys:
1084 Package to order (see L<FS::part_pkg>).
1088 Quantity for this package order (default 1).
1092 Optional locationnum for this package order, for existing locations.
1094 Or, for new locations, pass the following fields: address1*, address2, city*,
1095 county, state*, zip*, country. (* = required in this case)
1097 (None of this is required at all if you are just ordering a package
1098 at the customer's existing default service location.)
1116 Service to order (see L<FS::part_svc>).
1118 Normally optional; required only to provision a non-svc_acct service, or if the
1119 package definition does not contain one svc_acct service definition with
1120 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1121 also be specified to indicate that no initial service should be provisioned.
1125 Fields used when provisioning an svc_acct service:
1139 Optional security phrase
1143 Optional Access number number
1147 Fields used when provisioning an svc_domain service:
1157 Fields used when provisioning an svc_phone service:
1175 Fields used when provisioning an svc_external service:
1181 External numeric ID.
1185 External text title.
1189 Fields used when provisioning an svc_pbx service:
1203 Returns a hash reference with a single key, B<error>, empty on success, or an
1204 error message on errors. The special error '_decline' is returned for
1205 declined transactions.
1209 Changes a package for this customer.
1211 Takes a hash reference as parameter with the following keys:
1221 Existing customer package.
1225 New package to order (see L<FS::part_pkg>).
1229 Quantity for this package order (default 1).
1233 Returns a hash reference with the following keys:
1239 Empty on success, or an error message on errors.
1243 On success, the new pkgnum
1250 Provides useful info for early renewals.
1252 Takes a hash reference as parameter with the following keys:
1262 Returns a hash reference. On errors, it contains a single key, B<error>, with
1263 the error message. Otherwise, contains a single key, B<dates>, pointing to
1264 an array refernce of hash references. Each hash reference contains the
1271 (Future) Bill date. Indicates a future date for which billing could be run.
1272 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1275 =item bill_date_pretty
1277 (Future) Bill date as a human-readable string. (Convenience for display;
1278 subject to change, so best not to parse for the date.)
1282 Base amount which will be charged if renewed early as of this date.
1286 Renewal date; i.e. even-futher future date at which the customer will be paid
1287 through if the early renewal is completed with the given B<bill-date>.
1288 Specified as an integer UNIX timestamp.
1290 =item renew_date_pretty
1292 Renewal date as a human-readable string. (Convenience for display;
1293 subject to change, so best not to parse for the date.)
1297 Package that will be renewed.
1301 Expiration date of the package that will be renewed.
1303 =item expire_date_pretty
1305 Expiration date of the package that will be renewed, as a human-readable
1306 string. (Convenience for display; subject to change, so best not to parse for
1313 Renews this customer early; i.e. runs billing for this customer in advance.
1315 Takes a hash reference as parameter with the following keys:
1325 Integer date as returned by the B<renew_info> function, indicating the advance
1326 date for which to run billing.
1330 Returns a hash reference with a single key, B<error>, empty on success, or an
1331 error message on errors.
1335 Cancels a package for this customer.
1337 Takes a hash reference as parameter with the following keys:
1347 pkgpart of package to cancel
1351 Optional date, for future cancellation (expiration) instead of immediate
1352 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1356 Returns a hash reference with a single key, B<error>, empty on success, or an
1357 error message on errors.
1359 =item provision_acct
1361 Provisions an account (svc_acct).
1363 Takes a hash reference as parameter with the following keys:
1373 pkgnum of package into which this service is provisioned
1377 svcpart or service definition to provision
1387 =item provision_phone
1389 Provisions a phone number (svc_phone).
1391 Takes a hash reference as parameter with the following keys:
1401 pkgnum of package into which this service is provisioned
1405 svcpart or service definition to provision
1425 E911 Address (optional)
1431 Provisions a customer PBX (svc_pbx).
1433 Takes a hash reference as parameter with the following keys:
1443 pkgnum of package into which this service is provisioned
1447 svcpart or service definition to provision
1453 =item max_extensions
1455 =item max_simultaneous
1461 =item provision_external
1463 Provisions an external service (svc_external).
1465 Takes a hash reference as parameter with the following keys:
1475 pkgnum of package into which this service is provisioned
1479 svcpart or service definition to provision
1489 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1493 =item contact_passwd
1495 Changes the password for the currently-logged in contact.
1497 Takes a hash reference as parameter with the following keys:
1507 Returns a hash reference with a single parameter, B<error>, which contains an
1508 error message, or empty on success.
1512 Takes a hash reference as parameter with a single key, B<session_id>.
1514 Returns a hash reference with two parameters: B<error>, which contains an error
1515 message, or empty on success, and B<contacts>, a list of contacts.
1517 B<contacts> is an array reference of hash references (i.e. an array of structs,
1518 in XML-RPC). Each hash reference (struct) has the following keys:
1526 Contact class name (contact type).
1538 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1542 Comma-separated list of email addresses
1546 =item selfservice_access
1554 Updates information for the currently-logged in contact, or (optionally) the
1557 Takes a hash reference as parameter with the following keys:
1565 If already logged in as a contact, this is optional.
1575 Returns a hash reference with a single parameter, B<error>, which contains an
1576 error message, or empty on success.
1580 Creates a new contact.
1582 Takes a hash reference as parameter with the following keys:
1596 Optional contact classnum (TODO: or name)
1600 =item selfservice_access
1602 Y to enable self-service access
1608 Returns a hash reference with a single parameter, B<error>, which contains an
1609 error message, or empty on success.
1611 =item delete_contact
1613 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1616 Takes a hash reference as parameter with the following keys:
1626 Returns a hash reference with a single parameter, B<error>, which contains an
1627 error message, or empty on success.
1631 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1633 All of these functions require the user to be logged in, and the 'session_id'
1634 key to be included in the argument hashref.`
1638 =item list_quotations HASHREF
1640 Returns a hashref listing this customer's active self-service quotations.
1647 an arrayref containing an element for each quotation.
1655 the date it was started
1659 the number of packages
1663 the sum of setup fees
1667 the sum of recurring charges
1671 =item quotation_new HASHREF
1673 Creates an empty quotation and returns a hashref containing 'quotationnum',
1674 the primary key of the new quotation.
1676 =item quotation_delete HASHREF
1678 Disables (does not really delete) a quotation. Takes the following arguments:
1684 =item quotationnum - the quotation to delete
1688 Returns 'error' => a string, which will be empty on success.
1690 =item quotation_info HASHREF
1692 Returns total and detailed pricing information on a quotation.
1694 Takes the following arguments:
1700 =item quotationnum - the quotation to return
1704 Returns a hashref containing:
1706 - total_setup, the total of setup fees (and their taxes)
1707 - total_recur, the total of all recurring charges (and their taxes)
1708 - sections, an arrayref containing an element for each quotation section.
1709 - description, a line of text describing the group of charges
1710 - subtotal, the total of charges in this group (if appropriate)
1711 - detail_items, an arrayref of line items
1712 - pkgnum, the reference number of the package
1713 - description, the package name (or tax name)
1715 - amount, the amount charged
1716 If the detail item represents a subtotal, it will instead contain:
1717 - total_item: description of the subtotal
1718 - total_amount: the subtotal amount
1721 =item quotation_print HASHREF
1723 Renders the quotation as HTML or PDF. Takes the following arguments:
1729 =item quotationnum - the quotation to return
1731 =item format - 'html' or 'pdf'
1735 Returns a hashref containing 'document', the contents of the file.
1737 =item quotation_add_pkg HASHREF
1739 Adds a package to a quotation. Takes the following arguments:
1745 =item pkgpart - the package to add
1747 =item quotationnum - the quotation to add it to
1749 =item quantity - the package quantity (defaults to 1)
1751 =item address1, address2, city, state, zip, country - address fields to set
1752 the service location
1756 Returns 'error' => a string, which will be empty on success.
1758 =item quotation_remove_pkg HASHREF
1760 Removes a package from a quotation. Takes the following arguments:
1766 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1768 =item quotationnum - the quotation to remove it from
1772 Returns 'error' => a string, which will be empty on success.
1774 =item quotation_order HASHREF
1776 Converts the packages in a quotation into real packages. Takes the following
1779 Takes the following arguments:
1785 =item quotationnum - the quotation to order
1791 =head1 SIGNUP FUNCTIONS
1795 =item signup_info HASHREF
1797 Takes a hash reference as parameter with the following keys:
1801 =item session_id - Optional agent/reseller interface session
1805 Returns a hash reference containing information that may be useful in
1806 displaying a signup page. The hash reference contains the following keys:
1810 =item cust_main_county
1812 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.
1816 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
1817 an agentnum specified explicitly via reseller interface session_id in the
1822 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.
1824 =item agentnum2part_pkg
1826 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.
1830 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.
1832 =item security_phrase
1834 True if the "security_phrase" feature is enabled
1838 Array reference of acceptable payment types for signup
1844 credit card - automatic
1848 credit card - on-demand - version 1.5+ only
1852 electronic check - automatic
1856 electronic check - on-demand - version 1.5+ only
1864 billing, not recommended for signups
1868 free, definitely not recommended for signups
1872 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1878 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1882 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".
1888 =item countrydefault
1894 =item new_customer_minimal HASHREF
1896 Creates a new customer.
1898 Current differences from new_customer: An address is not required. promo_code
1899 and reg_code are not supported. If invoicing_list and _password is passed, a
1900 contact will be created with self-service access (no pkgpart or username is
1901 necessary). No initial billing is run (this may change in a future version).
1903 Takes a hash reference as parameter with the following keys:
1909 first name (required)
1913 last name (required)
1917 (not typically collected; mostly used for ACH transactions)
1949 Daytime phone number
1953 Evening phone number
1961 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1965 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1969 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1973 Expiration date for CARD/DCRD
1977 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1979 =item invoicing_list
1981 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),
1983 =item referral_custnum
1985 referring customer number
1993 pkgpart of initial package
2009 Access number (index, not the literal number)
2013 Country code (to be provisioned as a service)
2017 Phone number (to be provisioned as a service)
2025 Returns a hash reference with the following keys:
2031 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)
2035 =item new_customer HASHREF
2037 Creates a new customer. Takes a hash reference as parameter with the
2044 first name (required)
2048 last name (required)
2052 (not typically collected; mostly used for ACH transactions)
2058 =item address1 (required)
2066 =item city (required)
2074 =item state (required)
2078 =item zip (required)
2084 Daytime phone number
2088 Evening phone number
2096 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2100 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2104 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2108 Expiration date for CARD/DCRD
2112 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2114 =item invoicing_list
2116 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),
2118 =item referral_custnum
2120 referring customer number
2128 pkgpart of initial package
2144 Access number (index, not the literal number)
2148 Country code (to be provisioned as a service)
2152 Phone number (to be provisioned as a service)
2160 Returns a hash reference with the following keys:
2166 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)
2170 =item regionselector HASHREF | LIST
2172 Takes as input a hashref or list of key/value pairs with the following keys:
2176 =item selected_county
2178 Currently selected county
2180 =item selected_state
2182 Currently selected state
2184 =item selected_country
2186 Currently selected country
2190 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2194 Specify a javascript subroutine to call on changes
2200 =item default_country
2206 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>.
2210 Returns a list consisting of three HTML fragments for county selection,
2211 state selection and country selection, respectively.
2215 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2216 sub regionselector {
2223 $param->{'selected_country'} ||= $param->{'default_country'};
2224 $param->{'selected_state'} ||= $param->{'default_state'};
2226 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2230 my %cust_main_county;
2232 # unless ( @cust_main_county ) { #cache
2233 #@cust_main_county = qsearch('cust_main_county', {} );
2234 #foreach my $c ( @cust_main_county ) {
2235 foreach my $c ( @{ $param->{'locales'} } ) {
2236 #$countyflag=1 if $c->county;
2237 $countyflag=1 if $c->{county};
2238 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2239 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2240 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2243 $countyflag=1 if $param->{selected_county};
2245 my $script_html = <<END;
2247 function opt(what,value,text) {
2248 var optionName = new Option(text, value, false, false);
2249 var length = what.length;
2250 what.options[length] = optionName;
2252 function ${prefix}country_changed(what) {
2253 country = what.options[what.selectedIndex].text;
2254 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2255 what.form.${prefix}state.options[i] = null;
2257 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2259 foreach my $country ( sort keys %cust_main_county ) {
2260 $script_html .= "\nif ( country == \"$country\" ) {\n";
2261 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2262 my $text = $state || '(n/a)';
2263 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2265 $script_html .= "}\n";
2268 $script_html .= <<END;
2270 function ${prefix}state_changed(what) {
2273 if ( $countyflag ) {
2274 $script_html .= <<END;
2275 state = what.options[what.selectedIndex].text;
2276 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2277 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2278 what.form.${prefix}county.options[i] = null;
2281 foreach my $country ( sort keys %cust_main_county ) {
2282 $script_html .= "\nif ( country == \"$country\" ) {\n";
2283 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2284 $script_html .= "\nif ( state == \"$state\" ) {\n";
2285 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2286 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2287 my $text = $county || '(n/a)';
2289 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2291 $script_html .= "}\n";
2293 $script_html .= "}\n";
2297 $script_html .= <<END;
2302 my $county_html = $script_html;
2303 if ( $countyflag ) {
2304 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2305 foreach my $county (
2306 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2308 my $text = $county || '(n/a)';
2309 $county_html .= qq!<OPTION VALUE="$county"!.
2310 ($county eq $param->{'selected_county'} ?
2317 $county_html .= '</SELECT>';
2320 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2323 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2324 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2325 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2326 my $text = $state || '(n/a)';
2327 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2328 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2330 $state_html .= '</SELECT>';
2332 my $country_html = '';
2333 if ( scalar( keys %cust_main_county ) > 1 ) {
2335 $country_html = qq(<SELECT NAME="${prefix}country" ).
2336 qq(onChange="${prefix}country_changed(this); ).
2337 $param->{'onchange'}.
2340 my $countrydefault = $param->{default_country} || 'US';
2341 foreach my $country (
2342 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2343 keys %cust_main_county
2345 my $selected = $country eq $param->{'selected_country'}
2348 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2350 $country_html .= '</SELECT>';
2353 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2354 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2358 ($county_html, $state_html, $country_html);
2362 sub regionselector_hashref {
2363 my ($county_html, $state_html, $country_html) = regionselector(@_);
2365 'county_html' => $county_html,
2366 'state_html' => $state_html,
2367 'country_html' => $country_html,
2371 =item location_form HASHREF | LIST
2373 Takes as input a hashref or list of key/value pairs with the following keys:
2379 Current customer session_id
2383 Omit red asterisks from required fields.
2385 =item address1_label
2387 Label for first address line.
2391 Returns an HTML fragment for a location form (address, city, state, zip,
2404 my $session_id = delete $param->{'session_id'};
2406 my $rv = mason_comp( 'session_id' => $session_id,
2407 'comp' => '/elements/location.html',
2408 'args' => [ %$param ],
2412 $rv->{'error'} || $rv->{'output'};
2417 #=item expselect HASHREF | LIST
2419 #Takes as input a hashref or list of key/value pairs with the following keys:
2423 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2425 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2429 =item expselect PREFIX [ DATE ]
2431 Takes as input a unique prefix string and the current expiration date, in
2432 yyyy-mm-dd or m-d-yyyy format
2434 Returns an HTML fragments for expiration date selection.
2440 #if ( ref($_[0]) ) {
2444 #my $prefix = $param->{'prefix'};
2445 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2446 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2448 my $date = scalar(@_) ? shift : '';
2450 my( $m, $y ) = ( 0, 0 );
2451 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2452 ( $m, $y ) = ( $2, $1 );
2453 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2454 ( $m, $y ) = ( $1, $3 );
2456 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2458 $return .= qq!<OPTION VALUE="$_"!;
2459 $return .= " SELECTED" if $_ == $m;
2462 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2464 my $thisYear = $t[5] + 1900;
2465 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2466 $return .= qq!<OPTION VALUE="$_"!;
2467 $return .= " SELECTED" if $_ == $y;
2470 $return .= "</SELECT>";
2475 =item popselector HASHREF | LIST
2477 Takes as input a hashref or list of key/value pairs with the following keys:
2483 Access number number
2487 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>.
2491 Returns an HTML fragment for access number selection.
2495 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2503 my $popnum = $param->{'popnum'};
2504 my $pops = $param->{'pops'};
2506 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2507 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2508 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2509 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2510 if scalar(@$pops) == 1;
2513 my %popnum2pop = ();
2515 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2516 $popnum2pop{$_->{popnum}} = $_;
2521 function opt(what,href,text) {
2522 var optionName = new Option(text, href, false, false)
2523 var length = what.length;
2524 what.options[length] = optionName;
2528 my $init_popstate = $param->{'init_popstate'};
2529 if ( $init_popstate ) {
2530 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2531 $init_popstate. '">';
2534 function acstate_changed(what) {
2535 state = what.options[what.selectedIndex].text;
2536 what.form.popac.options.length = 0
2537 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2541 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2542 foreach my $state ( sort { $a cmp $b } @states ) {
2543 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2545 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2546 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2547 if ($ac eq $param->{'popac'}) {
2548 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2551 $text .= "}\n" unless $init_popstate;
2553 $text .= "popac_changed(what.form.popac)}\n";
2556 function popac_changed(what) {
2557 ac = what.options[what.selectedIndex].text;
2558 what.form.popnum.options.length = 0;
2559 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2563 foreach my $state ( @states ) {
2564 foreach my $popac ( keys %{ $pop{$state} } ) {
2565 $text .= "\nif ( ac == \"$popac\" ) {\n";
2567 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2568 my $o_popnum = $pop->{popnum};
2569 my $poptext = $pop->{city}. ', '. $pop->{state}.
2570 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2572 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2573 if ($popnum == $o_popnum) {
2574 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2582 $text .= "}\n</SCRIPT>\n";
2584 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2587 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2588 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2589 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2590 ">$_" foreach sort { $a cmp $b } @states;
2591 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2594 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2595 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2597 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2600 #comment this block to disable initial list polulation
2601 my @initial_select = ();
2602 if ( scalar( @$pops ) > 100 ) {
2603 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2605 @initial_select = @$pops;
2607 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2608 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2609 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2610 $pop->{city}. ', '. $pop->{state}.
2611 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2614 $text .= qq!</SELECT></TD></TR></TABLE>!;
2620 =item domainselector HASHREF | LIST
2622 Takes as input a hashref or list of key/value pairs with the following keys:
2632 Service number of the selected item.
2636 Returns an HTML fragment for domain selection.
2640 sub domainselector {
2647 my $domsvc= $param->{'domsvc'};
2649 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2650 my $domains = $rv->{'domains'};
2651 $domsvc = $rv->{'domsvc'} unless $domsvc;
2653 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2654 unless scalar(keys %$domains);
2656 if (scalar(keys %$domains) == 1) {
2658 foreach(keys %$domains) {
2661 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2662 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2665 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2667 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2669 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2670 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2671 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2672 $domains->{$domain};
2675 $text .= qq!</SELECT></TD></TR>!;
2681 =item didselector HASHREF | LIST
2683 Takes as input a hashref or list of key/value pairs with the following keys:
2689 Field name for the returned HTML fragment.
2693 Service definition (see L<FS::part_svc>)
2697 Returns an HTML fragment for DID selection.
2709 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2710 'args'=>[ %$param ],
2714 $rv->{'error'} || $rv->{'output'};
2720 =head1 RESELLER FUNCTIONS
2722 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2723 with their active session, and the B<customer_info> and B<order_pkg> functions
2724 with their active session and an additional I<custnum> parameter.
2726 For the most part, development of the reseller web interface has been
2727 superceded by agent-virtualized access to the backend.
2739 =item agent_list_customers
2741 List agent's customers.
2749 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>