1 package FS::SelfService;
4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
5 $skip_uid_check $dir $socket %autoload $tag );
11 use Storable 2.09 qw(nstore_fd fd_retrieve);
15 @ISA = qw( Exporter );
19 $dir = "/usr/local/freeside";
20 $socket = "$dir/selfservice_socket";
21 $socket .= '.'.$tag if defined $tag && length($tag);
23 #maybe should ask ClientAPI for this list
25 'passwd' => 'passwd/passwd',
26 'chfn' => 'passwd/passwd',
27 'chsh' => 'passwd/passwd',
28 'login_info' => 'MyAccount/login_info',
29 'login_banner_image' => 'MyAccount/login_banner_image',
30 'login' => 'MyAccount/login',
31 'logout' => 'MyAccount/logout',
32 'switch_acct' => 'MyAccount/switch_acct',
33 'switch_cust' => 'MyAccount/switch_cust',
34 'customer_info' => 'MyAccount/customer_info',
35 'customer_info_short' => 'MyAccount/customer_info_short',
37 'contact_passwd' => 'MyAccount/contact/contact_passwd',
38 'list_contacts' => 'MyAccount/contact/list_contacts',
39 'edit_contact' => 'MyAccount/contact/edit_contact',
40 'delete_contact' => 'MyAccount/contact/delete_contact',
41 'new_contact' => 'MyAccount/contact/new_contact',
43 'billing_history' => 'MyAccount/billing_history',
44 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
45 'invoice' => 'MyAccount/invoice',
46 'invoice_pdf' => 'MyAccount/invoice_pdf',
47 'legacy_invoice' => 'MyAccount/legacy_invoice',
48 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
49 'invoice_logo' => 'MyAccount/invoice_logo',
50 'list_invoices' => 'MyAccount/list_invoices', #?
51 'list_payby' => 'MyAccount/list_payby',
52 'insert_payby' => 'MyAccount/insert_payby',
53 'delete_payby' => 'MyAccount/delete_payby',
54 'cancel' => 'MyAccount/cancel', #add to ss cgi!
55 'payment_info' => 'MyAccount/payment_info',
56 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
57 'process_payment' => 'MyAccount/process_payment',
58 'store_payment' => 'MyAccount/store_payment',
59 'process_stored_payment' => 'MyAccount/process_stored_payment',
60 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
61 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
62 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
63 'process_prepay' => 'MyAccount/process_prepay',
64 'realtime_collect' => 'MyAccount/realtime_collect',
65 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
66 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
67 'list_svc_usage' => 'MyAccount/list_svc_usage',
68 'svc_status_html' => 'MyAccount/svc_status_html',
69 'svc_status_hash' => 'MyAccount/svc_status_hash',
70 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
71 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
72 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
73 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
74 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
75 'acct_forward_info' => 'MyAccount/acct_forward_info',
76 'process_acct_forward' => 'MyAccount/process_acct_forward',
77 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
78 'add_dsl_device' => 'MyAccount/add_dsl_device',
79 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
80 'port_graph' => 'MyAccount/port_graph',
81 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
82 'list_support_usage' => 'MyAccount/list_support_usage',
83 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
84 'change_pkg' => 'MyAccount/change_pkg',
85 'order_recharge' => 'MyAccount/order_recharge',
86 'renew_info' => 'MyAccount/renew_info',
87 'order_renew' => 'MyAccount/order_renew',
88 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
89 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
90 'charge' => 'MyAccount/charge', #?
91 'part_svc_info' => 'MyAccount/part_svc_info',
92 'provision_acct' => 'MyAccount/provision_acct',
93 'provision_phone' => 'MyAccount/provision_phone',
94 'provision_pbx' => 'MyAccount/provision_pbx',
95 'provision_external' => 'MyAccount/provision_external',
96 'provision_forward' => 'MyAccount/provision_forward',
97 'unprovision_svc' => 'MyAccount/unprovision_svc',
98 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
99 'reset_passwd' => 'MyAccount/reset_passwd',
100 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
101 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
102 'validate_passwd' => 'MyAccount/validate_passwd',
103 'list_tickets' => 'MyAccount/list_tickets',
104 'create_ticket' => 'MyAccount/create_ticket',
105 'get_ticket' => 'MyAccount/get_ticket',
106 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
107 'did_report' => 'MyAccount/did_report',
108 'signup_info' => 'Signup/signup_info',
109 'skin_info' => 'MyAccount/skin_info',
110 'access_info' => 'MyAccount/access_info',
111 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
112 'new_customer' => 'Signup/new_customer',
113 'new_customer_minimal' => 'Signup/new_customer_minimal',
114 'capture_payment' => 'Signup/capture_payment',
115 'new_prospect' => 'Signup/new_prospect',
116 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
117 'new_agent' => 'Agent/new_agent',
118 'agent_login' => 'Agent/agent_login',
119 'agent_logout' => 'Agent/agent_logout',
120 'agent_info' => 'Agent/agent_info',
121 'agent_list_customers' => 'Agent/agent_list_customers',
122 'check_username' => 'Agent/check_username',
123 'suspend_username' => 'Agent/suspend_username',
124 'unsuspend_username' => 'Agent/unsuspend_username',
125 'mason_comp' => 'MasonComponent/mason_comp',
126 'call_time' => 'PrepaidPhone/call_time',
127 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
128 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
130 'start_thirdparty' => 'MyAccount/start_thirdparty',
131 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
133 'list_quotations' => 'MyAccount/quotation/list_quotations',
134 'quotation_new' => 'MyAccount/quotation/quotation_new',
135 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
136 'quotation_info' => 'MyAccount/quotation/quotation_info',
137 'quotation_print' => 'MyAccount/quotation/quotation_print',
138 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
139 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
140 'quotation_order' => 'MyAccount/quotation/quotation_order',
142 'freesideinc_service' => 'Freeside/freesideinc_service',
147 qw( regionselector regionselector_hashref location_form
148 expselect popselector domainselector didselector
152 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
153 $ENV{'SHELL'} = '/bin/sh';
154 $ENV{'IFS'} = " \t\n";
157 $ENV{'BASH_ENV'} = '';
159 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
160 #if you grant appropriate permissions to whatever user
161 my $freeside_uid = scalar(getpwnam('freeside'));
162 die "not running as the freeside user\n"
163 if $> != $freeside_uid && ! $skip_uid_check;
165 -e $dir or die "FATAL: $dir doesn't exist!";
166 -d $dir or die "FATAL: $dir isn't a directory!";
167 -r $dir or die "FATAL: Can't read $dir as freeside user!";
168 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
170 foreach my $autoload ( keys %autoload ) {
173 "sub $autoload { ". '
178 #warn scalar(@_). ": ". join(" / ", @_);
182 $param->{_packet} = \''. $autoload{$autoload}. '\';
184 simple_packet($param);
194 warn "sending ". $packet->{_packet}. " to server"
196 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
197 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
198 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
201 #shoudl trap: Magic number checking on storable file failed at blib/lib/Storable.pm (autosplit into blib/lib/auto/Storable/fd_retrieve.al) line 337, at /usr/local/share/perl/5.6.1/FS/SelfService.pm line 71
203 #block until there is a message on socket
204 # my $w = new IO::Select;
206 # my @wait = $w->can_read;
208 warn "reading message from server"
211 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
212 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
214 warn "returning message to client"
222 FS::SelfService - Freeside self-service API
226 # password and shell account changes
227 use FS::SelfService qw(passwd chfn chsh);
229 # "my account" functionality
230 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
232 #new-style login with an email address and password
233 # can also be used for svc_acct login, set $emailaddress to username@domain
234 my $rv = login ( { 'email' => $emailaddress,
235 'password' => $password,
238 if ( $rv->{'error'} ) {
239 #handle login error...
242 $session_id = $rv->{'session_id'};
245 #classic svc_acct-based login with separate username and password
246 my $rv = login( { 'username' => $username,
248 'password' => $password,
251 if ( $rv->{'error'} ) {
252 #handle login error...
255 $session_id = $rv->{'session_id'};
258 #svc_phone login with phone number and PIN
259 my $rv = login( { 'username' => $phone_number,
260 'domain' => 'svc_phone',
264 if ( $rv->{'error'} ) {
265 #handle login error...
268 $session_id = $rv->{'session_id'};
271 my $customer_info = customer_info( { 'session_id' => $session_id } );
273 #payment_info and process_payment are available in 1.5+ only
274 my $payment_info = payment_info( { 'session_id' => $session_id } );
276 #!!! process_payment example
278 #!!! list_pkgs example
280 #ordering a package with an svc_acct service
281 my $rv = order_pkg( { 'session_id' => $session_id,
282 'pkgpart' => $pkgpart,
283 'svcpart' => $svcpart,
284 'username' => $username,
285 'domsvc' => $domsvc, #svcnum of svc_domain
286 '_password' => $password,
290 #!!! ordering a package with an svc_domain service example
292 #!!! ordering a package with an svc_phone service example
294 #!!! ordering a package with an svc_external service example
296 #!!! ordering a package with an svc_pbx service
298 #ordering a package with no service
299 my $rv = order_pkg( { 'session_id' => $session_id,
300 'pkgpart' => $pkgpart,
305 #quoting a package, then ordering after confirmation
307 my $rv = quotation_new({ 'session_id' => $session_id });
308 my $qnum = $rv->{quotationnum};
309 # add packages to the quotation
310 $rv = quotation_add_pkg({ 'session_id' => $session_id,
311 'quotationnum' => $qnum,
312 'pkgpart' => $pkgpart,
313 'quantity' => $quantity, # defaults to 1
315 # repeat until all packages are added
316 # view the pricing information
317 $rv = quotation_info({ 'session_id' => $session_id,
318 'quotationnum' => $qnum,
320 print "Total setup charges: ".$rv->{total_setup}."\n".
321 "Total recurring charges: ".$rv->{total_recur}."\n";
322 # quotation_info also provides a detailed breakdown of charges, in
325 # ask customer for confirmation, then:
326 $rv = quotation_order({ 'session_id' => $session_id,
327 'quotationnum' => $qnum,
330 #!!! cancel_pkg example
332 # signup functionality
333 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
335 my $signup_info = signup_info;
337 $rv = new_customer( {
340 'company' => $company,
341 'address1' => $address1,
342 'address2' => $address2,
346 'country' => $country,
347 'daytime' => $daytime,
351 'payinfo' => $payinfo,
353 'paystart_month' => $paystart_month
354 'paystart_year' => $paystart_year,
355 'payissue' => $payissue,
357 'paydate' => $paydate,
358 'payname' => $payname,
359 'invoicing_list' => $invoicing_list,
360 'referral_custnum' => $referral_custnum,
361 'agentnum' => $agentnum,
362 'pkgpart' => $pkgpart,
364 'username' => $username,
365 '_password' => $password,
369 'phonenum' => $phonenum,
374 my $error = $rv->{'error'};
375 if ( $error eq '_decline' ) {
385 Use this API to implement your own client "self-service" module.
387 If you just want to customize the look of the existing "self-service" module,
390 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
396 Changes the password for an existing user in svc_acct. Takes a hash
397 reference with the following keys:
403 Username of the account (required)
407 Domain of the account (required)
411 Old password (required)
415 New password (required)
433 =head1 "MY ACCOUNT" FUNCTIONS
439 Creates a user session. Takes a hash reference as parameter with the
446 Email address (username@domain), instead of username and domain. Required for
447 contact-based self-service login, can also be used for svc_acct-based login.
463 Returns a hash reference with the following keys:
469 Empty on success, or an error message on errors.
473 Session identifier for successful logins
477 =item customer_info HASHREF
479 Returns general customer information.
481 Takes a hash reference as parameter with a single key: B<session_id>
483 Returns a hash reference with the following keys:
497 Array reference of hash references of open inoices. Each hash reference has
498 the following keys: invnum, date, owed
502 An HTML fragment containing shipping and billing addresses.
504 =item The following fields are also returned
506 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo payname month year invoicing_list postal_invoicing
510 =item edit_info HASHREF
512 Takes a hash reference as parameter with any of the following keys:
514 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo paycvv payname month year invoicing_list postal_invoicing
516 If a field exists, the customer record is updated with the new value of that
517 field. If a field does not exist, that field is not changed on the customer
520 Returns a hash reference with a single key, B<error>, empty on success, or an
521 error message on errors
523 =item invoice HASHREF
525 Returns an invoice. Takes a hash reference as parameter with two keys:
526 session_id and invnum
528 Returns a hash reference with the following keys:
534 Empty on success, or an error message on errors
546 =item list_invoices HASHREF
548 Returns a list of all customer invoices. Takes a hash reference with a single
551 Returns a hash reference with the following keys:
557 Empty on success, or an error message on errors
561 Reference to array of hash references with the following keys:
571 Invoice date, in UNIX epoch time
577 =item list_payby HASHREF
579 Returns a list of all stored customer payment information (credit cards and
580 electronic check accounts). Takes a hash reference with a single key,
583 Returns a hash reference with the following keys:
589 Empty on success, or an error message on errors
593 Reference to array of hash references with the following keys:
601 Numeric weighting. Stored payment information with a lower weight is attempted
606 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
607 (on-demand credit card) or DCHK (on-demand electronic check).
611 Masked credit card number (or, masked account and routing numbers)
615 Credit card expiration date
619 Exact name on card (or bank name, for electronic checks)
623 For electronic checks, bank state
627 For electronic checks, account type (Personal/Business, Checking/Savings)
633 =item insert_payby HASHREF
635 Adds new stored payment information for this customer. Takes a hash reference
636 with the following keys:
644 Numeric weighting. Stored payment information with a lower weight is attempted
649 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
650 (on-demand credit card) or DCHK (on-demand electronic check).
654 Credit card number (or electronic check "account@routing")
658 CVV2 number / security code
662 Credit card expiration date
666 Exact name on card (or bank name, for electronic checks)
670 For electronic checks, bank state
674 For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A
678 Optional IP address from which payment was submitted
682 If there is an error, returns a hash reference with a single key, B<error>,
683 otherwise returns a hash reference with a single key, B<custpaybynum>.
685 =item delete_payby HASHREF
687 Removes stored payment information. Takes a hash reference with two keys,
688 B<session_id> and B<custpaybynum>. Returns a hash reference with a single key,
689 B<error>, which is an error message or empty for successful removal.
693 Cancels this customer.
695 Takes a hash reference as parameter with a single key: B<session_id>
697 Returns a hash reference with a single key, B<error>, which is empty on
698 success or an error message on errors.
700 =item payment_info HASHREF
702 Returns information that may be useful in displaying a payment page.
704 Takes a hash reference as parameter with a single key: B<session_id>.
706 Returns a hash reference with the following keys:
712 Empty on success, or an error message on errors
720 Exact name on credit card (CARD/DCRD)
744 Customer's current default payment type.
748 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
752 For CARD/DCRD payment types, the card number
756 For CARD/DCRD payment types, expiration month
760 For CARD/DCRD payment types, expiration year
762 =item cust_main_county
764 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>). Note these are not FS::cust_main_county objects, but hash references of columns and values.
768 Array reference of all states in the current default country.
772 Hash reference of card types; keys are card types, values are the exact strings
773 passed to the process_payment function
777 #this doesn't actually work yet
781 #Unique transaction identifier (prevents multiple charges), passed to the
782 #process_payment function
786 =item process_payment HASHREF
788 Processes a payment and possible change of address or payment type. Takes a
789 hash reference as parameter with the following keys:
803 If true, address and card information entered will be saved for subsequent
808 If true, future credit card payments will be done automatically (sets payby to
809 CARD). If false, future credit card payments will be done on-demand (sets
810 payby to DCRD). This option only has meaning if B<save> is set true.
838 Two-letter country code
846 Card expiration month
854 #this doesn't actually work yet
858 #Unique transaction identifier, returned from the payment_info function.
859 #Prevents multiple charges.
863 Returns a hash reference with a single key, B<error>, empty on success, or an
864 error message on errors.
866 =item process_payment_order_pkg
868 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
869 payment processes sucessfully, the package is ordered. Takes a hash reference
870 as parameter with the keys of both methods.
872 Returns a hash reference with a single key, B<error>, empty on success, or an
873 error message on errors.
875 =item process_payment_change_pkg
877 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
878 payment processes sucessfully, the package is ordered. Takes a hash reference
879 as parameter with the keys of both methods.
881 Returns a hash reference with a single key, B<error>, empty on success, or an
882 error message on errors.
885 =item process_payment_order_renew
887 Combines the B<process_payment> and B<order_renew> functions in one step. If
888 the payment processes sucessfully, the renewal is processed. Takes a hash
889 reference as parameter with the keys of both methods.
891 Returns a hash reference with a single key, B<error>, empty on success, or an
892 error message on errors.
896 Returns package information for this customer. For more detail on services,
899 Takes a hash reference as parameter with a single key: B<session_id>
901 Returns a hash reference containing customer package information. The hash reference contains the following keys:
911 Empty on success, or an error message on errors.
913 =item cust_pkg HASHREF
915 Array reference of hash references, each of which has the fields of a cust_pkg
916 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
917 the internal FS:: objects, but hash references of columns and values.
921 =item part_pkg fields
923 All fields of part_pkg for this specific cust_pkg (be careful with this
924 information - it may reveal more about your available packages than you would
925 like users to know in aggregate)
929 #XXX pare part_pkg fields down to a more secure subset
933 An array of hash references indicating information on unprovisioned services
934 available for provisioning for this specific cust_pkg. Each has the following
939 =item part_svc fields
941 All fields of part_svc (be careful with this information - it may reveal more
942 about your available packages than you would like users to know in aggregate)
946 #XXX pare part_svc fields down to a more secure subset
952 An array of hash references indicating information on the customer services
953 already provisioned for this specific cust_pkg. Each has the following keys:
959 Array reference with three elements: The first element is the name of this service. The second element is a meaningful user-specific identifier for the service (i.e. username, domain or mail alias). The last element is the table name of this service.
965 Primary key for this service
969 Service definition (see L<FS::part_svc>)
973 Customer package (see L<FS::cust_pkg>)
977 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
985 Returns service information for this customer.
987 Takes a hash reference as parameter with a single key: B<session_id>
989 Returns a hash reference containing customer package information. The hash reference contains the following keys:
999 An array of hash references indicating information on all of this customer's
1000 services. Each has the following keys:
1006 Primary key for this service
1010 Name of this service
1014 Meaningful user-specific identifier for the service (i.e. username, domain, or
1019 Account (svc_acct) services also have the following keys:
1037 Upload bytes remaining
1041 Download bytes remaining
1045 Total bytes remaining
1047 =item recharge_amount
1051 =item recharge_seconds
1053 Number of seconds gained by recharge
1055 =item recharge_upbytes
1057 Number of upload bytes gained by recharge
1059 =item recharge_downbytes
1061 Number of download bytes gained by recharge
1063 =item recharge_totalbytes
1065 Number of total bytes gained by recharge
1073 Orders a package for this customer.
1075 If signup_server-realtime is set, bills the new package, attemps to collect
1076 payment and (for auto-payment customers) cancels the package if the payment is
1079 Takes a hash reference as parameter with the following keys:
1089 Package to order (see L<FS::part_pkg>).
1093 Quantity for this package order (default 1).
1095 =item run_bill_events
1097 If true, runs billing events for the customer after ordering and billing the
1098 package (signup_server-realtime must be set).
1102 Optional locationnum for this package order, for existing locations.
1104 Or, for new locations, pass the following fields: address1*, address2, city*,
1105 county, state*, zip*, country. (* = required in this case)
1107 (None of this is required at all if you are just ordering a package
1108 at the customer's existing default service location.)
1126 Service to order (see L<FS::part_svc>).
1128 Normally optional; required only to provision a non-svc_acct service, or if the
1129 package definition does not contain one svc_acct service definition with
1130 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1131 also be specified to indicate that no initial service should be provisioned.
1135 Fields used when provisioning an svc_acct service:
1149 Optional security phrase
1153 Optional Access number number
1157 Fields used when provisioning an svc_domain service:
1167 Fields used when provisioning an svc_phone service:
1185 Fields used when provisioning an svc_external service:
1191 External numeric ID.
1195 External text title.
1199 Fields used when provisioning an svc_pbx service:
1213 Returns a hash reference with a single key, B<error>, empty on success, or an
1214 error message on errors. The special error '_decline' is returned for
1215 declined transactions.
1219 Changes a package for this customer.
1221 Takes a hash reference as parameter with the following keys:
1231 Existing customer package.
1235 New package to order (see L<FS::part_pkg>).
1239 Quantity for this package order (default 1).
1243 Returns a hash reference with the following keys:
1249 Empty on success, or an error message on errors.
1253 On success, the new pkgnum
1260 Provides useful info for early renewals.
1262 Takes a hash reference as parameter with the following keys:
1272 Returns a hash reference. On errors, it contains a single key, B<error>, with
1273 the error message. Otherwise, contains a single key, B<dates>, pointing to
1274 an array refernce of hash references. Each hash reference contains the
1281 (Future) Bill date. Indicates a future date for which billing could be run.
1282 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1285 =item bill_date_pretty
1287 (Future) Bill date as a human-readable string. (Convenience for display;
1288 subject to change, so best not to parse for the date.)
1292 Base amount which will be charged if renewed early as of this date.
1296 Renewal date; i.e. even-futher future date at which the customer will be paid
1297 through if the early renewal is completed with the given B<bill-date>.
1298 Specified as an integer UNIX timestamp.
1300 =item renew_date_pretty
1302 Renewal date as a human-readable string. (Convenience for display;
1303 subject to change, so best not to parse for the date.)
1307 Package that will be renewed.
1311 Expiration date of the package that will be renewed.
1313 =item expire_date_pretty
1315 Expiration date of the package that will be renewed, as a human-readable
1316 string. (Convenience for display; subject to change, so best not to parse for
1323 Renews this customer early; i.e. runs billing for this customer in advance.
1325 Takes a hash reference as parameter with the following keys:
1335 Integer date as returned by the B<renew_info> function, indicating the advance
1336 date for which to run billing.
1340 Returns a hash reference with a single key, B<error>, empty on success, or an
1341 error message on errors.
1345 Cancels a package for this customer.
1347 Takes a hash reference as parameter with the following keys:
1357 pkgpart of package to cancel
1361 Optional date, for future cancellation (expiration) instead of immediate
1362 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1366 Returns a hash reference with a single key, B<error>, empty on success, or an
1367 error message on errors.
1369 =item provision_acct
1371 Provisions an account (svc_acct).
1373 Takes a hash reference as parameter with the following keys:
1383 pkgnum of package into which this service is provisioned
1387 svcpart or service definition to provision
1397 =item provision_phone
1399 Provisions a phone number (svc_phone).
1401 Takes a hash reference as parameter with the following keys:
1411 pkgnum of package into which this service is provisioned
1415 svcpart or service definition to provision
1435 E911 Address (optional)
1441 Provisions a customer PBX (svc_pbx).
1443 Takes a hash reference as parameter with the following keys:
1453 pkgnum of package into which this service is provisioned
1457 svcpart or service definition to provision
1463 =item max_extensions
1465 =item max_simultaneous
1471 =item provision_external
1473 Provisions an external service (svc_external).
1475 Takes a hash reference as parameter with the following keys:
1485 pkgnum of package into which this service is provisioned
1489 svcpart or service definition to provision
1499 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1503 =item contact_passwd
1505 Changes the password for the currently-logged in contact.
1507 Takes a hash reference as parameter with the following keys:
1517 Returns a hash reference with a single parameter, B<error>, which contains an
1518 error message, or empty on success.
1522 Takes a hash reference as parameter with a single key, B<session_id>.
1524 Returns a hash reference with two parameters: B<error>, which contains an error
1525 message, or empty on success, and B<contacts>, a list of contacts.
1527 B<contacts> is an array reference of hash references (i.e. an array of structs,
1528 in XML-RPC). Each hash reference (struct) has the following keys:
1536 Contact class name (contact type).
1548 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1552 Comma-separated list of email addresses
1556 =item selfservice_access
1564 Updates information for the currently-logged in contact, or (optionally) the
1567 Takes a hash reference as parameter with the following keys:
1575 If already logged in as a contact, this is optional.
1585 Returns a hash reference with a single parameter, B<error>, which contains an
1586 error message, or empty on success.
1590 Creates a new contact.
1592 Takes a hash reference as parameter with the following keys:
1606 Optional contact classnum (TODO: or name)
1610 =item selfservice_access
1612 Y to enable self-service access
1618 Returns a hash reference with a single parameter, B<error>, which contains an
1619 error message, or empty on success.
1621 =item delete_contact
1623 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1626 Takes a hash reference as parameter with the following keys:
1636 Returns a hash reference with a single parameter, B<error>, which contains an
1637 error message, or empty on success.
1641 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1643 All of these functions require the user to be logged in, and the 'session_id'
1644 key to be included in the argument hashref.`
1648 =item list_quotations HASHREF
1650 Returns a hashref listing this customer's active self-service quotations.
1657 an arrayref containing an element for each quotation.
1665 the date it was started
1669 the number of packages
1673 the sum of setup fees
1677 the sum of recurring charges
1681 =item quotation_new HASHREF
1683 Creates an empty quotation and returns a hashref containing 'quotationnum',
1684 the primary key of the new quotation.
1686 =item quotation_delete HASHREF
1688 Disables (does not really delete) a quotation. Takes the following arguments:
1694 =item quotationnum - the quotation to delete
1698 Returns 'error' => a string, which will be empty on success.
1700 =item quotation_info HASHREF
1702 Returns total and detailed pricing information on a quotation.
1704 Takes the following arguments:
1710 =item quotationnum - the quotation to return
1714 Returns a hashref containing:
1716 - total_setup, the total of setup fees (and their taxes)
1717 - total_recur, the total of all recurring charges (and their taxes)
1718 - sections, an arrayref containing an element for each quotation section.
1719 - description, a line of text describing the group of charges
1720 - subtotal, the total of charges in this group (if appropriate)
1721 - detail_items, an arrayref of line items
1722 - pkgnum, the reference number of the package
1723 - description, the package name (or tax name)
1725 - amount, the amount charged
1726 If the detail item represents a subtotal, it will instead contain:
1727 - total_item: description of the subtotal
1728 - total_amount: the subtotal amount
1731 =item quotation_print HASHREF
1733 Renders the quotation as HTML or PDF. Takes the following arguments:
1739 =item quotationnum - the quotation to return
1741 =item format - 'html' or 'pdf'
1745 Returns a hashref containing 'document', the contents of the file.
1747 =item quotation_add_pkg HASHREF
1749 Adds a package to a quotation. Takes the following arguments:
1755 =item pkgpart - the package to add
1757 =item quotationnum - the quotation to add it to
1759 =item quantity - the package quantity (defaults to 1)
1761 =item address1, address2, city, state, zip, country - address fields to set
1762 the service location
1766 Returns 'error' => a string, which will be empty on success.
1768 =item quotation_remove_pkg HASHREF
1770 Removes a package from a quotation. Takes the following arguments:
1776 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1778 =item quotationnum - the quotation to remove it from
1782 Returns 'error' => a string, which will be empty on success.
1784 =item quotation_order HASHREF
1786 Converts the packages in a quotation into real packages. Takes the following
1789 Takes the following arguments:
1795 =item quotationnum - the quotation to order
1801 =head1 SIGNUP FUNCTIONS
1805 =item signup_info HASHREF
1807 Takes a hash reference as parameter with the following keys:
1811 =item session_id - Optional agent/reseller interface session
1815 Returns a hash reference containing information that may be useful in
1816 displaying a signup page. The hash reference contains the following keys:
1820 =item cust_main_county
1822 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.
1826 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
1827 an agentnum specified explicitly via reseller interface session_id in the
1832 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.
1834 =item agentnum2part_pkg
1836 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.
1840 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.
1842 =item security_phrase
1844 True if the "security_phrase" feature is enabled
1848 Array reference of acceptable payment types for signup
1854 credit card - automatic
1858 credit card - on-demand - version 1.5+ only
1862 electronic check - automatic
1866 electronic check - on-demand - version 1.5+ only
1874 billing, not recommended for signups
1878 free, definitely not recommended for signups
1882 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1888 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1892 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".
1898 =item countrydefault
1904 =item new_customer_minimal HASHREF
1906 Creates a new customer.
1908 Current differences from new_customer: An address is not required. promo_code
1909 and reg_code are not supported. If invoicing_list and _password is passed, a
1910 contact will be created with self-service access (no pkgpart or username is
1911 necessary). No initial billing is run (this may change in a future version).
1913 Takes a hash reference as parameter with the following keys:
1919 first name (required)
1923 last name (required)
1927 (not typically collected; mostly used for ACH transactions)
1959 Daytime phone number
1963 Evening phone number
1971 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1975 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1979 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1983 Expiration date for CARD/DCRD
1987 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1989 =item invoicing_list
1991 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),
1993 =item referral_custnum
1995 referring customer number
2003 pkgpart of initial package
2019 Access number (index, not the literal number)
2023 Country code (to be provisioned as a service)
2027 Phone number (to be provisioned as a service)
2035 Returns a hash reference with the following keys:
2041 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)
2045 =item new_customer HASHREF
2047 Creates a new customer. Takes a hash reference as parameter with the
2054 first name (required)
2058 last name (required)
2062 (not typically collected; mostly used for ACH transactions)
2068 =item address1 (required)
2076 =item city (required)
2084 =item state (required)
2088 =item zip (required)
2094 Daytime phone number
2098 Evening phone number
2106 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2110 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2114 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2118 Expiration date for CARD/DCRD
2122 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2124 =item invoicing_list
2126 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),
2128 =item referral_custnum
2130 referring customer number
2138 pkgpart of initial package
2154 Access number (index, not the literal number)
2158 Country code (to be provisioned as a service)
2162 Phone number (to be provisioned as a service)
2170 Returns a hash reference with the following keys:
2176 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)
2180 =item regionselector HASHREF | LIST
2182 Takes as input a hashref or list of key/value pairs with the following keys:
2186 =item selected_county
2188 Currently selected county
2190 =item selected_state
2192 Currently selected state
2194 =item selected_country
2196 Currently selected country
2200 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2204 Specify a javascript subroutine to call on changes
2210 =item default_country
2216 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>.
2220 Returns a list consisting of three HTML fragments for county selection,
2221 state selection and country selection, respectively.
2225 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2226 sub regionselector {
2233 $param->{'selected_country'} ||= $param->{'default_country'};
2234 $param->{'selected_state'} ||= $param->{'default_state'};
2236 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2240 my %cust_main_county;
2242 # unless ( @cust_main_county ) { #cache
2243 #@cust_main_county = qsearch('cust_main_county', {} );
2244 #foreach my $c ( @cust_main_county ) {
2245 foreach my $c ( @{ $param->{'locales'} } ) {
2246 #$countyflag=1 if $c->county;
2247 $countyflag=1 if $c->{county};
2248 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2249 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2250 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2253 $countyflag=1 if $param->{selected_county};
2255 my $script_html = <<END;
2257 function opt(what,value,text) {
2258 var optionName = new Option(text, value, false, false);
2259 var length = what.length;
2260 what.options[length] = optionName;
2262 function ${prefix}country_changed(what) {
2263 country = what.options[what.selectedIndex].text;
2264 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2265 what.form.${prefix}state.options[i] = null;
2267 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2269 foreach my $country ( sort keys %cust_main_county ) {
2270 $script_html .= "\nif ( country == \"$country\" ) {\n";
2271 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2272 my $text = $state || '(n/a)';
2273 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2275 $script_html .= "}\n";
2278 $script_html .= <<END;
2280 function ${prefix}state_changed(what) {
2283 if ( $countyflag ) {
2284 $script_html .= <<END;
2285 state = what.options[what.selectedIndex].text;
2286 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2287 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2288 what.form.${prefix}county.options[i] = null;
2291 foreach my $country ( sort keys %cust_main_county ) {
2292 $script_html .= "\nif ( country == \"$country\" ) {\n";
2293 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2294 $script_html .= "\nif ( state == \"$state\" ) {\n";
2295 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2296 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2297 my $text = $county || '(n/a)';
2299 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2301 $script_html .= "}\n";
2303 $script_html .= "}\n";
2307 $script_html .= <<END;
2312 my $county_html = $script_html;
2313 if ( $countyflag ) {
2314 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2315 foreach my $county (
2316 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2318 my $text = $county || '(n/a)';
2319 $county_html .= qq!<OPTION VALUE="$county"!.
2320 ($county eq $param->{'selected_county'} ?
2327 $county_html .= '</SELECT>';
2330 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2333 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2334 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2335 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2336 my $text = $state || '(n/a)';
2337 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2338 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2340 $state_html .= '</SELECT>';
2342 my $country_html = '';
2343 if ( scalar( keys %cust_main_county ) > 1 ) {
2345 $country_html = qq(<SELECT NAME="${prefix}country" ).
2346 qq(onChange="${prefix}country_changed(this); ).
2347 $param->{'onchange'}.
2350 my $countrydefault = $param->{default_country} || 'US';
2351 foreach my $country (
2352 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2353 keys %cust_main_county
2355 my $selected = $country eq $param->{'selected_country'}
2358 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2360 $country_html .= '</SELECT>';
2363 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2364 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2368 ($county_html, $state_html, $country_html);
2372 sub regionselector_hashref {
2373 my ($county_html, $state_html, $country_html) = regionselector(@_);
2375 'county_html' => $county_html,
2376 'state_html' => $state_html,
2377 'country_html' => $country_html,
2381 =item location_form HASHREF | LIST
2383 Takes as input a hashref or list of key/value pairs with the following keys:
2389 Current customer session_id
2393 Omit red asterisks from required fields.
2395 =item address1_label
2397 Label for first address line.
2401 Returns an HTML fragment for a location form (address, city, state, zip,
2414 my $session_id = delete $param->{'session_id'};
2416 my $rv = mason_comp( 'session_id' => $session_id,
2417 'comp' => '/elements/location.html',
2418 'args' => [ %$param ],
2422 $rv->{'error'} || $rv->{'output'};
2427 #=item expselect HASHREF | LIST
2429 #Takes as input a hashref or list of key/value pairs with the following keys:
2433 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2435 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2439 =item expselect PREFIX [ DATE ]
2441 Takes as input a unique prefix string and the current expiration date, in
2442 yyyy-mm-dd or m-d-yyyy format
2444 Returns an HTML fragments for expiration date selection.
2450 #if ( ref($_[0]) ) {
2454 #my $prefix = $param->{'prefix'};
2455 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2456 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2458 my $date = scalar(@_) ? shift : '';
2460 my( $m, $y ) = ( 0, 0 );
2461 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2462 ( $m, $y ) = ( $2, $1 );
2463 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2464 ( $m, $y ) = ( $1, $3 );
2466 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2468 $return .= qq!<OPTION VALUE="$_"!;
2469 $return .= " SELECTED" if $_ == $m;
2472 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2474 my $thisYear = $t[5] + 1900;
2475 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2476 $return .= qq!<OPTION VALUE="$_"!;
2477 $return .= " SELECTED" if $_ == $y;
2480 $return .= "</SELECT>";
2485 =item popselector HASHREF | LIST
2487 Takes as input a hashref or list of key/value pairs with the following keys:
2493 Access number number
2497 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>.
2501 Returns an HTML fragment for access number selection.
2505 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2513 my $popnum = $param->{'popnum'};
2514 my $pops = $param->{'pops'};
2516 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2517 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2518 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2519 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2520 if scalar(@$pops) == 1;
2523 my %popnum2pop = ();
2525 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2526 $popnum2pop{$_->{popnum}} = $_;
2531 function opt(what,href,text) {
2532 var optionName = new Option(text, href, false, false)
2533 var length = what.length;
2534 what.options[length] = optionName;
2538 my $init_popstate = $param->{'init_popstate'};
2539 if ( $init_popstate ) {
2540 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2541 $init_popstate. '">';
2544 function acstate_changed(what) {
2545 state = what.options[what.selectedIndex].text;
2546 what.form.popac.options.length = 0
2547 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2551 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2552 foreach my $state ( sort { $a cmp $b } @states ) {
2553 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2555 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2556 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2557 if ($ac eq $param->{'popac'}) {
2558 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2561 $text .= "}\n" unless $init_popstate;
2563 $text .= "popac_changed(what.form.popac)}\n";
2566 function popac_changed(what) {
2567 ac = what.options[what.selectedIndex].text;
2568 what.form.popnum.options.length = 0;
2569 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2573 foreach my $state ( @states ) {
2574 foreach my $popac ( keys %{ $pop{$state} } ) {
2575 $text .= "\nif ( ac == \"$popac\" ) {\n";
2577 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2578 my $o_popnum = $pop->{popnum};
2579 my $poptext = $pop->{city}. ', '. $pop->{state}.
2580 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2582 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2583 if ($popnum == $o_popnum) {
2584 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2592 $text .= "}\n</SCRIPT>\n";
2594 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2597 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2598 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2599 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2600 ">$_" foreach sort { $a cmp $b } @states;
2601 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2604 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2605 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2607 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2610 #comment this block to disable initial list polulation
2611 my @initial_select = ();
2612 if ( scalar( @$pops ) > 100 ) {
2613 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2615 @initial_select = @$pops;
2617 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2618 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2619 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2620 $pop->{city}. ', '. $pop->{state}.
2621 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2624 $text .= qq!</SELECT></TD></TR></TABLE>!;
2630 =item domainselector HASHREF | LIST
2632 Takes as input a hashref or list of key/value pairs with the following keys:
2642 Service number of the selected item.
2646 Returns an HTML fragment for domain selection.
2650 sub domainselector {
2657 my $domsvc= $param->{'domsvc'};
2659 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2660 my $domains = $rv->{'domains'};
2661 $domsvc = $rv->{'domsvc'} unless $domsvc;
2663 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2664 unless scalar(keys %$domains);
2666 if (scalar(keys %$domains) == 1) {
2668 foreach(keys %$domains) {
2671 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2672 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2675 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2677 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2679 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2680 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2681 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2682 $domains->{$domain};
2685 $text .= qq!</SELECT></TD></TR>!;
2691 =item didselector HASHREF | LIST
2693 Takes as input a hashref or list of key/value pairs with the following keys:
2699 Field name for the returned HTML fragment.
2703 Service definition (see L<FS::part_svc>)
2707 Returns an HTML fragment for DID selection.
2719 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2720 'args'=>[ %$param ],
2724 $rv->{'error'} || $rv->{'output'};
2730 =head1 RESELLER FUNCTIONS
2732 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2733 with their active session, and the B<customer_info> and B<order_pkg> functions
2734 with their active session and an additional I<custnum> parameter.
2736 For the most part, development of the reseller web interface has been
2737 superceded by agent-virtualized access to the backend.
2749 =item agent_list_customers
2751 List agent's customers.
2759 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>