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 #!!! order_pkg example
263 #!!! cancel_pkg example
265 # signup functionality
266 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
268 my $signup_info = signup_info;
270 $rv = new_customer( {
273 'company' => $company,
274 'address1' => $address1,
275 'address2' => $address2,
279 'country' => $country,
280 'daytime' => $daytime,
284 'payinfo' => $payinfo,
286 'paystart_month' => $paystart_month
287 'paystart_year' => $paystart_year,
288 'payissue' => $payissue,
290 'paydate' => $paydate,
291 'payname' => $payname,
292 'invoicing_list' => $invoicing_list,
293 'referral_custnum' => $referral_custnum,
294 'agentnum' => $agentnum,
295 'pkgpart' => $pkgpart,
297 'username' => $username,
298 '_password' => $password,
302 'phonenum' => $phonenum,
307 my $error = $rv->{'error'};
308 if ( $error eq '_decline' ) {
318 Use this API to implement your own client "self-service" module.
320 If you just want to customize the look of the existing "self-service" module,
323 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
329 Changes the password for an existing user in svc_acct. Takes a hash
330 reference with the following keys:
336 Username of the account (required)
340 Domain of the account (required)
344 Old password (required)
348 New password (required)
366 =head1 "MY ACCOUNT" FUNCTIONS
372 Creates a user session. Takes a hash reference as parameter with the
379 Email address (username@domain), instead of username and domain. Required for
380 contact-based self-service login, can also be used for svc_acct-based login.
396 Returns a hash reference with the following keys:
402 Empty on success, or an error message on errors.
406 Session identifier for successful logins
410 =item customer_info HASHREF
412 Returns general customer information.
414 Takes a hash reference as parameter with a single key: B<session_id>
416 Returns a hash reference with the following keys:
430 Array reference of hash references of open inoices. Each hash reference has
431 the following keys: invnum, date, owed
435 An HTML fragment containing shipping and billing addresses.
437 =item The following fields are also returned
439 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
443 =item edit_info HASHREF
445 Takes a hash reference as parameter with any of the following keys:
447 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
449 If a field exists, the customer record is updated with the new value of that
450 field. If a field does not exist, that field is not changed on the customer
453 Returns a hash reference with a single key, B<error>, empty on success, or an
454 error message on errors
456 =item invoice HASHREF
458 Returns an invoice. Takes a hash reference as parameter with two keys:
459 session_id and invnum
461 Returns a hash reference with the following keys:
467 Empty on success, or an error message on errors
479 =item list_invoices HASHREF
481 Returns a list of all customer invoices. Takes a hash references with a single
484 Returns a hash reference with the following keys:
490 Empty on success, or an error message on errors
494 Reference to array of hash references with the following keys:
504 Invoice date, in UNIX epoch time
512 Cancels this customer.
514 Takes a hash reference as parameter with a single key: B<session_id>
516 Returns a hash reference with a single key, B<error>, which is empty on
517 success or an error message on errors.
519 =item payment_info HASHREF
521 Returns information that may be useful in displaying a payment page.
523 Takes a hash reference as parameter with a single key: B<session_id>.
525 Returns a hash reference with the following keys:
531 Empty on success, or an error message on errors
539 Exact name on credit card (CARD/DCRD)
563 Customer's current default payment type.
567 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
571 For CARD/DCRD payment types, the card number
575 For CARD/DCRD payment types, expiration month
579 For CARD/DCRD payment types, expiration year
581 =item cust_main_county
583 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.
587 Array reference of all states in the current default country.
591 Hash reference of card types; keys are card types, values are the exact strings
592 passed to the process_payment function
596 #this doesn't actually work yet
600 #Unique transaction identifier (prevents multiple charges), passed to the
601 #process_payment function
605 =item process_payment HASHREF
607 Processes a payment and possible change of address or payment type. Takes a
608 hash reference as parameter with the following keys:
622 If true, address and card information entered will be saved for subsequent
627 If true, future credit card payments will be done automatically (sets payby to
628 CARD). If false, future credit card payments will be done on-demand (sets
629 payby to DCRD). This option only has meaning if B<save> is set true.
657 Two-letter country code
665 Card expiration month
673 #this doesn't actually work yet
677 #Unique transaction identifier, returned from the payment_info function.
678 #Prevents multiple charges.
682 Returns a hash reference with a single key, B<error>, empty on success, or an
683 error message on errors.
685 =item process_payment_order_pkg
687 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
688 payment processes sucessfully, the package is ordered. Takes a hash reference
689 as parameter with the keys of both methods.
691 Returns a hash reference with a single key, B<error>, empty on success, or an
692 error message on errors.
694 =item process_payment_change_pkg
696 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
697 payment processes sucessfully, the package is ordered. Takes a hash reference
698 as parameter with the keys of both methods.
700 Returns a hash reference with a single key, B<error>, empty on success, or an
701 error message on errors.
704 =item process_payment_order_renew
706 Combines the B<process_payment> and B<order_renew> functions in one step. If
707 the payment processes sucessfully, the renewal is processed. Takes a hash
708 reference as parameter with the keys of both methods.
710 Returns a hash reference with a single key, B<error>, empty on success, or an
711 error message on errors.
715 Returns package information for this customer. For more detail on services,
718 Takes a hash reference as parameter with a single key: B<session_id>
720 Returns a hash reference containing customer package information. The hash reference contains the following keys:
730 Empty on success, or an error message on errors.
732 =item cust_pkg HASHREF
734 Array reference of hash references, each of which has the fields of a cust_pkg
735 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
736 the internal FS:: objects, but hash references of columns and values.
740 =item part_pkg fields
742 All fields of part_pkg for this specific cust_pkg (be careful with this
743 information - it may reveal more about your available packages than you would
744 like users to know in aggregate)
748 #XXX pare part_pkg fields down to a more secure subset
752 An array of hash references indicating information on unprovisioned services
753 available for provisioning for this specific cust_pkg. Each has the following
758 =item part_svc fields
760 All fields of part_svc (be careful with this information - it may reveal more
761 about your available packages than you would like users to know in aggregate)
765 #XXX pare part_svc fields down to a more secure subset
771 An array of hash references indicating information on the customer services
772 already provisioned for this specific cust_pkg. Each has the following keys:
778 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.
784 Primary key for this service
788 Service definition (see L<FS::part_svc>)
792 Customer package (see L<FS::cust_pkg>)
796 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
804 Returns service information for this customer.
806 Takes a hash reference as parameter with a single key: B<session_id>
808 Returns a hash reference containing customer package information. The hash reference contains the following keys:
818 An array of hash references indicating information on all of this customer's
819 services. Each has the following keys:
825 Primary key for this service
833 Meaningful user-specific identifier for the service (i.e. username, domain, or
838 Account (svc_acct) services also have the following keys:
856 Upload bytes remaining
860 Download bytes remaining
864 Total bytes remaining
866 =item recharge_amount
870 =item recharge_seconds
872 Number of seconds gained by recharge
874 =item recharge_upbytes
876 Number of upload bytes gained by recharge
878 =item recharge_downbytes
880 Number of download bytes gained by recharge
882 =item recharge_totalbytes
884 Number of total bytes gained by recharge
892 Orders a package for this customer.
894 Takes a hash reference as parameter with the following keys:
904 Package to order (see L<FS::part_pkg>).
908 Quantity for this package order (default 1).
912 Optional locationnum for this package order, for existing locations.
914 Or, for new locations, pass the following fields: address1*, address2, city*,
915 county, state*, zip*, country. (* = required in this case)
927 Service to order (see L<FS::part_svc>).
929 Normally optional; required only to provision a non-svc_acct service, or if the
930 package definition does not contain one svc_acct service definition with
931 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
932 also be specified to indicate that no initial service should be provisioned.
936 Fields used when provisioning an svc_acct service:
950 Optional security phrase
954 Optional Access number number
958 Fields used when provisioning an svc_domain service:
968 Fields used when provisioning an svc_phone service:
986 Fields used when provisioning an svc_external service:
1000 Fields used when provisioning an svc_pbx service:
1014 Returns a hash reference with a single key, B<error>, empty on success, or an
1015 error message on errors. The special error '_decline' is returned for
1016 declined transactions.
1020 Changes a package for this customer.
1022 Takes a hash reference as parameter with the following keys:
1032 Existing customer package.
1036 New package to order (see L<FS::part_pkg>).
1040 Quantity for this package order (default 1).
1044 Returns a hash reference with the following keys:
1050 Empty on success, or an error message on errors.
1054 On success, the new pkgnum
1061 Provides useful info for early renewals.
1063 Takes a hash reference as parameter with the following keys:
1073 Returns a hash reference. On errors, it contains a single key, B<error>, with
1074 the error message. Otherwise, contains a single key, B<dates>, pointing to
1075 an array refernce of hash references. Each hash reference contains the
1082 (Future) Bill date. Indicates a future date for which billing could be run.
1083 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1086 =item bill_date_pretty
1088 (Future) Bill date as a human-readable string. (Convenience for display;
1089 subject to change, so best not to parse for the date.)
1093 Base amount which will be charged if renewed early as of this date.
1097 Renewal date; i.e. even-futher future date at which the customer will be paid
1098 through if the early renewal is completed with the given B<bill-date>.
1099 Specified as a integer UNIX timestamp.
1101 =item renew_date_pretty
1103 Renewal date as a human-readable string. (Convenience for display;
1104 subject to change, so best not to parse for the date.)
1108 Package that will be renewed.
1112 Expiration date of the package that will be renewed.
1114 =item expire_date_pretty
1116 Expiration date of the package that will be renewed, as a human-readable
1117 string. (Convenience for display; subject to change, so best not to parse for
1124 Renews this customer early; i.e. runs billing for this customer in advance.
1126 Takes a hash reference as parameter with the following keys:
1136 Integer date as returned by the B<renew_info> function, indicating the advance
1137 date for which to run billing.
1141 Returns a hash reference with a single key, B<error>, empty on success, or an
1142 error message on errors.
1146 Cancels a package for this customer.
1148 Takes a hash reference as parameter with the following keys:
1158 pkgpart of package to cancel
1162 Returns a hash reference with a single key, B<error>, empty on success, or an
1163 error message on errors.
1165 =item provision_acct
1167 Provisions an account (svc_acct).
1169 Takes a hash references as parameter with the following keys:
1179 pkgnum of package into which this service is provisioned
1183 svcpart or service definition to provision
1193 =item provision_phone
1195 Provisions a phone number (svc_phone).
1197 Takes a hash references as parameter with the following keys:
1207 pkgnum of package into which this service is provisioned
1211 svcpart or service definition to provision
1231 E911 Address (optional)
1235 =item provision_external
1237 Provisions an external service (svc_external).
1239 Takes a hash references as parameter with the following keys:
1249 pkgnum of package into which this service is provisioned
1253 svcpart or service definition to provision
1263 =head1 SIGNUP FUNCTIONS
1267 =item signup_info HASHREF
1269 Takes a hash reference as parameter with the following keys:
1273 =item session_id - Optional agent/reseller interface session
1277 Returns a hash reference containing information that may be useful in
1278 displaying a signup page. The hash reference contains the following keys:
1282 =item cust_main_county
1284 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.
1288 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
1289 an agentnum specified explicitly via reseller interface session_id in the
1294 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.
1296 =item agentnum2part_pkg
1298 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.
1302 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.
1304 =item security_phrase
1306 True if the "security_phrase" feature is enabled
1310 Array reference of acceptable payment types for signup
1316 credit card - automatic
1320 credit card - on-demand - version 1.5+ only
1324 electronic check - automatic
1328 electronic check - on-demand - version 1.5+ only
1336 billing, not recommended for signups
1340 free, definitely not recommended for signups
1344 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1350 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1354 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".
1360 =item countrydefault
1366 =item new_customer_minimal HASHREF
1368 Creates a new customer.
1370 Current differences from new_customer: An address is not required. promo_code
1371 and reg_code are not supported. If invoicing_list and _password is passed, a
1372 contact will be created with self-service access (no pkgpart or username is
1373 necessary). No initial billing is run (this may change in a future version).
1375 Takes a hash reference as parameter with the following keys:
1381 first name (required)
1385 last name (required)
1389 (not typically collected; mostly used for ACH transactions)
1421 Daytime phone number
1425 Evening phone number
1433 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1437 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1441 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1445 Expiration date for CARD/DCRD
1449 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1451 =item invoicing_list
1453 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),
1455 =item referral_custnum
1457 referring customer number
1465 pkgpart of initial package
1481 Access number (index, not the literal number)
1485 Country code (to be provisioned as a service)
1489 Phone number (to be provisioned as a service)
1497 Returns a hash reference with the following keys:
1503 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)
1507 =item new_customer HASHREF
1509 Creates a new customer. Takes a hash reference as parameter with the
1516 first name (required)
1520 last name (required)
1524 (not typically collected; mostly used for ACH transactions)
1530 =item address1 (required)
1538 =item city (required)
1546 =item state (required)
1550 =item zip (required)
1556 Daytime phone number
1560 Evening phone number
1568 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1572 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1576 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1580 Expiration date for CARD/DCRD
1584 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1586 =item invoicing_list
1588 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),
1590 =item referral_custnum
1592 referring customer number
1600 pkgpart of initial package
1616 Access number (index, not the literal number)
1620 Country code (to be provisioned as a service)
1624 Phone number (to be provisioned as a service)
1632 Returns a hash reference with the following keys:
1638 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)
1642 =item regionselector HASHREF | LIST
1644 Takes as input a hashref or list of key/value pairs with the following keys:
1648 =item selected_county
1650 Currently selected county
1652 =item selected_state
1654 Currently selected state
1656 =item selected_country
1658 Currently selected country
1662 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1666 Specify a javascript subroutine to call on changes
1672 =item default_country
1678 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>.
1682 Returns a list consisting of three HTML fragments for county selection,
1683 state selection and country selection, respectively.
1687 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1688 sub regionselector {
1695 $param->{'selected_country'} ||= $param->{'default_country'};
1696 $param->{'selected_state'} ||= $param->{'default_state'};
1698 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1702 my %cust_main_county;
1704 # unless ( @cust_main_county ) { #cache
1705 #@cust_main_county = qsearch('cust_main_county', {} );
1706 #foreach my $c ( @cust_main_county ) {
1707 foreach my $c ( @{ $param->{'locales'} } ) {
1708 #$countyflag=1 if $c->county;
1709 $countyflag=1 if $c->{county};
1710 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1711 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1712 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1715 $countyflag=1 if $param->{selected_county};
1717 my $script_html = <<END;
1719 function opt(what,value,text) {
1720 var optionName = new Option(text, value, false, false);
1721 var length = what.length;
1722 what.options[length] = optionName;
1724 function ${prefix}country_changed(what) {
1725 country = what.options[what.selectedIndex].text;
1726 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1727 what.form.${prefix}state.options[i] = null;
1729 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1731 foreach my $country ( sort keys %cust_main_county ) {
1732 $script_html .= "\nif ( country == \"$country\" ) {\n";
1733 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1734 my $text = $state || '(n/a)';
1735 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1737 $script_html .= "}\n";
1740 $script_html .= <<END;
1742 function ${prefix}state_changed(what) {
1745 if ( $countyflag ) {
1746 $script_html .= <<END;
1747 state = what.options[what.selectedIndex].text;
1748 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1749 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1750 what.form.${prefix}county.options[i] = null;
1753 foreach my $country ( sort keys %cust_main_county ) {
1754 $script_html .= "\nif ( country == \"$country\" ) {\n";
1755 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1756 $script_html .= "\nif ( state == \"$state\" ) {\n";
1757 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1758 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1759 my $text = $county || '(n/a)';
1761 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1763 $script_html .= "}\n";
1765 $script_html .= "}\n";
1769 $script_html .= <<END;
1774 my $county_html = $script_html;
1775 if ( $countyflag ) {
1776 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1777 foreach my $county (
1778 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1780 my $text = $county || '(n/a)';
1781 $county_html .= qq!<OPTION VALUE="$county"!.
1782 ($county eq $param->{'selected_county'} ?
1789 $county_html .= '</SELECT>';
1792 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1795 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1796 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1797 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1798 my $text = $state || '(n/a)';
1799 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
1800 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
1802 $state_html .= '</SELECT>';
1804 my $country_html = '';
1805 if ( scalar( keys %cust_main_county ) > 1 ) {
1807 $country_html = qq(<SELECT NAME="${prefix}country" ).
1808 qq(onChange="${prefix}country_changed(this); ).
1809 $param->{'onchange'}.
1812 my $countrydefault = $param->{default_country} || 'US';
1813 foreach my $country (
1814 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
1815 keys %cust_main_county
1817 my $selected = $country eq $param->{'selected_country'}
1820 $country_html .= "\n<OPTION $selected>$country</OPTION>"
1822 $country_html .= '</SELECT>';
1825 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
1826 ' VALUE="'. (keys %cust_main_county )[0]. '">';
1830 ($county_html, $state_html, $country_html);
1834 sub regionselector_hashref {
1835 my ($county_html, $state_html, $country_html) = regionselector(@_);
1837 'county_html' => $county_html,
1838 'state_html' => $state_html,
1839 'country_html' => $country_html,
1843 =item location_form HASHREF | LIST
1845 Takes as input a hashref or list of key/value pairs with the following keys:
1851 Current customer session_id
1855 Omit red asterisks from required fields.
1857 =item address1_label
1859 Label for first address line.
1863 Returns an HTML fragment for a location form (address, city, state, zip,
1876 my $session_id = delete $param->{'session_id'};
1878 my $rv = mason_comp( 'session_id' => $session_id,
1879 'comp' => '/elements/location.html',
1880 'args' => [ %$param ],
1884 $rv->{'error'} || $rv->{'output'};
1889 #=item expselect HASHREF | LIST
1891 #Takes as input a hashref or list of key/value pairs with the following keys:
1895 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1897 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
1901 =item expselect PREFIX [ DATE ]
1903 Takes as input a unique prefix string and the current expiration date, in
1904 yyyy-mm-dd or m-d-yyyy format
1906 Returns an HTML fragments for expiration date selection.
1912 #if ( ref($_[0]) ) {
1916 #my $prefix = $param->{'prefix'};
1917 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1918 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
1920 my $date = scalar(@_) ? shift : '';
1922 my( $m, $y ) = ( 0, 0 );
1923 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
1924 ( $m, $y ) = ( $2, $1 );
1925 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
1926 ( $m, $y ) = ( $1, $3 );
1928 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
1930 $return .= qq!<OPTION VALUE="$_"!;
1931 $return .= " SELECTED" if $_ == $m;
1934 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
1936 my $thisYear = $t[5] + 1900;
1937 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
1938 $return .= qq!<OPTION VALUE="$_"!;
1939 $return .= " SELECTED" if $_ == $y;
1942 $return .= "</SELECT>";
1947 =item popselector HASHREF | LIST
1949 Takes as input a hashref or list of key/value pairs with the following keys:
1955 Access number number
1959 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>.
1963 Returns an HTML fragment for access number selection.
1967 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
1975 my $popnum = $param->{'popnum'};
1976 my $pops = $param->{'pops'};
1978 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
1979 return $pops->[0]{city}. ', '. $pops->[0]{state}.
1980 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
1981 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
1982 if scalar(@$pops) == 1;
1985 my %popnum2pop = ();
1987 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
1988 $popnum2pop{$_->{popnum}} = $_;
1993 function opt(what,href,text) {
1994 var optionName = new Option(text, href, false, false)
1995 var length = what.length;
1996 what.options[length] = optionName;
2000 my $init_popstate = $param->{'init_popstate'};
2001 if ( $init_popstate ) {
2002 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2003 $init_popstate. '">';
2006 function acstate_changed(what) {
2007 state = what.options[what.selectedIndex].text;
2008 what.form.popac.options.length = 0
2009 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2013 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2014 foreach my $state ( sort { $a cmp $b } @states ) {
2015 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2017 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2018 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2019 if ($ac eq $param->{'popac'}) {
2020 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2023 $text .= "}\n" unless $init_popstate;
2025 $text .= "popac_changed(what.form.popac)}\n";
2028 function popac_changed(what) {
2029 ac = what.options[what.selectedIndex].text;
2030 what.form.popnum.options.length = 0;
2031 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2035 foreach my $state ( @states ) {
2036 foreach my $popac ( keys %{ $pop{$state} } ) {
2037 $text .= "\nif ( ac == \"$popac\" ) {\n";
2039 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2040 my $o_popnum = $pop->{popnum};
2041 my $poptext = $pop->{city}. ', '. $pop->{state}.
2042 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2044 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2045 if ($popnum == $o_popnum) {
2046 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2054 $text .= "}\n</SCRIPT>\n";
2056 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2059 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2060 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2061 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2062 ">$_" foreach sort { $a cmp $b } @states;
2063 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2066 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2067 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2069 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2072 #comment this block to disable initial list polulation
2073 my @initial_select = ();
2074 if ( scalar( @$pops ) > 100 ) {
2075 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2077 @initial_select = @$pops;
2079 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2080 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2081 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2082 $pop->{city}. ', '. $pop->{state}.
2083 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2086 $text .= qq!</SELECT></TD></TR></TABLE>!;
2092 =item domainselector HASHREF | LIST
2094 Takes as input a hashref or list of key/value pairs with the following keys:
2104 Service number of the selected item.
2108 Returns an HTML fragment for domain selection.
2112 sub domainselector {
2119 my $domsvc= $param->{'domsvc'};
2121 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2122 my $domains = $rv->{'domains'};
2123 $domsvc = $rv->{'domsvc'} unless $domsvc;
2125 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2126 unless scalar(keys %$domains);
2128 if (scalar(keys %$domains) == 1) {
2130 foreach(keys %$domains) {
2133 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2134 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2137 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2139 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2141 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2142 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2143 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2144 $domains->{$domain};
2147 $text .= qq!</SELECT></TD></TR>!;
2153 =item didselector HASHREF | LIST
2155 Takes as input a hashref or list of key/value pairs with the following keys:
2161 Field name for the returned HTML fragment.
2165 Service definition (see L<FS::part_svc>)
2169 Returns an HTML fragment for DID selection.
2181 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2182 'args'=>[ %$param ],
2186 $rv->{'error'} || $rv->{'output'};
2192 =head1 RESELLER FUNCTIONS
2194 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2195 with their active session, and the B<customer_info> and B<order_pkg> functions
2196 with their active session and an additional I<custnum> parameter.
2198 For the most part, development of the reseller web interface has been
2199 superceded by agent-virtualized access to the backend.
2211 =item agent_list_customers
2213 List agent's customers.
2221 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>