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 'list_tickets' => 'MyAccount/list_tickets',
103 'create_ticket' => 'MyAccount/create_ticket',
104 'get_ticket' => 'MyAccount/get_ticket',
105 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
106 'did_report' => 'MyAccount/did_report',
107 'signup_info' => 'Signup/signup_info',
108 'skin_info' => 'MyAccount/skin_info',
109 'access_info' => 'MyAccount/access_info',
110 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
111 'new_customer' => 'Signup/new_customer',
112 'new_customer_minimal' => 'Signup/new_customer_minimal',
113 'capture_payment' => 'Signup/capture_payment',
114 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
115 'new_agent' => 'Agent/new_agent',
116 'agent_login' => 'Agent/agent_login',
117 'agent_logout' => 'Agent/agent_logout',
118 'agent_info' => 'Agent/agent_info',
119 'agent_list_customers' => 'Agent/agent_list_customers',
120 'check_username' => 'Agent/check_username',
121 'suspend_username' => 'Agent/suspend_username',
122 'unsuspend_username' => 'Agent/unsuspend_username',
123 'mason_comp' => 'MasonComponent/mason_comp',
124 'call_time' => 'PrepaidPhone/call_time',
125 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
126 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
128 'start_thirdparty' => 'MyAccount/start_thirdparty',
129 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
131 'list_quotations' => 'MyAccount/quotation/list_quotations',
132 'quotation_new' => 'MyAccount/quotation/quotation_new',
133 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
134 'quotation_info' => 'MyAccount/quotation/quotation_info',
135 'quotation_print' => 'MyAccount/quotation/quotation_print',
136 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
137 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
138 'quotation_order' => 'MyAccount/quotation/quotation_order',
143 qw( regionselector regionselector_hashref location_form
144 expselect popselector domainselector didselector
148 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
149 $ENV{'SHELL'} = '/bin/sh';
150 $ENV{'IFS'} = " \t\n";
153 $ENV{'BASH_ENV'} = '';
155 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
156 #if you grant appropriate permissions to whatever user
157 my $freeside_uid = scalar(getpwnam('freeside'));
158 die "not running as the freeside user\n"
159 if $> != $freeside_uid && ! $skip_uid_check;
161 -e $dir or die "FATAL: $dir doesn't exist!";
162 -d $dir or die "FATAL: $dir isn't a directory!";
163 -r $dir or die "FATAL: Can't read $dir as freeside user!";
164 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
166 foreach my $autoload ( keys %autoload ) {
169 "sub $autoload { ". '
174 #warn scalar(@_). ": ". join(" / ", @_);
178 $param->{_packet} = \''. $autoload{$autoload}. '\';
180 simple_packet($param);
190 warn "sending ". $packet->{_packet}. " to server"
192 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
193 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
194 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
197 #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
199 #block until there is a message on socket
200 # my $w = new IO::Select;
202 # my @wait = $w->can_read;
204 warn "reading message from server"
207 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
208 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
210 warn "returning message to client"
218 FS::SelfService - Freeside self-service API
222 # password and shell account changes
223 use FS::SelfService qw(passwd chfn chsh);
225 # "my account" functionality
226 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
228 #new-style login with an email address and password
229 # can also be used for svc_acct login, set $emailaddress to username@domain
230 my $rv = login ( { 'email' => $emailaddress,
231 'password' => $password,
234 if ( $rv->{'error'} ) {
235 #handle login error...
238 $session_id = $rv->{'session_id'};
241 #classic svc_acct-based login with separate username and password
242 my $rv = login( { 'username' => $username,
244 'password' => $password,
247 if ( $rv->{'error'} ) {
248 #handle login error...
251 $session_id = $rv->{'session_id'};
254 #svc_phone login with phone number and PIN
255 my $rv = login( { 'username' => $phone_number,
256 'domain' => 'svc_phone',
260 if ( $rv->{'error'} ) {
261 #handle login error...
264 $session_id = $rv->{'session_id'};
267 my $customer_info = customer_info( { 'session_id' => $session_id } );
269 #payment_info and process_payment are available in 1.5+ only
270 my $payment_info = payment_info( { 'session_id' => $session_id } );
272 #!!! process_payment example
274 #!!! list_pkgs example
276 #ordering a package with an svc_acct service
277 my $rv = order_pkg( { 'session_id' => $session_id,
278 'pkgpart' => $pkgpart,
279 'svcpart' => $svcpart,
280 'username' => $username,
281 'domsvc' => $domsvc, #svcnum of svc_domain
282 '_password' => $password,
286 #!!! ordering a package with an svc_domain service example
288 #!!! ordering a package with an svc_phone service example
290 #!!! ordering a package with an svc_external service example
292 #!!! ordering a package with an svc_pbx service
294 #ordering a package with no service
295 my $rv = order_pkg( { 'session_id' => $session_id,
296 'pkgpart' => $pkgpart,
301 #quoting a package, then ordering after confirmation
303 my $rv = quotation_new({ 'session_id' => $session_id });
304 my $qnum = $rv->{quotationnum};
305 # add packages to the quotation
306 $rv = quotation_add_pkg({ 'session_id' => $session_id,
307 'quotationnum' => $qnum,
308 'pkgpart' => $pkgpart,
309 'quantity' => $quantity, # defaults to 1
311 # repeat until all packages are added
312 # view the pricing information
313 $rv = quotation_info({ 'session_id' => $session_id,
314 'quotationnum' => $qnum,
316 print "Total setup charges: ".$rv->{total_setup}."\n".
317 "Total recurring charges: ".$rv->{total_recur}."\n";
318 # quotation_info also provides a detailed breakdown of charges, in
321 # ask customer for confirmation, then:
322 $rv = quotation_order({ 'session_id' => $session_id,
323 'quotationnum' => $qnum,
326 #!!! cancel_pkg example
328 # signup functionality
329 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
331 my $signup_info = signup_info;
333 $rv = new_customer( {
336 'company' => $company,
337 'address1' => $address1,
338 'address2' => $address2,
342 'country' => $country,
343 'daytime' => $daytime,
347 'payinfo' => $payinfo,
349 'paystart_month' => $paystart_month
350 'paystart_year' => $paystart_year,
351 'payissue' => $payissue,
353 'paydate' => $paydate,
354 'payname' => $payname,
355 'invoicing_list' => $invoicing_list,
356 'referral_custnum' => $referral_custnum,
357 'agentnum' => $agentnum,
358 'pkgpart' => $pkgpart,
360 'username' => $username,
361 '_password' => $password,
365 'phonenum' => $phonenum,
370 my $error = $rv->{'error'};
371 if ( $error eq '_decline' ) {
381 Use this API to implement your own client "self-service" module.
383 If you just want to customize the look of the existing "self-service" module,
386 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
392 Changes the password for an existing user in svc_acct. Takes a hash
393 reference with the following keys:
399 Username of the account (required)
403 Domain of the account (required)
407 Old password (required)
411 New password (required)
429 =head1 "MY ACCOUNT" FUNCTIONS
435 Creates a user session. Takes a hash reference as parameter with the
442 Email address (username@domain), instead of username and domain. Required for
443 contact-based self-service login, can also be used for svc_acct-based login.
459 Returns a hash reference with the following keys:
465 Empty on success, or an error message on errors.
469 Session identifier for successful logins
473 =item customer_info HASHREF
475 Returns general customer information.
477 Takes a hash reference as parameter with a single key: B<session_id>
479 Returns a hash reference with the following keys:
493 Array reference of hash references of open inoices. Each hash reference has
494 the following keys: invnum, date, owed
498 An HTML fragment containing shipping and billing addresses.
500 =item The following fields are also returned
502 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
506 =item edit_info HASHREF
508 Takes a hash reference as parameter with any of the following keys:
510 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
512 If a field exists, the customer record is updated with the new value of that
513 field. If a field does not exist, that field is not changed on the customer
516 Returns a hash reference with a single key, B<error>, empty on success, or an
517 error message on errors
519 =item invoice HASHREF
521 Returns an invoice. Takes a hash reference as parameter with two keys:
522 session_id and invnum
524 Returns a hash reference with the following keys:
530 Empty on success, or an error message on errors
542 =item list_invoices HASHREF
544 Returns a list of all customer invoices. Takes a hash reference with a single
547 Returns a hash reference with the following keys:
553 Empty on success, or an error message on errors
557 Reference to array of hash references with the following keys:
567 Invoice date, in UNIX epoch time
573 =item list_payby HASHREF
575 Returns a list of all stored customer payment information (credit cards and
576 electronic check accounts). Takes a hash reference with a single key,
579 Returns a hash reference with the following keys:
585 Empty on success, or an error message on errors
589 Reference to array of hash references with the following keys:
597 Numeric weighting. Stored payment information with a lower weight is attempted
602 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
603 (on-demand credit card) or DCHK (on-demand electronic check).
607 Masked credit card number (or, masked account and routing numbers)
611 Credit card expiration date
615 Exact name on card (or bank name, for electronic checks)
619 For electronic checks, bank state
623 For electronic checks, account type (Personal/Business, Checking/Savings)
629 =item insert_payby HASHREF
631 Adds new stored payment information for this customer. Takes a hash reference
632 with the following keys:
640 Numeric weighting. Stored payment information with a lower weight is attempted
645 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
646 (on-demand credit card) or DCHK (on-demand electronic check).
650 Credit card number (or electronic check "account@routing")
654 CVV2 number / security code
658 Credit card expiration date
662 Exact name on card (or bank name, for electronic checks)
666 For electronic checks, bank state
670 For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A
674 Optional IP address from which payment was submitted
678 If there is an error, returns a hash reference with a single key, B<error>,
679 otherwise returns a hash reference with a single key, B<custpaybynum>.
681 =item delete_payby HASHREF
683 Removes stored payment information. Takes a hash reference with two keys,
684 B<session_id> and B<custpaybynum>. Returns a hash reference with a single key,
685 B<error>, which is an error message or empty for successful removal.
689 Cancels this customer.
691 Takes a hash reference as parameter with a single key: B<session_id>
693 Returns a hash reference with a single key, B<error>, which is empty on
694 success or an error message on errors.
696 =item payment_info HASHREF
698 Returns information that may be useful in displaying a payment page.
700 Takes a hash reference as parameter with a single key: B<session_id>.
702 Returns a hash reference with the following keys:
708 Empty on success, or an error message on errors
716 Exact name on credit card (CARD/DCRD)
740 Customer's current default payment type.
744 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
748 For CARD/DCRD payment types, the card number
752 For CARD/DCRD payment types, expiration month
756 For CARD/DCRD payment types, expiration year
758 =item cust_main_county
760 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.
764 Array reference of all states in the current default country.
768 Hash reference of card types; keys are card types, values are the exact strings
769 passed to the process_payment function
773 #this doesn't actually work yet
777 #Unique transaction identifier (prevents multiple charges), passed to the
778 #process_payment function
782 =item process_payment HASHREF
784 Processes a payment and possible change of address or payment type. Takes a
785 hash reference as parameter with the following keys:
799 If true, address and card information entered will be saved for subsequent
804 If true, future credit card payments will be done automatically (sets payby to
805 CARD). If false, future credit card payments will be done on-demand (sets
806 payby to DCRD). This option only has meaning if B<save> is set true.
834 Two-letter country code
842 Card expiration month
850 #this doesn't actually work yet
854 #Unique transaction identifier, returned from the payment_info function.
855 #Prevents multiple charges.
859 Returns a hash reference with a single key, B<error>, empty on success, or an
860 error message on errors.
862 =item process_payment_order_pkg
864 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
865 payment processes sucessfully, the package is ordered. Takes a hash reference
866 as parameter with the keys of both methods.
868 Returns a hash reference with a single key, B<error>, empty on success, or an
869 error message on errors.
871 =item process_payment_change_pkg
873 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
874 payment processes sucessfully, the package is ordered. Takes a hash reference
875 as parameter with the keys of both methods.
877 Returns a hash reference with a single key, B<error>, empty on success, or an
878 error message on errors.
881 =item process_payment_order_renew
883 Combines the B<process_payment> and B<order_renew> functions in one step. If
884 the payment processes sucessfully, the renewal is processed. Takes a hash
885 reference as parameter with the keys of both methods.
887 Returns a hash reference with a single key, B<error>, empty on success, or an
888 error message on errors.
892 Returns package information for this customer. For more detail on services,
895 Takes a hash reference as parameter with a single key: B<session_id>
897 Returns a hash reference containing customer package information. The hash reference contains the following keys:
907 Empty on success, or an error message on errors.
909 =item cust_pkg HASHREF
911 Array reference of hash references, each of which has the fields of a cust_pkg
912 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
913 the internal FS:: objects, but hash references of columns and values.
917 =item part_pkg fields
919 All fields of part_pkg for this specific cust_pkg (be careful with this
920 information - it may reveal more about your available packages than you would
921 like users to know in aggregate)
925 #XXX pare part_pkg fields down to a more secure subset
929 An array of hash references indicating information on unprovisioned services
930 available for provisioning for this specific cust_pkg. Each has the following
935 =item part_svc fields
937 All fields of part_svc (be careful with this information - it may reveal more
938 about your available packages than you would like users to know in aggregate)
942 #XXX pare part_svc fields down to a more secure subset
948 An array of hash references indicating information on the customer services
949 already provisioned for this specific cust_pkg. Each has the following keys:
955 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.
961 Primary key for this service
965 Service definition (see L<FS::part_svc>)
969 Customer package (see L<FS::cust_pkg>)
973 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
981 Returns service information for this customer.
983 Takes a hash reference as parameter with a single key: B<session_id>
985 Returns a hash reference containing customer package information. The hash reference contains the following keys:
995 An array of hash references indicating information on all of this customer's
996 services. Each has the following keys:
1002 Primary key for this service
1006 Name of this service
1010 Meaningful user-specific identifier for the service (i.e. username, domain, or
1015 Account (svc_acct) services also have the following keys:
1033 Upload bytes remaining
1037 Download bytes remaining
1041 Total bytes remaining
1043 =item recharge_amount
1047 =item recharge_seconds
1049 Number of seconds gained by recharge
1051 =item recharge_upbytes
1053 Number of upload bytes gained by recharge
1055 =item recharge_downbytes
1057 Number of download bytes gained by recharge
1059 =item recharge_totalbytes
1061 Number of total bytes gained by recharge
1069 Orders a package for this customer.
1071 Takes a hash reference as parameter with the following keys:
1081 Package to order (see L<FS::part_pkg>).
1085 Quantity for this package order (default 1).
1089 Optional locationnum for this package order, for existing locations.
1091 Or, for new locations, pass the following fields: address1*, address2, city*,
1092 county, state*, zip*, country. (* = required in this case)
1104 Service to order (see L<FS::part_svc>).
1106 Normally optional; required only to provision a non-svc_acct service, or if the
1107 package definition does not contain one svc_acct service definition with
1108 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1109 also be specified to indicate that no initial service should be provisioned.
1113 Fields used when provisioning an svc_acct service:
1127 Optional security phrase
1131 Optional Access number number
1135 Fields used when provisioning an svc_domain service:
1145 Fields used when provisioning an svc_phone service:
1163 Fields used when provisioning an svc_external service:
1169 External numeric ID.
1173 External text title.
1177 Fields used when provisioning an svc_pbx service:
1191 Returns a hash reference with a single key, B<error>, empty on success, or an
1192 error message on errors. The special error '_decline' is returned for
1193 declined transactions.
1197 Changes a package for this customer.
1199 Takes a hash reference as parameter with the following keys:
1209 Existing customer package.
1213 New package to order (see L<FS::part_pkg>).
1217 Quantity for this package order (default 1).
1221 Returns a hash reference with the following keys:
1227 Empty on success, or an error message on errors.
1231 On success, the new pkgnum
1238 Provides useful info for early renewals.
1240 Takes a hash reference as parameter with the following keys:
1250 Returns a hash reference. On errors, it contains a single key, B<error>, with
1251 the error message. Otherwise, contains a single key, B<dates>, pointing to
1252 an array refernce of hash references. Each hash reference contains the
1259 (Future) Bill date. Indicates a future date for which billing could be run.
1260 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1263 =item bill_date_pretty
1265 (Future) Bill date as a human-readable string. (Convenience for display;
1266 subject to change, so best not to parse for the date.)
1270 Base amount which will be charged if renewed early as of this date.
1274 Renewal date; i.e. even-futher future date at which the customer will be paid
1275 through if the early renewal is completed with the given B<bill-date>.
1276 Specified as a integer UNIX timestamp.
1278 =item renew_date_pretty
1280 Renewal date as a human-readable string. (Convenience for display;
1281 subject to change, so best not to parse for the date.)
1285 Package that will be renewed.
1289 Expiration date of the package that will be renewed.
1291 =item expire_date_pretty
1293 Expiration date of the package that will be renewed, as a human-readable
1294 string. (Convenience for display; subject to change, so best not to parse for
1301 Renews this customer early; i.e. runs billing for this customer in advance.
1303 Takes a hash reference as parameter with the following keys:
1313 Integer date as returned by the B<renew_info> function, indicating the advance
1314 date for which to run billing.
1318 Returns a hash reference with a single key, B<error>, empty on success, or an
1319 error message on errors.
1323 Cancels a package for this customer.
1325 Takes a hash reference as parameter with the following keys:
1335 pkgpart of package to cancel
1339 Returns a hash reference with a single key, B<error>, empty on success, or an
1340 error message on errors.
1342 =item provision_acct
1344 Provisions an account (svc_acct).
1346 Takes a hash reference as parameter with the following keys:
1356 pkgnum of package into which this service is provisioned
1360 svcpart or service definition to provision
1370 =item provision_phone
1372 Provisions a phone number (svc_phone).
1374 Takes a hash reference as parameter with the following keys:
1384 pkgnum of package into which this service is provisioned
1388 svcpart or service definition to provision
1408 E911 Address (optional)
1414 Provisions a customer PBX (svc_pbx).
1416 Takes a hash reference as parameter with the following keys:
1426 pkgnum of package into which this service is provisioned
1430 svcpart or service definition to provision
1436 =item max_extensions
1438 =item max_simultaneous
1444 =item provision_external
1446 Provisions an external service (svc_external).
1448 Takes a hash reference as parameter with the following keys:
1458 pkgnum of package into which this service is provisioned
1462 svcpart or service definition to provision
1472 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1476 =item contact_passwd
1478 Changes the password for the currently-logged in contact.
1480 Takes a hash reference as parameter with the following keys:
1490 Returns a hash reference with a single parameter, B<error>, which contains an
1491 error message, or empty on success.
1495 Takes a hash reference as parameter with a single key, B<session_id>.
1497 Returns a hash reference with two parameters: B<error>, which contains an error
1498 message, or empty on success, and B<contacts>, a list of contacts.
1500 B<contacts> is an array reference of hash references (i.e. an array of structs,
1501 in XML-RPC). Each hash reference (struct) has the following keys:
1509 Contact class name (contact type).
1521 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1525 Comma-separated list of email addresses
1529 =item selfservice_access
1537 Updates information for the currently-logged in contact, or (optionally) the
1540 Takes a hash reference as parameter with the following keys:
1548 If already logged in as a contact, this is optional.
1558 Returns a hash reference with a single parameter, B<error>, which contains an
1559 error message, or empty on success.
1563 Creates a new contact.
1565 Takes a hash reference as parameter with the following keys:
1579 Optional contact classnum (TODO: or name)
1583 =item selfservice_access
1585 Y to enable self-service access
1591 Returns a hash reference with a single parameter, B<error>, which contains an
1592 error message, or empty on success.
1594 =item delete_contact
1596 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1599 Takes a hash reference as parameter with the following keys:
1609 Returns a hash reference with a single parameter, B<error>, which contains an
1610 error message, or empty on success.
1612 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1614 All of these functions require the user to be logged in, and the 'session_id'
1615 key to be included in the argument hashref.`
1619 =item list_quotations HASHREF
1621 Returns a hashref listing this customer's active self-service quotations.
1628 an arrayref containing an element for each quotation.
1636 the date it was started
1640 the number of packages
1644 the sum of setup fees
1648 the sum of recurring charges
1652 =item quotation_new HASHREF
1654 Creates an empty quotation and returns a hashref containing 'quotationnum',
1655 the primary key of the new quotation.
1657 =item quotation_delete HASHREF
1659 Disables (does not really delete) a quotation. Takes the following arguments:
1665 =item quotationnum - the quotation to delete
1669 Returns 'error' => a string, which will be empty on success.
1671 =item quotation_info HASHREF
1673 Returns total and detailed pricing information on a quotation.
1675 Takes the following arguments:
1681 =item quotationnum - the quotation to return
1685 Returns a hashref containing:
1687 - total_setup, the total of setup fees (and their taxes)
1688 - total_recur, the total of all recurring charges (and their taxes)
1689 - sections, an arrayref containing an element for each quotation section.
1690 - description, a line of text describing the group of charges
1691 - subtotal, the total of charges in this group (if appropriate)
1692 - detail_items, an arrayref of line items
1693 - pkgnum, the reference number of the package
1694 - description, the package name (or tax name)
1696 - amount, the amount charged
1697 If the detail item represents a subtotal, it will instead contain:
1698 - total_item: description of the subtotal
1699 - total_amount: the subtotal amount
1702 =item quotation_print HASHREF
1704 Renders the quotation as HTML or PDF. Takes the following arguments:
1710 =item quotationnum - the quotation to return
1712 =item format - 'html' or 'pdf'
1716 Returns a hashref containing 'document', the contents of the file.
1718 =item quotation_add_pkg HASHREF
1720 Adds a package to a quotation. Takes the following arguments:
1726 =item pkgpart - the package to add
1728 =item quotationnum - the quotation to add it to
1730 =item quantity - the package quantity (defaults to 1)
1732 =item address1, address2, city, state, zip, country - address fields to set
1733 the service location
1737 Returns 'error' => a string, which will be empty on success.
1739 =item quotation_remove_pkg HASHREF
1741 Removes a package from a quotation. Takes the following arguments:
1747 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1749 =item quotationnum - the quotation to remove it from
1753 Returns 'error' => a string, which will be empty on success.
1757 =item quotation_order HASHREF
1759 Converts the packages in a quotation into real packages. Takes the following
1762 Takes the following arguments:
1768 =item quotationnum - the quotation to order
1774 =head1 SIGNUP FUNCTIONS
1778 =item signup_info HASHREF
1780 Takes a hash reference as parameter with the following keys:
1784 =item session_id - Optional agent/reseller interface session
1788 Returns a hash reference containing information that may be useful in
1789 displaying a signup page. The hash reference contains the following keys:
1793 =item cust_main_county
1795 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.
1799 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
1800 an agentnum specified explicitly via reseller interface session_id in the
1805 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.
1807 =item agentnum2part_pkg
1809 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.
1813 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.
1815 =item security_phrase
1817 True if the "security_phrase" feature is enabled
1821 Array reference of acceptable payment types for signup
1827 credit card - automatic
1831 credit card - on-demand - version 1.5+ only
1835 electronic check - automatic
1839 electronic check - on-demand - version 1.5+ only
1847 billing, not recommended for signups
1851 free, definitely not recommended for signups
1855 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1861 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1865 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".
1871 =item countrydefault
1877 =item new_customer_minimal HASHREF
1879 Creates a new customer.
1881 Current differences from new_customer: An address is not required. promo_code
1882 and reg_code are not supported. If invoicing_list and _password is passed, a
1883 contact will be created with self-service access (no pkgpart or username is
1884 necessary). No initial billing is run (this may change in a future version).
1886 Takes a hash reference as parameter with the following keys:
1892 first name (required)
1896 last name (required)
1900 (not typically collected; mostly used for ACH transactions)
1932 Daytime phone number
1936 Evening phone number
1944 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1948 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1952 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1956 Expiration date for CARD/DCRD
1960 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1962 =item invoicing_list
1964 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),
1966 =item referral_custnum
1968 referring customer number
1976 pkgpart of initial package
1992 Access number (index, not the literal number)
1996 Country code (to be provisioned as a service)
2000 Phone number (to be provisioned as a service)
2008 Returns a hash reference with the following keys:
2014 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)
2018 =item new_customer HASHREF
2020 Creates a new customer. Takes a hash reference as parameter with the
2027 first name (required)
2031 last name (required)
2035 (not typically collected; mostly used for ACH transactions)
2041 =item address1 (required)
2049 =item city (required)
2057 =item state (required)
2061 =item zip (required)
2067 Daytime phone number
2071 Evening phone number
2079 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2083 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2087 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2091 Expiration date for CARD/DCRD
2095 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2097 =item invoicing_list
2099 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),
2101 =item referral_custnum
2103 referring customer number
2111 pkgpart of initial package
2127 Access number (index, not the literal number)
2131 Country code (to be provisioned as a service)
2135 Phone number (to be provisioned as a service)
2143 Returns a hash reference with the following keys:
2149 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)
2153 =item regionselector HASHREF | LIST
2155 Takes as input a hashref or list of key/value pairs with the following keys:
2159 =item selected_county
2161 Currently selected county
2163 =item selected_state
2165 Currently selected state
2167 =item selected_country
2169 Currently selected country
2173 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2177 Specify a javascript subroutine to call on changes
2183 =item default_country
2189 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>.
2193 Returns a list consisting of three HTML fragments for county selection,
2194 state selection and country selection, respectively.
2198 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2199 sub regionselector {
2206 $param->{'selected_country'} ||= $param->{'default_country'};
2207 $param->{'selected_state'} ||= $param->{'default_state'};
2209 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2213 my %cust_main_county;
2215 # unless ( @cust_main_county ) { #cache
2216 #@cust_main_county = qsearch('cust_main_county', {} );
2217 #foreach my $c ( @cust_main_county ) {
2218 foreach my $c ( @{ $param->{'locales'} } ) {
2219 #$countyflag=1 if $c->county;
2220 $countyflag=1 if $c->{county};
2221 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2222 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2223 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2226 $countyflag=1 if $param->{selected_county};
2228 my $script_html = <<END;
2230 function opt(what,value,text) {
2231 var optionName = new Option(text, value, false, false);
2232 var length = what.length;
2233 what.options[length] = optionName;
2235 function ${prefix}country_changed(what) {
2236 country = what.options[what.selectedIndex].text;
2237 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2238 what.form.${prefix}state.options[i] = null;
2240 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2242 foreach my $country ( sort keys %cust_main_county ) {
2243 $script_html .= "\nif ( country == \"$country\" ) {\n";
2244 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2245 my $text = $state || '(n/a)';
2246 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2248 $script_html .= "}\n";
2251 $script_html .= <<END;
2253 function ${prefix}state_changed(what) {
2256 if ( $countyflag ) {
2257 $script_html .= <<END;
2258 state = what.options[what.selectedIndex].text;
2259 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2260 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2261 what.form.${prefix}county.options[i] = null;
2264 foreach my $country ( sort keys %cust_main_county ) {
2265 $script_html .= "\nif ( country == \"$country\" ) {\n";
2266 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2267 $script_html .= "\nif ( state == \"$state\" ) {\n";
2268 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2269 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2270 my $text = $county || '(n/a)';
2272 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2274 $script_html .= "}\n";
2276 $script_html .= "}\n";
2280 $script_html .= <<END;
2285 my $county_html = $script_html;
2286 if ( $countyflag ) {
2287 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2288 foreach my $county (
2289 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2291 my $text = $county || '(n/a)';
2292 $county_html .= qq!<OPTION VALUE="$county"!.
2293 ($county eq $param->{'selected_county'} ?
2300 $county_html .= '</SELECT>';
2303 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2306 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2307 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2308 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2309 my $text = $state || '(n/a)';
2310 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2311 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2313 $state_html .= '</SELECT>';
2315 my $country_html = '';
2316 if ( scalar( keys %cust_main_county ) > 1 ) {
2318 $country_html = qq(<SELECT NAME="${prefix}country" ).
2319 qq(onChange="${prefix}country_changed(this); ).
2320 $param->{'onchange'}.
2323 my $countrydefault = $param->{default_country} || 'US';
2324 foreach my $country (
2325 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2326 keys %cust_main_county
2328 my $selected = $country eq $param->{'selected_country'}
2331 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2333 $country_html .= '</SELECT>';
2336 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2337 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2341 ($county_html, $state_html, $country_html);
2345 sub regionselector_hashref {
2346 my ($county_html, $state_html, $country_html) = regionselector(@_);
2348 'county_html' => $county_html,
2349 'state_html' => $state_html,
2350 'country_html' => $country_html,
2354 =item location_form HASHREF | LIST
2356 Takes as input a hashref or list of key/value pairs with the following keys:
2362 Current customer session_id
2366 Omit red asterisks from required fields.
2368 =item address1_label
2370 Label for first address line.
2374 Returns an HTML fragment for a location form (address, city, state, zip,
2387 my $session_id = delete $param->{'session_id'};
2389 my $rv = mason_comp( 'session_id' => $session_id,
2390 'comp' => '/elements/location.html',
2391 'args' => [ %$param ],
2395 $rv->{'error'} || $rv->{'output'};
2400 #=item expselect HASHREF | LIST
2402 #Takes as input a hashref or list of key/value pairs with the following keys:
2406 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2408 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2412 =item expselect PREFIX [ DATE ]
2414 Takes as input a unique prefix string and the current expiration date, in
2415 yyyy-mm-dd or m-d-yyyy format
2417 Returns an HTML fragments for expiration date selection.
2423 #if ( ref($_[0]) ) {
2427 #my $prefix = $param->{'prefix'};
2428 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2429 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2431 my $date = scalar(@_) ? shift : '';
2433 my( $m, $y ) = ( 0, 0 );
2434 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2435 ( $m, $y ) = ( $2, $1 );
2436 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2437 ( $m, $y ) = ( $1, $3 );
2439 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2441 $return .= qq!<OPTION VALUE="$_"!;
2442 $return .= " SELECTED" if $_ == $m;
2445 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2447 my $thisYear = $t[5] + 1900;
2448 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2449 $return .= qq!<OPTION VALUE="$_"!;
2450 $return .= " SELECTED" if $_ == $y;
2453 $return .= "</SELECT>";
2458 =item popselector HASHREF | LIST
2460 Takes as input a hashref or list of key/value pairs with the following keys:
2466 Access number number
2470 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>.
2474 Returns an HTML fragment for access number selection.
2478 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2486 my $popnum = $param->{'popnum'};
2487 my $pops = $param->{'pops'};
2489 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2490 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2491 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2492 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2493 if scalar(@$pops) == 1;
2496 my %popnum2pop = ();
2498 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2499 $popnum2pop{$_->{popnum}} = $_;
2504 function opt(what,href,text) {
2505 var optionName = new Option(text, href, false, false)
2506 var length = what.length;
2507 what.options[length] = optionName;
2511 my $init_popstate = $param->{'init_popstate'};
2512 if ( $init_popstate ) {
2513 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2514 $init_popstate. '">';
2517 function acstate_changed(what) {
2518 state = what.options[what.selectedIndex].text;
2519 what.form.popac.options.length = 0
2520 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2524 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2525 foreach my $state ( sort { $a cmp $b } @states ) {
2526 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2528 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2529 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2530 if ($ac eq $param->{'popac'}) {
2531 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2534 $text .= "}\n" unless $init_popstate;
2536 $text .= "popac_changed(what.form.popac)}\n";
2539 function popac_changed(what) {
2540 ac = what.options[what.selectedIndex].text;
2541 what.form.popnum.options.length = 0;
2542 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2546 foreach my $state ( @states ) {
2547 foreach my $popac ( keys %{ $pop{$state} } ) {
2548 $text .= "\nif ( ac == \"$popac\" ) {\n";
2550 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2551 my $o_popnum = $pop->{popnum};
2552 my $poptext = $pop->{city}. ', '. $pop->{state}.
2553 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2555 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2556 if ($popnum == $o_popnum) {
2557 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2565 $text .= "}\n</SCRIPT>\n";
2567 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2570 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2571 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2572 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2573 ">$_" foreach sort { $a cmp $b } @states;
2574 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2577 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2578 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2580 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2583 #comment this block to disable initial list polulation
2584 my @initial_select = ();
2585 if ( scalar( @$pops ) > 100 ) {
2586 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2588 @initial_select = @$pops;
2590 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2591 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2592 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2593 $pop->{city}. ', '. $pop->{state}.
2594 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2597 $text .= qq!</SELECT></TD></TR></TABLE>!;
2603 =item domainselector HASHREF | LIST
2605 Takes as input a hashref or list of key/value pairs with the following keys:
2615 Service number of the selected item.
2619 Returns an HTML fragment for domain selection.
2623 sub domainselector {
2630 my $domsvc= $param->{'domsvc'};
2632 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2633 my $domains = $rv->{'domains'};
2634 $domsvc = $rv->{'domsvc'} unless $domsvc;
2636 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2637 unless scalar(keys %$domains);
2639 if (scalar(keys %$domains) == 1) {
2641 foreach(keys %$domains) {
2644 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2645 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2648 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2650 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2652 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2653 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2654 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2655 $domains->{$domain};
2658 $text .= qq!</SELECT></TD></TR>!;
2664 =item didselector HASHREF | LIST
2666 Takes as input a hashref or list of key/value pairs with the following keys:
2672 Field name for the returned HTML fragment.
2676 Service definition (see L<FS::part_svc>)
2680 Returns an HTML fragment for DID selection.
2692 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2693 'args'=>[ %$param ],
2697 $rv->{'error'} || $rv->{'output'};
2703 =head1 RESELLER FUNCTIONS
2705 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2706 with their active session, and the B<customer_info> and B<order_pkg> functions
2707 with their active session and an additional I<custnum> parameter.
2709 For the most part, development of the reseller web interface has been
2710 superceded by agent-virtualized access to the backend.
2722 =item agent_list_customers
2724 List agent's customers.
2732 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>