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 my $payment_info = payment_info( { 'session_id' => $session_id } );
277 #!!! process_payment example
279 #!!! list_pkgs example
281 #ordering a package with an svc_acct service
282 my $rv = order_pkg( { 'session_id' => $session_id,
283 'pkgpart' => $pkgpart,
284 'svcpart' => $svcpart,
285 'username' => $username,
286 'domsvc' => $domsvc, #svcnum of svc_domain
287 '_password' => $password,
291 #!!! ordering a package with an svc_domain service example
293 #!!! ordering a package with an svc_phone service example
295 #!!! ordering a package with an svc_external service example
297 #!!! ordering a package with an svc_pbx service
299 #ordering a package with no service
300 my $rv = order_pkg( { 'session_id' => $session_id,
301 'pkgpart' => $pkgpart,
306 #quoting a package, then ordering after confirmation
308 my $rv = quotation_new({ 'session_id' => $session_id });
309 my $qnum = $rv->{quotationnum};
310 # add packages to the quotation
311 $rv = quotation_add_pkg({ 'session_id' => $session_id,
312 'quotationnum' => $qnum,
313 'pkgpart' => $pkgpart,
314 'quantity' => $quantity, # defaults to 1
316 # repeat until all packages are added
317 # view the pricing information
318 $rv = quotation_info({ 'session_id' => $session_id,
319 'quotationnum' => $qnum,
321 print "Total setup charges: ".$rv->{total_setup}."\n".
322 "Total recurring charges: ".$rv->{total_recur}."\n";
323 # quotation_info also provides a detailed breakdown of charges, in
326 # ask customer for confirmation, then:
327 $rv = quotation_order({ 'session_id' => $session_id,
328 'quotationnum' => $qnum,
331 #!!! cancel_pkg example
333 # signup functionality
334 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
336 my $signup_info = signup_info;
338 $rv = new_customer( {
341 'company' => $company,
342 'address1' => $address1,
343 'address2' => $address2,
347 'country' => $country,
348 'daytime' => $daytime,
352 'payinfo' => $payinfo,
354 'paystart_month' => $paystart_month
355 'paystart_year' => $paystart_year,
356 'payissue' => $payissue,
358 'paydate' => $paydate,
359 'payname' => $payname,
360 'invoicing_list' => $invoicing_list,
361 'referral_custnum' => $referral_custnum,
362 'agentnum' => $agentnum,
363 'pkgpart' => $pkgpart,
365 'username' => $username,
366 '_password' => $password,
370 'phonenum' => $phonenum,
375 my $error = $rv->{'error'};
376 if ( $error eq '_decline' ) {
386 Use this API to implement your own client "self-service" module.
388 If you just want to customize the look of the existing "self-service" module,
391 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
397 Changes the password for an existing user in svc_acct. Takes a hash
398 reference with the following keys:
404 Username of the account (required)
408 Domain of the account (required)
412 Old password (required)
416 New password (required)
434 =head1 "MY ACCOUNT" FUNCTIONS
440 Creates a user session. Takes a hash reference as parameter with the
447 Email address (username@domain), instead of username and domain. Required for
448 contact-based self-service login, can also be used for svc_acct-based login.
464 Returns a hash reference with the following keys:
470 Empty on success, or an error message on errors.
474 Session identifier for successful logins
478 =item customer_info HASHREF
480 Returns general customer information.
482 Takes a hash reference as parameter with a single key: B<session_id>
484 Returns a hash reference with the following keys:
498 Array reference of hash references of open inoices. Each hash reference has
499 the following keys: invnum, date, owed
503 An HTML fragment containing shipping and billing addresses.
505 =item The following fields are also returned
507 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
511 =item customer_recurring HASHREF
513 Takes a hash reference as parameter with a single key B<session_id>
514 or keys B<agent_session_id> and B<custnum>.
516 Returns a hash reference with the keys error, custnum and display_recurring.
518 display_recurring is an arrayref of hashrefs with the following keys:
524 frequency of charge, in months unless units are specified
528 frequency of charge, suitable for display
532 amount charged at this frequency
536 =item edit_info HASHREF
538 Takes a hash reference as parameter with any of the following keys:
540 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
542 If a field exists, the customer record is updated with the new value of that
543 field. If a field does not exist, that field is not changed on the customer
546 Returns a hash reference with a single key, B<error>, empty on success, or an
547 error message on errors
549 =item invoice HASHREF
551 Returns an invoice. Takes a hash reference as parameter with two keys:
552 session_id and invnum
554 Returns a hash reference with the following keys:
560 Empty on success, or an error message on errors
572 =item list_invoices HASHREF
574 Returns a list of all customer invoices. Takes a hash reference with a single
577 Returns a hash reference with the following keys:
583 Empty on success, or an error message on errors
587 Reference to array of hash references with the following keys:
597 Invoice date, in UNIX epoch time
603 =item list_payby HASHREF
605 Returns a list of all stored customer payment information (credit cards and
606 electronic check accounts). Takes a hash reference with a single key,
609 Returns a hash reference with the following keys:
615 Empty on success, or an error message on errors
619 Reference to array of hash references with the following keys:
627 Numeric weighting. Stored payment information with a lower weight is attempted
632 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
633 (on-demand credit card) or DCHK (on-demand electronic check).
637 Masked credit card number (or, masked account and routing numbers)
641 Credit card expiration date
645 Exact name on card (or bank name, for electronic checks)
649 For electronic checks, bank state
653 For electronic checks, account type (Personal/Business, Checking/Savings)
659 =item insert_payby HASHREF
661 Adds new stored payment information for this customer. Takes a hash reference
662 with the following keys:
670 Numeric weighting. Stored payment information with a lower weight is attempted
675 CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD
676 (on-demand credit card) or DCHK (on-demand electronic check).
680 Credit card number (or electronic check "account@routing")
684 CVV2 number / security code
688 Credit card expiration date
692 Exact name on card (or bank name, for electronic checks)
696 For electronic checks, bank state
700 For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A
704 Optional IP address from which payment was submitted
708 If there is an error, returns a hash reference with a single key, B<error>,
709 otherwise returns a hash reference with a single key, B<custpaybynum>.
711 =item update_payby HASHREF
713 Updates stored payment information. Takes a hash reference with the same
714 keys as insert_payby, as well as B<custpaybynum> to specify which record
715 to update. All keys except B<session_id> and B<custpaybynum> are optional;
716 if omitted, the previous values in the record will be preserved.
718 If there is an error, returns a hash reference with a single key, B<error>,
719 otherwise returns a hash reference with a single key, B<custpaybynum>.
721 =item delete_payby HASHREF
723 Removes stored payment information. Takes a hash reference with two keys,
724 B<session_id> and B<custpaybynum>. Returns a hash reference with a single key,
725 B<error>, which is an error message or empty for successful removal.
729 Cancels this customer.
731 Takes a hash reference as parameter with a single key: B<session_id>
733 Returns a hash reference with a single key, B<error>, which is empty on
734 success or an error message on errors.
736 =item payment_info HASHREF
738 Returns information that may be useful in displaying a payment page.
740 Takes a hash reference as parameter with the following keys:
750 =item omit_cust_main_county
752 Optional, pass a true value to omit cust_main_county data for performance.
756 Returns a hash reference with the following keys:
762 Empty on success, or an error message on errors
770 Exact name on credit card (CARD/DCRD)
794 Customer's current default payment type.
798 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
802 For CARD/DCRD payment types, the card number
806 For CARD/DCRD payment types, expiration month
810 For CARD/DCRD payment types, expiration year
812 =item cust_main_county
814 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.
818 Array reference of all states in the current default country.
822 Hash reference of card types; keys are card types, values are the exact strings
823 passed to the process_payment function
827 #this doesn't actually work yet
831 #Unique transaction identifier (prevents multiple charges), passed to the
832 #process_payment function
836 =item process_payment HASHREF
838 Processes a payment and possible change of address or payment type. Takes a
839 hash reference as parameter with the following keys:
853 If true, address and card information entered will be saved for subsequent
858 If true, future credit card payments will be done automatically (sets payby to
859 CARD). If false, future credit card payments will be done on-demand (sets
860 payby to DCRD). This option only has meaning if B<save> is set true.
888 Two-letter country code
896 Card expiration month
904 #this doesn't actually work yet
908 #Unique transaction identifier, returned from the payment_info function.
909 #Prevents multiple charges.
913 Returns a hash reference with a single key, B<error>, empty on success, or an
914 error message on errors.
916 =item process_payment_order_pkg
918 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
919 payment processes sucessfully, the package is ordered. Takes a hash reference
920 as parameter with the keys of both methods.
922 Returns a hash reference with a single key, B<error>, empty on success, or an
923 error message on errors.
925 =item process_payment_change_pkg
927 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
928 payment processes sucessfully, the package is ordered. Takes a hash reference
929 as parameter with the keys of both methods.
931 Returns a hash reference with a single key, B<error>, empty on success, or an
932 error message on errors.
935 =item process_payment_order_renew
937 Combines the B<process_payment> and B<order_renew> functions in one step. If
938 the payment processes sucessfully, the renewal is processed. Takes a hash
939 reference as parameter with the keys of both methods.
941 Returns a hash reference with a single key, B<error>, empty on success, or an
942 error message on errors.
946 Returns package information for this customer. For more detail on services,
949 Takes a hash reference as parameter with a single key: B<session_id>
951 Returns a hash reference containing customer package information. The hash reference contains the following keys:
961 Empty on success, or an error message on errors.
963 =item cust_pkg HASHREF
965 Array reference of hash references, each of which has the fields of a cust_pkg
966 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
967 the internal FS:: objects, but hash references of columns and values.
971 =item part_pkg fields
973 All fields of part_pkg for this specific cust_pkg (be careful with this
974 information - it may reveal more about your available packages than you would
975 like users to know in aggregate)
979 #XXX pare part_pkg fields down to a more secure subset
983 An array of hash references indicating information on unprovisioned services
984 available for provisioning for this specific cust_pkg. Each has the following
989 =item part_svc fields
991 All fields of part_svc (be careful with this information - it may reveal more
992 about your available packages than you would like users to know in aggregate)
996 #XXX pare part_svc fields down to a more secure subset
1002 An array of hash references indicating information on the customer services
1003 already provisioned for this specific cust_pkg. Each has the following keys:
1009 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.
1015 Primary key for this service
1019 Service definition (see L<FS::part_svc>)
1023 Customer package (see L<FS::cust_pkg>)
1027 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
1035 Returns service information for this customer.
1037 Takes a hash reference as parameter with a single key: B<session_id>
1039 Returns a hash reference containing customer package information. The hash reference contains the following keys:
1049 An array of hash references indicating information on all of this customer's
1050 services. Each has the following keys:
1056 Primary key for this service
1060 Name of this service
1064 Meaningful user-specific identifier for the service (i.e. username, domain, or
1069 Account (svc_acct) services also have the following keys:
1087 Upload bytes remaining
1091 Download bytes remaining
1095 Total bytes remaining
1097 =item recharge_amount
1101 =item recharge_seconds
1103 Number of seconds gained by recharge
1105 =item recharge_upbytes
1107 Number of upload bytes gained by recharge
1109 =item recharge_downbytes
1111 Number of download bytes gained by recharge
1113 =item recharge_totalbytes
1115 Number of total bytes gained by recharge
1123 Orders a package for this customer.
1125 If signup_server-realtime is set, bills the new package, attemps to collect
1126 payment and (for auto-payment customers) cancels the package if the payment is
1129 Takes a hash reference as parameter with the following keys:
1139 Package to order (see L<FS::part_pkg>).
1143 Quantity for this package order (default 1).
1145 =item run_bill_events
1147 If true, runs billing events for the customer after ordering and billing the
1148 package (signup_server-realtime must be set).
1152 Optional locationnum for this package order, for existing locations.
1154 Or, for new locations, pass the following fields: address1*, address2, city*,
1155 county, state*, zip*, country. (* = required in this case)
1157 (None of this is required at all if you are just ordering a package
1158 at the customer's existing default service location.)
1176 Service to order (see L<FS::part_svc>).
1178 Normally optional; required only to provision a non-svc_acct service, or if the
1179 package definition does not contain one svc_acct service definition with
1180 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1181 also be specified to indicate that no initial service should be provisioned.
1185 Fields used when provisioning an svc_acct service:
1199 Optional security phrase
1203 Optional Access number number
1207 Fields used when provisioning an svc_domain service:
1217 Fields used when provisioning an svc_phone service:
1235 Fields used when provisioning an svc_external service:
1241 External numeric ID.
1245 External text title.
1249 Fields used when provisioning an svc_pbx service:
1263 Returns a hash reference with a single key, B<error>, empty on success, or an
1264 error message on errors. The special error '_decline' is returned for
1265 declined transactions.
1269 Changes a package for this customer.
1271 Takes a hash reference as parameter with the following keys:
1281 Existing customer package.
1285 New package to order (see L<FS::part_pkg>).
1289 Quantity for this package order (default 1).
1293 Returns a hash reference with the following keys:
1299 Empty on success, or an error message on errors.
1303 On success, the new pkgnum
1310 Provides useful info for early renewals.
1312 Takes a hash reference as parameter with the following keys:
1322 Returns a hash reference. On errors, it contains a single key, B<error>, with
1323 the error message. Otherwise, contains a single key, B<dates>, pointing to
1324 an array refernce of hash references. Each hash reference contains the
1331 (Future) Bill date. Indicates a future date for which billing could be run.
1332 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1335 =item bill_date_pretty
1337 (Future) Bill date as a human-readable string. (Convenience for display;
1338 subject to change, so best not to parse for the date.)
1342 Base amount which will be charged if renewed early as of this date.
1346 Renewal date; i.e. even-futher future date at which the customer will be paid
1347 through if the early renewal is completed with the given B<bill-date>.
1348 Specified as an integer UNIX timestamp.
1350 =item renew_date_pretty
1352 Renewal date as a human-readable string. (Convenience for display;
1353 subject to change, so best not to parse for the date.)
1357 Package that will be renewed.
1361 Expiration date of the package that will be renewed.
1363 =item expire_date_pretty
1365 Expiration date of the package that will be renewed, as a human-readable
1366 string. (Convenience for display; subject to change, so best not to parse for
1373 Renews this customer early; i.e. runs billing for this customer in advance.
1375 Takes a hash reference as parameter with the following keys:
1385 Integer date as returned by the B<renew_info> function, indicating the advance
1386 date for which to run billing.
1390 Returns a hash reference with a single key, B<error>, empty on success, or an
1391 error message on errors.
1395 Cancels a package for this customer.
1397 Takes a hash reference as parameter with the following keys:
1407 pkgpart of package to cancel
1411 Optional date, for future cancellation (expiration) instead of immediate
1412 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1416 Returns a hash reference with a single key, B<error>, empty on success, or an
1417 error message on errors.
1419 =item provision_acct
1421 Provisions an account (svc_acct).
1423 Takes a hash reference as parameter with the following keys:
1433 pkgnum of package into which this service is provisioned
1437 svcpart or service definition to provision
1447 =item provision_phone
1449 Provisions a phone number (svc_phone).
1451 Takes a hash reference as parameter with the following keys:
1461 pkgnum of package into which this service is provisioned
1465 svcpart or service definition to provision
1485 E911 Address (optional)
1491 Provisions a customer PBX (svc_pbx).
1493 Takes a hash reference as parameter with the following keys:
1503 pkgnum of package into which this service is provisioned
1507 svcpart or service definition to provision
1513 =item max_extensions
1515 =item max_simultaneous
1521 =item provision_external
1523 Provisions an external service (svc_external).
1525 Takes a hash reference as parameter with the following keys:
1535 pkgnum of package into which this service is provisioned
1539 svcpart or service definition to provision
1549 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1553 =item contact_passwd
1555 Changes the password for the currently-logged in contact.
1557 Takes a hash reference as parameter with the following keys:
1567 Returns a hash reference with a single parameter, B<error>, which contains an
1568 error message, or empty on success.
1572 Takes a hash reference as parameter with a single key, B<session_id>.
1574 Returns a hash reference with two parameters: B<error>, which contains an error
1575 message, or empty on success, and B<contacts>, a list of contacts.
1577 B<contacts> is an array reference of hash references (i.e. an array of structs,
1578 in XML-RPC). Each hash reference (struct) has the following keys:
1586 Contact class name (contact type).
1598 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1602 Comma-separated list of email addresses
1606 =item selfservice_access
1614 Updates information for the currently-logged in contact, or (optionally) the
1617 Takes a hash reference as parameter with the following keys:
1625 If already logged in as a contact, this is optional.
1635 Returns a hash reference with a single parameter, B<error>, which contains an
1636 error message, or empty on success.
1640 Creates a new contact.
1642 Takes a hash reference as parameter with the following keys:
1656 Optional contact classnum (TODO: or name)
1660 =item selfservice_access
1662 Y to enable self-service access
1668 Returns a hash reference with a single parameter, B<error>, which contains an
1669 error message, or empty on success.
1671 =item delete_contact
1673 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1676 Takes a hash reference as parameter with the following keys:
1686 Returns a hash reference with a single parameter, B<error>, which contains an
1687 error message, or empty on success.
1691 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1693 All of these functions require the user to be logged in, and the 'session_id'
1694 key to be included in the argument hashref.`
1698 =item list_quotations HASHREF
1700 Returns a hashref listing this customer's active self-service quotations.
1707 an arrayref containing an element for each quotation.
1715 the date it was started
1719 the number of packages
1723 the sum of setup fees
1727 the sum of recurring charges
1731 =item quotation_new HASHREF
1733 Creates an empty quotation and returns a hashref containing 'quotationnum',
1734 the primary key of the new quotation.
1736 =item quotation_delete HASHREF
1738 Disables (does not really delete) a quotation. Takes the following arguments:
1744 =item quotationnum - the quotation to delete
1748 Returns 'error' => a string, which will be empty on success.
1750 =item quotation_info HASHREF
1752 Returns total and detailed pricing information on a quotation.
1754 Takes the following arguments:
1760 =item quotationnum - the quotation to return
1764 Returns a hashref containing:
1766 - total_setup, the total of setup fees (and their taxes)
1767 - total_recur, the total of all recurring charges (and their taxes)
1768 - sections, an arrayref containing an element for each quotation section.
1769 - description, a line of text describing the group of charges
1770 - subtotal, the total of charges in this group (if appropriate)
1771 - detail_items, an arrayref of line items
1772 - pkgnum, the reference number of the package
1773 - description, the package name (or tax name)
1775 - amount, the amount charged
1776 If the detail item represents a subtotal, it will instead contain:
1777 - total_item: description of the subtotal
1778 - total_amount: the subtotal amount
1781 =item quotation_print HASHREF
1783 Renders the quotation as HTML or PDF. Takes the following arguments:
1789 =item quotationnum - the quotation to return
1791 =item format - 'html' or 'pdf'
1795 Returns a hashref containing 'document', the contents of the file.
1797 =item quotation_add_pkg HASHREF
1799 Adds a package to a quotation. Takes the following arguments:
1805 =item pkgpart - the package to add
1807 =item quotationnum - the quotation to add it to
1809 =item quantity - the package quantity (defaults to 1)
1811 =item address1, address2, city, state, zip, country - address fields to set
1812 the service location
1816 Returns 'error' => a string, which will be empty on success.
1818 =item quotation_remove_pkg HASHREF
1820 Removes a package from a quotation. Takes the following arguments:
1826 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1828 =item quotationnum - the quotation to remove it from
1832 Returns 'error' => a string, which will be empty on success.
1834 =item quotation_order HASHREF
1836 Converts the packages in a quotation into real packages. Takes the following
1839 Takes the following arguments:
1845 =item quotationnum - the quotation to order
1851 =head1 SIGNUP FUNCTIONS
1855 =item signup_info HASHREF
1857 Takes a hash reference as parameter with the following keys:
1861 =item session_id - Optional agent/reseller interface session
1865 Returns a hash reference containing information that may be useful in
1866 displaying a signup page. The hash reference contains the following keys:
1870 =item cust_main_county
1872 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.
1876 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
1877 an agentnum specified explicitly via reseller interface session_id in the
1882 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.
1884 =item agentnum2part_pkg
1886 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.
1890 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.
1892 =item security_phrase
1894 True if the "security_phrase" feature is enabled
1898 Array reference of acceptable payment types for signup
1904 credit card - automatic
1908 credit card - on-demand - version 1.5+ only
1912 electronic check - automatic
1916 electronic check - on-demand - version 1.5+ only
1924 billing, not recommended for signups
1928 free, definitely not recommended for signups
1932 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1938 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1942 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".
1948 =item countrydefault
1954 =item new_customer_minimal HASHREF
1956 Creates a new customer.
1958 Current differences from new_customer: An address is not required. promo_code
1959 and reg_code are not supported. If invoicing_list and _password is passed, a
1960 contact will be created with self-service access (no pkgpart or username is
1961 necessary). No initial billing is run (this may change in a future version).
1963 Takes a hash reference as parameter with the following keys:
1969 first name (required)
1973 last name (required)
1977 (not typically collected; mostly used for ACH transactions)
2009 Daytime phone number
2013 Evening phone number
2021 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2025 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2029 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2033 Expiration date for CARD/DCRD
2037 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2039 =item invoicing_list
2041 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),
2043 =item referral_custnum
2045 referring customer number
2053 pkgpart of initial package
2069 Access number (index, not the literal number)
2073 Country code (to be provisioned as a service)
2077 Phone number (to be provisioned as a service)
2085 Returns a hash reference with the following keys:
2091 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)
2095 =item new_customer HASHREF
2097 Creates a new customer. Takes a hash reference as parameter with the
2104 first name (required)
2108 last name (required)
2112 (not typically collected; mostly used for ACH transactions)
2118 =item address1 (required)
2126 =item city (required)
2134 =item state (required)
2138 =item zip (required)
2144 Daytime phone number
2148 Evening phone number
2156 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2160 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2164 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2168 Expiration date for CARD/DCRD
2172 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2174 =item invoicing_list
2176 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),
2178 =item referral_custnum
2180 referring customer number
2188 pkgpart of initial package
2204 Access number (index, not the literal number)
2208 Country code (to be provisioned as a service)
2212 Phone number (to be provisioned as a service)
2220 Returns a hash reference with the following keys:
2226 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)
2230 =item regionselector HASHREF | LIST
2232 Takes as input a hashref or list of key/value pairs with the following keys:
2236 =item selected_county
2238 Currently selected county
2240 =item selected_state
2242 Currently selected state
2244 =item selected_country
2246 Currently selected country
2250 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2254 Specify a javascript subroutine to call on changes
2260 =item default_country
2266 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>.
2270 Returns a list consisting of three HTML fragments for county selection,
2271 state selection and country selection, respectively.
2275 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2276 sub regionselector {
2283 $param->{'selected_country'} ||= $param->{'default_country'};
2284 $param->{'selected_state'} ||= $param->{'default_state'};
2286 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2290 my %cust_main_county;
2292 # unless ( @cust_main_county ) { #cache
2293 #@cust_main_county = qsearch('cust_main_county', {} );
2294 #foreach my $c ( @cust_main_county ) {
2295 foreach my $c ( @{ $param->{'locales'} } ) {
2296 #$countyflag=1 if $c->county;
2297 $countyflag=1 if $c->{county};
2298 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2299 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2300 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2303 $countyflag=1 if $param->{selected_county};
2305 my $script_html = <<END;
2307 function opt(what,value,text) {
2308 var optionName = new Option(text, value, false, false);
2309 var length = what.length;
2310 what.options[length] = optionName;
2312 function ${prefix}country_changed(what) {
2313 country = what.options[what.selectedIndex].text;
2314 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2315 what.form.${prefix}state.options[i] = null;
2317 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2319 foreach my $country ( sort keys %cust_main_county ) {
2320 $script_html .= "\nif ( country == \"$country\" ) {\n";
2321 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2322 my $text = $state || '(n/a)';
2323 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2325 $script_html .= "}\n";
2328 $script_html .= <<END;
2330 function ${prefix}state_changed(what) {
2333 if ( $countyflag ) {
2334 $script_html .= <<END;
2335 state = what.options[what.selectedIndex].text;
2336 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2337 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2338 what.form.${prefix}county.options[i] = null;
2341 foreach my $country ( sort keys %cust_main_county ) {
2342 $script_html .= "\nif ( country == \"$country\" ) {\n";
2343 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2344 $script_html .= "\nif ( state == \"$state\" ) {\n";
2345 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2346 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2347 my $text = $county || '(n/a)';
2349 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2351 $script_html .= "}\n";
2353 $script_html .= "}\n";
2357 $script_html .= <<END;
2362 my $county_html = $script_html;
2363 if ( $countyflag ) {
2364 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2365 foreach my $county (
2366 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2368 my $text = $county || '(n/a)';
2369 $county_html .= qq!<OPTION VALUE="$county"!.
2370 ($county eq $param->{'selected_county'} ?
2377 $county_html .= '</SELECT>';
2380 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2383 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2384 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2385 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2386 my $text = $state || '(n/a)';
2387 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2388 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2390 $state_html .= '</SELECT>';
2392 my $country_html = '';
2393 if ( scalar( keys %cust_main_county ) > 1 ) {
2395 $country_html = qq(<SELECT NAME="${prefix}country" ).
2396 qq(onChange="${prefix}country_changed(this); ).
2397 $param->{'onchange'}.
2400 my $countrydefault = $param->{default_country} || 'US';
2401 foreach my $country (
2402 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2403 keys %cust_main_county
2405 my $selected = $country eq $param->{'selected_country'}
2408 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2410 $country_html .= '</SELECT>';
2413 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2414 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2418 ($county_html, $state_html, $country_html);
2422 sub regionselector_hashref {
2423 my ($county_html, $state_html, $country_html) = regionselector(@_);
2425 'county_html' => $county_html,
2426 'state_html' => $state_html,
2427 'country_html' => $country_html,
2431 =item location_form HASHREF | LIST
2433 Takes as input a hashref or list of key/value pairs with the following keys:
2439 Current customer session_id
2443 Omit red asterisks from required fields.
2445 =item address1_label
2447 Label for first address line.
2451 Returns an HTML fragment for a location form (address, city, state, zip,
2464 my $session_id = delete $param->{'session_id'};
2466 my $rv = mason_comp( 'session_id' => $session_id,
2467 'comp' => '/elements/location.html',
2468 'args' => [ %$param ],
2472 $rv->{'error'} || $rv->{'output'};
2477 #=item expselect HASHREF | LIST
2479 #Takes as input a hashref or list of key/value pairs with the following keys:
2483 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2485 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2489 =item expselect PREFIX [ DATE ]
2491 Takes as input a unique prefix string and the current expiration date, in
2492 yyyy-mm-dd or m-d-yyyy format
2494 Returns an HTML fragments for expiration date selection.
2500 #if ( ref($_[0]) ) {
2504 #my $prefix = $param->{'prefix'};
2505 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2506 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2508 my $date = scalar(@_) ? shift : '';
2510 my( $m, $y ) = ( 0, 0 );
2511 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2512 ( $m, $y ) = ( $2, $1 );
2513 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2514 ( $m, $y ) = ( $1, $3 );
2516 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2518 $return .= qq!<OPTION VALUE="$_"!;
2519 $return .= " SELECTED" if $_ == $m;
2522 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2524 my $thisYear = $t[5] + 1900;
2525 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2526 $return .= qq!<OPTION VALUE="$_"!;
2527 $return .= " SELECTED" if $_ == $y;
2530 $return .= "</SELECT>";
2535 =item popselector HASHREF | LIST
2537 Takes as input a hashref or list of key/value pairs with the following keys:
2543 Access number number
2547 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>.
2551 Returns an HTML fragment for access number selection.
2555 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2563 my $popnum = $param->{'popnum'};
2564 my $pops = $param->{'pops'};
2566 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2567 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2568 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2569 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2570 if scalar(@$pops) == 1;
2573 my %popnum2pop = ();
2575 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2576 $popnum2pop{$_->{popnum}} = $_;
2581 function opt(what,href,text) {
2582 var optionName = new Option(text, href, false, false)
2583 var length = what.length;
2584 what.options[length] = optionName;
2588 my $init_popstate = $param->{'init_popstate'};
2589 if ( $init_popstate ) {
2590 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2591 $init_popstate. '">';
2594 function acstate_changed(what) {
2595 state = what.options[what.selectedIndex].text;
2596 what.form.popac.options.length = 0
2597 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2601 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2602 foreach my $state ( sort { $a cmp $b } @states ) {
2603 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2605 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2606 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2607 if ($ac eq $param->{'popac'}) {
2608 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2611 $text .= "}\n" unless $init_popstate;
2613 $text .= "popac_changed(what.form.popac)}\n";
2616 function popac_changed(what) {
2617 ac = what.options[what.selectedIndex].text;
2618 what.form.popnum.options.length = 0;
2619 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2623 foreach my $state ( @states ) {
2624 foreach my $popac ( keys %{ $pop{$state} } ) {
2625 $text .= "\nif ( ac == \"$popac\" ) {\n";
2627 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2628 my $o_popnum = $pop->{popnum};
2629 my $poptext = $pop->{city}. ', '. $pop->{state}.
2630 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2632 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2633 if ($popnum == $o_popnum) {
2634 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2642 $text .= "}\n</SCRIPT>\n";
2644 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2647 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2648 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2649 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2650 ">$_" foreach sort { $a cmp $b } @states;
2651 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2654 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2655 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2657 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2660 #comment this block to disable initial list polulation
2661 my @initial_select = ();
2662 if ( scalar( @$pops ) > 100 ) {
2663 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2665 @initial_select = @$pops;
2667 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2668 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2669 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2670 $pop->{city}. ', '. $pop->{state}.
2671 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2674 $text .= qq!</SELECT></TD></TR></TABLE>!;
2680 =item domainselector HASHREF | LIST
2682 Takes as input a hashref or list of key/value pairs with the following keys:
2692 Service number of the selected item.
2696 Returns an HTML fragment for domain selection.
2700 sub domainselector {
2707 my $domsvc= $param->{'domsvc'};
2709 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2710 my $domains = $rv->{'domains'};
2711 $domsvc = $rv->{'domsvc'} unless $domsvc;
2713 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2714 unless scalar(keys %$domains);
2716 if (scalar(keys %$domains) == 1) {
2718 foreach(keys %$domains) {
2721 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2722 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2725 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2727 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2729 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2730 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2731 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2732 $domains->{$domain};
2735 $text .= qq!</SELECT></TD></TR>!;
2741 =item didselector HASHREF | LIST
2743 Takes as input a hashref or list of key/value pairs with the following keys:
2749 Field name for the returned HTML fragment.
2753 Service definition (see L<FS::part_svc>)
2757 Returns an HTML fragment for DID selection.
2769 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2770 'args'=>[ %$param ],
2774 $rv->{'error'} || $rv->{'output'};
2780 =head1 RESELLER FUNCTIONS
2782 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2783 with their active session, and the B<customer_info> and B<order_pkg> functions
2784 with their active session and an additional I<custnum> parameter.
2786 For the most part, development of the reseller web interface has been
2787 superceded by agent-virtualized access to the backend.
2799 =item agent_list_customers
2801 List agent's customers.
2809 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>