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 'billing_history' => 'MyAccount/billing_history',
37 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
38 'invoice' => 'MyAccount/invoice',
39 'invoice_pdf' => 'MyAccount/invoice_pdf',
40 'legacy_invoice' => 'MyAccount/legacy_invoice',
41 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
42 'invoice_logo' => 'MyAccount/invoice_logo',
43 'list_invoices' => 'MyAccount/list_invoices', #?
44 'cancel' => 'MyAccount/cancel', #add to ss cgi!
45 'payment_info' => 'MyAccount/payment_info',
46 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
47 'process_payment' => 'MyAccount/process_payment',
48 'store_payment' => 'MyAccount/store_payment',
49 'process_stored_payment' => 'MyAccount/process_stored_payment',
50 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
51 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
52 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
53 'process_prepay' => 'MyAccount/process_prepay',
54 'realtime_collect' => 'MyAccount/realtime_collect',
55 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
56 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
57 'list_svc_usage' => 'MyAccount/list_svc_usage',
58 'svc_status_html' => 'MyAccount/svc_status_html',
59 'svc_status_hash' => 'MyAccount/svc_status_hash',
60 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
61 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
62 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
63 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
64 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
65 'acct_forward_info' => 'MyAccount/acct_forward_info',
66 'process_acct_forward' => 'MyAccount/process_acct_forward',
67 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
68 'add_dsl_device' => 'MyAccount/add_dsl_device',
69 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
70 'port_graph' => 'MyAccount/port_graph',
71 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
72 'list_support_usage' => 'MyAccount/list_support_usage',
73 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
74 'change_pkg' => 'MyAccount/change_pkg',
75 'order_recharge' => 'MyAccount/order_recharge',
76 'renew_info' => 'MyAccount/renew_info',
77 'order_renew' => 'MyAccount/order_renew',
78 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
79 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
80 'charge' => 'MyAccount/charge', #?
81 'part_svc_info' => 'MyAccount/part_svc_info',
82 'provision_acct' => 'MyAccount/provision_acct',
83 'provision_phone' => 'MyAccount/provision_phone',
84 'provision_external' => 'MyAccount/provision_external',
85 'unprovision_svc' => 'MyAccount/unprovision_svc',
86 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
87 'reset_passwd' => 'MyAccount/reset_passwd',
88 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
89 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
90 'list_tickets' => 'MyAccount/list_tickets',
91 'create_ticket' => 'MyAccount/create_ticket',
92 'get_ticket' => 'MyAccount/get_ticket',
93 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
94 'did_report' => 'MyAccount/did_report',
95 'signup_info' => 'Signup/signup_info',
96 'skin_info' => 'MyAccount/skin_info',
97 'access_info' => 'MyAccount/access_info',
98 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
99 'new_customer' => 'Signup/new_customer',
100 'new_customer_minimal' => 'Signup/new_customer_minimal',
101 'capture_payment' => 'Signup/capture_payment',
102 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
103 'new_agent' => 'Agent/new_agent',
104 'agent_login' => 'Agent/agent_login',
105 'agent_logout' => 'Agent/agent_logout',
106 'agent_info' => 'Agent/agent_info',
107 'agent_list_customers' => 'Agent/agent_list_customers',
108 'check_username' => 'Agent/check_username',
109 'suspend_username' => 'Agent/suspend_username',
110 'unsuspend_username' => 'Agent/unsuspend_username',
111 'mason_comp' => 'MasonComponent/mason_comp',
112 'call_time' => 'PrepaidPhone/call_time',
113 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
114 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
116 'start_thirdparty' => 'MyAccount/start_thirdparty',
117 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
119 'quotation_info' => 'MyAccount/quotation/quotation_info',
120 'quotation_print' => 'MyAccount/quotation/quotation_print',
121 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
122 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
123 'quotation_order' => 'MyAccount/quotation/quotation_order',
128 qw( regionselector regionselector_hashref location_form
129 expselect popselector domainselector didselector
133 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
134 $ENV{'SHELL'} = '/bin/sh';
135 $ENV{'IFS'} = " \t\n";
138 $ENV{'BASH_ENV'} = '';
140 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
141 #if you grant appropriate permissions to whatever user
142 my $freeside_uid = scalar(getpwnam('freeside'));
143 die "not running as the freeside user\n"
144 if $> != $freeside_uid && ! $skip_uid_check;
146 -e $dir or die "FATAL: $dir doesn't exist!";
147 -d $dir or die "FATAL: $dir isn't a directory!";
148 -r $dir or die "FATAL: Can't read $dir as freeside user!";
149 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
151 foreach my $autoload ( keys %autoload ) {
154 "sub $autoload { ". '
159 #warn scalar(@_). ": ". join(" / ", @_);
163 $param->{_packet} = \''. $autoload{$autoload}. '\';
165 simple_packet($param);
175 warn "sending ". $packet->{_packet}. " to server"
177 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
178 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
179 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
182 #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
184 #block until there is a message on socket
185 # my $w = new IO::Select;
187 # my @wait = $w->can_read;
189 warn "reading message from server"
192 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
193 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
195 warn "returning message to client"
203 FS::SelfService - Freeside self-service API
207 # password and shell account changes
208 use FS::SelfService qw(passwd chfn chsh);
210 # "my account" functionality
211 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
213 #new-style login with an email address and password
214 # can also be used for svc_acct login, set $emailaddress to username@domain
215 my $rv = login ( { 'email' => $emailaddress,
216 'password' => $password,
219 if ( $rv->{'error'} ) {
220 #handle login error...
223 $session_id = $rv->{'session_id'};
226 #classic svc_acct-based login with separate username and password
227 my $rv = login( { 'username' => $username,
229 'password' => $password,
232 if ( $rv->{'error'} ) {
233 #handle login error...
236 $session_id = $rv->{'session_id'};
239 #svc_phone login with phone number and PIN
240 my $rv = login( { 'username' => $phone_number,
241 'domain' => 'svc_phone',
245 if ( $rv->{'error'} ) {
246 #handle login error...
249 $session_id = $rv->{'session_id'};
252 my $customer_info = customer_info( { 'session_id' => $session_id } );
254 #payment_info and process_payment are available in 1.5+ only
255 my $payment_info = payment_info( { 'session_id' => $session_id } );
257 #!!! process_payment example
259 #!!! list_pkgs example
261 #ordering a package with an svc_acct service
262 my $rv = order_pkg( { 'session_id' => $session_id,
263 'pkgpart' => $pkgpart,
264 'svcpart' => $svcpart,
265 'username' => $username,
266 'domsvc' => $domsvc, #svcnum of svc_domain
267 '_password' => $password,
271 #!!! ordering a package with an svc_domain service example
273 #!!! ordering a package with an svc_phone service example
275 #!!! ordering a package with an svc_external service example
277 #!!! ordering a package with an svc_pbx service
279 #ordering a package with no service
280 my $rv = order_pkg( { 'session_id' => $session_id,
281 'pkgpart' => $pkgpart,
286 #!!! cancel_pkg example
288 # signup functionality
289 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
291 my $signup_info = signup_info;
293 $rv = new_customer( {
296 'company' => $company,
297 'address1' => $address1,
298 'address2' => $address2,
302 'country' => $country,
303 'daytime' => $daytime,
307 'payinfo' => $payinfo,
309 'paystart_month' => $paystart_month
310 'paystart_year' => $paystart_year,
311 'payissue' => $payissue,
313 'paydate' => $paydate,
314 'payname' => $payname,
315 'invoicing_list' => $invoicing_list,
316 'referral_custnum' => $referral_custnum,
317 'agentnum' => $agentnum,
318 'pkgpart' => $pkgpart,
320 'username' => $username,
321 '_password' => $password,
325 'phonenum' => $phonenum,
330 my $error = $rv->{'error'};
331 if ( $error eq '_decline' ) {
341 Use this API to implement your own client "self-service" module.
343 If you just want to customize the look of the existing "self-service" module,
346 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
352 Changes the password for an existing user in svc_acct. Takes a hash
353 reference with the following keys:
359 Username of the account (required)
363 Domain of the account (required)
367 Old password (required)
371 New password (required)
389 =head1 "MY ACCOUNT" FUNCTIONS
395 Creates a user session. Takes a hash reference as parameter with the
402 Email address (username@domain), instead of username and domain. Required for
403 contact-based self-service login, can also be used for svc_acct-based login.
419 Returns a hash reference with the following keys:
425 Empty on success, or an error message on errors.
429 Session identifier for successful logins
433 =item customer_info HASHREF
435 Returns general customer information.
437 Takes a hash reference as parameter with a single key: B<session_id>
439 Returns a hash reference with the following keys:
453 Array reference of hash references of open inoices. Each hash reference has
454 the following keys: invnum, date, owed
458 An HTML fragment containing shipping and billing addresses.
460 =item The following fields are also returned
462 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
466 =item edit_info HASHREF
468 Takes a hash reference as parameter with any of the following keys:
470 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
472 If a field exists, the customer record is updated with the new value of that
473 field. If a field does not exist, that field is not changed on the customer
476 Returns a hash reference with a single key, B<error>, empty on success, or an
477 error message on errors
479 =item invoice HASHREF
481 Returns an invoice. Takes a hash reference as parameter with two keys:
482 session_id and invnum
484 Returns a hash reference with the following keys:
490 Empty on success, or an error message on errors
502 =item list_invoices HASHREF
504 Returns a list of all customer invoices. Takes a hash references with a single
507 Returns a hash reference with the following keys:
513 Empty on success, or an error message on errors
517 Reference to array of hash references with the following keys:
527 Invoice date, in UNIX epoch time
535 Cancels this customer.
537 Takes a hash reference as parameter with a single key: B<session_id>
539 Returns a hash reference with a single key, B<error>, which is empty on
540 success or an error message on errors.
542 =item payment_info HASHREF
544 Returns information that may be useful in displaying a payment page.
546 Takes a hash reference as parameter with a single key: B<session_id>.
548 Returns a hash reference with the following keys:
554 Empty on success, or an error message on errors
562 Exact name on credit card (CARD/DCRD)
586 Customer's current default payment type.
590 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
594 For CARD/DCRD payment types, the card number
598 For CARD/DCRD payment types, expiration month
602 For CARD/DCRD payment types, expiration year
604 =item cust_main_county
606 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.
610 Array reference of all states in the current default country.
614 Hash reference of card types; keys are card types, values are the exact strings
615 passed to the process_payment function
619 #this doesn't actually work yet
623 #Unique transaction identifier (prevents multiple charges), passed to the
624 #process_payment function
628 =item process_payment HASHREF
630 Processes a payment and possible change of address or payment type. Takes a
631 hash reference as parameter with the following keys:
645 If true, address and card information entered will be saved for subsequent
650 If true, future credit card payments will be done automatically (sets payby to
651 CARD). If false, future credit card payments will be done on-demand (sets
652 payby to DCRD). This option only has meaning if B<save> is set true.
680 Two-letter country code
688 Card expiration month
696 #this doesn't actually work yet
700 #Unique transaction identifier, returned from the payment_info function.
701 #Prevents multiple charges.
705 Returns a hash reference with a single key, B<error>, empty on success, or an
706 error message on errors.
708 =item process_payment_order_pkg
710 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
711 payment processes sucessfully, the package is ordered. Takes a hash reference
712 as parameter with the keys of both methods.
714 Returns a hash reference with a single key, B<error>, empty on success, or an
715 error message on errors.
717 =item process_payment_change_pkg
719 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
720 payment processes sucessfully, the package is ordered. Takes a hash reference
721 as parameter with the keys of both methods.
723 Returns a hash reference with a single key, B<error>, empty on success, or an
724 error message on errors.
727 =item process_payment_order_renew
729 Combines the B<process_payment> and B<order_renew> functions in one step. If
730 the payment processes sucessfully, the renewal is processed. Takes a hash
731 reference as parameter with the keys of both methods.
733 Returns a hash reference with a single key, B<error>, empty on success, or an
734 error message on errors.
738 Returns package information for this customer. For more detail on services,
741 Takes a hash reference as parameter with a single key: B<session_id>
743 Returns a hash reference containing customer package information. The hash reference contains the following keys:
753 Empty on success, or an error message on errors.
755 =item cust_pkg HASHREF
757 Array reference of hash references, each of which has the fields of a cust_pkg
758 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
759 the internal FS:: objects, but hash references of columns and values.
763 =item part_pkg fields
765 All fields of part_pkg for this specific cust_pkg (be careful with this
766 information - it may reveal more about your available packages than you would
767 like users to know in aggregate)
771 #XXX pare part_pkg fields down to a more secure subset
775 An array of hash references indicating information on unprovisioned services
776 available for provisioning for this specific cust_pkg. Each has the following
781 =item part_svc fields
783 All fields of part_svc (be careful with this information - it may reveal more
784 about your available packages than you would like users to know in aggregate)
788 #XXX pare part_svc fields down to a more secure subset
794 An array of hash references indicating information on the customer services
795 already provisioned for this specific cust_pkg. Each has the following keys:
801 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.
807 Primary key for this service
811 Service definition (see L<FS::part_svc>)
815 Customer package (see L<FS::cust_pkg>)
819 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
827 Returns service information for this customer.
829 Takes a hash reference as parameter with a single key: B<session_id>
831 Returns a hash reference containing customer package information. The hash reference contains the following keys:
841 An array of hash references indicating information on all of this customer's
842 services. Each has the following keys:
848 Primary key for this service
856 Meaningful user-specific identifier for the service (i.e. username, domain, or
861 Account (svc_acct) services also have the following keys:
879 Upload bytes remaining
883 Download bytes remaining
887 Total bytes remaining
889 =item recharge_amount
893 =item recharge_seconds
895 Number of seconds gained by recharge
897 =item recharge_upbytes
899 Number of upload bytes gained by recharge
901 =item recharge_downbytes
903 Number of download bytes gained by recharge
905 =item recharge_totalbytes
907 Number of total bytes gained by recharge
915 Orders a package for this customer.
917 Takes a hash reference as parameter with the following keys:
927 Package to order (see L<FS::part_pkg>).
931 Quantity for this package order (default 1).
935 Optional locationnum for this package order, for existing locations.
937 Or, for new locations, pass the following fields: address1*, address2, city*,
938 county, state*, zip*, country. (* = required in this case)
950 Service to order (see L<FS::part_svc>).
952 Normally optional; required only to provision a non-svc_acct service, or if the
953 package definition does not contain one svc_acct service definition with
954 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
955 also be specified to indicate that no initial service should be provisioned.
959 Fields used when provisioning an svc_acct service:
973 Optional security phrase
977 Optional Access number number
981 Fields used when provisioning an svc_domain service:
991 Fields used when provisioning an svc_phone service:
1009 Fields used when provisioning an svc_external service:
1015 External numeric ID.
1019 External text title.
1023 Fields used when provisioning an svc_pbx service:
1037 Returns a hash reference with a single key, B<error>, empty on success, or an
1038 error message on errors. The special error '_decline' is returned for
1039 declined transactions.
1043 Changes a package for this customer.
1045 Takes a hash reference as parameter with the following keys:
1055 Existing customer package.
1059 New package to order (see L<FS::part_pkg>).
1063 Quantity for this package order (default 1).
1067 Returns a hash reference with the following keys:
1073 Empty on success, or an error message on errors.
1077 On success, the new pkgnum
1084 Provides useful info for early renewals.
1086 Takes a hash reference as parameter with the following keys:
1096 Returns a hash reference. On errors, it contains a single key, B<error>, with
1097 the error message. Otherwise, contains a single key, B<dates>, pointing to
1098 an array refernce of hash references. Each hash reference contains the
1105 (Future) Bill date. Indicates a future date for which billing could be run.
1106 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1109 =item bill_date_pretty
1111 (Future) Bill date as a human-readable string. (Convenience for display;
1112 subject to change, so best not to parse for the date.)
1116 Base amount which will be charged if renewed early as of this date.
1120 Renewal date; i.e. even-futher future date at which the customer will be paid
1121 through if the early renewal is completed with the given B<bill-date>.
1122 Specified as a integer UNIX timestamp.
1124 =item renew_date_pretty
1126 Renewal date as a human-readable string. (Convenience for display;
1127 subject to change, so best not to parse for the date.)
1131 Package that will be renewed.
1135 Expiration date of the package that will be renewed.
1137 =item expire_date_pretty
1139 Expiration date of the package that will be renewed, as a human-readable
1140 string. (Convenience for display; subject to change, so best not to parse for
1147 Renews this customer early; i.e. runs billing for this customer in advance.
1149 Takes a hash reference as parameter with the following keys:
1159 Integer date as returned by the B<renew_info> function, indicating the advance
1160 date for which to run billing.
1164 Returns a hash reference with a single key, B<error>, empty on success, or an
1165 error message on errors.
1169 Cancels a package for this customer.
1171 Takes a hash reference as parameter with the following keys:
1181 pkgpart of package to cancel
1185 Returns a hash reference with a single key, B<error>, empty on success, or an
1186 error message on errors.
1188 =item provision_acct
1190 Provisions an account (svc_acct).
1192 Takes a hash references as parameter with the following keys:
1202 pkgnum of package into which this service is provisioned
1206 svcpart or service definition to provision
1216 =item provision_phone
1218 Provisions a phone number (svc_phone).
1220 Takes a hash references as parameter with the following keys:
1230 pkgnum of package into which this service is provisioned
1234 svcpart or service definition to provision
1254 E911 Address (optional)
1258 =item provision_external
1260 Provisions an external service (svc_external).
1262 Takes a hash references as parameter with the following keys:
1272 pkgnum of package into which this service is provisioned
1276 svcpart or service definition to provision
1286 =head1 SIGNUP FUNCTIONS
1290 =item signup_info HASHREF
1292 Takes a hash reference as parameter with the following keys:
1296 =item session_id - Optional agent/reseller interface session
1300 Returns a hash reference containing information that may be useful in
1301 displaying a signup page. The hash reference contains the following keys:
1305 =item cust_main_county
1307 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.
1311 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
1312 an agentnum specified explicitly via reseller interface session_id in the
1317 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.
1319 =item agentnum2part_pkg
1321 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.
1325 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.
1327 =item security_phrase
1329 True if the "security_phrase" feature is enabled
1333 Array reference of acceptable payment types for signup
1339 credit card - automatic
1343 credit card - on-demand - version 1.5+ only
1347 electronic check - automatic
1351 electronic check - on-demand - version 1.5+ only
1359 billing, not recommended for signups
1363 free, definitely not recommended for signups
1367 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1373 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1377 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".
1383 =item countrydefault
1389 =item new_customer_minimal HASHREF
1391 Creates a new customer.
1393 Current differences from new_customer: An address is not required. promo_code
1394 and reg_code are not supported. If invoicing_list and _password is passed, a
1395 contact will be created with self-service access (no pkgpart or username is
1396 necessary). No initial billing is run (this may change in a future version).
1398 Takes a hash reference as parameter with the following keys:
1404 first name (required)
1408 last name (required)
1412 (not typically collected; mostly used for ACH transactions)
1444 Daytime phone number
1448 Evening phone number
1456 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1460 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1464 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1468 Expiration date for CARD/DCRD
1472 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1474 =item invoicing_list
1476 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),
1478 =item referral_custnum
1480 referring customer number
1488 pkgpart of initial package
1504 Access number (index, not the literal number)
1508 Country code (to be provisioned as a service)
1512 Phone number (to be provisioned as a service)
1520 Returns a hash reference with the following keys:
1526 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)
1530 =item new_customer HASHREF
1532 Creates a new customer. Takes a hash reference as parameter with the
1539 first name (required)
1543 last name (required)
1547 (not typically collected; mostly used for ACH transactions)
1553 =item address1 (required)
1561 =item city (required)
1569 =item state (required)
1573 =item zip (required)
1579 Daytime phone number
1583 Evening phone number
1591 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1595 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1599 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1603 Expiration date for CARD/DCRD
1607 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1609 =item invoicing_list
1611 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),
1613 =item referral_custnum
1615 referring customer number
1623 pkgpart of initial package
1639 Access number (index, not the literal number)
1643 Country code (to be provisioned as a service)
1647 Phone number (to be provisioned as a service)
1655 Returns a hash reference with the following keys:
1661 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)
1665 =item regionselector HASHREF | LIST
1667 Takes as input a hashref or list of key/value pairs with the following keys:
1671 =item selected_county
1673 Currently selected county
1675 =item selected_state
1677 Currently selected state
1679 =item selected_country
1681 Currently selected country
1685 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1689 Specify a javascript subroutine to call on changes
1695 =item default_country
1701 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>.
1705 Returns a list consisting of three HTML fragments for county selection,
1706 state selection and country selection, respectively.
1710 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1711 sub regionselector {
1718 $param->{'selected_country'} ||= $param->{'default_country'};
1719 $param->{'selected_state'} ||= $param->{'default_state'};
1721 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1725 my %cust_main_county;
1727 # unless ( @cust_main_county ) { #cache
1728 #@cust_main_county = qsearch('cust_main_county', {} );
1729 #foreach my $c ( @cust_main_county ) {
1730 foreach my $c ( @{ $param->{'locales'} } ) {
1731 #$countyflag=1 if $c->county;
1732 $countyflag=1 if $c->{county};
1733 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1734 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1735 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1738 $countyflag=1 if $param->{selected_county};
1740 my $script_html = <<END;
1742 function opt(what,value,text) {
1743 var optionName = new Option(text, value, false, false);
1744 var length = what.length;
1745 what.options[length] = optionName;
1747 function ${prefix}country_changed(what) {
1748 country = what.options[what.selectedIndex].text;
1749 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1750 what.form.${prefix}state.options[i] = null;
1752 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1754 foreach my $country ( sort keys %cust_main_county ) {
1755 $script_html .= "\nif ( country == \"$country\" ) {\n";
1756 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1757 my $text = $state || '(n/a)';
1758 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1760 $script_html .= "}\n";
1763 $script_html .= <<END;
1765 function ${prefix}state_changed(what) {
1768 if ( $countyflag ) {
1769 $script_html .= <<END;
1770 state = what.options[what.selectedIndex].text;
1771 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1772 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1773 what.form.${prefix}county.options[i] = null;
1776 foreach my $country ( sort keys %cust_main_county ) {
1777 $script_html .= "\nif ( country == \"$country\" ) {\n";
1778 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1779 $script_html .= "\nif ( state == \"$state\" ) {\n";
1780 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1781 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1782 my $text = $county || '(n/a)';
1784 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1786 $script_html .= "}\n";
1788 $script_html .= "}\n";
1792 $script_html .= <<END;
1797 my $county_html = $script_html;
1798 if ( $countyflag ) {
1799 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1800 foreach my $county (
1801 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1803 my $text = $county || '(n/a)';
1804 $county_html .= qq!<OPTION VALUE="$county"!.
1805 ($county eq $param->{'selected_county'} ?
1812 $county_html .= '</SELECT>';
1815 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1818 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1819 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1820 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1821 my $text = $state || '(n/a)';
1822 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1823 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
1825 $state_html .= '</SELECT>';
1827 my $country_html = '';
1828 if ( scalar( keys %cust_main_county ) > 1 ) {
1830 $country_html = qq(<SELECT NAME="${prefix}country" ).
1831 qq(onChange="${prefix}country_changed(this); ).
1832 $param->{'onchange'}.
1835 my $countrydefault = $param->{default_country} || 'US';
1836 foreach my $country (
1837 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1838 keys %cust_main_county
1840 my $selected = $country eq $param->{'selected_country'}
1843 $country_html .= "\n<OPTION $selected>$country</OPTION>"
1845 $country_html .= '</SELECT>';
1848 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1849 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1853 ($county_html, $state_html, $country_html);
1857 sub regionselector_hashref {
1858 my ($county_html, $state_html, $country_html) = regionselector(@_);
1860 'county_html' => $county_html,
1861 'state_html' => $state_html,
1862 'country_html' => $country_html,
1866 =item location_form HASHREF | LIST
1868 Takes as input a hashref or list of key/value pairs with the following keys:
1874 Current customer session_id
1878 Omit red asterisks from required fields.
1880 =item address1_label
1882 Label for first address line.
1886 Returns an HTML fragment for a location form (address, city, state, zip,
1899 my $session_id = delete $param->{'session_id'};
1901 my $rv = mason_comp( 'session_id' => $session_id,
1902 'comp' => '/elements/location.html',
1903 'args' => [ %$param ],
1907 $rv->{'error'} || $rv->{'output'};
1912 #=item expselect HASHREF | LIST
1914 #Takes as input a hashref or list of key/value pairs with the following keys:
1918 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1920 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1924 =item expselect PREFIX [ DATE ]
1926 Takes as input a unique prefix string and the current expiration date, in
1927 yyyy-mm-dd or m-d-yyyy format
1929 Returns an HTML fragments for expiration date selection.
1935 #if ( ref($_[0]) ) {
1939 #my $prefix = $param->{'prefix'};
1940 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1941 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1943 my $date = scalar(@_) ? shift : '';
1945 my( $m, $y ) = ( 0, 0 );
1946 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1947 ( $m, $y ) = ( $2, $1 );
1948 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1949 ( $m, $y ) = ( $1, $3 );
1951 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1953 $return .= qq!<OPTION VALUE="$_"!;
1954 $return .= " SELECTED" if $_ == $m;
1957 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1959 my $thisYear = $t[5] + 1900;
1960 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1961 $return .= qq!<OPTION VALUE="$_"!;
1962 $return .= " SELECTED" if $_ == $y;
1965 $return .= "</SELECT>";
1970 =item popselector HASHREF | LIST
1972 Takes as input a hashref or list of key/value pairs with the following keys:
1978 Access number number
1982 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>.
1986 Returns an HTML fragment for access number selection.
1990 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1998 my $popnum = $param->{'popnum'};
1999 my $pops = $param->{'pops'};
2001 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2002 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2003 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2004 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2005 if scalar(@$pops) == 1;
2008 my %popnum2pop = ();
2010 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2011 $popnum2pop{$_->{popnum}} = $_;
2016 function opt(what,href,text) {
2017 var optionName = new Option(text, href, false, false)
2018 var length = what.length;
2019 what.options[length] = optionName;
2023 my $init_popstate = $param->{'init_popstate'};
2024 if ( $init_popstate ) {
2025 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2026 $init_popstate. '">';
2029 function acstate_changed(what) {
2030 state = what.options[what.selectedIndex].text;
2031 what.form.popac.options.length = 0
2032 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2036 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2037 foreach my $state ( sort { $a cmp $b } @states ) {
2038 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2040 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2041 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2042 if ($ac eq $param->{'popac'}) {
2043 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2046 $text .= "}\n" unless $init_popstate;
2048 $text .= "popac_changed(what.form.popac)}\n";
2051 function popac_changed(what) {
2052 ac = what.options[what.selectedIndex].text;
2053 what.form.popnum.options.length = 0;
2054 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2058 foreach my $state ( @states ) {
2059 foreach my $popac ( keys %{ $pop{$state} } ) {
2060 $text .= "\nif ( ac == \"$popac\" ) {\n";
2062 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2063 my $o_popnum = $pop->{popnum};
2064 my $poptext = $pop->{city}. ', '. $pop->{state}.
2065 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2067 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2068 if ($popnum == $o_popnum) {
2069 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2077 $text .= "}\n</SCRIPT>\n";
2079 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2082 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2083 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2084 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2085 ">$_" foreach sort { $a cmp $b } @states;
2086 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2089 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2090 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2092 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2095 #comment this block to disable initial list polulation
2096 my @initial_select = ();
2097 if ( scalar( @$pops ) > 100 ) {
2098 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2100 @initial_select = @$pops;
2102 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2103 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2104 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2105 $pop->{city}. ', '. $pop->{state}.
2106 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2109 $text .= qq!</SELECT></TD></TR></TABLE>!;
2115 =item domainselector HASHREF | LIST
2117 Takes as input a hashref or list of key/value pairs with the following keys:
2127 Service number of the selected item.
2131 Returns an HTML fragment for domain selection.
2135 sub domainselector {
2142 my $domsvc= $param->{'domsvc'};
2144 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2145 my $domains = $rv->{'domains'};
2146 $domsvc = $rv->{'domsvc'} unless $domsvc;
2148 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2149 unless scalar(keys %$domains);
2151 if (scalar(keys %$domains) == 1) {
2153 foreach(keys %$domains) {
2156 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2157 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2160 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2162 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2164 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2165 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2166 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2167 $domains->{$domain};
2170 $text .= qq!</SELECT></TD></TR>!;
2176 =item didselector HASHREF | LIST
2178 Takes as input a hashref or list of key/value pairs with the following keys:
2184 Field name for the returned HTML fragment.
2188 Service definition (see L<FS::part_svc>)
2192 Returns an HTML fragment for DID selection.
2204 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2205 'args'=>[ %$param ],
2209 $rv->{'error'} || $rv->{'output'};
2215 =head1 RESELLER FUNCTIONS
2217 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2218 with their active session, and the B<customer_info> and B<order_pkg> functions
2219 with their active session and an additional I<custnum> parameter.
2221 For the most part, development of the reseller web interface has been
2222 superceded by agent-virtualized access to the backend.
2234 =item agent_list_customers
2236 List agent's customers.
2244 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>