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 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
118 'new_agent' => 'Agent/new_agent',
119 'agent_login' => 'Agent/agent_login',
120 'agent_logout' => 'Agent/agent_logout',
121 'agent_info' => 'Agent/agent_info',
122 'agent_list_customers' => 'Agent/agent_list_customers',
123 'check_username' => 'Agent/check_username',
124 'suspend_username' => 'Agent/suspend_username',
125 'unsuspend_username' => 'Agent/unsuspend_username',
126 'mason_comp' => 'MasonComponent/mason_comp',
127 'call_time' => 'PrepaidPhone/call_time',
128 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
129 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
131 'start_thirdparty' => 'MyAccount/start_thirdparty',
132 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
134 'list_quotations' => 'MyAccount/quotation/list_quotations',
135 'quotation_new' => 'MyAccount/quotation/quotation_new',
136 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
137 'quotation_info' => 'MyAccount/quotation/quotation_info',
138 'quotation_print' => 'MyAccount/quotation/quotation_print',
139 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
140 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
141 'quotation_order' => 'MyAccount/quotation/quotation_order',
143 'freesideinc_service' => 'Freeside/freesideinc_service',
148 qw( regionselector regionselector_hashref location_form
149 expselect popselector domainselector didselector
153 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
154 $ENV{'SHELL'} = '/bin/sh';
155 $ENV{'IFS'} = " \t\n";
158 $ENV{'BASH_ENV'} = '';
160 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
161 #if you grant appropriate permissions to whatever user
162 my $freeside_uid = scalar(getpwnam('freeside'));
163 die "not running as the freeside user\n"
164 if $> != $freeside_uid && ! $skip_uid_check;
166 -e $dir or die "FATAL: $dir doesn't exist!";
167 -d $dir or die "FATAL: $dir isn't a directory!";
168 -r $dir or die "FATAL: Can't read $dir as freeside user!";
169 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
171 foreach my $autoload ( keys %autoload ) {
174 "sub $autoload { ". '
179 #warn scalar(@_). ": ". join(" / ", @_);
183 $param->{_packet} = \''. $autoload{$autoload}. '\';
185 simple_packet($param);
195 warn "sending ". $packet->{_packet}. " to server"
197 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
198 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
199 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
202 #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
204 #block until there is a message on socket
205 # my $w = new IO::Select;
207 # my @wait = $w->can_read;
209 warn "reading message from server"
212 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
213 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
215 warn "returning message to client"
223 FS::SelfService - Freeside self-service API
227 # password and shell account changes
228 use FS::SelfService qw(passwd chfn chsh);
230 # "my account" functionality
231 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
233 #new-style login with an email address and password
234 # can also be used for svc_acct login, set $emailaddress to username@domain
235 my $rv = login ( { 'email' => $emailaddress,
236 'password' => $password,
239 if ( $rv->{'error'} ) {
240 #handle login error...
243 $session_id = $rv->{'session_id'};
246 #classic svc_acct-based login with separate username and password
247 my $rv = login( { 'username' => $username,
249 'password' => $password,
252 if ( $rv->{'error'} ) {
253 #handle login error...
256 $session_id = $rv->{'session_id'};
259 #svc_phone login with phone number and PIN
260 my $rv = login( { 'username' => $phone_number,
261 'domain' => 'svc_phone',
265 if ( $rv->{'error'} ) {
266 #handle login error...
269 $session_id = $rv->{'session_id'};
272 my $customer_info = customer_info( { 'session_id' => $session_id } );
274 #payment_info and process_payment are available in 1.5+ only
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 a single key: B<session_id>.
742 Returns a hash reference with the following keys:
748 Empty on success, or an error message on errors
756 Exact name on credit card (CARD/DCRD)
780 Customer's current default payment type.
784 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
788 For CARD/DCRD payment types, the card number
792 For CARD/DCRD payment types, expiration month
796 For CARD/DCRD payment types, expiration year
798 =item cust_main_county
800 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.
804 Array reference of all states in the current default country.
808 Hash reference of card types; keys are card types, values are the exact strings
809 passed to the process_payment function
813 #this doesn't actually work yet
817 #Unique transaction identifier (prevents multiple charges), passed to the
818 #process_payment function
822 =item process_payment HASHREF
824 Processes a payment and possible change of address or payment type. Takes a
825 hash reference as parameter with the following keys:
839 If true, address and card information entered will be saved for subsequent
844 If true, future credit card payments will be done automatically (sets payby to
845 CARD). If false, future credit card payments will be done on-demand (sets
846 payby to DCRD). This option only has meaning if B<save> is set true.
874 Two-letter country code
882 Card expiration month
890 #this doesn't actually work yet
894 #Unique transaction identifier, returned from the payment_info function.
895 #Prevents multiple charges.
899 Returns a hash reference with a single key, B<error>, empty on success, or an
900 error message on errors.
902 =item process_payment_order_pkg
904 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
905 payment processes sucessfully, the package is ordered. Takes a hash reference
906 as parameter with the keys of both methods.
908 Returns a hash reference with a single key, B<error>, empty on success, or an
909 error message on errors.
911 =item process_payment_change_pkg
913 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
914 payment processes sucessfully, the package is ordered. Takes a hash reference
915 as parameter with the keys of both methods.
917 Returns a hash reference with a single key, B<error>, empty on success, or an
918 error message on errors.
921 =item process_payment_order_renew
923 Combines the B<process_payment> and B<order_renew> functions in one step. If
924 the payment processes sucessfully, the renewal is processed. Takes a hash
925 reference as parameter with the keys of both methods.
927 Returns a hash reference with a single key, B<error>, empty on success, or an
928 error message on errors.
932 Returns package information for this customer. For more detail on services,
935 Takes a hash reference as parameter with a single key: B<session_id>
937 Returns a hash reference containing customer package information. The hash reference contains the following keys:
947 Empty on success, or an error message on errors.
949 =item cust_pkg HASHREF
951 Array reference of hash references, each of which has the fields of a cust_pkg
952 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
953 the internal FS:: objects, but hash references of columns and values.
957 =item part_pkg fields
959 All fields of part_pkg for this specific cust_pkg (be careful with this
960 information - it may reveal more about your available packages than you would
961 like users to know in aggregate)
965 #XXX pare part_pkg fields down to a more secure subset
969 An array of hash references indicating information on unprovisioned services
970 available for provisioning for this specific cust_pkg. Each has the following
975 =item part_svc fields
977 All fields of part_svc (be careful with this information - it may reveal more
978 about your available packages than you would like users to know in aggregate)
982 #XXX pare part_svc fields down to a more secure subset
988 An array of hash references indicating information on the customer services
989 already provisioned for this specific cust_pkg. Each has the following keys:
995 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.
1001 Primary key for this service
1005 Service definition (see L<FS::part_svc>)
1009 Customer package (see L<FS::cust_pkg>)
1013 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
1021 Returns service information for this customer.
1023 Takes a hash reference as parameter with a single key: B<session_id>
1025 Returns a hash reference containing customer package information. The hash reference contains the following keys:
1035 An array of hash references indicating information on all of this customer's
1036 services. Each has the following keys:
1042 Primary key for this service
1046 Name of this service
1050 Meaningful user-specific identifier for the service (i.e. username, domain, or
1055 Account (svc_acct) services also have the following keys:
1073 Upload bytes remaining
1077 Download bytes remaining
1081 Total bytes remaining
1083 =item recharge_amount
1087 =item recharge_seconds
1089 Number of seconds gained by recharge
1091 =item recharge_upbytes
1093 Number of upload bytes gained by recharge
1095 =item recharge_downbytes
1097 Number of download bytes gained by recharge
1099 =item recharge_totalbytes
1101 Number of total bytes gained by recharge
1109 Orders a package for this customer.
1111 If signup_server-realtime is set, bills the new package, attemps to collect
1112 payment and (for auto-payment customers) cancels the package if the payment is
1115 Takes a hash reference as parameter with the following keys:
1125 Package to order (see L<FS::part_pkg>).
1129 Quantity for this package order (default 1).
1131 =item run_bill_events
1133 If true, runs billing events for the customer after ordering and billing the
1134 package (signup_server-realtime must be set).
1138 Optional locationnum for this package order, for existing locations.
1140 Or, for new locations, pass the following fields: address1*, address2, city*,
1141 county, state*, zip*, country. (* = required in this case)
1143 (None of this is required at all if you are just ordering a package
1144 at the customer's existing default service location.)
1162 Service to order (see L<FS::part_svc>).
1164 Normally optional; required only to provision a non-svc_acct service, or if the
1165 package definition does not contain one svc_acct service definition with
1166 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1167 also be specified to indicate that no initial service should be provisioned.
1171 Fields used when provisioning an svc_acct service:
1185 Optional security phrase
1189 Optional Access number number
1193 Fields used when provisioning an svc_domain service:
1203 Fields used when provisioning an svc_phone service:
1221 Fields used when provisioning an svc_external service:
1227 External numeric ID.
1231 External text title.
1235 Fields used when provisioning an svc_pbx service:
1249 Returns a hash reference with a single key, B<error>, empty on success, or an
1250 error message on errors. The special error '_decline' is returned for
1251 declined transactions.
1255 Changes a package for this customer.
1257 Takes a hash reference as parameter with the following keys:
1267 Existing customer package.
1271 New package to order (see L<FS::part_pkg>).
1275 Quantity for this package order (default 1).
1279 Returns a hash reference with the following keys:
1285 Empty on success, or an error message on errors.
1289 On success, the new pkgnum
1296 Provides useful info for early renewals.
1298 Takes a hash reference as parameter with the following keys:
1308 Returns a hash reference. On errors, it contains a single key, B<error>, with
1309 the error message. Otherwise, contains a single key, B<dates>, pointing to
1310 an array refernce of hash references. Each hash reference contains the
1317 (Future) Bill date. Indicates a future date for which billing could be run.
1318 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1321 =item bill_date_pretty
1323 (Future) Bill date as a human-readable string. (Convenience for display;
1324 subject to change, so best not to parse for the date.)
1328 Base amount which will be charged if renewed early as of this date.
1332 Renewal date; i.e. even-futher future date at which the customer will be paid
1333 through if the early renewal is completed with the given B<bill-date>.
1334 Specified as an integer UNIX timestamp.
1336 =item renew_date_pretty
1338 Renewal date as a human-readable string. (Convenience for display;
1339 subject to change, so best not to parse for the date.)
1343 Package that will be renewed.
1347 Expiration date of the package that will be renewed.
1349 =item expire_date_pretty
1351 Expiration date of the package that will be renewed, as a human-readable
1352 string. (Convenience for display; subject to change, so best not to parse for
1359 Renews this customer early; i.e. runs billing for this customer in advance.
1361 Takes a hash reference as parameter with the following keys:
1371 Integer date as returned by the B<renew_info> function, indicating the advance
1372 date for which to run billing.
1376 Returns a hash reference with a single key, B<error>, empty on success, or an
1377 error message on errors.
1381 Cancels a package for this customer.
1383 Takes a hash reference as parameter with the following keys:
1393 pkgpart of package to cancel
1397 Optional date, for future cancellation (expiration) instead of immediate
1398 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1402 Returns a hash reference with a single key, B<error>, empty on success, or an
1403 error message on errors.
1405 =item provision_acct
1407 Provisions an account (svc_acct).
1409 Takes a hash reference as parameter with the following keys:
1419 pkgnum of package into which this service is provisioned
1423 svcpart or service definition to provision
1433 =item provision_phone
1435 Provisions a phone number (svc_phone).
1437 Takes a hash reference as parameter with the following keys:
1447 pkgnum of package into which this service is provisioned
1451 svcpart or service definition to provision
1471 E911 Address (optional)
1477 Provisions a customer PBX (svc_pbx).
1479 Takes a hash reference as parameter with the following keys:
1489 pkgnum of package into which this service is provisioned
1493 svcpart or service definition to provision
1499 =item max_extensions
1501 =item max_simultaneous
1507 =item provision_external
1509 Provisions an external service (svc_external).
1511 Takes a hash reference as parameter with the following keys:
1521 pkgnum of package into which this service is provisioned
1525 svcpart or service definition to provision
1535 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1539 =item contact_passwd
1541 Changes the password for the currently-logged in contact.
1543 Takes a hash reference as parameter with the following keys:
1553 Returns a hash reference with a single parameter, B<error>, which contains an
1554 error message, or empty on success.
1558 Takes a hash reference as parameter with a single key, B<session_id>.
1560 Returns a hash reference with two parameters: B<error>, which contains an error
1561 message, or empty on success, and B<contacts>, a list of contacts.
1563 B<contacts> is an array reference of hash references (i.e. an array of structs,
1564 in XML-RPC). Each hash reference (struct) has the following keys:
1572 Contact class name (contact type).
1584 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1588 Comma-separated list of email addresses
1592 =item selfservice_access
1600 Updates information for the currently-logged in contact, or (optionally) the
1603 Takes a hash reference as parameter with the following keys:
1611 If already logged in as a contact, this is optional.
1621 Returns a hash reference with a single parameter, B<error>, which contains an
1622 error message, or empty on success.
1626 Creates a new contact.
1628 Takes a hash reference as parameter with the following keys:
1642 Optional contact classnum (TODO: or name)
1646 =item selfservice_access
1648 Y to enable self-service access
1654 Returns a hash reference with a single parameter, B<error>, which contains an
1655 error message, or empty on success.
1657 =item delete_contact
1659 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1662 Takes a hash reference as parameter with the following keys:
1672 Returns a hash reference with a single parameter, B<error>, which contains an
1673 error message, or empty on success.
1677 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1679 All of these functions require the user to be logged in, and the 'session_id'
1680 key to be included in the argument hashref.`
1684 =item list_quotations HASHREF
1686 Returns a hashref listing this customer's active self-service quotations.
1693 an arrayref containing an element for each quotation.
1701 the date it was started
1705 the number of packages
1709 the sum of setup fees
1713 the sum of recurring charges
1717 =item quotation_new HASHREF
1719 Creates an empty quotation and returns a hashref containing 'quotationnum',
1720 the primary key of the new quotation.
1722 =item quotation_delete HASHREF
1724 Disables (does not really delete) a quotation. Takes the following arguments:
1730 =item quotationnum - the quotation to delete
1734 Returns 'error' => a string, which will be empty on success.
1736 =item quotation_info HASHREF
1738 Returns total and detailed pricing information on a quotation.
1740 Takes the following arguments:
1746 =item quotationnum - the quotation to return
1750 Returns a hashref containing:
1752 - total_setup, the total of setup fees (and their taxes)
1753 - total_recur, the total of all recurring charges (and their taxes)
1754 - sections, an arrayref containing an element for each quotation section.
1755 - description, a line of text describing the group of charges
1756 - subtotal, the total of charges in this group (if appropriate)
1757 - detail_items, an arrayref of line items
1758 - pkgnum, the reference number of the package
1759 - description, the package name (or tax name)
1761 - amount, the amount charged
1762 If the detail item represents a subtotal, it will instead contain:
1763 - total_item: description of the subtotal
1764 - total_amount: the subtotal amount
1767 =item quotation_print HASHREF
1769 Renders the quotation as HTML or PDF. Takes the following arguments:
1775 =item quotationnum - the quotation to return
1777 =item format - 'html' or 'pdf'
1781 Returns a hashref containing 'document', the contents of the file.
1783 =item quotation_add_pkg HASHREF
1785 Adds a package to a quotation. Takes the following arguments:
1791 =item pkgpart - the package to add
1793 =item quotationnum - the quotation to add it to
1795 =item quantity - the package quantity (defaults to 1)
1797 =item address1, address2, city, state, zip, country - address fields to set
1798 the service location
1802 Returns 'error' => a string, which will be empty on success.
1804 =item quotation_remove_pkg HASHREF
1806 Removes a package from a quotation. Takes the following arguments:
1812 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1814 =item quotationnum - the quotation to remove it from
1818 Returns 'error' => a string, which will be empty on success.
1820 =item quotation_order HASHREF
1822 Converts the packages in a quotation into real packages. Takes the following
1825 Takes the following arguments:
1831 =item quotationnum - the quotation to order
1837 =head1 SIGNUP FUNCTIONS
1841 =item signup_info HASHREF
1843 Takes a hash reference as parameter with the following keys:
1847 =item session_id - Optional agent/reseller interface session
1851 Returns a hash reference containing information that may be useful in
1852 displaying a signup page. The hash reference contains the following keys:
1856 =item cust_main_county
1858 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.
1862 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
1863 an agentnum specified explicitly via reseller interface session_id in the
1868 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.
1870 =item agentnum2part_pkg
1872 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.
1876 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.
1878 =item security_phrase
1880 True if the "security_phrase" feature is enabled
1884 Array reference of acceptable payment types for signup
1890 credit card - automatic
1894 credit card - on-demand - version 1.5+ only
1898 electronic check - automatic
1902 electronic check - on-demand - version 1.5+ only
1910 billing, not recommended for signups
1914 free, definitely not recommended for signups
1918 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1924 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1928 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".
1934 =item countrydefault
1940 =item new_customer_minimal HASHREF
1942 Creates a new customer.
1944 Current differences from new_customer: An address is not required. promo_code
1945 and reg_code are not supported. If invoicing_list and _password is passed, a
1946 contact will be created with self-service access (no pkgpart or username is
1947 necessary). No initial billing is run (this may change in a future version).
1949 Takes a hash reference as parameter with the following keys:
1955 first name (required)
1959 last name (required)
1963 (not typically collected; mostly used for ACH transactions)
1995 Daytime phone number
1999 Evening phone number
2007 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2011 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2015 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2019 Expiration date for CARD/DCRD
2023 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2025 =item invoicing_list
2027 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),
2029 =item referral_custnum
2031 referring customer number
2039 pkgpart of initial package
2055 Access number (index, not the literal number)
2059 Country code (to be provisioned as a service)
2063 Phone number (to be provisioned as a service)
2071 Returns a hash reference with the following keys:
2077 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)
2081 =item new_customer HASHREF
2083 Creates a new customer. Takes a hash reference as parameter with the
2090 first name (required)
2094 last name (required)
2098 (not typically collected; mostly used for ACH transactions)
2104 =item address1 (required)
2112 =item city (required)
2120 =item state (required)
2124 =item zip (required)
2130 Daytime phone number
2134 Evening phone number
2142 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2146 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2150 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2154 Expiration date for CARD/DCRD
2158 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2160 =item invoicing_list
2162 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),
2164 =item referral_custnum
2166 referring customer number
2174 pkgpart of initial package
2190 Access number (index, not the literal number)
2194 Country code (to be provisioned as a service)
2198 Phone number (to be provisioned as a service)
2206 Returns a hash reference with the following keys:
2212 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)
2216 =item regionselector HASHREF | LIST
2218 Takes as input a hashref or list of key/value pairs with the following keys:
2222 =item selected_county
2224 Currently selected county
2226 =item selected_state
2228 Currently selected state
2230 =item selected_country
2232 Currently selected country
2236 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2240 Specify a javascript subroutine to call on changes
2246 =item default_country
2252 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>.
2256 Returns a list consisting of three HTML fragments for county selection,
2257 state selection and country selection, respectively.
2261 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2262 sub regionselector {
2269 $param->{'selected_country'} ||= $param->{'default_country'};
2270 $param->{'selected_state'} ||= $param->{'default_state'};
2272 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2276 my %cust_main_county;
2278 # unless ( @cust_main_county ) { #cache
2279 #@cust_main_county = qsearch('cust_main_county', {} );
2280 #foreach my $c ( @cust_main_county ) {
2281 foreach my $c ( @{ $param->{'locales'} } ) {
2282 #$countyflag=1 if $c->county;
2283 $countyflag=1 if $c->{county};
2284 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2285 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2286 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2289 $countyflag=1 if $param->{selected_county};
2291 my $script_html = <<END;
2293 function opt(what,value,text) {
2294 var optionName = new Option(text, value, false, false);
2295 var length = what.length;
2296 what.options[length] = optionName;
2298 function ${prefix}country_changed(what) {
2299 country = what.options[what.selectedIndex].text;
2300 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2301 what.form.${prefix}state.options[i] = null;
2303 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2305 foreach my $country ( sort keys %cust_main_county ) {
2306 $script_html .= "\nif ( country == \"$country\" ) {\n";
2307 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2308 my $text = $state || '(n/a)';
2309 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2311 $script_html .= "}\n";
2314 $script_html .= <<END;
2316 function ${prefix}state_changed(what) {
2319 if ( $countyflag ) {
2320 $script_html .= <<END;
2321 state = what.options[what.selectedIndex].text;
2322 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2323 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2324 what.form.${prefix}county.options[i] = null;
2327 foreach my $country ( sort keys %cust_main_county ) {
2328 $script_html .= "\nif ( country == \"$country\" ) {\n";
2329 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2330 $script_html .= "\nif ( state == \"$state\" ) {\n";
2331 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2332 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2333 my $text = $county || '(n/a)';
2335 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2337 $script_html .= "}\n";
2339 $script_html .= "}\n";
2343 $script_html .= <<END;
2348 my $county_html = $script_html;
2349 if ( $countyflag ) {
2350 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2351 foreach my $county (
2352 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2354 my $text = $county || '(n/a)';
2355 $county_html .= qq!<OPTION VALUE="$county"!.
2356 ($county eq $param->{'selected_county'} ?
2363 $county_html .= '</SELECT>';
2366 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2369 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2370 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2371 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2372 my $text = $state || '(n/a)';
2373 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2374 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2376 $state_html .= '</SELECT>';
2378 my $country_html = '';
2379 if ( scalar( keys %cust_main_county ) > 1 ) {
2381 $country_html = qq(<SELECT NAME="${prefix}country" ).
2382 qq(onChange="${prefix}country_changed(this); ).
2383 $param->{'onchange'}.
2386 my $countrydefault = $param->{default_country} || 'US';
2387 foreach my $country (
2388 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2389 keys %cust_main_county
2391 my $selected = $country eq $param->{'selected_country'}
2394 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2396 $country_html .= '</SELECT>';
2399 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2400 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2404 ($county_html, $state_html, $country_html);
2408 sub regionselector_hashref {
2409 my ($county_html, $state_html, $country_html) = regionselector(@_);
2411 'county_html' => $county_html,
2412 'state_html' => $state_html,
2413 'country_html' => $country_html,
2417 =item location_form HASHREF | LIST
2419 Takes as input a hashref or list of key/value pairs with the following keys:
2425 Current customer session_id
2429 Omit red asterisks from required fields.
2431 =item address1_label
2433 Label for first address line.
2437 Returns an HTML fragment for a location form (address, city, state, zip,
2450 my $session_id = delete $param->{'session_id'};
2452 my $rv = mason_comp( 'session_id' => $session_id,
2453 'comp' => '/elements/location.html',
2454 'args' => [ %$param ],
2458 $rv->{'error'} || $rv->{'output'};
2463 #=item expselect HASHREF | LIST
2465 #Takes as input a hashref or list of key/value pairs with the following keys:
2469 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2471 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2475 =item expselect PREFIX [ DATE ]
2477 Takes as input a unique prefix string and the current expiration date, in
2478 yyyy-mm-dd or m-d-yyyy format
2480 Returns an HTML fragments for expiration date selection.
2486 #if ( ref($_[0]) ) {
2490 #my $prefix = $param->{'prefix'};
2491 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2492 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2494 my $date = scalar(@_) ? shift : '';
2496 my( $m, $y ) = ( 0, 0 );
2497 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2498 ( $m, $y ) = ( $2, $1 );
2499 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2500 ( $m, $y ) = ( $1, $3 );
2502 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2504 $return .= qq!<OPTION VALUE="$_"!;
2505 $return .= " SELECTED" if $_ == $m;
2508 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2510 my $thisYear = $t[5] + 1900;
2511 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2512 $return .= qq!<OPTION VALUE="$_"!;
2513 $return .= " SELECTED" if $_ == $y;
2516 $return .= "</SELECT>";
2521 =item popselector HASHREF | LIST
2523 Takes as input a hashref or list of key/value pairs with the following keys:
2529 Access number number
2533 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>.
2537 Returns an HTML fragment for access number selection.
2541 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2549 my $popnum = $param->{'popnum'};
2550 my $pops = $param->{'pops'};
2552 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2553 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2554 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2555 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2556 if scalar(@$pops) == 1;
2559 my %popnum2pop = ();
2561 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2562 $popnum2pop{$_->{popnum}} = $_;
2567 function opt(what,href,text) {
2568 var optionName = new Option(text, href, false, false)
2569 var length = what.length;
2570 what.options[length] = optionName;
2574 my $init_popstate = $param->{'init_popstate'};
2575 if ( $init_popstate ) {
2576 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2577 $init_popstate. '">';
2580 function acstate_changed(what) {
2581 state = what.options[what.selectedIndex].text;
2582 what.form.popac.options.length = 0
2583 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2587 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2588 foreach my $state ( sort { $a cmp $b } @states ) {
2589 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2591 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2592 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2593 if ($ac eq $param->{'popac'}) {
2594 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2597 $text .= "}\n" unless $init_popstate;
2599 $text .= "popac_changed(what.form.popac)}\n";
2602 function popac_changed(what) {
2603 ac = what.options[what.selectedIndex].text;
2604 what.form.popnum.options.length = 0;
2605 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2609 foreach my $state ( @states ) {
2610 foreach my $popac ( keys %{ $pop{$state} } ) {
2611 $text .= "\nif ( ac == \"$popac\" ) {\n";
2613 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2614 my $o_popnum = $pop->{popnum};
2615 my $poptext = $pop->{city}. ', '. $pop->{state}.
2616 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2618 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2619 if ($popnum == $o_popnum) {
2620 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2628 $text .= "}\n</SCRIPT>\n";
2630 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2633 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2634 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2635 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2636 ">$_" foreach sort { $a cmp $b } @states;
2637 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2640 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2641 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2643 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2646 #comment this block to disable initial list polulation
2647 my @initial_select = ();
2648 if ( scalar( @$pops ) > 100 ) {
2649 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2651 @initial_select = @$pops;
2653 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2654 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2655 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2656 $pop->{city}. ', '. $pop->{state}.
2657 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2660 $text .= qq!</SELECT></TD></TR></TABLE>!;
2666 =item domainselector HASHREF | LIST
2668 Takes as input a hashref or list of key/value pairs with the following keys:
2678 Service number of the selected item.
2682 Returns an HTML fragment for domain selection.
2686 sub domainselector {
2693 my $domsvc= $param->{'domsvc'};
2695 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2696 my $domains = $rv->{'domains'};
2697 $domsvc = $rv->{'domsvc'} unless $domsvc;
2699 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2700 unless scalar(keys %$domains);
2702 if (scalar(keys %$domains) == 1) {
2704 foreach(keys %$domains) {
2707 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2708 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2711 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2713 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2715 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2716 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2717 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2718 $domains->{$domain};
2721 $text .= qq!</SELECT></TD></TR>!;
2727 =item didselector HASHREF | LIST
2729 Takes as input a hashref or list of key/value pairs with the following keys:
2735 Field name for the returned HTML fragment.
2739 Service definition (see L<FS::part_svc>)
2743 Returns an HTML fragment for DID selection.
2755 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2756 'args'=>[ %$param ],
2760 $rv->{'error'} || $rv->{'output'};
2766 =head1 RESELLER FUNCTIONS
2768 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2769 with their active session, and the B<customer_info> and B<order_pkg> functions
2770 with their active session and an additional I<custnum> parameter.
2772 For the most part, development of the reseller web interface has been
2773 superceded by agent-virtualized access to the backend.
2785 =item agent_list_customers
2787 List agent's customers.
2795 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>