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 'customer_info' => 'MyAccount/customer_info',
34 'customer_info_short' => 'MyAccount/customer_info_short',
36 'contact_passwd' => 'MyAccount/contact/contact_passwd',
37 'list_contacts' => 'MyAccount/contact/list_contacts',
38 'edit_contact' => 'MyAccount/contact/edit_contact',
39 'delete_contact' => 'MyAccount/contact/delete_contact',
40 'new_contact' => 'MyAccount/contact/new_contact',
42 'billing_history' => 'MyAccount/billing_history',
43 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
44 'invoice' => 'MyAccount/invoice',
45 'invoice_pdf' => 'MyAccount/invoice_pdf',
46 'legacy_invoice' => 'MyAccount/legacy_invoice',
47 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
48 'invoice_logo' => 'MyAccount/invoice_logo',
49 'list_invoices' => 'MyAccount/list_invoices', #?
50 'cancel' => 'MyAccount/cancel', #add to ss cgi!
51 'payment_info' => 'MyAccount/payment_info',
52 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
53 'process_payment' => 'MyAccount/process_payment',
54 'store_payment' => 'MyAccount/store_payment',
55 'process_stored_payment' => 'MyAccount/process_stored_payment',
56 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
57 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
58 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
59 'process_prepay' => 'MyAccount/process_prepay',
60 'realtime_collect' => 'MyAccount/realtime_collect',
61 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
62 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
63 'list_svc_usage' => 'MyAccount/list_svc_usage',
64 'svc_status_html' => 'MyAccount/svc_status_html',
65 'svc_status_hash' => 'MyAccount/svc_status_hash',
66 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
67 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
68 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
69 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
70 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
71 'acct_forward_info' => 'MyAccount/acct_forward_info',
72 'process_acct_forward' => 'MyAccount/process_acct_forward',
73 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
74 'add_dsl_device' => 'MyAccount/add_dsl_device',
75 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
76 'port_graph' => 'MyAccount/port_graph',
77 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
78 'list_support_usage' => 'MyAccount/list_support_usage',
79 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
80 'change_pkg' => 'MyAccount/change_pkg',
81 'order_recharge' => 'MyAccount/order_recharge',
82 'renew_info' => 'MyAccount/renew_info',
83 'order_renew' => 'MyAccount/order_renew',
84 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
85 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
86 'charge' => 'MyAccount/charge', #?
87 'part_svc_info' => 'MyAccount/part_svc_info',
88 'provision_acct' => 'MyAccount/provision_acct',
89 'provision_phone' => 'MyAccount/provision_phone',
90 'provision_pbx' => 'MyAccount/provision_pbx',
91 'provision_external' => 'MyAccount/provision_external',
92 'provision_forward' => 'MyAccount/provision_forward',
93 'unprovision_svc' => 'MyAccount/unprovision_svc',
94 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
95 'reset_passwd' => 'MyAccount/reset_passwd',
96 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
97 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
98 'list_tickets' => 'MyAccount/list_tickets',
99 'create_ticket' => 'MyAccount/create_ticket',
100 'get_ticket' => 'MyAccount/get_ticket',
101 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
102 'did_report' => 'MyAccount/did_report',
103 'signup_info' => 'Signup/signup_info',
104 'skin_info' => 'MyAccount/skin_info',
105 'access_info' => 'MyAccount/access_info',
106 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
107 'new_customer' => 'Signup/new_customer',
108 'new_customer_minimal' => 'Signup/new_customer_minimal',
109 'capture_payment' => 'Signup/capture_payment',
110 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
111 'new_agent' => 'Agent/new_agent',
112 'agent_login' => 'Agent/agent_login',
113 'agent_logout' => 'Agent/agent_logout',
114 'agent_info' => 'Agent/agent_info',
115 'agent_list_customers' => 'Agent/agent_list_customers',
116 'check_username' => 'Agent/check_username',
117 'suspend_username' => 'Agent/suspend_username',
118 'unsuspend_username' => 'Agent/unsuspend_username',
119 'mason_comp' => 'MasonComponent/mason_comp',
120 'call_time' => 'PrepaidPhone/call_time',
121 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
122 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
124 'start_thirdparty' => 'MyAccount/start_thirdparty',
125 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
127 'list_quotations' => 'MyAccount/quotation/list_quotations',
128 'quotation_new' => 'MyAccount/quotation/quotation_new',
129 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
130 'quotation_info' => 'MyAccount/quotation/quotation_info',
131 'quotation_print' => 'MyAccount/quotation/quotation_print',
132 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
133 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
134 'quotation_order' => 'MyAccount/quotation/quotation_order',
139 qw( regionselector regionselector_hashref location_form
140 expselect popselector domainselector didselector
144 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
145 $ENV{'SHELL'} = '/bin/sh';
146 $ENV{'IFS'} = " \t\n";
149 $ENV{'BASH_ENV'} = '';
151 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
152 #if you grant appropriate permissions to whatever user
153 my $freeside_uid = scalar(getpwnam('freeside'));
154 die "not running as the freeside user\n"
155 if $> != $freeside_uid && ! $skip_uid_check;
157 -e $dir or die "FATAL: $dir doesn't exist!";
158 -d $dir or die "FATAL: $dir isn't a directory!";
159 -r $dir or die "FATAL: Can't read $dir as freeside user!";
160 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
162 foreach my $autoload ( keys %autoload ) {
165 "sub $autoload { ". '
170 #warn scalar(@_). ": ". join(" / ", @_);
174 $param->{_packet} = \''. $autoload{$autoload}. '\';
176 simple_packet($param);
186 warn "sending ". $packet->{_packet}. " to server"
188 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
189 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
190 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
193 #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
195 #block until there is a message on socket
196 # my $w = new IO::Select;
198 # my @wait = $w->can_read;
200 warn "reading message from server"
203 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
204 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
206 warn "returning message to client"
214 FS::SelfService - Freeside self-service API
218 # password and shell account changes
219 use FS::SelfService qw(passwd chfn chsh);
221 # "my account" functionality
222 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
224 #new-style login with an email address and password
225 # can also be used for svc_acct login, set $emailaddress to username@domain
226 my $rv = login ( { 'email' => $emailaddress,
227 'password' => $password,
230 if ( $rv->{'error'} ) {
231 #handle login error...
234 $session_id = $rv->{'session_id'};
237 #classic svc_acct-based login with separate username and password
238 my $rv = login( { 'username' => $username,
240 'password' => $password,
243 if ( $rv->{'error'} ) {
244 #handle login error...
247 $session_id = $rv->{'session_id'};
250 #svc_phone login with phone number and PIN
251 my $rv = login( { 'username' => $phone_number,
252 'domain' => 'svc_phone',
256 if ( $rv->{'error'} ) {
257 #handle login error...
260 $session_id = $rv->{'session_id'};
263 my $customer_info = customer_info( { 'session_id' => $session_id } );
265 #payment_info and process_payment are available in 1.5+ only
266 my $payment_info = payment_info( { 'session_id' => $session_id } );
268 #!!! process_payment example
270 #!!! list_pkgs example
272 #!!! order_pkg example
274 #quoting a package, then ordering after confirmation
276 my $rv = quotation_new({ 'session_id' => $session_id });
277 my $qnum = $rv->{quotationnum};
278 # add packages to the quotation
279 $rv = quotation_add_pkg({ 'session_id' => $session_id,
280 'quotationnum' => $qnum,
281 'pkgpart' => $pkgpart,
282 'quantity' => $quantity, # defaults to 1
284 # repeat until all packages are added
285 # view the pricing information
286 $rv = quotation_info({ 'session_id' => $session_id,
287 'quotationnum' => $qnum,
289 print "Total setup charges: ".$rv->{total_setup}."\n".
290 "Total recurring charges: ".$rv->{total_recur}."\n";
291 # quotation_info also provides a detailed breakdown of charges, in
294 # ask customer for confirmation, then:
295 $rv = quotation_order({ 'session_id' => $session_id,
296 'quotationnum' => $qnum,
299 #!!! cancel_pkg example
301 # signup functionality
302 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
304 my $signup_info = signup_info;
306 $rv = new_customer( {
309 'company' => $company,
310 'address1' => $address1,
311 'address2' => $address2,
315 'country' => $country,
316 'daytime' => $daytime,
320 'payinfo' => $payinfo,
322 'paystart_month' => $paystart_month
323 'paystart_year' => $paystart_year,
324 'payissue' => $payissue,
326 'paydate' => $paydate,
327 'payname' => $payname,
328 'invoicing_list' => $invoicing_list,
329 'referral_custnum' => $referral_custnum,
330 'agentnum' => $agentnum,
331 'pkgpart' => $pkgpart,
333 'username' => $username,
334 '_password' => $password,
338 'phonenum' => $phonenum,
343 my $error = $rv->{'error'};
344 if ( $error eq '_decline' ) {
354 Use this API to implement your own client "self-service" module.
356 If you just want to customize the look of the existing "self-service" module,
359 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
365 Changes the password for an existing user in svc_acct. Takes a hash
366 reference with the following keys:
372 Username of the account (required)
376 Domain of the account (required)
380 Old password (required)
384 New password (required)
402 =head1 "MY ACCOUNT" FUNCTIONS
408 Creates a user session. Takes a hash reference as parameter with the
415 Email address (username@domain), instead of username and domain. Required for
416 contact-based self-service login, can also be used for svc_acct-based login.
432 Returns a hash reference with the following keys:
438 Empty on success, or an error message on errors.
442 Session identifier for successful logins
446 =item customer_info HASHREF
448 Returns general customer information.
450 Takes a hash reference as parameter with a single key: B<session_id>
452 Returns a hash reference with the following keys:
466 Array reference of hash references of open inoices. Each hash reference has
467 the following keys: invnum, date, owed
471 An HTML fragment containing shipping and billing addresses.
473 =item The following fields are also returned
475 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
479 =item edit_info HASHREF
481 Takes a hash reference as parameter with any of the following keys:
483 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
485 If a field exists, the customer record is updated with the new value of that
486 field. If a field does not exist, that field is not changed on the customer
489 Returns a hash reference with a single key, B<error>, empty on success, or an
490 error message on errors
492 =item invoice HASHREF
494 Returns an invoice. Takes a hash reference as parameter with two keys:
495 session_id and invnum
497 Returns a hash reference with the following keys:
503 Empty on success, or an error message on errors
515 =item list_invoices HASHREF
517 Returns a list of all customer invoices. Takes a hash reference with a single
520 Returns a hash reference with the following keys:
526 Empty on success, or an error message on errors
530 Reference to array of hash references with the following keys:
540 Invoice date, in UNIX epoch time
548 Cancels this customer.
550 Takes a hash reference as parameter with a single key: B<session_id>
552 Returns a hash reference with a single key, B<error>, which is empty on
553 success or an error message on errors.
555 =item payment_info HASHREF
557 Returns information that may be useful in displaying a payment page.
559 Takes a hash reference as parameter with a single key: B<session_id>.
561 Returns a hash reference with the following keys:
567 Empty on success, or an error message on errors
575 Exact name on credit card (CARD/DCRD)
599 Customer's current default payment type.
603 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
607 For CARD/DCRD payment types, the card number
611 For CARD/DCRD payment types, expiration month
615 For CARD/DCRD payment types, expiration year
617 =item cust_main_county
619 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.
623 Array reference of all states in the current default country.
627 Hash reference of card types; keys are card types, values are the exact strings
628 passed to the process_payment function
632 #this doesn't actually work yet
636 #Unique transaction identifier (prevents multiple charges), passed to the
637 #process_payment function
641 =item process_payment HASHREF
643 Processes a payment and possible change of address or payment type. Takes a
644 hash reference as parameter with the following keys:
658 If true, address and card information entered will be saved for subsequent
663 If true, future credit card payments will be done automatically (sets payby to
664 CARD). If false, future credit card payments will be done on-demand (sets
665 payby to DCRD). This option only has meaning if B<save> is set true.
693 Two-letter country code
701 Card expiration month
709 #this doesn't actually work yet
713 #Unique transaction identifier, returned from the payment_info function.
714 #Prevents multiple charges.
718 Returns a hash reference with a single key, B<error>, empty on success, or an
719 error message on errors.
721 =item process_payment_order_pkg
723 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
724 payment processes sucessfully, the package is ordered. Takes a hash reference
725 as parameter with the keys of both methods.
727 Returns a hash reference with a single key, B<error>, empty on success, or an
728 error message on errors.
730 =item process_payment_change_pkg
732 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
733 payment processes sucessfully, the package is ordered. Takes a hash reference
734 as parameter with the keys of both methods.
736 Returns a hash reference with a single key, B<error>, empty on success, or an
737 error message on errors.
740 =item process_payment_order_renew
742 Combines the B<process_payment> and B<order_renew> functions in one step. If
743 the payment processes sucessfully, the renewal is processed. Takes a hash
744 reference as parameter with the keys of both methods.
746 Returns a hash reference with a single key, B<error>, empty on success, or an
747 error message on errors.
751 Returns package information for this customer. For more detail on services,
754 Takes a hash reference as parameter with a single key: B<session_id>
756 Returns a hash reference containing customer package information. The hash reference contains the following keys:
766 Empty on success, or an error message on errors.
768 =item cust_pkg HASHREF
770 Array reference of hash references, each of which has the fields of a cust_pkg
771 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
772 the internal FS:: objects, but hash references of columns and values.
776 =item part_pkg fields
778 All fields of part_pkg for this specific cust_pkg (be careful with this
779 information - it may reveal more about your available packages than you would
780 like users to know in aggregate)
784 #XXX pare part_pkg fields down to a more secure subset
788 An array of hash references indicating information on unprovisioned services
789 available for provisioning for this specific cust_pkg. Each has the following
794 =item part_svc fields
796 All fields of part_svc (be careful with this information - it may reveal more
797 about your available packages than you would like users to know in aggregate)
801 #XXX pare part_svc fields down to a more secure subset
807 An array of hash references indicating information on the customer services
808 already provisioned for this specific cust_pkg. Each has the following keys:
814 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.
820 Primary key for this service
824 Service definition (see L<FS::part_svc>)
828 Customer package (see L<FS::cust_pkg>)
832 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
840 Returns service information for this customer.
842 Takes a hash reference as parameter with a single key: B<session_id>
844 Returns a hash reference containing customer package information. The hash reference contains the following keys:
854 An array of hash references indicating information on all of this customer's
855 services. Each has the following keys:
861 Primary key for this service
869 Meaningful user-specific identifier for the service (i.e. username, domain, or
874 Account (svc_acct) services also have the following keys:
892 Upload bytes remaining
896 Download bytes remaining
900 Total bytes remaining
902 =item recharge_amount
906 =item recharge_seconds
908 Number of seconds gained by recharge
910 =item recharge_upbytes
912 Number of upload bytes gained by recharge
914 =item recharge_downbytes
916 Number of download bytes gained by recharge
918 =item recharge_totalbytes
920 Number of total bytes gained by recharge
928 Orders a package for this customer.
930 Takes a hash reference as parameter with the following keys:
940 Package to order (see L<FS::part_pkg>).
944 Quantity for this package order (default 1).
948 Optional locationnum for this package order, for existing locations.
950 Or, for new locations, pass the following fields: address1*, address2, city*,
951 county, state*, zip*, country. (* = required in this case)
963 Service to order (see L<FS::part_svc>).
965 Normally optional; required only to provision a non-svc_acct service, or if the
966 package definition does not contain one svc_acct service definition with
967 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
968 also be specified to indicate that no initial service should be provisioned.
972 Fields used when provisioning an svc_acct service:
986 Optional security phrase
990 Optional Access number number
994 Fields used when provisioning an svc_domain service:
1004 Fields used when provisioning an svc_phone service:
1022 Fields used when provisioning an svc_external service:
1028 External numeric ID.
1032 External text title.
1036 Fields used when provisioning an svc_pbx service:
1050 Returns a hash reference with a single key, B<error>, empty on success, or an
1051 error message on errors. The special error '_decline' is returned for
1052 declined transactions.
1056 Changes a package for this customer.
1058 Takes a hash reference as parameter with the following keys:
1068 Existing customer package.
1072 New package to order (see L<FS::part_pkg>).
1076 Quantity for this package order (default 1).
1080 Returns a hash reference with the following keys:
1086 Empty on success, or an error message on errors.
1090 On success, the new pkgnum
1097 Provides useful info for early renewals.
1099 Takes a hash reference as parameter with the following keys:
1109 Returns a hash reference. On errors, it contains a single key, B<error>, with
1110 the error message. Otherwise, contains a single key, B<dates>, pointing to
1111 an array refernce of hash references. Each hash reference contains the
1118 (Future) Bill date. Indicates a future date for which billing could be run.
1119 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1122 =item bill_date_pretty
1124 (Future) Bill date as a human-readable string. (Convenience for display;
1125 subject to change, so best not to parse for the date.)
1129 Base amount which will be charged if renewed early as of this date.
1133 Renewal date; i.e. even-futher future date at which the customer will be paid
1134 through if the early renewal is completed with the given B<bill-date>.
1135 Specified as a integer UNIX timestamp.
1137 =item renew_date_pretty
1139 Renewal date as a human-readable string. (Convenience for display;
1140 subject to change, so best not to parse for the date.)
1144 Package that will be renewed.
1148 Expiration date of the package that will be renewed.
1150 =item expire_date_pretty
1152 Expiration date of the package that will be renewed, as a human-readable
1153 string. (Convenience for display; subject to change, so best not to parse for
1160 Renews this customer early; i.e. runs billing for this customer in advance.
1162 Takes a hash reference as parameter with the following keys:
1172 Integer date as returned by the B<renew_info> function, indicating the advance
1173 date for which to run billing.
1177 Returns a hash reference with a single key, B<error>, empty on success, or an
1178 error message on errors.
1182 Cancels a package for this customer.
1184 Takes a hash reference as parameter with the following keys:
1194 pkgpart of package to cancel
1198 Returns a hash reference with a single key, B<error>, empty on success, or an
1199 error message on errors.
1201 =item provision_acct
1203 Provisions an account (svc_acct).
1205 Takes a hash reference as parameter with the following keys:
1215 pkgnum of package into which this service is provisioned
1219 svcpart or service definition to provision
1229 =item provision_phone
1231 Provisions a phone number (svc_phone).
1233 Takes a hash reference as parameter with the following keys:
1243 pkgnum of package into which this service is provisioned
1247 svcpart or service definition to provision
1267 E911 Address (optional)
1273 Provisions a customer PBX (svc_pbx).
1275 Takes a hash reference as parameter with the following keys:
1285 pkgnum of package into which this service is provisioned
1289 svcpart or service definition to provision
1295 =item max_extensions
1297 =item max_simultaneous
1303 =item provision_external
1305 Provisions an external service (svc_external).
1307 Takes a hash reference as parameter with the following keys:
1317 pkgnum of package into which this service is provisioned
1321 svcpart or service definition to provision
1331 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1335 =item contact_passwd
1337 Changes the password for the currently-logged in contact.
1339 Takes a hash reference as parameter with the following keys:
1349 Returns a hash reference with a single parameter, B<error>, which contains an
1350 error message, or empty on success.
1356 Updates information for the currently-logged in contact, or (optionally) the
1359 Takes a hash reference as parameter with the following keys:
1367 If already logged in as a contact, this is optional.
1377 Returns a hash reference with a single parameter, B<error>, which contains an
1378 error message, or empty on success.
1382 Creates a new contact.
1384 Takes a hash reference as parameter with the following keys:
1398 Optional contact classnum (TODO: or name)
1402 =item selfservice_access
1404 Y to enable self-service access
1410 Returns a hash reference with a single parameter, B<error>, which contains an
1411 error message, or empty on success.
1413 =item delete_contact
1415 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1418 Takes a hash reference as parameter with the following keys:
1428 Returns a hash reference with a single parameter, B<error>, which contains an
1429 error message, or empty on success.
1431 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1433 All of these functions require the user to be logged in, and the 'session_id'
1434 key to be included in the argument hashref.`
1438 =item list_quotations HASHREF
1440 Returns a hashref listing this customer's active self-service quotations.
1447 an arrayref containing an element for each quotation.
1455 the date it was started
1459 the number of packages
1463 the sum of setup fees
1467 the sum of recurring charges
1471 =item quotation_new HASHREF
1473 Creates an empty quotation and returns a hashref containing 'quotationnum',
1474 the primary key of the new quotation.
1476 =item quotation_delete HASHREF
1478 Disables (does not really delete) a quotation. Takes the following arguments:
1484 =item quotationnum - the quotation to delete
1488 Returns 'error' => a string, which will be empty on success.
1490 =item quotation_info HASHREF
1492 Returns total and detailed pricing information on a quotation.
1494 Takes the following arguments:
1500 =item quotationnum - the quotation to return
1504 Returns a hashref containing:
1506 - total_setup, the total of setup fees (and their taxes)
1507 - total_recur, the total of all recurring charges (and their taxes)
1508 - sections, an arrayref containing an element for each quotation section.
1509 - description, a line of text describing the group of charges
1510 - subtotal, the total of charges in this group (if appropriate)
1511 - detail_items, an arrayref of line items
1512 - pkgnum, the reference number of the package
1513 - description, the package name (or tax name)
1515 - amount, the amount charged
1516 If the detail item represents a subtotal, it will instead contain:
1517 - total_item: description of the subtotal
1518 - total_amount: the subtotal amount
1521 =item quotation_print HASHREF
1523 Renders the quotation as HTML or PDF. Takes the following arguments:
1529 =item quotationnum - the quotation to return
1531 =item format - 'html' or 'pdf'
1535 Returns a hashref containing 'document', the contents of the file.
1537 =item quotation_add_pkg HASHREF
1539 Adds a package to a quotation. Takes the following arguments:
1545 =item pkgpart - the package to add
1547 =item quotationnum - the quotation to add it to
1549 =item quantity - the package quantity (defaults to 1)
1551 =item address1, address2, city, state, zip, country - address fields to set
1552 the service location
1556 Returns 'error' => a string, which will be empty on success.
1558 =item quotation_remove_pkg HASHREF
1560 Removes a package from a quotation. Takes the following arguments:
1566 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1568 =item quotationnum - the quotation to remove it from
1572 Returns 'error' => a string, which will be empty on success.
1576 =item quotation_order HASHREF
1578 Converts the packages in a quotation into real packages. Takes the following
1581 Takes the following arguments:
1587 =item quotationnum - the quotation to order
1593 =head1 SIGNUP FUNCTIONS
1597 =item signup_info HASHREF
1599 Takes a hash reference as parameter with the following keys:
1603 =item session_id - Optional agent/reseller interface session
1607 Returns a hash reference containing information that may be useful in
1608 displaying a signup page. The hash reference contains the following keys:
1612 =item cust_main_county
1614 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.
1618 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
1619 an agentnum specified explicitly via reseller interface session_id in the
1624 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.
1626 =item agentnum2part_pkg
1628 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.
1632 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.
1634 =item security_phrase
1636 True if the "security_phrase" feature is enabled
1640 Array reference of acceptable payment types for signup
1646 credit card - automatic
1650 credit card - on-demand - version 1.5+ only
1654 electronic check - automatic
1658 electronic check - on-demand - version 1.5+ only
1666 billing, not recommended for signups
1670 free, definitely not recommended for signups
1674 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1680 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1684 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".
1690 =item countrydefault
1696 =item new_customer_minimal HASHREF
1698 Creates a new customer.
1700 Current differences from new_customer: An address is not required. promo_code
1701 and reg_code are not supported. If invoicing_list and _password is passed, a
1702 contact will be created with self-service access (no pkgpart or username is
1703 necessary). No initial billing is run (this may change in a future version).
1705 Takes a hash reference as parameter with the following keys:
1711 first name (required)
1715 last name (required)
1719 (not typically collected; mostly used for ACH transactions)
1751 Daytime phone number
1755 Evening phone number
1763 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1767 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1771 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1775 Expiration date for CARD/DCRD
1779 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1781 =item invoicing_list
1783 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),
1785 =item referral_custnum
1787 referring customer number
1795 pkgpart of initial package
1811 Access number (index, not the literal number)
1815 Country code (to be provisioned as a service)
1819 Phone number (to be provisioned as a service)
1827 Returns a hash reference with the following keys:
1833 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)
1837 =item new_customer HASHREF
1839 Creates a new customer. Takes a hash reference as parameter with the
1846 first name (required)
1850 last name (required)
1854 (not typically collected; mostly used for ACH transactions)
1860 =item address1 (required)
1868 =item city (required)
1876 =item state (required)
1880 =item zip (required)
1886 Daytime phone number
1890 Evening phone number
1898 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1902 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1906 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1910 Expiration date for CARD/DCRD
1914 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1916 =item invoicing_list
1918 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),
1920 =item referral_custnum
1922 referring customer number
1930 pkgpart of initial package
1946 Access number (index, not the literal number)
1950 Country code (to be provisioned as a service)
1954 Phone number (to be provisioned as a service)
1962 Returns a hash reference with the following keys:
1968 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)
1972 =item regionselector HASHREF | LIST
1974 Takes as input a hashref or list of key/value pairs with the following keys:
1978 =item selected_county
1980 Currently selected county
1982 =item selected_state
1984 Currently selected state
1986 =item selected_country
1988 Currently selected country
1992 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1996 Specify a javascript subroutine to call on changes
2002 =item default_country
2008 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>.
2012 Returns a list consisting of three HTML fragments for county selection,
2013 state selection and country selection, respectively.
2017 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2018 sub regionselector {
2025 $param->{'selected_country'} ||= $param->{'default_country'};
2026 $param->{'selected_state'} ||= $param->{'default_state'};
2028 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2032 my %cust_main_county;
2034 # unless ( @cust_main_county ) { #cache
2035 #@cust_main_county = qsearch('cust_main_county', {} );
2036 #foreach my $c ( @cust_main_county ) {
2037 foreach my $c ( @{ $param->{'locales'} } ) {
2038 #$countyflag=1 if $c->county;
2039 $countyflag=1 if $c->{county};
2040 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2041 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2042 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2045 $countyflag=1 if $param->{selected_county};
2047 my $script_html = <<END;
2049 function opt(what,value,text) {
2050 var optionName = new Option(text, value, false, false);
2051 var length = what.length;
2052 what.options[length] = optionName;
2054 function ${prefix}country_changed(what) {
2055 country = what.options[what.selectedIndex].text;
2056 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2057 what.form.${prefix}state.options[i] = null;
2059 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2061 foreach my $country ( sort keys %cust_main_county ) {
2062 $script_html .= "\nif ( country == \"$country\" ) {\n";
2063 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2064 my $text = $state || '(n/a)';
2065 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2067 $script_html .= "}\n";
2070 $script_html .= <<END;
2072 function ${prefix}state_changed(what) {
2075 if ( $countyflag ) {
2076 $script_html .= <<END;
2077 state = what.options[what.selectedIndex].text;
2078 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2079 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2080 what.form.${prefix}county.options[i] = null;
2083 foreach my $country ( sort keys %cust_main_county ) {
2084 $script_html .= "\nif ( country == \"$country\" ) {\n";
2085 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2086 $script_html .= "\nif ( state == \"$state\" ) {\n";
2087 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2088 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2089 my $text = $county || '(n/a)';
2091 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2093 $script_html .= "}\n";
2095 $script_html .= "}\n";
2099 $script_html .= <<END;
2104 my $county_html = $script_html;
2105 if ( $countyflag ) {
2106 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2107 foreach my $county (
2108 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2110 my $text = $county || '(n/a)';
2111 $county_html .= qq!<OPTION VALUE="$county"!.
2112 ($county eq $param->{'selected_county'} ?
2119 $county_html .= '</SELECT>';
2122 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2125 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2126 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2127 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2128 my $text = $state || '(n/a)';
2129 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2130 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
2132 $state_html .= '</SELECT>';
2134 my $country_html = '';
2135 if ( scalar( keys %cust_main_county ) > 1 ) {
2137 $country_html = qq(<SELECT NAME="${prefix}country" ).
2138 qq(onChange="${prefix}country_changed(this); ).
2139 $param->{'onchange'}.
2142 my $countrydefault = $param->{default_country} || 'US';
2143 foreach my $country (
2144 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2145 keys %cust_main_county
2147 my $selected = $country eq $param->{'selected_country'}
2150 $country_html .= "\n<OPTION$selected>$country</OPTION>"
2152 $country_html .= '</SELECT>';
2155 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2156 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2160 ($county_html, $state_html, $country_html);
2164 sub regionselector_hashref {
2165 my ($county_html, $state_html, $country_html) = regionselector(@_);
2167 'county_html' => $county_html,
2168 'state_html' => $state_html,
2169 'country_html' => $country_html,
2173 =item location_form HASHREF | LIST
2175 Takes as input a hashref or list of key/value pairs with the following keys:
2181 Current customer session_id
2185 Omit red asterisks from required fields.
2187 =item address1_label
2189 Label for first address line.
2193 Returns an HTML fragment for a location form (address, city, state, zip,
2206 my $session_id = delete $param->{'session_id'};
2208 my $rv = mason_comp( 'session_id' => $session_id,
2209 'comp' => '/elements/location.html',
2210 'args' => [ %$param ],
2214 $rv->{'error'} || $rv->{'output'};
2219 #=item expselect HASHREF | LIST
2221 #Takes as input a hashref or list of key/value pairs with the following keys:
2225 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2227 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2231 =item expselect PREFIX [ DATE ]
2233 Takes as input a unique prefix string and the current expiration date, in
2234 yyyy-mm-dd or m-d-yyyy format
2236 Returns an HTML fragments for expiration date selection.
2242 #if ( ref($_[0]) ) {
2246 #my $prefix = $param->{'prefix'};
2247 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2248 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2250 my $date = scalar(@_) ? shift : '';
2252 my( $m, $y ) = ( 0, 0 );
2253 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2254 ( $m, $y ) = ( $2, $1 );
2255 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2256 ( $m, $y ) = ( $1, $3 );
2258 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2260 $return .= qq!<OPTION VALUE="$_"!;
2261 $return .= " SELECTED" if $_ == $m;
2264 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2266 my $thisYear = $t[5] + 1900;
2267 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2268 $return .= qq!<OPTION VALUE="$_"!;
2269 $return .= " SELECTED" if $_ == $y;
2272 $return .= "</SELECT>";
2277 =item popselector HASHREF | LIST
2279 Takes as input a hashref or list of key/value pairs with the following keys:
2285 Access number number
2289 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>.
2293 Returns an HTML fragment for access number selection.
2297 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2305 my $popnum = $param->{'popnum'};
2306 my $pops = $param->{'pops'};
2308 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2309 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2310 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2311 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2312 if scalar(@$pops) == 1;
2315 my %popnum2pop = ();
2317 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2318 $popnum2pop{$_->{popnum}} = $_;
2323 function opt(what,href,text) {
2324 var optionName = new Option(text, href, false, false)
2325 var length = what.length;
2326 what.options[length] = optionName;
2330 my $init_popstate = $param->{'init_popstate'};
2331 if ( $init_popstate ) {
2332 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2333 $init_popstate. '">';
2336 function acstate_changed(what) {
2337 state = what.options[what.selectedIndex].text;
2338 what.form.popac.options.length = 0
2339 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2343 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2344 foreach my $state ( sort { $a cmp $b } @states ) {
2345 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2347 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2348 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2349 if ($ac eq $param->{'popac'}) {
2350 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2353 $text .= "}\n" unless $init_popstate;
2355 $text .= "popac_changed(what.form.popac)}\n";
2358 function popac_changed(what) {
2359 ac = what.options[what.selectedIndex].text;
2360 what.form.popnum.options.length = 0;
2361 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2365 foreach my $state ( @states ) {
2366 foreach my $popac ( keys %{ $pop{$state} } ) {
2367 $text .= "\nif ( ac == \"$popac\" ) {\n";
2369 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2370 my $o_popnum = $pop->{popnum};
2371 my $poptext = $pop->{city}. ', '. $pop->{state}.
2372 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2374 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2375 if ($popnum == $o_popnum) {
2376 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2384 $text .= "}\n</SCRIPT>\n";
2386 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2389 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2390 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2391 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2392 ">$_" foreach sort { $a cmp $b } @states;
2393 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2396 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2397 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2399 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2402 #comment this block to disable initial list polulation
2403 my @initial_select = ();
2404 if ( scalar( @$pops ) > 100 ) {
2405 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2407 @initial_select = @$pops;
2409 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2410 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2411 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2412 $pop->{city}. ', '. $pop->{state}.
2413 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2416 $text .= qq!</SELECT></TD></TR></TABLE>!;
2422 =item domainselector HASHREF | LIST
2424 Takes as input a hashref or list of key/value pairs with the following keys:
2434 Service number of the selected item.
2438 Returns an HTML fragment for domain selection.
2442 sub domainselector {
2449 my $domsvc= $param->{'domsvc'};
2451 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2452 my $domains = $rv->{'domains'};
2453 $domsvc = $rv->{'domsvc'} unless $domsvc;
2455 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2456 unless scalar(keys %$domains);
2458 if (scalar(keys %$domains) == 1) {
2460 foreach(keys %$domains) {
2463 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2464 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2467 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2469 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2471 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2472 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2473 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2474 $domains->{$domain};
2477 $text .= qq!</SELECT></TD></TR>!;
2483 =item didselector HASHREF | LIST
2485 Takes as input a hashref or list of key/value pairs with the following keys:
2491 Field name for the returned HTML fragment.
2495 Service definition (see L<FS::part_svc>)
2499 Returns an HTML fragment for DID selection.
2511 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2512 'args'=>[ %$param ],
2516 $rv->{'error'} || $rv->{'output'};
2522 =head1 RESELLER FUNCTIONS
2524 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2525 with their active session, and the B<customer_info> and B<order_pkg> functions
2526 with their active session and an additional I<custnum> parameter.
2528 For the most part, development of the reseller web interface has been
2529 superceded by agent-virtualized access to the backend.
2541 =item agent_list_customers
2543 List agent's customers.
2551 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>