1 package FS::SelfService;
4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
5 $skip_uid_check $dir $socket %autoload $tag );
11 use Storable 2.09 qw(nstore_fd fd_retrieve);
15 @ISA = qw( Exporter );
19 $dir = "/usr/local/freeside";
20 $socket = "$dir/selfservice_socket";
21 $socket .= '.'.$tag if defined $tag && length($tag);
23 #maybe should ask ClientAPI for this list
25 'passwd' => 'passwd/passwd',
26 'chfn' => 'passwd/passwd',
27 'chsh' => 'passwd/passwd',
28 'login_info' => 'MyAccount/login_info',
29 'login_banner_image' => 'MyAccount/login_banner_image',
30 'login' => 'MyAccount/login',
31 'logout' => 'MyAccount/logout',
32 'switch_acct' => 'MyAccount/switch_acct',
33 'switch_cust' => 'MyAccount/switch_cust',
34 'customer_info' => 'MyAccount/customer_info',
35 'customer_info_short' => 'MyAccount/customer_info_short',
36 'billing_history' => 'MyAccount/billing_history',
37 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
38 'invoice' => 'MyAccount/invoice',
39 'invoice_pdf' => 'MyAccount/invoice_pdf',
40 'legacy_invoice' => 'MyAccount/legacy_invoice',
41 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
42 'invoice_logo' => 'MyAccount/invoice_logo',
43 'list_invoices' => 'MyAccount/list_invoices', #?
44 'cancel' => 'MyAccount/cancel', #add to ss cgi!
45 'payment_info' => 'MyAccount/payment_info',
46 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
47 'process_payment' => 'MyAccount/process_payment',
48 'store_payment' => 'MyAccount/store_payment',
49 'process_stored_payment' => 'MyAccount/process_stored_payment',
50 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
51 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
52 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
53 'process_prepay' => 'MyAccount/process_prepay',
54 'realtime_collect' => 'MyAccount/realtime_collect',
55 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
56 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
57 'list_svc_usage' => 'MyAccount/list_svc_usage',
58 'svc_status_html' => 'MyAccount/svc_status_html',
59 'svc_status_hash' => 'MyAccount/svc_status_hash',
60 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
61 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
62 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
63 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
64 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
65 'acct_forward_info' => 'MyAccount/acct_forward_info',
66 'process_acct_forward' => 'MyAccount/process_acct_forward',
67 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
68 'add_dsl_device' => 'MyAccount/add_dsl_device',
69 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
70 'port_graph' => 'MyAccount/port_graph',
71 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
72 'list_support_usage' => 'MyAccount/list_support_usage',
73 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
74 'change_pkg' => 'MyAccount/change_pkg',
75 'order_recharge' => 'MyAccount/order_recharge',
76 'renew_info' => 'MyAccount/renew_info',
77 'order_renew' => 'MyAccount/order_renew',
78 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
79 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
80 'charge' => 'MyAccount/charge', #?
81 'part_svc_info' => 'MyAccount/part_svc_info',
82 'provision_acct' => 'MyAccount/provision_acct',
83 'provision_phone' => 'MyAccount/provision_phone',
84 'provision_pbx' => 'MyAccount/provision_pbx',
85 'provision_external' => 'MyAccount/provision_external',
86 'provision_forward' => 'MyAccount/provision_forward',
87 'unprovision_svc' => 'MyAccount/unprovision_svc',
88 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
89 'reset_passwd' => 'MyAccount/reset_passwd',
90 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
91 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
92 'list_tickets' => 'MyAccount/list_tickets',
93 'create_ticket' => 'MyAccount/create_ticket',
94 'get_ticket' => 'MyAccount/get_ticket',
95 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
96 'did_report' => 'MyAccount/did_report',
97 'signup_info' => 'Signup/signup_info',
98 'skin_info' => 'MyAccount/skin_info',
99 'access_info' => 'MyAccount/access_info',
100 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
101 'new_customer' => 'Signup/new_customer',
102 'new_customer_minimal' => 'Signup/new_customer_minimal',
103 'capture_payment' => 'Signup/capture_payment',
104 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
105 'new_agent' => 'Agent/new_agent',
106 'agent_login' => 'Agent/agent_login',
107 'agent_logout' => 'Agent/agent_logout',
108 'agent_info' => 'Agent/agent_info',
109 'agent_list_customers' => 'Agent/agent_list_customers',
110 'check_username' => 'Agent/check_username',
111 'suspend_username' => 'Agent/suspend_username',
112 'unsuspend_username' => 'Agent/unsuspend_username',
113 'mason_comp' => 'MasonComponent/mason_comp',
114 'call_time' => 'PrepaidPhone/call_time',
115 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
116 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
118 'start_thirdparty' => 'MyAccount/start_thirdparty',
119 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
121 'list_quotations' => 'MyAccount/quotation/list_quotations',
122 'quotation_new' => 'MyAccount/quotation/quotation_new',
123 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
124 'quotation_info' => 'MyAccount/quotation/quotation_info',
125 'quotation_print' => 'MyAccount/quotation/quotation_print',
126 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
127 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
128 'quotation_order' => 'MyAccount/quotation/quotation_order',
133 qw( regionselector regionselector_hashref location_form
134 expselect popselector domainselector didselector
138 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
139 $ENV{'SHELL'} = '/bin/sh';
140 $ENV{'IFS'} = " \t\n";
143 $ENV{'BASH_ENV'} = '';
145 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
146 #if you grant appropriate permissions to whatever user
147 my $freeside_uid = scalar(getpwnam('freeside'));
148 die "not running as the freeside user\n"
149 if $> != $freeside_uid && ! $skip_uid_check;
151 -e $dir or die "FATAL: $dir doesn't exist!";
152 -d $dir or die "FATAL: $dir isn't a directory!";
153 -r $dir or die "FATAL: Can't read $dir as freeside user!";
154 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
156 foreach my $autoload ( keys %autoload ) {
159 "sub $autoload { ". '
164 #warn scalar(@_). ": ". join(" / ", @_);
168 $param->{_packet} = \''. $autoload{$autoload}. '\';
170 simple_packet($param);
180 warn "sending ". $packet->{_packet}. " to server"
182 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
183 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
184 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
187 #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
189 #block until there is a message on socket
190 # my $w = new IO::Select;
192 # my @wait = $w->can_read;
194 warn "reading message from server"
197 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
198 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
200 warn "returning message to client"
208 FS::SelfService - Freeside self-service API
212 # password and shell account changes
213 use FS::SelfService qw(passwd chfn chsh);
215 # "my account" functionality
216 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
218 #new-style login with an email address and password
219 # can also be used for svc_acct login, set $emailaddress to username@domain
220 my $rv = login ( { 'email' => $emailaddress,
221 'password' => $password,
224 if ( $rv->{'error'} ) {
225 #handle login error...
228 $session_id = $rv->{'session_id'};
231 #classic svc_acct-based login with separate username and password
232 my $rv = login( { 'username' => $username,
234 'password' => $password,
237 if ( $rv->{'error'} ) {
238 #handle login error...
241 $session_id = $rv->{'session_id'};
244 #svc_phone login with phone number and PIN
245 my $rv = login( { 'username' => $phone_number,
246 'domain' => 'svc_phone',
250 if ( $rv->{'error'} ) {
251 #handle login error...
254 $session_id = $rv->{'session_id'};
257 my $customer_info = customer_info( { 'session_id' => $session_id } );
259 #payment_info and process_payment are available in 1.5+ only
260 my $payment_info = payment_info( { 'session_id' => $session_id } );
262 #!!! process_payment example
264 #!!! list_pkgs example
266 #ordering a package with an svc_acct service
267 my $rv = order_pkg( { 'session_id' => $session_id,
268 'pkgpart' => $pkgpart,
269 'svcpart' => $svcpart,
270 'username' => $username,
271 'domsvc' => $domsvc, #svcnum of svc_domain
272 '_password' => $password,
276 #!!! ordering a package with an svc_domain service example
278 #!!! ordering a package with an svc_phone service example
280 #!!! ordering a package with an svc_external service example
282 #!!! ordering a package with an svc_pbx service
284 #ordering a package with no service
285 my $rv = order_pkg( { 'session_id' => $session_id,
286 'pkgpart' => $pkgpart,
291 #quoting a package, then ordering after confirmation
293 my $rv = quotation_new({ 'session_id' => $session_id });
294 my $qnum = $rv->{quotationnum};
295 # add packages to the quotation
296 $rv = quotation_add_pkg({ 'session_id' => $session_id,
297 'quotationnum' => $qnum,
298 'pkgpart' => $pkgpart,
299 'quantity' => $quantity, # defaults to 1
301 # repeat until all packages are added
302 # view the pricing information
303 $rv = quotation_info({ 'session_id' => $session_id,
304 'quotationnum' => $qnum,
306 print "Total setup charges: ".$rv->{total_setup}."\n".
307 "Total recurring charges: ".$rv->{total_recur}."\n";
308 # quotation_info also provides a detailed breakdown of charges, in
311 # ask customer for confirmation, then:
312 $rv = quotation_order({ 'session_id' => $session_id,
313 'quotationnum' => $qnum,
316 #!!! cancel_pkg example
318 # signup functionality
319 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
321 my $signup_info = signup_info;
323 $rv = new_customer( {
326 'company' => $company,
327 'address1' => $address1,
328 'address2' => $address2,
332 'country' => $country,
333 'daytime' => $daytime,
337 'payinfo' => $payinfo,
339 'paystart_month' => $paystart_month
340 'paystart_year' => $paystart_year,
341 'payissue' => $payissue,
343 'paydate' => $paydate,
344 'payname' => $payname,
345 'invoicing_list' => $invoicing_list,
346 'referral_custnum' => $referral_custnum,
347 'agentnum' => $agentnum,
348 'pkgpart' => $pkgpart,
350 'username' => $username,
351 '_password' => $password,
355 'phonenum' => $phonenum,
360 my $error = $rv->{'error'};
361 if ( $error eq '_decline' ) {
371 Use this API to implement your own client "self-service" module.
373 If you just want to customize the look of the existing "self-service" module,
376 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
382 Changes the password for an existing user in svc_acct. Takes a hash
383 reference with the following keys:
389 Username of the account (required)
393 Domain of the account (required)
397 Old password (required)
401 New password (required)
419 =head1 "MY ACCOUNT" FUNCTIONS
425 Creates a user session. Takes a hash reference as parameter with the
432 Email address (username@domain), instead of username and domain. Required for
433 contact-based self-service login, can also be used for svc_acct-based login.
449 Returns a hash reference with the following keys:
455 Empty on success, or an error message on errors.
459 Session identifier for successful logins
463 =item customer_info HASHREF
465 Returns general customer information.
467 Takes a hash reference as parameter with a single key: B<session_id>
469 Returns a hash reference with the following keys:
483 Array reference of hash references of open inoices. Each hash reference has
484 the following keys: invnum, date, owed
488 An HTML fragment containing shipping and billing addresses.
490 =item The following fields are also returned
492 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
496 =item edit_info HASHREF
498 Takes a hash reference as parameter with any of the following keys:
500 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
502 If a field exists, the customer record is updated with the new value of that
503 field. If a field does not exist, that field is not changed on the customer
506 Returns a hash reference with a single key, B<error>, empty on success, or an
507 error message on errors
509 =item invoice HASHREF
511 Returns an invoice. Takes a hash reference as parameter with two keys:
512 session_id and invnum
514 Returns a hash reference with the following keys:
520 Empty on success, or an error message on errors
532 =item list_invoices HASHREF
534 Returns a list of all customer invoices. Takes a hash references with a single
537 Returns a hash reference with the following keys:
543 Empty on success, or an error message on errors
547 Reference to array of hash references with the following keys:
557 Invoice date, in UNIX epoch time
565 Cancels this customer.
567 Takes a hash reference as parameter with a single key: B<session_id>
569 Returns a hash reference with a single key, B<error>, which is empty on
570 success or an error message on errors.
572 =item payment_info HASHREF
574 Returns information that may be useful in displaying a payment page.
576 Takes a hash reference as parameter with a single key: B<session_id>.
578 Returns a hash reference with the following keys:
584 Empty on success, or an error message on errors
592 Exact name on credit card (CARD/DCRD)
616 Customer's current default payment type.
620 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
624 For CARD/DCRD payment types, the card number
628 For CARD/DCRD payment types, expiration month
632 For CARD/DCRD payment types, expiration year
634 =item cust_main_county
636 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.
640 Array reference of all states in the current default country.
644 Hash reference of card types; keys are card types, values are the exact strings
645 passed to the process_payment function
649 #this doesn't actually work yet
653 #Unique transaction identifier (prevents multiple charges), passed to the
654 #process_payment function
658 =item process_payment HASHREF
660 Processes a payment and possible change of address or payment type. Takes a
661 hash reference as parameter with the following keys:
675 If true, address and card information entered will be saved for subsequent
680 If true, future credit card payments will be done automatically (sets payby to
681 CARD). If false, future credit card payments will be done on-demand (sets
682 payby to DCRD). This option only has meaning if B<save> is set true.
710 Two-letter country code
718 Card expiration month
726 #this doesn't actually work yet
730 #Unique transaction identifier, returned from the payment_info function.
731 #Prevents multiple charges.
735 Returns a hash reference with a single key, B<error>, empty on success, or an
736 error message on errors.
738 =item process_payment_order_pkg
740 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
741 payment processes sucessfully, the package is ordered. Takes a hash reference
742 as parameter with the keys of both methods.
744 Returns a hash reference with a single key, B<error>, empty on success, or an
745 error message on errors.
747 =item process_payment_change_pkg
749 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
750 payment processes sucessfully, the package is ordered. Takes a hash reference
751 as parameter with the keys of both methods.
753 Returns a hash reference with a single key, B<error>, empty on success, or an
754 error message on errors.
757 =item process_payment_order_renew
759 Combines the B<process_payment> and B<order_renew> functions in one step. If
760 the payment processes sucessfully, the renewal is processed. Takes a hash
761 reference as parameter with the keys of both methods.
763 Returns a hash reference with a single key, B<error>, empty on success, or an
764 error message on errors.
768 Returns package information for this customer. For more detail on services,
771 Takes a hash reference as parameter with a single key: B<session_id>
773 Returns a hash reference containing customer package information. The hash reference contains the following keys:
783 Empty on success, or an error message on errors.
785 =item cust_pkg HASHREF
787 Array reference of hash references, each of which has the fields of a cust_pkg
788 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
789 the internal FS:: objects, but hash references of columns and values.
793 =item part_pkg fields
795 All fields of part_pkg for this specific cust_pkg (be careful with this
796 information - it may reveal more about your available packages than you would
797 like users to know in aggregate)
801 #XXX pare part_pkg fields down to a more secure subset
805 An array of hash references indicating information on unprovisioned services
806 available for provisioning for this specific cust_pkg. Each has the following
811 =item part_svc fields
813 All fields of part_svc (be careful with this information - it may reveal more
814 about your available packages than you would like users to know in aggregate)
818 #XXX pare part_svc fields down to a more secure subset
824 An array of hash references indicating information on the customer services
825 already provisioned for this specific cust_pkg. Each has the following keys:
831 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.
837 Primary key for this service
841 Service definition (see L<FS::part_svc>)
845 Customer package (see L<FS::cust_pkg>)
849 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
857 Returns service information for this customer.
859 Takes a hash reference as parameter with a single key: B<session_id>
861 Returns a hash reference containing customer package information. The hash reference contains the following keys:
871 An array of hash references indicating information on all of this customer's
872 services. Each has the following keys:
878 Primary key for this service
886 Meaningful user-specific identifier for the service (i.e. username, domain, or
891 Account (svc_acct) services also have the following keys:
909 Upload bytes remaining
913 Download bytes remaining
917 Total bytes remaining
919 =item recharge_amount
923 =item recharge_seconds
925 Number of seconds gained by recharge
927 =item recharge_upbytes
929 Number of upload bytes gained by recharge
931 =item recharge_downbytes
933 Number of download bytes gained by recharge
935 =item recharge_totalbytes
937 Number of total bytes gained by recharge
945 Orders a package for this customer.
947 Takes a hash reference as parameter with the following keys:
957 Package to order (see L<FS::part_pkg>).
961 Quantity for this package order (default 1).
965 Optional locationnum for this package order, for existing locations.
967 Or, for new locations, pass the following fields: address1*, address2, city*,
968 county, state*, zip*, country. (* = required in this case)
980 Service to order (see L<FS::part_svc>).
982 Normally optional; required only to provision a non-svc_acct service, or if the
983 package definition does not contain one svc_acct service definition with
984 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
985 also be specified to indicate that no initial service should be provisioned.
989 Fields used when provisioning an svc_acct service:
1003 Optional security phrase
1007 Optional Access number number
1011 Fields used when provisioning an svc_domain service:
1021 Fields used when provisioning an svc_phone service:
1039 Fields used when provisioning an svc_external service:
1045 External numeric ID.
1049 External text title.
1053 Fields used when provisioning an svc_pbx service:
1067 Returns a hash reference with a single key, B<error>, empty on success, or an
1068 error message on errors. The special error '_decline' is returned for
1069 declined transactions.
1073 Changes a package for this customer.
1075 Takes a hash reference as parameter with the following keys:
1085 Existing customer package.
1089 New package to order (see L<FS::part_pkg>).
1093 Quantity for this package order (default 1).
1097 Returns a hash reference with the following keys:
1103 Empty on success, or an error message on errors.
1107 On success, the new pkgnum
1114 Provides useful info for early renewals.
1116 Takes a hash reference as parameter with the following keys:
1126 Returns a hash reference. On errors, it contains a single key, B<error>, with
1127 the error message. Otherwise, contains a single key, B<dates>, pointing to
1128 an array refernce of hash references. Each hash reference contains the
1135 (Future) Bill date. Indicates a future date for which billing could be run.
1136 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1139 =item bill_date_pretty
1141 (Future) Bill date as a human-readable string. (Convenience for display;
1142 subject to change, so best not to parse for the date.)
1146 Base amount which will be charged if renewed early as of this date.
1150 Renewal date; i.e. even-futher future date at which the customer will be paid
1151 through if the early renewal is completed with the given B<bill-date>.
1152 Specified as a integer UNIX timestamp.
1154 =item renew_date_pretty
1156 Renewal date as a human-readable string. (Convenience for display;
1157 subject to change, so best not to parse for the date.)
1161 Package that will be renewed.
1165 Expiration date of the package that will be renewed.
1167 =item expire_date_pretty
1169 Expiration date of the package that will be renewed, as a human-readable
1170 string. (Convenience for display; subject to change, so best not to parse for
1177 Renews this customer early; i.e. runs billing for this customer in advance.
1179 Takes a hash reference as parameter with the following keys:
1189 Integer date as returned by the B<renew_info> function, indicating the advance
1190 date for which to run billing.
1194 Returns a hash reference with a single key, B<error>, empty on success, or an
1195 error message on errors.
1199 Cancels a package for this customer.
1201 Takes a hash reference as parameter with the following keys:
1211 pkgpart of package to cancel
1215 Returns a hash reference with a single key, B<error>, empty on success, or an
1216 error message on errors.
1218 =item provision_acct
1220 Provisions an account (svc_acct).
1222 Takes a hash references as parameter with the following keys:
1232 pkgnum of package into which this service is provisioned
1236 svcpart or service definition to provision
1246 =item provision_phone
1248 Provisions a phone number (svc_phone).
1250 Takes a hash references as parameter with the following keys:
1260 pkgnum of package into which this service is provisioned
1264 svcpart or service definition to provision
1284 E911 Address (optional)
1290 Provisions a customer PBX (svc_pbx).
1292 Takes a hash references as parameter with the following keys:
1302 pkgnum of package into which this service is provisioned
1306 svcpart or service definition to provision
1312 =item max_extensions
1314 =item max_simultaneous
1320 =item provision_external
1322 Provisions an external service (svc_external).
1324 Takes a hash references as parameter with the following keys:
1334 pkgnum of package into which this service is provisioned
1338 svcpart or service definition to provision
1348 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1350 All of these functions require the user to be logged in, and the 'session_id'
1351 key to be included in the argument hashref.`
1355 =item list_quotations HASHREF
1357 Returns a hashref listing this customer's active self-service quotations.
1360 - 'quotations', an arrayref containing an element for each quotation.
1361 - quotationnum, the primary key
1362 - _date, the date it was started
1363 - num_pkgs, the number of packages
1364 - total_setup, the sum of setup fees
1365 - total_recur, the sum of recurring charges
1367 =item quotation_new HASHREF
1369 Creates an empty quotation and returns a hashref containing 'quotationnum',
1370 the primary key of the new quotation.
1372 =item quotation_delete HASHREF
1374 Disables (does not really delete) a quotation. Takes the following arguments:
1380 =item quotationnum - the quotation to delete
1384 Returns 'error' => a string, which will be empty on success.
1386 =item quotation_info HASHREF
1388 Returns total and detailed pricing information on a quotation.
1390 Takes the following arguments:
1396 =item quotationnum - the quotation to return
1400 Returns a hashref containing:
1402 - total_setup, the total of setup fees (and their taxes)
1403 - total_recur, the total of all recurring charges (and their taxes)
1404 - sections, an arrayref containing an element for each quotation section.
1405 - description, a line of text describing the group of charges
1406 - subtotal, the total of charges in this group (if appropriate)
1407 - detail_items, an arrayref of line items
1408 - pkgnum, the reference number of the package
1409 - description, the package name (or tax name)
1411 - amount, the amount charged
1412 If the detail item represents a subtotal, it will instead contain:
1413 - total_item: description of the subtotal
1414 - total_amount: the subtotal amount
1417 =item quotation_print HASHREF
1419 Renders the quotation as HTML or PDF. Takes the following arguments:
1425 =item quotationnum - the quotation to return
1427 =item format - 'html' or 'pdf'
1431 Returns a hashref containing 'document', the contents of the file.
1433 =item quotation_add_pkg HASHREF
1435 Adds a package to a quotation. Takes the following arguments:
1441 =item pkgpart - the package to add
1443 =item quotationnum - the quotation to add it to
1445 =item quantity - the package quantity (defaults to 1)
1447 =item address1, address2, city, state, zip, country - address fields to set
1448 the service location
1452 Returns 'error' => a string, which will be empty on success.
1454 =item quotation_remove_pkg HASHREF
1456 Removes a package from a quotation. Takes the following arguments:
1462 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1464 =item quotationnum - the quotation to remove it from
1468 Returns 'error' => a string, which will be empty on success.
1472 =item quotation_order HASHREF
1474 Converts the packages in a quotation into real packages. Takes the following
1477 Takes the following arguments:
1483 =item quotationnum - the quotation to order
1489 =head1 SIGNUP FUNCTIONS
1493 =item signup_info HASHREF
1495 Takes a hash reference as parameter with the following keys:
1499 =item session_id - Optional agent/reseller interface session
1503 Returns a hash reference containing information that may be useful in
1504 displaying a signup page. The hash reference contains the following keys:
1508 =item cust_main_county
1510 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.
1514 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
1515 an agentnum specified explicitly via reseller interface session_id in the
1520 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.
1522 =item agentnum2part_pkg
1524 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.
1528 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.
1530 =item security_phrase
1532 True if the "security_phrase" feature is enabled
1536 Array reference of acceptable payment types for signup
1542 credit card - automatic
1546 credit card - on-demand - version 1.5+ only
1550 electronic check - automatic
1554 electronic check - on-demand - version 1.5+ only
1562 billing, not recommended for signups
1566 free, definitely not recommended for signups
1570 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1576 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1580 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".
1586 =item countrydefault
1592 =item new_customer_minimal HASHREF
1594 Creates a new customer.
1596 Current differences from new_customer: An address is not required. promo_code
1597 and reg_code are not supported. If invoicing_list and _password is passed, a
1598 contact will be created with self-service access (no pkgpart or username is
1599 necessary). No initial billing is run (this may change in a future version).
1601 Takes a hash reference as parameter with the following keys:
1607 first name (required)
1611 last name (required)
1615 (not typically collected; mostly used for ACH transactions)
1647 Daytime phone number
1651 Evening phone number
1659 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1663 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1667 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1671 Expiration date for CARD/DCRD
1675 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1677 =item invoicing_list
1679 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),
1681 =item referral_custnum
1683 referring customer number
1691 pkgpart of initial package
1707 Access number (index, not the literal number)
1711 Country code (to be provisioned as a service)
1715 Phone number (to be provisioned as a service)
1723 Returns a hash reference with the following keys:
1729 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)
1733 =item new_customer HASHREF
1735 Creates a new customer. Takes a hash reference as parameter with the
1742 first name (required)
1746 last name (required)
1750 (not typically collected; mostly used for ACH transactions)
1756 =item address1 (required)
1764 =item city (required)
1772 =item state (required)
1776 =item zip (required)
1782 Daytime phone number
1786 Evening phone number
1794 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1798 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1802 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1806 Expiration date for CARD/DCRD
1810 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1812 =item invoicing_list
1814 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),
1816 =item referral_custnum
1818 referring customer number
1826 pkgpart of initial package
1842 Access number (index, not the literal number)
1846 Country code (to be provisioned as a service)
1850 Phone number (to be provisioned as a service)
1858 Returns a hash reference with the following keys:
1864 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)
1868 =item regionselector HASHREF | LIST
1870 Takes as input a hashref or list of key/value pairs with the following keys:
1874 =item selected_county
1876 Currently selected county
1878 =item selected_state
1880 Currently selected state
1882 =item selected_country
1884 Currently selected country
1888 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1892 Specify a javascript subroutine to call on changes
1898 =item default_country
1904 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>.
1908 Returns a list consisting of three HTML fragments for county selection,
1909 state selection and country selection, respectively.
1913 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1914 sub regionselector {
1921 $param->{'selected_country'} ||= $param->{'default_country'};
1922 $param->{'selected_state'} ||= $param->{'default_state'};
1924 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1928 my %cust_main_county;
1930 # unless ( @cust_main_county ) { #cache
1931 #@cust_main_county = qsearch('cust_main_county', {} );
1932 #foreach my $c ( @cust_main_county ) {
1933 foreach my $c ( @{ $param->{'locales'} } ) {
1934 #$countyflag=1 if $c->county;
1935 $countyflag=1 if $c->{county};
1936 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1937 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1938 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1941 $countyflag=1 if $param->{selected_county};
1943 my $script_html = <<END;
1945 function opt(what,value,text) {
1946 var optionName = new Option(text, value, false, false);
1947 var length = what.length;
1948 what.options[length] = optionName;
1950 function ${prefix}country_changed(what) {
1951 country = what.options[what.selectedIndex].text;
1952 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1953 what.form.${prefix}state.options[i] = null;
1955 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1957 foreach my $country ( sort keys %cust_main_county ) {
1958 $script_html .= "\nif ( country == \"$country\" ) {\n";
1959 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1960 my $text = $state || '(n/a)';
1961 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1963 $script_html .= "}\n";
1966 $script_html .= <<END;
1968 function ${prefix}state_changed(what) {
1971 if ( $countyflag ) {
1972 $script_html .= <<END;
1973 state = what.options[what.selectedIndex].text;
1974 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1975 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1976 what.form.${prefix}county.options[i] = null;
1979 foreach my $country ( sort keys %cust_main_county ) {
1980 $script_html .= "\nif ( country == \"$country\" ) {\n";
1981 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1982 $script_html .= "\nif ( state == \"$state\" ) {\n";
1983 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1984 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1985 my $text = $county || '(n/a)';
1987 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1989 $script_html .= "}\n";
1991 $script_html .= "}\n";
1995 $script_html .= <<END;
2000 my $county_html = $script_html;
2001 if ( $countyflag ) {
2002 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2003 foreach my $county (
2004 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2006 my $text = $county || '(n/a)';
2007 $county_html .= qq!<OPTION VALUE="$county"!.
2008 ($county eq $param->{'selected_county'} ?
2015 $county_html .= '</SELECT>';
2018 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2021 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2022 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2023 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2024 my $text = $state || '(n/a)';
2025 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2026 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2028 $state_html .= '</SELECT>';
2030 my $country_html = '';
2031 if ( scalar( keys %cust_main_county ) > 1 ) {
2033 $country_html = qq(<SELECT NAME="${prefix}country" ).
2034 qq(onChange="${prefix}country_changed(this); ).
2035 $param->{'onchange'}.
2038 my $countrydefault = $param->{default_country} || 'US';
2039 foreach my $country (
2040 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2041 keys %cust_main_county
2043 my $selected = $country eq $param->{'selected_country'}
2046 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2048 $country_html .= '</SELECT>';
2051 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2052 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2056 ($county_html, $state_html, $country_html);
2060 sub regionselector_hashref {
2061 my ($county_html, $state_html, $country_html) = regionselector(@_);
2063 'county_html' => $county_html,
2064 'state_html' => $state_html,
2065 'country_html' => $country_html,
2069 =item location_form HASHREF | LIST
2071 Takes as input a hashref or list of key/value pairs with the following keys:
2077 Current customer session_id
2081 Omit red asterisks from required fields.
2083 =item address1_label
2085 Label for first address line.
2089 Returns an HTML fragment for a location form (address, city, state, zip,
2102 my $session_id = delete $param->{'session_id'};
2104 my $rv = mason_comp( 'session_id' => $session_id,
2105 'comp' => '/elements/location.html',
2106 'args' => [ %$param ],
2110 $rv->{'error'} || $rv->{'output'};
2115 #=item expselect HASHREF | LIST
2117 #Takes as input a hashref or list of key/value pairs with the following keys:
2121 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2123 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2127 =item expselect PREFIX [ DATE ]
2129 Takes as input a unique prefix string and the current expiration date, in
2130 yyyy-mm-dd or m-d-yyyy format
2132 Returns an HTML fragments for expiration date selection.
2138 #if ( ref($_[0]) ) {
2142 #my $prefix = $param->{'prefix'};
2143 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2144 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2146 my $date = scalar(@_) ? shift : '';
2148 my( $m, $y ) = ( 0, 0 );
2149 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2150 ( $m, $y ) = ( $2, $1 );
2151 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2152 ( $m, $y ) = ( $1, $3 );
2154 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2156 $return .= qq!<OPTION VALUE="$_"!;
2157 $return .= " SELECTED" if $_ == $m;
2160 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2162 my $thisYear = $t[5] + 1900;
2163 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2164 $return .= qq!<OPTION VALUE="$_"!;
2165 $return .= " SELECTED" if $_ == $y;
2168 $return .= "</SELECT>";
2173 =item popselector HASHREF | LIST
2175 Takes as input a hashref or list of key/value pairs with the following keys:
2181 Access number number
2185 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>.
2189 Returns an HTML fragment for access number selection.
2193 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2201 my $popnum = $param->{'popnum'};
2202 my $pops = $param->{'pops'};
2204 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2205 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2206 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2207 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2208 if scalar(@$pops) == 1;
2211 my %popnum2pop = ();
2213 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2214 $popnum2pop{$_->{popnum}} = $_;
2219 function opt(what,href,text) {
2220 var optionName = new Option(text, href, false, false)
2221 var length = what.length;
2222 what.options[length] = optionName;
2226 my $init_popstate = $param->{'init_popstate'};
2227 if ( $init_popstate ) {
2228 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2229 $init_popstate. '">';
2232 function acstate_changed(what) {
2233 state = what.options[what.selectedIndex].text;
2234 what.form.popac.options.length = 0
2235 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2239 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2240 foreach my $state ( sort { $a cmp $b } @states ) {
2241 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2243 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2244 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2245 if ($ac eq $param->{'popac'}) {
2246 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2249 $text .= "}\n" unless $init_popstate;
2251 $text .= "popac_changed(what.form.popac)}\n";
2254 function popac_changed(what) {
2255 ac = what.options[what.selectedIndex].text;
2256 what.form.popnum.options.length = 0;
2257 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2261 foreach my $state ( @states ) {
2262 foreach my $popac ( keys %{ $pop{$state} } ) {
2263 $text .= "\nif ( ac == \"$popac\" ) {\n";
2265 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2266 my $o_popnum = $pop->{popnum};
2267 my $poptext = $pop->{city}. ', '. $pop->{state}.
2268 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2270 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2271 if ($popnum == $o_popnum) {
2272 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2280 $text .= "}\n</SCRIPT>\n";
2282 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2285 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2286 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2287 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2288 ">$_" foreach sort { $a cmp $b } @states;
2289 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2292 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2293 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2295 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2298 #comment this block to disable initial list polulation
2299 my @initial_select = ();
2300 if ( scalar( @$pops ) > 100 ) {
2301 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2303 @initial_select = @$pops;
2305 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2306 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2307 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2308 $pop->{city}. ', '. $pop->{state}.
2309 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2312 $text .= qq!</SELECT></TD></TR></TABLE>!;
2318 =item domainselector HASHREF | LIST
2320 Takes as input a hashref or list of key/value pairs with the following keys:
2330 Service number of the selected item.
2334 Returns an HTML fragment for domain selection.
2338 sub domainselector {
2345 my $domsvc= $param->{'domsvc'};
2347 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2348 my $domains = $rv->{'domains'};
2349 $domsvc = $rv->{'domsvc'} unless $domsvc;
2351 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2352 unless scalar(keys %$domains);
2354 if (scalar(keys %$domains) == 1) {
2356 foreach(keys %$domains) {
2359 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2360 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2363 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2365 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2367 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2368 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2369 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2370 $domains->{$domain};
2373 $text .= qq!</SELECT></TD></TR>!;
2379 =item didselector HASHREF | LIST
2381 Takes as input a hashref or list of key/value pairs with the following keys:
2387 Field name for the returned HTML fragment.
2391 Service definition (see L<FS::part_svc>)
2395 Returns an HTML fragment for DID selection.
2407 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2408 'args'=>[ %$param ],
2412 $rv->{'error'} || $rv->{'output'};
2418 =head1 RESELLER FUNCTIONS
2420 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2421 with their active session, and the B<customer_info> and B<order_pkg> functions
2422 with their active session and an additional I<custnum> parameter.
2424 For the most part, development of the reseller web interface has been
2425 superceded by agent-virtualized access to the backend.
2437 =item agent_list_customers
2439 List agent's customers.
2447 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>