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',
36 'customer_recurring' => 'MyAccount/customer_recurring',
38 'contact_passwd' => 'MyAccount/contact/contact_passwd',
39 'list_contacts' => 'MyAccount/contact/list_contacts',
40 'edit_contact' => 'MyAccount/contact/edit_contact',
41 'delete_contact' => 'MyAccount/contact/delete_contact',
42 'new_contact' => 'MyAccount/contact/new_contact',
44 'billing_history' => 'MyAccount/billing_history',
45 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
46 'invoice' => 'MyAccount/invoice',
47 'invoice_pdf' => 'MyAccount/invoice_pdf',
48 'legacy_invoice' => 'MyAccount/legacy_invoice',
49 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
50 'invoice_logo' => 'MyAccount/invoice_logo',
51 'list_invoices' => 'MyAccount/list_invoices', #?
52 'list_payby' => 'MyAccount/list_payby',
53 'insert_payby' => 'MyAccount/insert_payby',
54 'update_payby' => 'MyAccount/update_payby',
55 'delete_payby' => 'MyAccount/delete_payby',
56 'cancel' => 'MyAccount/cancel', #add to ss cgi!
57 'payment_info' => 'MyAccount/payment_info',
58 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
59 'process_payment' => 'MyAccount/process_payment',
60 'store_payment' => 'MyAccount/store_payment',
61 'process_stored_payment' => 'MyAccount/process_stored_payment',
62 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
63 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
64 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
65 'process_prepay' => 'MyAccount/process_prepay',
66 'realtime_collect' => 'MyAccount/realtime_collect',
67 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
68 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
69 'list_svc_usage' => 'MyAccount/list_svc_usage',
70 'svc_status_html' => 'MyAccount/svc_status_html',
71 'svc_status_hash' => 'MyAccount/svc_status_hash',
72 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
73 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
74 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
75 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
76 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
77 'acct_forward_info' => 'MyAccount/acct_forward_info',
78 'process_acct_forward' => 'MyAccount/process_acct_forward',
79 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
80 'add_dsl_device' => 'MyAccount/add_dsl_device',
81 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
82 'port_graph' => 'MyAccount/port_graph',
83 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
84 'list_support_usage' => 'MyAccount/list_support_usage',
85 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
86 'change_pkg' => 'MyAccount/change_pkg',
87 'order_recharge' => 'MyAccount/order_recharge',
88 'renew_info' => 'MyAccount/renew_info',
89 'order_renew' => 'MyAccount/order_renew',
90 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
91 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
92 'charge' => 'MyAccount/charge', #?
93 'part_svc_info' => 'MyAccount/part_svc_info',
94 'provision_acct' => 'MyAccount/provision_acct',
95 'provision_phone' => 'MyAccount/provision_phone',
96 'provision_pbx' => 'MyAccount/provision_pbx',
97 'provision_external' => 'MyAccount/provision_external',
98 'provision_forward' => 'MyAccount/provision_forward',
99 'unprovision_svc' => 'MyAccount/unprovision_svc',
100 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
101 'reset_passwd' => 'MyAccount/reset_passwd',
102 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
103 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
104 'validate_passwd' => 'MyAccount/validate_passwd',
105 'list_tickets' => 'MyAccount/list_tickets',
106 'create_ticket' => 'MyAccount/create_ticket',
107 'get_ticket' => 'MyAccount/get_ticket',
108 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
109 'did_report' => 'MyAccount/did_report',
110 'signup_info' => 'Signup/signup_info',
111 'skin_info' => 'MyAccount/skin_info',
112 'access_info' => 'MyAccount/access_info',
113 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
114 'new_customer' => 'Signup/new_customer',
115 'new_customer_minimal' => 'Signup/new_customer_minimal',
116 'capture_payment' => 'Signup/capture_payment',
117 'new_prospect' => 'Signup/new_prospect',
118 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
119 'new_agent' => 'Agent/new_agent',
120 'agent_login' => 'Agent/agent_login',
121 'agent_logout' => 'Agent/agent_logout',
122 'agent_info' => 'Agent/agent_info',
123 'agent_list_customers' => 'Agent/agent_list_customers',
124 'check_username' => 'Agent/check_username',
125 'suspend_username' => 'Agent/suspend_username',
126 'unsuspend_username' => 'Agent/unsuspend_username',
127 'mason_comp' => 'MasonComponent/mason_comp',
128 'call_time' => 'PrepaidPhone/call_time',
129 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
130 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
132 'start_thirdparty' => 'MyAccount/start_thirdparty',
133 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
135 'list_quotations' => 'MyAccount/quotation/list_quotations',
136 'quotation_new' => 'MyAccount/quotation/quotation_new',
137 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
138 'quotation_info' => 'MyAccount/quotation/quotation_info',
139 'quotation_print' => 'MyAccount/quotation/quotation_print',
140 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
141 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
142 'quotation_order' => 'MyAccount/quotation/quotation_order',
144 'freesideinc_service' => 'Freeside/freesideinc_service',
149 qw( regionselector regionselector_hashref location_form
150 expselect popselector domainselector didselector
154 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
155 $ENV{'SHELL'} = '/bin/sh';
156 $ENV{'IFS'} = " \t\n";
159 $ENV{'BASH_ENV'} = '';
161 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
162 #if you grant appropriate permissions to whatever user
163 my $freeside_uid = scalar(getpwnam('freeside'));
164 die "not running as the freeside user\n"
165 if $> != $freeside_uid && ! $skip_uid_check;
167 -e $dir or die "FATAL: $dir doesn't exist!";
168 -d $dir or die "FATAL: $dir isn't a directory!";
169 -r $dir or die "FATAL: Can't read $dir as freeside user!";
170 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
172 foreach my $autoload ( keys %autoload ) {
175 "sub $autoload { ". '
180 #warn scalar(@_). ": ". join(" / ", @_);
184 $param->{_packet} = \''. $autoload{$autoload}. '\';
186 simple_packet($param);
196 warn "sending ". $packet->{_packet}. " to server"
198 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
199 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
200 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
203 #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
205 #block until there is a message on socket
206 # my $w = new IO::Select;
208 # my @wait = $w->can_read;
210 warn "reading message from server"
213 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
214 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
216 warn "returning message to client"
224 FS::SelfService - Freeside self-service API
228 # password and shell account changes
229 use FS::SelfService qw(passwd chfn chsh);
231 # "my account" functionality
232 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
234 #new-style login with an email address and password
235 # can also be used for svc_acct login, set $emailaddress to username@domain
236 my $rv = login ( { 'email' => $emailaddress,
237 'password' => $password,
240 if ( $rv->{'error'} ) {
241 #handle login error...
244 $session_id = $rv->{'session_id'};
247 #classic svc_acct-based login with separate username and password
248 my $rv = login( { 'username' => $username,
250 'password' => $password,
253 if ( $rv->{'error'} ) {
254 #handle login error...
257 $session_id = $rv->{'session_id'};
260 #svc_phone login with phone number and PIN
261 my $rv = login( { 'username' => $phone_number,
262 'domain' => 'svc_phone',
266 if ( $rv->{'error'} ) {
267 #handle login error...
270 $session_id = $rv->{'session_id'};
273 my $customer_info = customer_info( { 'session_id' => $session_id } );
275 #payment_info and process_payment are available in 1.5+ only
276 my $payment_info = payment_info( { 'session_id' => $session_id } );
278 #!!! process_payment example
280 #!!! list_pkgs example
282 #ordering a package with an svc_acct service
283 my $rv = order_pkg( { 'session_id' => $session_id,
284 'pkgpart' => $pkgpart,
285 'svcpart' => $svcpart,
286 'username' => $username,
287 'domsvc' => $domsvc, #svcnum of svc_domain
288 '_password' => $password,
292 #!!! ordering a package with an svc_domain service example
294 #!!! ordering a package with an svc_phone service example
296 #!!! ordering a package with an svc_external service example
298 #!!! ordering a package with an svc_pbx service
300 #ordering a package with no service
301 my $rv = order_pkg( { 'session_id' => $session_id,
302 'pkgpart' => $pkgpart,
307 #quoting a package, then ordering after confirmation
309 my $rv = quotation_new({ 'session_id' => $session_id });
310 my $qnum = $rv->{quotationnum};
311 # add packages to the quotation
312 $rv = quotation_add_pkg({ 'session_id' => $session_id,
313 'quotationnum' => $qnum,
314 'pkgpart' => $pkgpart,
315 'quantity' => $quantity, # defaults to 1
317 # repeat until all packages are added
318 # view the pricing information
319 $rv = quotation_info({ 'session_id' => $session_id,
320 'quotationnum' => $qnum,
322 print "Total setup charges: ".$rv->{total_setup}."\n".
323 "Total recurring charges: ".$rv->{total_recur}."\n";
324 # quotation_info also provides a detailed breakdown of charges, in
327 # ask customer for confirmation, then:
328 $rv = quotation_order({ 'session_id' => $session_id,
329 'quotationnum' => $qnum,
332 #!!! cancel_pkg example
334 # signup functionality
335 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
337 my $signup_info = signup_info;
339 $rv = new_customer( {
342 'company' => $company,
343 'address1' => $address1,
344 'address2' => $address2,
348 'country' => $country,
349 'daytime' => $daytime,
353 'payinfo' => $payinfo,
355 'paystart_month' => $paystart_month
356 'paystart_year' => $paystart_year,
357 'payissue' => $payissue,
359 'paydate' => $paydate,
360 'payname' => $payname,
361 'invoicing_list' => $invoicing_list,
362 'referral_custnum' => $referral_custnum,
363 'agentnum' => $agentnum,
364 'pkgpart' => $pkgpart,
366 'username' => $username,
367 '_password' => $password,
371 'phonenum' => $phonenum,
376 my $error = $rv->{'error'};
377 if ( $error eq '_decline' ) {
387 Use this API to implement your own client "self-service" module.
389 If you just want to customize the look of the existing "self-service" module,
392 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
398 Changes the password for an existing user in svc_acct. Takes a hash
399 reference with the following keys:
405 Username of the account (required)
409 Domain of the account (required)
413 Old password (required)
417 New password (required)
435 =head1 "MY ACCOUNT" FUNCTIONS
441 Creates a user session. Takes a hash reference as parameter with the
448 Email address (username@domain), instead of username and domain. Required for
449 contact-based self-service login, can also be used for svc_acct-based login.
465 Returns a hash reference with the following keys:
471 Empty on success, or an error message on errors.
475 Session identifier for successful logins
479 =item customer_info HASHREF
481 Returns general customer information.
483 Takes a hash reference as parameter with a single key: B<session_id>
485 Returns a hash reference with the following keys:
499 Array reference of hash references of open inoices. Each hash reference has
500 the following keys: invnum, date, owed
504 An HTML fragment containing shipping and billing addresses.
506 =item The following fields are also returned
508 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
512 =item customer_recurring HASHREF
514 Takes a hash reference as parameter with a single key B<session_id>
515 or keys B<agent_session_id> and B<custnum>.
517 Returns a hash reference with the keys error, custnum and display_recurring.
519 display_recurring is an arrayref of hashrefs with the following keys:
525 frequency of charge, in months unless units are specified
529 frequency of charge, suitable for display
533 amount charged at this frequency
537 =item edit_info HASHREF
539 Takes a hash reference as parameter with any of the following keys:
541 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
543 If a field exists, the customer record is updated with the new value of that
544 field. If a field does not exist, that field is not changed on the customer
547 Returns a hash reference with a single key, B<error>, empty on success, or an
548 error message on errors
550 =item invoice HASHREF
552 Returns an invoice. Takes a hash reference as parameter with two keys:
553 session_id and invnum
555 Returns a hash reference with the following keys:
561 Empty on success, or an error message on errors
573 =item list_invoices HASHREF
575 Returns a list of all customer invoices. Takes a hash reference with a single
578 Returns a hash reference with the following keys:
584 Empty on success, or an error message on errors
588 Reference to array of hash references with the following keys:
598 Invoice date, in UNIX epoch time
604 =item list_payby HASHREF
606 Returns a list of all stored customer payment information (credit cards and
607 electronic check accounts). Takes a hash reference with a single key,
610 Returns a hash reference with the following keys:
616 Empty on success, or an error message on errors
620 Reference to array of hash references with the following keys:
628 Numeric weighting. Stored payment information with a lower weight is attempted
633 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
634 (on-demand credit card) or DCHK (on-demand electronic check).
638 Masked credit card number (or, masked account and routing numbers)
642 Credit card expiration date
646 Exact name on card (or bank name, for electronic checks)
650 For electronic checks, bank state
654 For electronic checks, account type (Personal/Business, Checking/Savings)
660 =item insert_payby HASHREF
662 Adds new stored payment information for this customer. Takes a hash reference
663 with the following keys:
671 Numeric weighting. Stored payment information with a lower weight is attempted
676 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
677 (on-demand credit card) or DCHK (on-demand electronic check).
681 Credit card number (or electronic check "account@routing")
685 CVV2 number / security code
689 Credit card expiration date
693 Exact name on card (or bank name, for electronic checks)
697 For electronic checks, bank state
701 For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A
705 Optional IP address from which payment was submitted
709 If there is an error, returns a hash reference with a single key, B<error>,
710 otherwise returns a hash reference with a single key, B<custpaybynum>.
712 =item update_payby HASHREF
714 Updates stored payment information. Takes a hash reference with the same
715 keys as insert_payby, as well as B<custpaybynum> to specify which record
716 to update. All keys except B<session_id> and B<custpaybynum> are optional;
717 if omitted, the previous values in the record will be preserved.
719 If there is an error, returns a hash reference with a single key, B<error>,
720 otherwise returns a hash reference with a single key, B<custpaybynum>.
722 =item delete_payby HASHREF
724 Removes stored payment information. Takes a hash reference with two keys,
725 B<session_id> and B<custpaybynum>. Returns a hash reference with a single key,
726 B<error>, which is an error message or empty for successful removal.
730 Cancels this customer.
732 Takes a hash reference as parameter with a single key: B<session_id>
734 Returns a hash reference with a single key, B<error>, which is empty on
735 success or an error message on errors.
737 =item payment_info HASHREF
739 Returns information that may be useful in displaying a payment page.
741 Takes a hash reference as parameter with a single key: B<session_id>.
743 Returns a hash reference with the following keys:
749 Empty on success, or an error message on errors
757 Exact name on credit card (CARD/DCRD)
781 Customer's current default payment type.
785 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
789 For CARD/DCRD payment types, the card number
793 For CARD/DCRD payment types, expiration month
797 For CARD/DCRD payment types, expiration year
799 =item cust_main_county
801 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.
805 Array reference of all states in the current default country.
809 Hash reference of card types; keys are card types, values are the exact strings
810 passed to the process_payment function
814 #this doesn't actually work yet
818 #Unique transaction identifier (prevents multiple charges), passed to the
819 #process_payment function
823 =item process_payment HASHREF
825 Processes a payment and possible change of address or payment type. Takes a
826 hash reference as parameter with the following keys:
840 If true, address and card information entered will be saved for subsequent
845 If true, future credit card payments will be done automatically (sets payby to
846 CARD). If false, future credit card payments will be done on-demand (sets
847 payby to DCRD). This option only has meaning if B<save> is set true.
875 Two-letter country code
883 Card expiration month
891 #this doesn't actually work yet
895 #Unique transaction identifier, returned from the payment_info function.
896 #Prevents multiple charges.
900 Returns a hash reference with a single key, B<error>, empty on success, or an
901 error message on errors.
903 =item process_payment_order_pkg
905 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
906 payment processes sucessfully, the package is ordered. Takes a hash reference
907 as parameter with the keys of both methods.
909 Returns a hash reference with a single key, B<error>, empty on success, or an
910 error message on errors.
912 =item process_payment_change_pkg
914 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
915 payment processes sucessfully, the package is ordered. Takes a hash reference
916 as parameter with the keys of both methods.
918 Returns a hash reference with a single key, B<error>, empty on success, or an
919 error message on errors.
922 =item process_payment_order_renew
924 Combines the B<process_payment> and B<order_renew> functions in one step. If
925 the payment processes sucessfully, the renewal is processed. Takes a hash
926 reference as parameter with the keys of both methods.
928 Returns a hash reference with a single key, B<error>, empty on success, or an
929 error message on errors.
933 Returns package information for this customer. For more detail on services,
936 Takes a hash reference as parameter with a single key: B<session_id>
938 Returns a hash reference containing customer package information. The hash reference contains the following keys:
948 Empty on success, or an error message on errors.
950 =item cust_pkg HASHREF
952 Array reference of hash references, each of which has the fields of a cust_pkg
953 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
954 the internal FS:: objects, but hash references of columns and values.
958 =item part_pkg fields
960 All fields of part_pkg for this specific cust_pkg (be careful with this
961 information - it may reveal more about your available packages than you would
962 like users to know in aggregate)
966 #XXX pare part_pkg fields down to a more secure subset
970 An array of hash references indicating information on unprovisioned services
971 available for provisioning for this specific cust_pkg. Each has the following
976 =item part_svc fields
978 All fields of part_svc (be careful with this information - it may reveal more
979 about your available packages than you would like users to know in aggregate)
983 #XXX pare part_svc fields down to a more secure subset
989 An array of hash references indicating information on the customer services
990 already provisioned for this specific cust_pkg. Each has the following keys:
996 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.
1002 Primary key for this service
1006 Service definition (see L<FS::part_svc>)
1010 Customer package (see L<FS::cust_pkg>)
1014 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
1022 Returns service information for this customer.
1024 Takes a hash reference as parameter with a single key: B<session_id>
1026 Returns a hash reference containing customer package information. The hash reference contains the following keys:
1036 An array of hash references indicating information on all of this customer's
1037 services. Each has the following keys:
1043 Primary key for this service
1047 Name of this service
1051 Meaningful user-specific identifier for the service (i.e. username, domain, or
1056 Account (svc_acct) services also have the following keys:
1074 Upload bytes remaining
1078 Download bytes remaining
1082 Total bytes remaining
1084 =item recharge_amount
1088 =item recharge_seconds
1090 Number of seconds gained by recharge
1092 =item recharge_upbytes
1094 Number of upload bytes gained by recharge
1096 =item recharge_downbytes
1098 Number of download bytes gained by recharge
1100 =item recharge_totalbytes
1102 Number of total bytes gained by recharge
1110 Orders a package for this customer.
1112 If signup_server-realtime is set, bills the new package, attemps to collect
1113 payment and (for auto-payment customers) cancels the package if the payment is
1116 Takes a hash reference as parameter with the following keys:
1126 Package to order (see L<FS::part_pkg>).
1130 Quantity for this package order (default 1).
1132 =item run_bill_events
1134 If true, runs billing events for the customer after ordering and billing the
1135 package (signup_server-realtime must be set).
1139 Optional locationnum for this package order, for existing locations.
1141 Or, for new locations, pass the following fields: address1*, address2, city*,
1142 county, state*, zip*, country. (* = required in this case)
1144 (None of this is required at all if you are just ordering a package
1145 at the customer's existing default service location.)
1163 Service to order (see L<FS::part_svc>).
1165 Normally optional; required only to provision a non-svc_acct service, or if the
1166 package definition does not contain one svc_acct service definition with
1167 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1168 also be specified to indicate that no initial service should be provisioned.
1172 Fields used when provisioning an svc_acct service:
1186 Optional security phrase
1190 Optional Access number number
1194 Fields used when provisioning an svc_domain service:
1204 Fields used when provisioning an svc_phone service:
1222 Fields used when provisioning an svc_external service:
1228 External numeric ID.
1232 External text title.
1236 Fields used when provisioning an svc_pbx service:
1250 Returns a hash reference with a single key, B<error>, empty on success, or an
1251 error message on errors. The special error '_decline' is returned for
1252 declined transactions.
1256 Changes a package for this customer.
1258 Takes a hash reference as parameter with the following keys:
1268 Existing customer package.
1272 New package to order (see L<FS::part_pkg>).
1276 Quantity for this package order (default 1).
1280 Returns a hash reference with the following keys:
1286 Empty on success, or an error message on errors.
1290 On success, the new pkgnum
1297 Provides useful info for early renewals.
1299 Takes a hash reference as parameter with the following keys:
1309 Returns a hash reference. On errors, it contains a single key, B<error>, with
1310 the error message. Otherwise, contains a single key, B<dates>, pointing to
1311 an array refernce of hash references. Each hash reference contains the
1318 (Future) Bill date. Indicates a future date for which billing could be run.
1319 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1322 =item bill_date_pretty
1324 (Future) Bill date as a human-readable string. (Convenience for display;
1325 subject to change, so best not to parse for the date.)
1329 Base amount which will be charged if renewed early as of this date.
1333 Renewal date; i.e. even-futher future date at which the customer will be paid
1334 through if the early renewal is completed with the given B<bill-date>.
1335 Specified as an integer UNIX timestamp.
1337 =item renew_date_pretty
1339 Renewal date as a human-readable string. (Convenience for display;
1340 subject to change, so best not to parse for the date.)
1344 Package that will be renewed.
1348 Expiration date of the package that will be renewed.
1350 =item expire_date_pretty
1352 Expiration date of the package that will be renewed, as a human-readable
1353 string. (Convenience for display; subject to change, so best not to parse for
1360 Renews this customer early; i.e. runs billing for this customer in advance.
1362 Takes a hash reference as parameter with the following keys:
1372 Integer date as returned by the B<renew_info> function, indicating the advance
1373 date for which to run billing.
1377 Returns a hash reference with a single key, B<error>, empty on success, or an
1378 error message on errors.
1382 Cancels a package for this customer.
1384 Takes a hash reference as parameter with the following keys:
1394 pkgpart of package to cancel
1398 Optional date, for future cancellation (expiration) instead of immediate
1399 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1403 Returns a hash reference with a single key, B<error>, empty on success, or an
1404 error message on errors.
1406 =item provision_acct
1408 Provisions an account (svc_acct).
1410 Takes a hash reference as parameter with the following keys:
1420 pkgnum of package into which this service is provisioned
1424 svcpart or service definition to provision
1434 =item provision_phone
1436 Provisions a phone number (svc_phone).
1438 Takes a hash reference as parameter with the following keys:
1448 pkgnum of package into which this service is provisioned
1452 svcpart or service definition to provision
1472 E911 Address (optional)
1478 Provisions a customer PBX (svc_pbx).
1480 Takes a hash reference as parameter with the following keys:
1490 pkgnum of package into which this service is provisioned
1494 svcpart or service definition to provision
1500 =item max_extensions
1502 =item max_simultaneous
1508 =item provision_external
1510 Provisions an external service (svc_external).
1512 Takes a hash reference as parameter with the following keys:
1522 pkgnum of package into which this service is provisioned
1526 svcpart or service definition to provision
1536 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1540 =item contact_passwd
1542 Changes the password for the currently-logged in contact.
1544 Takes a hash reference as parameter with the following keys:
1554 Returns a hash reference with a single parameter, B<error>, which contains an
1555 error message, or empty on success.
1559 Takes a hash reference as parameter with a single key, B<session_id>.
1561 Returns a hash reference with two parameters: B<error>, which contains an error
1562 message, or empty on success, and B<contacts>, a list of contacts.
1564 B<contacts> is an array reference of hash references (i.e. an array of structs,
1565 in XML-RPC). Each hash reference (struct) has the following keys:
1573 Contact class name (contact type).
1585 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1589 Comma-separated list of email addresses
1593 =item selfservice_access
1601 Updates information for the currently-logged in contact, or (optionally) the
1604 Takes a hash reference as parameter with the following keys:
1612 If already logged in as a contact, this is optional.
1622 Returns a hash reference with a single parameter, B<error>, which contains an
1623 error message, or empty on success.
1627 Creates a new contact.
1629 Takes a hash reference as parameter with the following keys:
1643 Optional contact classnum (TODO: or name)
1647 =item selfservice_access
1649 Y to enable self-service access
1655 Returns a hash reference with a single parameter, B<error>, which contains an
1656 error message, or empty on success.
1658 =item delete_contact
1660 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1663 Takes a hash reference as parameter with the following keys:
1673 Returns a hash reference with a single parameter, B<error>, which contains an
1674 error message, or empty on success.
1678 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1680 All of these functions require the user to be logged in, and the 'session_id'
1681 key to be included in the argument hashref.`
1685 =item list_quotations HASHREF
1687 Returns a hashref listing this customer's active self-service quotations.
1694 an arrayref containing an element for each quotation.
1702 the date it was started
1706 the number of packages
1710 the sum of setup fees
1714 the sum of recurring charges
1718 =item quotation_new HASHREF
1720 Creates an empty quotation and returns a hashref containing 'quotationnum',
1721 the primary key of the new quotation.
1723 =item quotation_delete HASHREF
1725 Disables (does not really delete) a quotation. Takes the following arguments:
1731 =item quotationnum - the quotation to delete
1735 Returns 'error' => a string, which will be empty on success.
1737 =item quotation_info HASHREF
1739 Returns total and detailed pricing information on a quotation.
1741 Takes the following arguments:
1747 =item quotationnum - the quotation to return
1751 Returns a hashref containing:
1753 - total_setup, the total of setup fees (and their taxes)
1754 - total_recur, the total of all recurring charges (and their taxes)
1755 - sections, an arrayref containing an element for each quotation section.
1756 - description, a line of text describing the group of charges
1757 - subtotal, the total of charges in this group (if appropriate)
1758 - detail_items, an arrayref of line items
1759 - pkgnum, the reference number of the package
1760 - description, the package name (or tax name)
1762 - amount, the amount charged
1763 If the detail item represents a subtotal, it will instead contain:
1764 - total_item: description of the subtotal
1765 - total_amount: the subtotal amount
1768 =item quotation_print HASHREF
1770 Renders the quotation as HTML or PDF. Takes the following arguments:
1776 =item quotationnum - the quotation to return
1778 =item format - 'html' or 'pdf'
1782 Returns a hashref containing 'document', the contents of the file.
1784 =item quotation_add_pkg HASHREF
1786 Adds a package to a quotation. Takes the following arguments:
1792 =item pkgpart - the package to add
1794 =item quotationnum - the quotation to add it to
1796 =item quantity - the package quantity (defaults to 1)
1798 =item address1, address2, city, state, zip, country - address fields to set
1799 the service location
1803 Returns 'error' => a string, which will be empty on success.
1805 =item quotation_remove_pkg HASHREF
1807 Removes a package from a quotation. Takes the following arguments:
1813 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1815 =item quotationnum - the quotation to remove it from
1819 Returns 'error' => a string, which will be empty on success.
1821 =item quotation_order HASHREF
1823 Converts the packages in a quotation into real packages. Takes the following
1826 Takes the following arguments:
1832 =item quotationnum - the quotation to order
1838 =head1 SIGNUP FUNCTIONS
1842 =item signup_info HASHREF
1844 Takes a hash reference as parameter with the following keys:
1848 =item session_id - Optional agent/reseller interface session
1852 Returns a hash reference containing information that may be useful in
1853 displaying a signup page. The hash reference contains the following keys:
1857 =item cust_main_county
1859 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.
1863 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
1864 an agentnum specified explicitly via reseller interface session_id in the
1869 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.
1871 =item agentnum2part_pkg
1873 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.
1877 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.
1879 =item security_phrase
1881 True if the "security_phrase" feature is enabled
1885 Array reference of acceptable payment types for signup
1891 credit card - automatic
1895 credit card - on-demand - version 1.5+ only
1899 electronic check - automatic
1903 electronic check - on-demand - version 1.5+ only
1911 billing, not recommended for signups
1915 free, definitely not recommended for signups
1919 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1925 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1929 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".
1935 =item countrydefault
1941 =item new_customer_minimal HASHREF
1943 Creates a new customer.
1945 Current differences from new_customer: An address is not required. promo_code
1946 and reg_code are not supported. If invoicing_list and _password is passed, a
1947 contact will be created with self-service access (no pkgpart or username is
1948 necessary). No initial billing is run (this may change in a future version).
1950 Takes a hash reference as parameter with the following keys:
1956 first name (required)
1960 last name (required)
1964 (not typically collected; mostly used for ACH transactions)
1996 Daytime phone number
2000 Evening phone number
2008 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2012 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2016 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2020 Expiration date for CARD/DCRD
2024 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2026 =item invoicing_list
2028 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),
2030 =item referral_custnum
2032 referring customer number
2040 pkgpart of initial package
2056 Access number (index, not the literal number)
2060 Country code (to be provisioned as a service)
2064 Phone number (to be provisioned as a service)
2072 Returns a hash reference with the following keys:
2078 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)
2082 =item new_customer HASHREF
2084 Creates a new customer. Takes a hash reference as parameter with the
2091 first name (required)
2095 last name (required)
2099 (not typically collected; mostly used for ACH transactions)
2105 =item address1 (required)
2113 =item city (required)
2121 =item state (required)
2125 =item zip (required)
2131 Daytime phone number
2135 Evening phone number
2143 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2147 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2151 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2155 Expiration date for CARD/DCRD
2159 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2161 =item invoicing_list
2163 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),
2165 =item referral_custnum
2167 referring customer number
2175 pkgpart of initial package
2191 Access number (index, not the literal number)
2195 Country code (to be provisioned as a service)
2199 Phone number (to be provisioned as a service)
2207 Returns a hash reference with the following keys:
2213 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)
2217 =item regionselector HASHREF | LIST
2219 Takes as input a hashref or list of key/value pairs with the following keys:
2223 =item selected_county
2225 Currently selected county
2227 =item selected_state
2229 Currently selected state
2231 =item selected_country
2233 Currently selected country
2237 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2241 Specify a javascript subroutine to call on changes
2247 =item default_country
2253 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>.
2257 Returns a list consisting of three HTML fragments for county selection,
2258 state selection and country selection, respectively.
2262 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2263 sub regionselector {
2270 $param->{'selected_country'} ||= $param->{'default_country'};
2271 $param->{'selected_state'} ||= $param->{'default_state'};
2273 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2277 my %cust_main_county;
2279 # unless ( @cust_main_county ) { #cache
2280 #@cust_main_county = qsearch('cust_main_county', {} );
2281 #foreach my $c ( @cust_main_county ) {
2282 foreach my $c ( @{ $param->{'locales'} } ) {
2283 #$countyflag=1 if $c->county;
2284 $countyflag=1 if $c->{county};
2285 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2286 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2287 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2290 $countyflag=1 if $param->{selected_county};
2292 my $script_html = <<END;
2294 function opt(what,value,text) {
2295 var optionName = new Option(text, value, false, false);
2296 var length = what.length;
2297 what.options[length] = optionName;
2299 function ${prefix}country_changed(what) {
2300 country = what.options[what.selectedIndex].text;
2301 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2302 what.form.${prefix}state.options[i] = null;
2304 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2306 foreach my $country ( sort keys %cust_main_county ) {
2307 $script_html .= "\nif ( country == \"$country\" ) {\n";
2308 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2309 my $text = $state || '(n/a)';
2310 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2312 $script_html .= "}\n";
2315 $script_html .= <<END;
2317 function ${prefix}state_changed(what) {
2320 if ( $countyflag ) {
2321 $script_html .= <<END;
2322 state = what.options[what.selectedIndex].text;
2323 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2324 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2325 what.form.${prefix}county.options[i] = null;
2328 foreach my $country ( sort keys %cust_main_county ) {
2329 $script_html .= "\nif ( country == \"$country\" ) {\n";
2330 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2331 $script_html .= "\nif ( state == \"$state\" ) {\n";
2332 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2333 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2334 my $text = $county || '(n/a)';
2336 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2338 $script_html .= "}\n";
2340 $script_html .= "}\n";
2344 $script_html .= <<END;
2349 my $county_html = $script_html;
2350 if ( $countyflag ) {
2351 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2352 foreach my $county (
2353 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2355 my $text = $county || '(n/a)';
2356 $county_html .= qq!<OPTION VALUE="$county"!.
2357 ($county eq $param->{'selected_county'} ?
2364 $county_html .= '</SELECT>';
2367 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2370 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2371 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2372 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2373 my $text = $state || '(n/a)';
2374 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2375 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2377 $state_html .= '</SELECT>';
2379 my $country_html = '';
2380 if ( scalar( keys %cust_main_county ) > 1 ) {
2382 $country_html = qq(<SELECT NAME="${prefix}country" ).
2383 qq(onChange="${prefix}country_changed(this); ).
2384 $param->{'onchange'}.
2387 my $countrydefault = $param->{default_country} || 'US';
2388 foreach my $country (
2389 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2390 keys %cust_main_county
2392 my $selected = $country eq $param->{'selected_country'}
2395 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2397 $country_html .= '</SELECT>';
2400 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2401 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2405 ($county_html, $state_html, $country_html);
2409 sub regionselector_hashref {
2410 my ($county_html, $state_html, $country_html) = regionselector(@_);
2412 'county_html' => $county_html,
2413 'state_html' => $state_html,
2414 'country_html' => $country_html,
2418 =item location_form HASHREF | LIST
2420 Takes as input a hashref or list of key/value pairs with the following keys:
2426 Current customer session_id
2430 Omit red asterisks from required fields.
2432 =item address1_label
2434 Label for first address line.
2438 Returns an HTML fragment for a location form (address, city, state, zip,
2451 my $session_id = delete $param->{'session_id'};
2453 my $rv = mason_comp( 'session_id' => $session_id,
2454 'comp' => '/elements/location.html',
2455 'args' => [ %$param ],
2459 $rv->{'error'} || $rv->{'output'};
2464 #=item expselect HASHREF | LIST
2466 #Takes as input a hashref or list of key/value pairs with the following keys:
2470 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2472 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2476 =item expselect PREFIX [ DATE ]
2478 Takes as input a unique prefix string and the current expiration date, in
2479 yyyy-mm-dd or m-d-yyyy format
2481 Returns an HTML fragments for expiration date selection.
2487 #if ( ref($_[0]) ) {
2491 #my $prefix = $param->{'prefix'};
2492 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2493 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2495 my $date = scalar(@_) ? shift : '';
2497 my( $m, $y ) = ( 0, 0 );
2498 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2499 ( $m, $y ) = ( $2, $1 );
2500 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2501 ( $m, $y ) = ( $1, $3 );
2503 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2505 $return .= qq!<OPTION VALUE="$_"!;
2506 $return .= " SELECTED" if $_ == $m;
2509 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2511 my $thisYear = $t[5] + 1900;
2512 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2513 $return .= qq!<OPTION VALUE="$_"!;
2514 $return .= " SELECTED" if $_ == $y;
2517 $return .= "</SELECT>";
2522 =item popselector HASHREF | LIST
2524 Takes as input a hashref or list of key/value pairs with the following keys:
2530 Access number number
2534 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>.
2538 Returns an HTML fragment for access number selection.
2542 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2550 my $popnum = $param->{'popnum'};
2551 my $pops = $param->{'pops'};
2553 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2554 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2555 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2556 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2557 if scalar(@$pops) == 1;
2560 my %popnum2pop = ();
2562 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2563 $popnum2pop{$_->{popnum}} = $_;
2568 function opt(what,href,text) {
2569 var optionName = new Option(text, href, false, false)
2570 var length = what.length;
2571 what.options[length] = optionName;
2575 my $init_popstate = $param->{'init_popstate'};
2576 if ( $init_popstate ) {
2577 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2578 $init_popstate. '">';
2581 function acstate_changed(what) {
2582 state = what.options[what.selectedIndex].text;
2583 what.form.popac.options.length = 0
2584 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2588 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2589 foreach my $state ( sort { $a cmp $b } @states ) {
2590 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2592 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2593 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2594 if ($ac eq $param->{'popac'}) {
2595 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2598 $text .= "}\n" unless $init_popstate;
2600 $text .= "popac_changed(what.form.popac)}\n";
2603 function popac_changed(what) {
2604 ac = what.options[what.selectedIndex].text;
2605 what.form.popnum.options.length = 0;
2606 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2610 foreach my $state ( @states ) {
2611 foreach my $popac ( keys %{ $pop{$state} } ) {
2612 $text .= "\nif ( ac == \"$popac\" ) {\n";
2614 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2615 my $o_popnum = $pop->{popnum};
2616 my $poptext = $pop->{city}. ', '. $pop->{state}.
2617 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2619 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2620 if ($popnum == $o_popnum) {
2621 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2629 $text .= "}\n</SCRIPT>\n";
2631 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2634 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2635 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2636 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2637 ">$_" foreach sort { $a cmp $b } @states;
2638 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2641 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2642 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2644 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2647 #comment this block to disable initial list polulation
2648 my @initial_select = ();
2649 if ( scalar( @$pops ) > 100 ) {
2650 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2652 @initial_select = @$pops;
2654 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2655 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2656 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2657 $pop->{city}. ', '. $pop->{state}.
2658 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2661 $text .= qq!</SELECT></TD></TR></TABLE>!;
2667 =item domainselector HASHREF | LIST
2669 Takes as input a hashref or list of key/value pairs with the following keys:
2679 Service number of the selected item.
2683 Returns an HTML fragment for domain selection.
2687 sub domainselector {
2694 my $domsvc= $param->{'domsvc'};
2696 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2697 my $domains = $rv->{'domains'};
2698 $domsvc = $rv->{'domsvc'} unless $domsvc;
2700 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2701 unless scalar(keys %$domains);
2703 if (scalar(keys %$domains) == 1) {
2705 foreach(keys %$domains) {
2708 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2709 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2712 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2714 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2716 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2717 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2718 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2719 $domains->{$domain};
2722 $text .= qq!</SELECT></TD></TR>!;
2728 =item didselector HASHREF | LIST
2730 Takes as input a hashref or list of key/value pairs with the following keys:
2736 Field name for the returned HTML fragment.
2740 Service definition (see L<FS::part_svc>)
2744 Returns an HTML fragment for DID selection.
2756 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2757 'args'=>[ %$param ],
2761 $rv->{'error'} || $rv->{'output'};
2767 =head1 RESELLER FUNCTIONS
2769 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2770 with their active session, and the B<customer_info> and B<order_pkg> functions
2771 with their active session and an additional I<custnum> parameter.
2773 For the most part, development of the reseller web interface has been
2774 superceded by agent-virtualized access to the backend.
2786 =item agent_list_customers
2788 List agent's customers.
2796 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>