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)
1107 Service to order (see L<FS::part_svc>).
1109 Normally optional; required only to provision a non-svc_acct service, or if the
1110 package definition does not contain one svc_acct service definition with
1111 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1112 also be specified to indicate that no initial service should be provisioned.
1116 Fields used when provisioning an svc_acct service:
1130 Optional security phrase
1134 Optional Access number number
1138 Fields used when provisioning an svc_domain service:
1148 Fields used when provisioning an svc_phone service:
1166 Fields used when provisioning an svc_external service:
1172 External numeric ID.
1176 External text title.
1180 Fields used when provisioning an svc_pbx service:
1194 Returns a hash reference with a single key, B<error>, empty on success, or an
1195 error message on errors. The special error '_decline' is returned for
1196 declined transactions.
1200 Changes a package for this customer.
1202 Takes a hash reference as parameter with the following keys:
1212 Existing customer package.
1216 New package to order (see L<FS::part_pkg>).
1220 Quantity for this package order (default 1).
1224 Returns a hash reference with the following keys:
1230 Empty on success, or an error message on errors.
1234 On success, the new pkgnum
1241 Provides useful info for early renewals.
1243 Takes a hash reference as parameter with the following keys:
1253 Returns a hash reference. On errors, it contains a single key, B<error>, with
1254 the error message. Otherwise, contains a single key, B<dates>, pointing to
1255 an array refernce of hash references. Each hash reference contains the
1262 (Future) Bill date. Indicates a future date for which billing could be run.
1263 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1266 =item bill_date_pretty
1268 (Future) Bill date as a human-readable string. (Convenience for display;
1269 subject to change, so best not to parse for the date.)
1273 Base amount which will be charged if renewed early as of this date.
1277 Renewal date; i.e. even-futher future date at which the customer will be paid
1278 through if the early renewal is completed with the given B<bill-date>.
1279 Specified as a integer UNIX timestamp.
1281 =item renew_date_pretty
1283 Renewal date as a human-readable string. (Convenience for display;
1284 subject to change, so best not to parse for the date.)
1288 Package that will be renewed.
1292 Expiration date of the package that will be renewed.
1294 =item expire_date_pretty
1296 Expiration date of the package that will be renewed, as a human-readable
1297 string. (Convenience for display; subject to change, so best not to parse for
1304 Renews this customer early; i.e. runs billing for this customer in advance.
1306 Takes a hash reference as parameter with the following keys:
1316 Integer date as returned by the B<renew_info> function, indicating the advance
1317 date for which to run billing.
1321 Returns a hash reference with a single key, B<error>, empty on success, or an
1322 error message on errors.
1326 Cancels a package for this customer.
1328 Takes a hash reference as parameter with the following keys:
1338 pkgpart of package to cancel
1342 Returns a hash reference with a single key, B<error>, empty on success, or an
1343 error message on errors.
1345 =item provision_acct
1347 Provisions an account (svc_acct).
1349 Takes a hash reference as parameter with the following keys:
1359 pkgnum of package into which this service is provisioned
1363 svcpart or service definition to provision
1373 =item provision_phone
1375 Provisions a phone number (svc_phone).
1377 Takes a hash reference as parameter with the following keys:
1387 pkgnum of package into which this service is provisioned
1391 svcpart or service definition to provision
1411 E911 Address (optional)
1417 Provisions a customer PBX (svc_pbx).
1419 Takes a hash reference as parameter with the following keys:
1429 pkgnum of package into which this service is provisioned
1433 svcpart or service definition to provision
1439 =item max_extensions
1441 =item max_simultaneous
1447 =item provision_external
1449 Provisions an external service (svc_external).
1451 Takes a hash reference as parameter with the following keys:
1461 pkgnum of package into which this service is provisioned
1465 svcpart or service definition to provision
1475 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1479 =item contact_passwd
1481 Changes the password for the currently-logged in contact.
1483 Takes a hash reference as parameter with the following keys:
1493 Returns a hash reference with a single parameter, B<error>, which contains an
1494 error message, or empty on success.
1498 Takes a hash reference as parameter with a single key, B<session_id>.
1500 Returns a hash reference with two parameters: B<error>, which contains an error
1501 message, or empty on success, and B<contacts>, a list of contacts.
1503 B<contacts> is an array reference of hash references (i.e. an array of structs,
1504 in XML-RPC). Each hash reference (struct) has the following keys:
1512 Contact class name (contact type).
1524 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1528 Comma-separated list of email addresses
1532 =item selfservice_access
1540 Updates information for the currently-logged in contact, or (optionally) the
1543 Takes a hash reference as parameter with the following keys:
1551 If already logged in as a contact, this is optional.
1561 Returns a hash reference with a single parameter, B<error>, which contains an
1562 error message, or empty on success.
1566 Creates a new contact.
1568 Takes a hash reference as parameter with the following keys:
1582 Optional contact classnum (TODO: or name)
1586 =item selfservice_access
1588 Y to enable self-service access
1594 Returns a hash reference with a single parameter, B<error>, which contains an
1595 error message, or empty on success.
1597 =item delete_contact
1599 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1602 Takes a hash reference as parameter with the following keys:
1612 Returns a hash reference with a single parameter, B<error>, which contains an
1613 error message, or empty on success.
1615 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1617 All of these functions require the user to be logged in, and the 'session_id'
1618 key to be included in the argument hashref.`
1622 =item list_quotations HASHREF
1624 Returns a hashref listing this customer's active self-service quotations.
1631 an arrayref containing an element for each quotation.
1639 the date it was started
1643 the number of packages
1647 the sum of setup fees
1651 the sum of recurring charges
1655 =item quotation_new HASHREF
1657 Creates an empty quotation and returns a hashref containing 'quotationnum',
1658 the primary key of the new quotation.
1660 =item quotation_delete HASHREF
1662 Disables (does not really delete) a quotation. Takes the following arguments:
1668 =item quotationnum - the quotation to delete
1672 Returns 'error' => a string, which will be empty on success.
1674 =item quotation_info HASHREF
1676 Returns total and detailed pricing information on a quotation.
1678 Takes the following arguments:
1684 =item quotationnum - the quotation to return
1688 Returns a hashref containing:
1690 - total_setup, the total of setup fees (and their taxes)
1691 - total_recur, the total of all recurring charges (and their taxes)
1692 - sections, an arrayref containing an element for each quotation section.
1693 - description, a line of text describing the group of charges
1694 - subtotal, the total of charges in this group (if appropriate)
1695 - detail_items, an arrayref of line items
1696 - pkgnum, the reference number of the package
1697 - description, the package name (or tax name)
1699 - amount, the amount charged
1700 If the detail item represents a subtotal, it will instead contain:
1701 - total_item: description of the subtotal
1702 - total_amount: the subtotal amount
1705 =item quotation_print HASHREF
1707 Renders the quotation as HTML or PDF. Takes the following arguments:
1713 =item quotationnum - the quotation to return
1715 =item format - 'html' or 'pdf'
1719 Returns a hashref containing 'document', the contents of the file.
1721 =item quotation_add_pkg HASHREF
1723 Adds a package to a quotation. Takes the following arguments:
1729 =item pkgpart - the package to add
1731 =item quotationnum - the quotation to add it to
1733 =item quantity - the package quantity (defaults to 1)
1735 =item address1, address2, city, state, zip, country - address fields to set
1736 the service location
1740 Returns 'error' => a string, which will be empty on success.
1742 =item quotation_remove_pkg HASHREF
1744 Removes a package from a quotation. Takes the following arguments:
1750 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1752 =item quotationnum - the quotation to remove it from
1756 Returns 'error' => a string, which will be empty on success.
1760 =item quotation_order HASHREF
1762 Converts the packages in a quotation into real packages. Takes the following
1765 Takes the following arguments:
1771 =item quotationnum - the quotation to order
1777 =head1 SIGNUP FUNCTIONS
1781 =item signup_info HASHREF
1783 Takes a hash reference as parameter with the following keys:
1787 =item session_id - Optional agent/reseller interface session
1791 Returns a hash reference containing information that may be useful in
1792 displaying a signup page. The hash reference contains the following keys:
1796 =item cust_main_county
1798 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.
1802 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
1803 an agentnum specified explicitly via reseller interface session_id in the
1808 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.
1810 =item agentnum2part_pkg
1812 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.
1816 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.
1818 =item security_phrase
1820 True if the "security_phrase" feature is enabled
1824 Array reference of acceptable payment types for signup
1830 credit card - automatic
1834 credit card - on-demand - version 1.5+ only
1838 electronic check - automatic
1842 electronic check - on-demand - version 1.5+ only
1850 billing, not recommended for signups
1854 free, definitely not recommended for signups
1858 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1864 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1868 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".
1874 =item countrydefault
1880 =item new_customer_minimal HASHREF
1882 Creates a new customer.
1884 Current differences from new_customer: An address is not required. promo_code
1885 and reg_code are not supported. If invoicing_list and _password is passed, a
1886 contact will be created with self-service access (no pkgpart or username is
1887 necessary). No initial billing is run (this may change in a future version).
1889 Takes a hash reference as parameter with the following keys:
1895 first name (required)
1899 last name (required)
1903 (not typically collected; mostly used for ACH transactions)
1935 Daytime phone number
1939 Evening phone number
1947 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1951 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1955 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1959 Expiration date for CARD/DCRD
1963 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1965 =item invoicing_list
1967 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),
1969 =item referral_custnum
1971 referring customer number
1979 pkgpart of initial package
1995 Access number (index, not the literal number)
1999 Country code (to be provisioned as a service)
2003 Phone number (to be provisioned as a service)
2011 Returns a hash reference with the following keys:
2017 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)
2021 =item new_customer HASHREF
2023 Creates a new customer. Takes a hash reference as parameter with the
2030 first name (required)
2034 last name (required)
2038 (not typically collected; mostly used for ACH transactions)
2044 =item address1 (required)
2052 =item city (required)
2060 =item state (required)
2064 =item zip (required)
2070 Daytime phone number
2074 Evening phone number
2082 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2086 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2090 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2094 Expiration date for CARD/DCRD
2098 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2100 =item invoicing_list
2102 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),
2104 =item referral_custnum
2106 referring customer number
2114 pkgpart of initial package
2130 Access number (index, not the literal number)
2134 Country code (to be provisioned as a service)
2138 Phone number (to be provisioned as a service)
2146 Returns a hash reference with the following keys:
2152 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)
2156 =item regionselector HASHREF | LIST
2158 Takes as input a hashref or list of key/value pairs with the following keys:
2162 =item selected_county
2164 Currently selected county
2166 =item selected_state
2168 Currently selected state
2170 =item selected_country
2172 Currently selected country
2176 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2180 Specify a javascript subroutine to call on changes
2186 =item default_country
2192 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>.
2196 Returns a list consisting of three HTML fragments for county selection,
2197 state selection and country selection, respectively.
2201 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2202 sub regionselector {
2209 $param->{'selected_country'} ||= $param->{'default_country'};
2210 $param->{'selected_state'} ||= $param->{'default_state'};
2212 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2216 my %cust_main_county;
2218 # unless ( @cust_main_county ) { #cache
2219 #@cust_main_county = qsearch('cust_main_county', {} );
2220 #foreach my $c ( @cust_main_county ) {
2221 foreach my $c ( @{ $param->{'locales'} } ) {
2222 #$countyflag=1 if $c->county;
2223 $countyflag=1 if $c->{county};
2224 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2225 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2226 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2229 $countyflag=1 if $param->{selected_county};
2231 my $script_html = <<END;
2233 function opt(what,value,text) {
2234 var optionName = new Option(text, value, false, false);
2235 var length = what.length;
2236 what.options[length] = optionName;
2238 function ${prefix}country_changed(what) {
2239 country = what.options[what.selectedIndex].text;
2240 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2241 what.form.${prefix}state.options[i] = null;
2243 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2245 foreach my $country ( sort keys %cust_main_county ) {
2246 $script_html .= "\nif ( country == \"$country\" ) {\n";
2247 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2248 my $text = $state || '(n/a)';
2249 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2251 $script_html .= "}\n";
2254 $script_html .= <<END;
2256 function ${prefix}state_changed(what) {
2259 if ( $countyflag ) {
2260 $script_html .= <<END;
2261 state = what.options[what.selectedIndex].text;
2262 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2263 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2264 what.form.${prefix}county.options[i] = null;
2267 foreach my $country ( sort keys %cust_main_county ) {
2268 $script_html .= "\nif ( country == \"$country\" ) {\n";
2269 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2270 $script_html .= "\nif ( state == \"$state\" ) {\n";
2271 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2272 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2273 my $text = $county || '(n/a)';
2275 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2277 $script_html .= "}\n";
2279 $script_html .= "}\n";
2283 $script_html .= <<END;
2288 my $county_html = $script_html;
2289 if ( $countyflag ) {
2290 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2291 foreach my $county (
2292 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2294 my $text = $county || '(n/a)';
2295 $county_html .= qq!<OPTION VALUE="$county"!.
2296 ($county eq $param->{'selected_county'} ?
2303 $county_html .= '</SELECT>';
2306 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2309 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2310 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2311 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2312 my $text = $state || '(n/a)';
2313 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2314 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2316 $state_html .= '</SELECT>';
2318 my $country_html = '';
2319 if ( scalar( keys %cust_main_county ) > 1 ) {
2321 $country_html = qq(<SELECT NAME="${prefix}country" ).
2322 qq(onChange="${prefix}country_changed(this); ).
2323 $param->{'onchange'}.
2326 my $countrydefault = $param->{default_country} || 'US';
2327 foreach my $country (
2328 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2329 keys %cust_main_county
2331 my $selected = $country eq $param->{'selected_country'}
2334 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2336 $country_html .= '</SELECT>';
2339 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2340 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2344 ($county_html, $state_html, $country_html);
2348 sub regionselector_hashref {
2349 my ($county_html, $state_html, $country_html) = regionselector(@_);
2351 'county_html' => $county_html,
2352 'state_html' => $state_html,
2353 'country_html' => $country_html,
2357 =item location_form HASHREF | LIST
2359 Takes as input a hashref or list of key/value pairs with the following keys:
2365 Current customer session_id
2369 Omit red asterisks from required fields.
2371 =item address1_label
2373 Label for first address line.
2377 Returns an HTML fragment for a location form (address, city, state, zip,
2390 my $session_id = delete $param->{'session_id'};
2392 my $rv = mason_comp( 'session_id' => $session_id,
2393 'comp' => '/elements/location.html',
2394 'args' => [ %$param ],
2398 $rv->{'error'} || $rv->{'output'};
2403 #=item expselect HASHREF | LIST
2405 #Takes as input a hashref or list of key/value pairs with the following keys:
2409 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2411 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2415 =item expselect PREFIX [ DATE ]
2417 Takes as input a unique prefix string and the current expiration date, in
2418 yyyy-mm-dd or m-d-yyyy format
2420 Returns an HTML fragments for expiration date selection.
2426 #if ( ref($_[0]) ) {
2430 #my $prefix = $param->{'prefix'};
2431 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2432 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2434 my $date = scalar(@_) ? shift : '';
2436 my( $m, $y ) = ( 0, 0 );
2437 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2438 ( $m, $y ) = ( $2, $1 );
2439 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2440 ( $m, $y ) = ( $1, $3 );
2442 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2444 $return .= qq!<OPTION VALUE="$_"!;
2445 $return .= " SELECTED" if $_ == $m;
2448 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2450 my $thisYear = $t[5] + 1900;
2451 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2452 $return .= qq!<OPTION VALUE="$_"!;
2453 $return .= " SELECTED" if $_ == $y;
2456 $return .= "</SELECT>";
2461 =item popselector HASHREF | LIST
2463 Takes as input a hashref or list of key/value pairs with the following keys:
2469 Access number number
2473 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>.
2477 Returns an HTML fragment for access number selection.
2481 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2489 my $popnum = $param->{'popnum'};
2490 my $pops = $param->{'pops'};
2492 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2493 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2494 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2495 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2496 if scalar(@$pops) == 1;
2499 my %popnum2pop = ();
2501 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2502 $popnum2pop{$_->{popnum}} = $_;
2507 function opt(what,href,text) {
2508 var optionName = new Option(text, href, false, false)
2509 var length = what.length;
2510 what.options[length] = optionName;
2514 my $init_popstate = $param->{'init_popstate'};
2515 if ( $init_popstate ) {
2516 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2517 $init_popstate. '">';
2520 function acstate_changed(what) {
2521 state = what.options[what.selectedIndex].text;
2522 what.form.popac.options.length = 0
2523 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2527 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2528 foreach my $state ( sort { $a cmp $b } @states ) {
2529 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2531 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2532 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2533 if ($ac eq $param->{'popac'}) {
2534 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2537 $text .= "}\n" unless $init_popstate;
2539 $text .= "popac_changed(what.form.popac)}\n";
2542 function popac_changed(what) {
2543 ac = what.options[what.selectedIndex].text;
2544 what.form.popnum.options.length = 0;
2545 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2549 foreach my $state ( @states ) {
2550 foreach my $popac ( keys %{ $pop{$state} } ) {
2551 $text .= "\nif ( ac == \"$popac\" ) {\n";
2553 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2554 my $o_popnum = $pop->{popnum};
2555 my $poptext = $pop->{city}. ', '. $pop->{state}.
2556 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2558 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2559 if ($popnum == $o_popnum) {
2560 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2568 $text .= "}\n</SCRIPT>\n";
2570 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2573 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2574 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2575 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2576 ">$_" foreach sort { $a cmp $b } @states;
2577 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2580 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2581 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2583 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2586 #comment this block to disable initial list polulation
2587 my @initial_select = ();
2588 if ( scalar( @$pops ) > 100 ) {
2589 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2591 @initial_select = @$pops;
2593 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2594 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2595 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2596 $pop->{city}. ', '. $pop->{state}.
2597 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2600 $text .= qq!</SELECT></TD></TR></TABLE>!;
2606 =item domainselector HASHREF | LIST
2608 Takes as input a hashref or list of key/value pairs with the following keys:
2618 Service number of the selected item.
2622 Returns an HTML fragment for domain selection.
2626 sub domainselector {
2633 my $domsvc= $param->{'domsvc'};
2635 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2636 my $domains = $rv->{'domains'};
2637 $domsvc = $rv->{'domsvc'} unless $domsvc;
2639 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2640 unless scalar(keys %$domains);
2642 if (scalar(keys %$domains) == 1) {
2644 foreach(keys %$domains) {
2647 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2648 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2651 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2653 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2655 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2656 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2657 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2658 $domains->{$domain};
2661 $text .= qq!</SELECT></TD></TR>!;
2667 =item didselector HASHREF | LIST
2669 Takes as input a hashref or list of key/value pairs with the following keys:
2675 Field name for the returned HTML fragment.
2679 Service definition (see L<FS::part_svc>)
2683 Returns an HTML fragment for DID selection.
2695 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2696 'args'=>[ %$param ],
2700 $rv->{'error'} || $rv->{'output'};
2706 =head1 RESELLER FUNCTIONS
2708 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2709 with their active session, and the B<customer_info> and B<order_pkg> functions
2710 with their active session and an additional I<custnum> parameter.
2712 For the most part, development of the reseller web interface has been
2713 superceded by agent-virtualized access to the backend.
2725 =item agent_list_customers
2727 List agent's customers.
2735 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>