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',
37 'contact_passwd' => 'MyAccount/contact/contact_passwd',
38 'list_contacts' => 'MyAccount/contact/list_contacts',
39 'edit_contact' => 'MyAccount/contact/edit_contact',
40 'delete_contact' => 'MyAccount/contact/delete_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 #ordering a package with an svc_acct service
273 my $rv = order_pkg( { 'session_id' => $session_id,
274 'pkgpart' => $pkgpart,
275 'svcpart' => $svcpart,
276 'username' => $username,
277 'domsvc' => $domsvc, #svcnum of svc_domain
278 '_password' => $password,
282 #!!! ordering a package with an svc_domain service example
284 #!!! ordering a package with an svc_phone service example
286 #!!! ordering a package with an svc_external service example
288 #!!! ordering a package with an svc_pbx service
290 #ordering a package with no service
291 my $rv = order_pkg( { 'session_id' => $session_id,
292 'pkgpart' => $pkgpart,
297 #quoting a package, then ordering after confirmation
299 my $rv = quotation_new({ 'session_id' => $session_id });
300 my $qnum = $rv->{quotationnum};
301 # add packages to the quotation
302 $rv = quotation_add_pkg({ 'session_id' => $session_id,
303 'quotationnum' => $qnum,
304 'pkgpart' => $pkgpart,
305 'quantity' => $quantity, # defaults to 1
307 # repeat until all packages are added
308 # view the pricing information
309 $rv = quotation_info({ 'session_id' => $session_id,
310 'quotationnum' => $qnum,
312 print "Total setup charges: ".$rv->{total_setup}."\n".
313 "Total recurring charges: ".$rv->{total_recur}."\n";
314 # quotation_info also provides a detailed breakdown of charges, in
317 # ask customer for confirmation, then:
318 $rv = quotation_order({ 'session_id' => $session_id,
319 'quotationnum' => $qnum,
322 #!!! cancel_pkg example
324 # signup functionality
325 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
327 my $signup_info = signup_info;
329 $rv = new_customer( {
332 'company' => $company,
333 'address1' => $address1,
334 'address2' => $address2,
338 'country' => $country,
339 'daytime' => $daytime,
343 'payinfo' => $payinfo,
345 'paystart_month' => $paystart_month
346 'paystart_year' => $paystart_year,
347 'payissue' => $payissue,
349 'paydate' => $paydate,
350 'payname' => $payname,
351 'invoicing_list' => $invoicing_list,
352 'referral_custnum' => $referral_custnum,
353 'agentnum' => $agentnum,
354 'pkgpart' => $pkgpart,
356 'username' => $username,
357 '_password' => $password,
361 'phonenum' => $phonenum,
366 my $error = $rv->{'error'};
367 if ( $error eq '_decline' ) {
377 Use this API to implement your own client "self-service" module.
379 If you just want to customize the look of the existing "self-service" module,
382 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
388 Changes the password for an existing user in svc_acct. Takes a hash
389 reference with the following keys:
395 Username of the account (required)
399 Domain of the account (required)
403 Old password (required)
407 New password (required)
425 =head1 "MY ACCOUNT" FUNCTIONS
431 Creates a user session. Takes a hash reference as parameter with the
438 Email address (username@domain), instead of username and domain. Required for
439 contact-based self-service login, can also be used for svc_acct-based login.
455 Returns a hash reference with the following keys:
461 Empty on success, or an error message on errors.
465 Session identifier for successful logins
469 =item customer_info HASHREF
471 Returns general customer information.
473 Takes a hash reference as parameter with a single key: B<session_id>
475 Returns a hash reference with the following keys:
489 Array reference of hash references of open inoices. Each hash reference has
490 the following keys: invnum, date, owed
494 An HTML fragment containing shipping and billing addresses.
496 =item The following fields are also returned
498 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
502 =item edit_info HASHREF
504 Takes a hash reference as parameter with any of the following keys:
506 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
508 If a field exists, the customer record is updated with the new value of that
509 field. If a field does not exist, that field is not changed on the customer
512 Returns a hash reference with a single key, B<error>, empty on success, or an
513 error message on errors
515 =item invoice HASHREF
517 Returns an invoice. Takes a hash reference as parameter with two keys:
518 session_id and invnum
520 Returns a hash reference with the following keys:
526 Empty on success, or an error message on errors
538 =item list_invoices HASHREF
540 Returns a list of all customer invoices. Takes a hash reference with a single
543 Returns a hash reference with the following keys:
549 Empty on success, or an error message on errors
553 Reference to array of hash references with the following keys:
563 Invoice date, in UNIX epoch time
571 Cancels this customer.
573 Takes a hash reference as parameter with a single key: B<session_id>
575 Returns a hash reference with a single key, B<error>, which is empty on
576 success or an error message on errors.
578 =item payment_info HASHREF
580 Returns information that may be useful in displaying a payment page.
582 Takes a hash reference as parameter with a single key: B<session_id>.
584 Returns a hash reference with the following keys:
590 Empty on success, or an error message on errors
598 Exact name on credit card (CARD/DCRD)
622 Customer's current default payment type.
626 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
630 For CARD/DCRD payment types, the card number
634 For CARD/DCRD payment types, expiration month
638 For CARD/DCRD payment types, expiration year
640 =item cust_main_county
642 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.
646 Array reference of all states in the current default country.
650 Hash reference of card types; keys are card types, values are the exact strings
651 passed to the process_payment function
655 #this doesn't actually work yet
659 #Unique transaction identifier (prevents multiple charges), passed to the
660 #process_payment function
664 =item process_payment HASHREF
666 Processes a payment and possible change of address or payment type. Takes a
667 hash reference as parameter with the following keys:
681 If true, address and card information entered will be saved for subsequent
686 If true, future credit card payments will be done automatically (sets payby to
687 CARD). If false, future credit card payments will be done on-demand (sets
688 payby to DCRD). This option only has meaning if B<save> is set true.
716 Two-letter country code
724 Card expiration month
732 #this doesn't actually work yet
736 #Unique transaction identifier, returned from the payment_info function.
737 #Prevents multiple charges.
741 Returns a hash reference with a single key, B<error>, empty on success, or an
742 error message on errors.
744 =item process_payment_order_pkg
746 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
747 payment processes sucessfully, the package is ordered. Takes a hash reference
748 as parameter with the keys of both methods.
750 Returns a hash reference with a single key, B<error>, empty on success, or an
751 error message on errors.
753 =item process_payment_change_pkg
755 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
756 payment processes sucessfully, the package is ordered. Takes a hash reference
757 as parameter with the keys of both methods.
759 Returns a hash reference with a single key, B<error>, empty on success, or an
760 error message on errors.
763 =item process_payment_order_renew
765 Combines the B<process_payment> and B<order_renew> functions in one step. If
766 the payment processes sucessfully, the renewal is processed. Takes a hash
767 reference as parameter with the keys of both methods.
769 Returns a hash reference with a single key, B<error>, empty on success, or an
770 error message on errors.
774 Returns package information for this customer. For more detail on services,
777 Takes a hash reference as parameter with a single key: B<session_id>
779 Returns a hash reference containing customer package information. The hash reference contains the following keys:
789 Empty on success, or an error message on errors.
791 =item cust_pkg HASHREF
793 Array reference of hash references, each of which has the fields of a cust_pkg
794 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
795 the internal FS:: objects, but hash references of columns and values.
799 =item part_pkg fields
801 All fields of part_pkg for this specific cust_pkg (be careful with this
802 information - it may reveal more about your available packages than you would
803 like users to know in aggregate)
807 #XXX pare part_pkg fields down to a more secure subset
811 An array of hash references indicating information on unprovisioned services
812 available for provisioning for this specific cust_pkg. Each has the following
817 =item part_svc fields
819 All fields of part_svc (be careful with this information - it may reveal more
820 about your available packages than you would like users to know in aggregate)
824 #XXX pare part_svc fields down to a more secure subset
830 An array of hash references indicating information on the customer services
831 already provisioned for this specific cust_pkg. Each has the following keys:
837 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.
843 Primary key for this service
847 Service definition (see L<FS::part_svc>)
851 Customer package (see L<FS::cust_pkg>)
855 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
863 Returns service information for this customer.
865 Takes a hash reference as parameter with a single key: B<session_id>
867 Returns a hash reference containing customer package information. The hash reference contains the following keys:
877 An array of hash references indicating information on all of this customer's
878 services. Each has the following keys:
884 Primary key for this service
892 Meaningful user-specific identifier for the service (i.e. username, domain, or
897 Account (svc_acct) services also have the following keys:
915 Upload bytes remaining
919 Download bytes remaining
923 Total bytes remaining
925 =item recharge_amount
929 =item recharge_seconds
931 Number of seconds gained by recharge
933 =item recharge_upbytes
935 Number of upload bytes gained by recharge
937 =item recharge_downbytes
939 Number of download bytes gained by recharge
941 =item recharge_totalbytes
943 Number of total bytes gained by recharge
951 Orders a package for this customer.
953 Takes a hash reference as parameter with the following keys:
963 Package to order (see L<FS::part_pkg>).
967 Quantity for this package order (default 1).
971 Optional locationnum for this package order, for existing locations.
973 Or, for new locations, pass the following fields: address1*, address2, city*,
974 county, state*, zip*, country. (* = required in this case)
986 Service to order (see L<FS::part_svc>).
988 Normally optional; required only to provision a non-svc_acct service, or if the
989 package definition does not contain one svc_acct service definition with
990 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
991 also be specified to indicate that no initial service should be provisioned.
995 Fields used when provisioning an svc_acct service:
1009 Optional security phrase
1013 Optional Access number number
1017 Fields used when provisioning an svc_domain service:
1027 Fields used when provisioning an svc_phone service:
1045 Fields used when provisioning an svc_external service:
1051 External numeric ID.
1055 External text title.
1059 Fields used when provisioning an svc_pbx service:
1073 Returns a hash reference with a single key, B<error>, empty on success, or an
1074 error message on errors. The special error '_decline' is returned for
1075 declined transactions.
1079 Changes a package for this customer.
1081 Takes a hash reference as parameter with the following keys:
1091 Existing customer package.
1095 New package to order (see L<FS::part_pkg>).
1099 Quantity for this package order (default 1).
1103 Returns a hash reference with the following keys:
1109 Empty on success, or an error message on errors.
1113 On success, the new pkgnum
1120 Provides useful info for early renewals.
1122 Takes a hash reference as parameter with the following keys:
1132 Returns a hash reference. On errors, it contains a single key, B<error>, with
1133 the error message. Otherwise, contains a single key, B<dates>, pointing to
1134 an array refernce of hash references. Each hash reference contains the
1141 (Future) Bill date. Indicates a future date for which billing could be run.
1142 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1145 =item bill_date_pretty
1147 (Future) Bill date as a human-readable string. (Convenience for display;
1148 subject to change, so best not to parse for the date.)
1152 Base amount which will be charged if renewed early as of this date.
1156 Renewal date; i.e. even-futher future date at which the customer will be paid
1157 through if the early renewal is completed with the given B<bill-date>.
1158 Specified as a integer UNIX timestamp.
1160 =item renew_date_pretty
1162 Renewal date as a human-readable string. (Convenience for display;
1163 subject to change, so best not to parse for the date.)
1167 Package that will be renewed.
1171 Expiration date of the package that will be renewed.
1173 =item expire_date_pretty
1175 Expiration date of the package that will be renewed, as a human-readable
1176 string. (Convenience for display; subject to change, so best not to parse for
1183 Renews this customer early; i.e. runs billing for this customer in advance.
1185 Takes a hash reference as parameter with the following keys:
1195 Integer date as returned by the B<renew_info> function, indicating the advance
1196 date for which to run billing.
1200 Returns a hash reference with a single key, B<error>, empty on success, or an
1201 error message on errors.
1205 Cancels a package for this customer.
1207 Takes a hash reference as parameter with the following keys:
1217 pkgpart of package to cancel
1221 Returns a hash reference with a single key, B<error>, empty on success, or an
1222 error message on errors.
1224 =item provision_acct
1226 Provisions an account (svc_acct).
1228 Takes a hash reference as parameter with the following keys:
1238 pkgnum of package into which this service is provisioned
1242 svcpart or service definition to provision
1252 =item provision_phone
1254 Provisions a phone number (svc_phone).
1256 Takes a hash reference as parameter with the following keys:
1266 pkgnum of package into which this service is provisioned
1270 svcpart or service definition to provision
1290 E911 Address (optional)
1296 Provisions a customer PBX (svc_pbx).
1298 Takes a hash reference as parameter with the following keys:
1308 pkgnum of package into which this service is provisioned
1312 svcpart or service definition to provision
1318 =item max_extensions
1320 =item max_simultaneous
1326 =item provision_external
1328 Provisions an external service (svc_external).
1330 Takes a hash reference as parameter with the following keys:
1340 pkgnum of package into which this service is provisioned
1344 svcpart or service definition to provision
1354 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1358 =item contact_passwd
1360 Changes the password for the currently-logged in contact.
1362 Takes a hash reference as parameter with the following keys:
1372 Returns a hash reference with a single parameter, B<error>, which contains an
1373 error message, or empty on success.
1379 Updates information for the currently-logged in contact, or (optionally) the
1382 Takes a hash reference as parameter with the following keys:
1390 If already logged in as a contact, this is optional.
1400 Returns a hash reference with a single parameter, B<error>, which contains an
1401 error message, or empty on success.
1403 =item delete_contact
1405 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1408 Takes a hash reference as parameter with the following keys:
1418 Returns a hash reference with a single parameter, B<error>, which contains an
1419 error message, or empty on success.
1421 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1423 All of these functions require the user to be logged in, and the 'session_id'
1424 key to be included in the argument hashref.`
1428 =item list_quotations HASHREF
1430 Returns a hashref listing this customer's active self-service quotations.
1437 an arrayref containing an element for each quotation.
1445 the date it was started
1449 the number of packages
1453 the sum of setup fees
1457 the sum of recurring charges
1461 =item quotation_new HASHREF
1463 Creates an empty quotation and returns a hashref containing 'quotationnum',
1464 the primary key of the new quotation.
1466 =item quotation_delete HASHREF
1468 Disables (does not really delete) a quotation. Takes the following arguments:
1474 =item quotationnum - the quotation to delete
1478 Returns 'error' => a string, which will be empty on success.
1480 =item quotation_info HASHREF
1482 Returns total and detailed pricing information on a quotation.
1484 Takes the following arguments:
1490 =item quotationnum - the quotation to return
1494 Returns a hashref containing:
1496 - total_setup, the total of setup fees (and their taxes)
1497 - total_recur, the total of all recurring charges (and their taxes)
1498 - sections, an arrayref containing an element for each quotation section.
1499 - description, a line of text describing the group of charges
1500 - subtotal, the total of charges in this group (if appropriate)
1501 - detail_items, an arrayref of line items
1502 - pkgnum, the reference number of the package
1503 - description, the package name (or tax name)
1505 - amount, the amount charged
1506 If the detail item represents a subtotal, it will instead contain:
1507 - total_item: description of the subtotal
1508 - total_amount: the subtotal amount
1511 =item quotation_print HASHREF
1513 Renders the quotation as HTML or PDF. Takes the following arguments:
1519 =item quotationnum - the quotation to return
1521 =item format - 'html' or 'pdf'
1525 Returns a hashref containing 'document', the contents of the file.
1527 =item quotation_add_pkg HASHREF
1529 Adds a package to a quotation. Takes the following arguments:
1535 =item pkgpart - the package to add
1537 =item quotationnum - the quotation to add it to
1539 =item quantity - the package quantity (defaults to 1)
1541 =item address1, address2, city, state, zip, country - address fields to set
1542 the service location
1546 Returns 'error' => a string, which will be empty on success.
1548 =item quotation_remove_pkg HASHREF
1550 Removes a package from a quotation. Takes the following arguments:
1556 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1558 =item quotationnum - the quotation to remove it from
1562 Returns 'error' => a string, which will be empty on success.
1566 =item quotation_order HASHREF
1568 Converts the packages in a quotation into real packages. Takes the following
1571 Takes the following arguments:
1577 =item quotationnum - the quotation to order
1583 =head1 SIGNUP FUNCTIONS
1587 =item signup_info HASHREF
1589 Takes a hash reference as parameter with the following keys:
1593 =item session_id - Optional agent/reseller interface session
1597 Returns a hash reference containing information that may be useful in
1598 displaying a signup page. The hash reference contains the following keys:
1602 =item cust_main_county
1604 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.
1608 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
1609 an agentnum specified explicitly via reseller interface session_id in the
1614 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.
1616 =item agentnum2part_pkg
1618 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.
1622 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.
1624 =item security_phrase
1626 True if the "security_phrase" feature is enabled
1630 Array reference of acceptable payment types for signup
1636 credit card - automatic
1640 credit card - on-demand - version 1.5+ only
1644 electronic check - automatic
1648 electronic check - on-demand - version 1.5+ only
1656 billing, not recommended for signups
1660 free, definitely not recommended for signups
1664 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1670 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1674 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".
1680 =item countrydefault
1686 =item new_customer_minimal HASHREF
1688 Creates a new customer.
1690 Current differences from new_customer: An address is not required. promo_code
1691 and reg_code are not supported. If invoicing_list and _password is passed, a
1692 contact will be created with self-service access (no pkgpart or username is
1693 necessary). No initial billing is run (this may change in a future version).
1695 Takes a hash reference as parameter with the following keys:
1701 first name (required)
1705 last name (required)
1709 (not typically collected; mostly used for ACH transactions)
1741 Daytime phone number
1745 Evening phone number
1753 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1757 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1761 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1765 Expiration date for CARD/DCRD
1769 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1771 =item invoicing_list
1773 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),
1775 =item referral_custnum
1777 referring customer number
1785 pkgpart of initial package
1801 Access number (index, not the literal number)
1805 Country code (to be provisioned as a service)
1809 Phone number (to be provisioned as a service)
1817 Returns a hash reference with the following keys:
1823 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)
1827 =item new_customer HASHREF
1829 Creates a new customer. Takes a hash reference as parameter with the
1836 first name (required)
1840 last name (required)
1844 (not typically collected; mostly used for ACH transactions)
1850 =item address1 (required)
1858 =item city (required)
1866 =item state (required)
1870 =item zip (required)
1876 Daytime phone number
1880 Evening phone number
1888 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1892 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1896 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1900 Expiration date for CARD/DCRD
1904 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1906 =item invoicing_list
1908 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),
1910 =item referral_custnum
1912 referring customer number
1920 pkgpart of initial package
1936 Access number (index, not the literal number)
1940 Country code (to be provisioned as a service)
1944 Phone number (to be provisioned as a service)
1952 Returns a hash reference with the following keys:
1958 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)
1962 =item regionselector HASHREF | LIST
1964 Takes as input a hashref or list of key/value pairs with the following keys:
1968 =item selected_county
1970 Currently selected county
1972 =item selected_state
1974 Currently selected state
1976 =item selected_country
1978 Currently selected country
1982 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1986 Specify a javascript subroutine to call on changes
1992 =item default_country
1998 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>.
2002 Returns a list consisting of three HTML fragments for county selection,
2003 state selection and country selection, respectively.
2007 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2008 sub regionselector {
2015 $param->{'selected_country'} ||= $param->{'default_country'};
2016 $param->{'selected_state'} ||= $param->{'default_state'};
2018 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2022 my %cust_main_county;
2024 # unless ( @cust_main_county ) { #cache
2025 #@cust_main_county = qsearch('cust_main_county', {} );
2026 #foreach my $c ( @cust_main_county ) {
2027 foreach my $c ( @{ $param->{'locales'} } ) {
2028 #$countyflag=1 if $c->county;
2029 $countyflag=1 if $c->{county};
2030 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2031 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2032 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2035 $countyflag=1 if $param->{selected_county};
2037 my $script_html = <<END;
2039 function opt(what,value,text) {
2040 var optionName = new Option(text, value, false, false);
2041 var length = what.length;
2042 what.options[length] = optionName;
2044 function ${prefix}country_changed(what) {
2045 country = what.options[what.selectedIndex].text;
2046 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2047 what.form.${prefix}state.options[i] = null;
2049 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2051 foreach my $country ( sort keys %cust_main_county ) {
2052 $script_html .= "\nif ( country == \"$country\" ) {\n";
2053 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2054 my $text = $state || '(n/a)';
2055 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2057 $script_html .= "}\n";
2060 $script_html .= <<END;
2062 function ${prefix}state_changed(what) {
2065 if ( $countyflag ) {
2066 $script_html .= <<END;
2067 state = what.options[what.selectedIndex].text;
2068 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2069 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2070 what.form.${prefix}county.options[i] = null;
2073 foreach my $country ( sort keys %cust_main_county ) {
2074 $script_html .= "\nif ( country == \"$country\" ) {\n";
2075 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2076 $script_html .= "\nif ( state == \"$state\" ) {\n";
2077 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2078 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2079 my $text = $county || '(n/a)';
2081 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2083 $script_html .= "}\n";
2085 $script_html .= "}\n";
2089 $script_html .= <<END;
2094 my $county_html = $script_html;
2095 if ( $countyflag ) {
2096 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2097 foreach my $county (
2098 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2100 my $text = $county || '(n/a)';
2101 $county_html .= qq!<OPTION VALUE="$county"!.
2102 ($county eq $param->{'selected_county'} ?
2109 $county_html .= '</SELECT>';
2112 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2115 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2116 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2117 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2118 my $text = $state || '(n/a)';
2119 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2120 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2122 $state_html .= '</SELECT>';
2124 my $country_html = '';
2125 if ( scalar( keys %cust_main_county ) > 1 ) {
2127 $country_html = qq(<SELECT NAME="${prefix}country" ).
2128 qq(onChange="${prefix}country_changed(this); ).
2129 $param->{'onchange'}.
2132 my $countrydefault = $param->{default_country} || 'US';
2133 foreach my $country (
2134 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2135 keys %cust_main_county
2137 my $selected = $country eq $param->{'selected_country'}
2140 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2142 $country_html .= '</SELECT>';
2145 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2146 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2150 ($county_html, $state_html, $country_html);
2154 sub regionselector_hashref {
2155 my ($county_html, $state_html, $country_html) = regionselector(@_);
2157 'county_html' => $county_html,
2158 'state_html' => $state_html,
2159 'country_html' => $country_html,
2163 =item location_form HASHREF | LIST
2165 Takes as input a hashref or list of key/value pairs with the following keys:
2171 Current customer session_id
2175 Omit red asterisks from required fields.
2177 =item address1_label
2179 Label for first address line.
2183 Returns an HTML fragment for a location form (address, city, state, zip,
2196 my $session_id = delete $param->{'session_id'};
2198 my $rv = mason_comp( 'session_id' => $session_id,
2199 'comp' => '/elements/location.html',
2200 'args' => [ %$param ],
2204 $rv->{'error'} || $rv->{'output'};
2209 #=item expselect HASHREF | LIST
2211 #Takes as input a hashref or list of key/value pairs with the following keys:
2215 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2217 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2221 =item expselect PREFIX [ DATE ]
2223 Takes as input a unique prefix string and the current expiration date, in
2224 yyyy-mm-dd or m-d-yyyy format
2226 Returns an HTML fragments for expiration date selection.
2232 #if ( ref($_[0]) ) {
2236 #my $prefix = $param->{'prefix'};
2237 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2238 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2240 my $date = scalar(@_) ? shift : '';
2242 my( $m, $y ) = ( 0, 0 );
2243 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2244 ( $m, $y ) = ( $2, $1 );
2245 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2246 ( $m, $y ) = ( $1, $3 );
2248 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2250 $return .= qq!<OPTION VALUE="$_"!;
2251 $return .= " SELECTED" if $_ == $m;
2254 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2256 my $thisYear = $t[5] + 1900;
2257 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2258 $return .= qq!<OPTION VALUE="$_"!;
2259 $return .= " SELECTED" if $_ == $y;
2262 $return .= "</SELECT>";
2267 =item popselector HASHREF | LIST
2269 Takes as input a hashref or list of key/value pairs with the following keys:
2275 Access number number
2279 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>.
2283 Returns an HTML fragment for access number selection.
2287 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2295 my $popnum = $param->{'popnum'};
2296 my $pops = $param->{'pops'};
2298 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2299 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2300 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2301 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2302 if scalar(@$pops) == 1;
2305 my %popnum2pop = ();
2307 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2308 $popnum2pop{$_->{popnum}} = $_;
2313 function opt(what,href,text) {
2314 var optionName = new Option(text, href, false, false)
2315 var length = what.length;
2316 what.options[length] = optionName;
2320 my $init_popstate = $param->{'init_popstate'};
2321 if ( $init_popstate ) {
2322 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2323 $init_popstate. '">';
2326 function acstate_changed(what) {
2327 state = what.options[what.selectedIndex].text;
2328 what.form.popac.options.length = 0
2329 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2333 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2334 foreach my $state ( sort { $a cmp $b } @states ) {
2335 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2337 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2338 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2339 if ($ac eq $param->{'popac'}) {
2340 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2343 $text .= "}\n" unless $init_popstate;
2345 $text .= "popac_changed(what.form.popac)}\n";
2348 function popac_changed(what) {
2349 ac = what.options[what.selectedIndex].text;
2350 what.form.popnum.options.length = 0;
2351 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2355 foreach my $state ( @states ) {
2356 foreach my $popac ( keys %{ $pop{$state} } ) {
2357 $text .= "\nif ( ac == \"$popac\" ) {\n";
2359 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2360 my $o_popnum = $pop->{popnum};
2361 my $poptext = $pop->{city}. ', '. $pop->{state}.
2362 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2364 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2365 if ($popnum == $o_popnum) {
2366 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2374 $text .= "}\n</SCRIPT>\n";
2376 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2379 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2380 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2381 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2382 ">$_" foreach sort { $a cmp $b } @states;
2383 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2386 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2387 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2389 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2392 #comment this block to disable initial list polulation
2393 my @initial_select = ();
2394 if ( scalar( @$pops ) > 100 ) {
2395 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2397 @initial_select = @$pops;
2399 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2400 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2401 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2402 $pop->{city}. ', '. $pop->{state}.
2403 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2406 $text .= qq!</SELECT></TD></TR></TABLE>!;
2412 =item domainselector HASHREF | LIST
2414 Takes as input a hashref or list of key/value pairs with the following keys:
2424 Service number of the selected item.
2428 Returns an HTML fragment for domain selection.
2432 sub domainselector {
2439 my $domsvc= $param->{'domsvc'};
2441 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2442 my $domains = $rv->{'domains'};
2443 $domsvc = $rv->{'domsvc'} unless $domsvc;
2445 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2446 unless scalar(keys %$domains);
2448 if (scalar(keys %$domains) == 1) {
2450 foreach(keys %$domains) {
2453 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2454 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2457 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2459 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2461 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2462 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2463 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2464 $domains->{$domain};
2467 $text .= qq!</SELECT></TD></TR>!;
2473 =item didselector HASHREF | LIST
2475 Takes as input a hashref or list of key/value pairs with the following keys:
2481 Field name for the returned HTML fragment.
2485 Service definition (see L<FS::part_svc>)
2489 Returns an HTML fragment for DID selection.
2501 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2502 'args'=>[ %$param ],
2506 $rv->{'error'} || $rv->{'output'};
2512 =head1 RESELLER FUNCTIONS
2514 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2515 with their active session, and the B<customer_info> and B<order_pkg> functions
2516 with their active session and an additional I<custnum> parameter.
2518 For the most part, development of the reseller web interface has been
2519 superceded by agent-virtualized access to the backend.
2531 =item agent_list_customers
2533 List agent's customers.
2541 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>