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 'unprovision_svc' => 'MyAccount/unprovision_svc',
87 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
88 'reset_passwd' => 'MyAccount/reset_passwd',
89 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
90 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
91 'list_tickets' => 'MyAccount/list_tickets',
92 'create_ticket' => 'MyAccount/create_ticket',
93 'get_ticket' => 'MyAccount/get_ticket',
94 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
95 'did_report' => 'MyAccount/did_report',
96 'signup_info' => 'Signup/signup_info',
97 'skin_info' => 'MyAccount/skin_info',
98 'access_info' => 'MyAccount/access_info',
99 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
100 'new_customer' => 'Signup/new_customer',
101 'new_customer_minimal' => 'Signup/new_customer_minimal',
102 'capture_payment' => 'Signup/capture_payment',
103 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
104 'new_agent' => 'Agent/new_agent',
105 'agent_login' => 'Agent/agent_login',
106 'agent_logout' => 'Agent/agent_logout',
107 'agent_info' => 'Agent/agent_info',
108 'agent_list_customers' => 'Agent/agent_list_customers',
109 'check_username' => 'Agent/check_username',
110 'suspend_username' => 'Agent/suspend_username',
111 'unsuspend_username' => 'Agent/unsuspend_username',
112 'mason_comp' => 'MasonComponent/mason_comp',
113 'call_time' => 'PrepaidPhone/call_time',
114 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
115 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
117 'start_thirdparty' => 'MyAccount/start_thirdparty',
118 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
120 'list_quotations' => 'MyAccount/quotation/list_quotations',
121 'quotation_new' => 'MyAccount/quotation/quotation_new',
122 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
123 'quotation_info' => 'MyAccount/quotation/quotation_info',
124 'quotation_print' => 'MyAccount/quotation/quotation_print',
125 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
126 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
127 'quotation_order' => 'MyAccount/quotation/quotation_order',
132 qw( regionselector regionselector_hashref location_form
133 expselect popselector domainselector didselector
137 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
138 $ENV{'SHELL'} = '/bin/sh';
139 $ENV{'IFS'} = " \t\n";
142 $ENV{'BASH_ENV'} = '';
144 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
145 #if you grant appropriate permissions to whatever user
146 my $freeside_uid = scalar(getpwnam('freeside'));
147 die "not running as the freeside user\n"
148 if $> != $freeside_uid && ! $skip_uid_check;
150 -e $dir or die "FATAL: $dir doesn't exist!";
151 -d $dir or die "FATAL: $dir isn't a directory!";
152 -r $dir or die "FATAL: Can't read $dir as freeside user!";
153 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
155 foreach my $autoload ( keys %autoload ) {
158 "sub $autoload { ". '
163 #warn scalar(@_). ": ". join(" / ", @_);
167 $param->{_packet} = \''. $autoload{$autoload}. '\';
169 simple_packet($param);
179 warn "sending ". $packet->{_packet}. " to server"
181 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
182 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
183 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
186 #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
188 #block until there is a message on socket
189 # my $w = new IO::Select;
191 # my @wait = $w->can_read;
193 warn "reading message from server"
196 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
197 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
199 warn "returning message to client"
207 FS::SelfService - Freeside self-service API
211 # password and shell account changes
212 use FS::SelfService qw(passwd chfn chsh);
214 # "my account" functionality
215 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
217 #new-style login with an email address and password
218 # can also be used for svc_acct login, set $emailaddress to username@domain
219 my $rv = login ( { 'email' => $emailaddress,
220 'password' => $password,
223 if ( $rv->{'error'} ) {
224 #handle login error...
227 $session_id = $rv->{'session_id'};
230 #classic svc_acct-based login with separate username and password
231 my $rv = login( { 'username' => $username,
233 'password' => $password,
236 if ( $rv->{'error'} ) {
237 #handle login error...
240 $session_id = $rv->{'session_id'};
243 #svc_phone login with phone number and PIN
244 my $rv = login( { 'username' => $phone_number,
245 'domain' => 'svc_phone',
249 if ( $rv->{'error'} ) {
250 #handle login error...
253 $session_id = $rv->{'session_id'};
256 my $customer_info = customer_info( { 'session_id' => $session_id } );
258 #payment_info and process_payment are available in 1.5+ only
259 my $payment_info = payment_info( { 'session_id' => $session_id } );
261 #!!! process_payment example
263 #!!! list_pkgs example
265 #ordering a package with an svc_acct service
266 my $rv = order_pkg( { 'session_id' => $session_id,
267 'pkgpart' => $pkgpart,
268 'svcpart' => $svcpart,
269 'username' => $username,
270 'domsvc' => $domsvc, #svcnum of svc_domain
271 '_password' => $password,
275 #!!! ordering a package with an svc_domain service example
277 #!!! ordering a package with an svc_phone service example
279 #!!! ordering a package with an svc_external service example
281 #!!! ordering a package with an svc_pbx service
283 #ordering a package with no service
284 my $rv = order_pkg( { 'session_id' => $session_id,
285 'pkgpart' => $pkgpart,
290 #quoting a package, then ordering after confirmation
292 my $rv = quotation_new({ 'session_id' => $session_id });
293 my $qnum = $rv->{quotationnum};
294 # add packages to the quotation
295 $rv = quotation_add_pkg({ 'session_id' => $session_id,
296 'quotationnum' => $qnum,
297 'pkgpart' => $pkgpart,
298 'quantity' => $quantity, # defaults to 1
300 # repeat until all packages are added
301 # view the pricing information
302 $rv = quotation_info({ 'session_id' => $session_id,
303 'quotationnum' => $qnum,
305 print "Total setup charges: ".$rv->{total_setup}."\n".
306 "Total recurring charges: ".$rv->{total_recur}."\n";
307 # quotation_info also provides a detailed breakdown of charges, in
310 # ask customer for confirmation, then:
311 $rv = quotation_order({ 'session_id' => $session_id,
312 'quotationnum' => $qnum,
315 #!!! cancel_pkg example
317 # signup functionality
318 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
320 my $signup_info = signup_info;
322 $rv = new_customer( {
325 'company' => $company,
326 'address1' => $address1,
327 'address2' => $address2,
331 'country' => $country,
332 'daytime' => $daytime,
336 'payinfo' => $payinfo,
338 'paystart_month' => $paystart_month
339 'paystart_year' => $paystart_year,
340 'payissue' => $payissue,
342 'paydate' => $paydate,
343 'payname' => $payname,
344 'invoicing_list' => $invoicing_list,
345 'referral_custnum' => $referral_custnum,
346 'agentnum' => $agentnum,
347 'pkgpart' => $pkgpart,
349 'username' => $username,
350 '_password' => $password,
354 'phonenum' => $phonenum,
359 my $error = $rv->{'error'};
360 if ( $error eq '_decline' ) {
370 Use this API to implement your own client "self-service" module.
372 If you just want to customize the look of the existing "self-service" module,
375 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
381 Changes the password for an existing user in svc_acct. Takes a hash
382 reference with the following keys:
388 Username of the account (required)
392 Domain of the account (required)
396 Old password (required)
400 New password (required)
418 =head1 "MY ACCOUNT" FUNCTIONS
424 Creates a user session. Takes a hash reference as parameter with the
431 Email address (username@domain), instead of username and domain. Required for
432 contact-based self-service login, can also be used for svc_acct-based login.
448 Returns a hash reference with the following keys:
454 Empty on success, or an error message on errors.
458 Session identifier for successful logins
462 =item customer_info HASHREF
464 Returns general customer information.
466 Takes a hash reference as parameter with a single key: B<session_id>
468 Returns a hash reference with the following keys:
482 Array reference of hash references of open inoices. Each hash reference has
483 the following keys: invnum, date, owed
487 An HTML fragment containing shipping and billing addresses.
489 =item The following fields are also returned
491 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
495 =item edit_info HASHREF
497 Takes a hash reference as parameter with any of the following keys:
499 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
501 If a field exists, the customer record is updated with the new value of that
502 field. If a field does not exist, that field is not changed on the customer
505 Returns a hash reference with a single key, B<error>, empty on success, or an
506 error message on errors
508 =item invoice HASHREF
510 Returns an invoice. Takes a hash reference as parameter with two keys:
511 session_id and invnum
513 Returns a hash reference with the following keys:
519 Empty on success, or an error message on errors
531 =item list_invoices HASHREF
533 Returns a list of all customer invoices. Takes a hash references with a single
536 Returns a hash reference with the following keys:
542 Empty on success, or an error message on errors
546 Reference to array of hash references with the following keys:
556 Invoice date, in UNIX epoch time
564 Cancels this customer.
566 Takes a hash reference as parameter with a single key: B<session_id>
568 Returns a hash reference with a single key, B<error>, which is empty on
569 success or an error message on errors.
571 =item payment_info HASHREF
573 Returns information that may be useful in displaying a payment page.
575 Takes a hash reference as parameter with a single key: B<session_id>.
577 Returns a hash reference with the following keys:
583 Empty on success, or an error message on errors
591 Exact name on credit card (CARD/DCRD)
615 Customer's current default payment type.
619 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
623 For CARD/DCRD payment types, the card number
627 For CARD/DCRD payment types, expiration month
631 For CARD/DCRD payment types, expiration year
633 =item cust_main_county
635 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.
639 Array reference of all states in the current default country.
643 Hash reference of card types; keys are card types, values are the exact strings
644 passed to the process_payment function
648 #this doesn't actually work yet
652 #Unique transaction identifier (prevents multiple charges), passed to the
653 #process_payment function
657 =item process_payment HASHREF
659 Processes a payment and possible change of address or payment type. Takes a
660 hash reference as parameter with the following keys:
674 If true, address and card information entered will be saved for subsequent
679 If true, future credit card payments will be done automatically (sets payby to
680 CARD). If false, future credit card payments will be done on-demand (sets
681 payby to DCRD). This option only has meaning if B<save> is set true.
709 Two-letter country code
717 Card expiration month
725 #this doesn't actually work yet
729 #Unique transaction identifier, returned from the payment_info function.
730 #Prevents multiple charges.
734 Returns a hash reference with a single key, B<error>, empty on success, or an
735 error message on errors.
737 =item process_payment_order_pkg
739 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
740 payment processes sucessfully, the package is ordered. Takes a hash reference
741 as parameter with the keys of both methods.
743 Returns a hash reference with a single key, B<error>, empty on success, or an
744 error message on errors.
746 =item process_payment_change_pkg
748 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
749 payment processes sucessfully, the package is ordered. Takes a hash reference
750 as parameter with the keys of both methods.
752 Returns a hash reference with a single key, B<error>, empty on success, or an
753 error message on errors.
756 =item process_payment_order_renew
758 Combines the B<process_payment> and B<order_renew> functions in one step. If
759 the payment processes sucessfully, the renewal is processed. Takes a hash
760 reference as parameter with the keys of both methods.
762 Returns a hash reference with a single key, B<error>, empty on success, or an
763 error message on errors.
767 Returns package information for this customer. For more detail on services,
770 Takes a hash reference as parameter with a single key: B<session_id>
772 Returns a hash reference containing customer package information. The hash reference contains the following keys:
782 Empty on success, or an error message on errors.
784 =item cust_pkg HASHREF
786 Array reference of hash references, each of which has the fields of a cust_pkg
787 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
788 the internal FS:: objects, but hash references of columns and values.
792 =item part_pkg fields
794 All fields of part_pkg for this specific cust_pkg (be careful with this
795 information - it may reveal more about your available packages than you would
796 like users to know in aggregate)
800 #XXX pare part_pkg fields down to a more secure subset
804 An array of hash references indicating information on unprovisioned services
805 available for provisioning for this specific cust_pkg. Each has the following
810 =item part_svc fields
812 All fields of part_svc (be careful with this information - it may reveal more
813 about your available packages than you would like users to know in aggregate)
817 #XXX pare part_svc fields down to a more secure subset
823 An array of hash references indicating information on the customer services
824 already provisioned for this specific cust_pkg. Each has the following keys:
830 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.
836 Primary key for this service
840 Service definition (see L<FS::part_svc>)
844 Customer package (see L<FS::cust_pkg>)
848 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
856 Returns service information for this customer.
858 Takes a hash reference as parameter with a single key: B<session_id>
860 Returns a hash reference containing customer package information. The hash reference contains the following keys:
870 An array of hash references indicating information on all of this customer's
871 services. Each has the following keys:
877 Primary key for this service
885 Meaningful user-specific identifier for the service (i.e. username, domain, or
890 Account (svc_acct) services also have the following keys:
908 Upload bytes remaining
912 Download bytes remaining
916 Total bytes remaining
918 =item recharge_amount
922 =item recharge_seconds
924 Number of seconds gained by recharge
926 =item recharge_upbytes
928 Number of upload bytes gained by recharge
930 =item recharge_downbytes
932 Number of download bytes gained by recharge
934 =item recharge_totalbytes
936 Number of total bytes gained by recharge
944 Orders a package for this customer.
946 Takes a hash reference as parameter with the following keys:
956 Package to order (see L<FS::part_pkg>).
960 Quantity for this package order (default 1).
964 Optional locationnum for this package order, for existing locations.
966 Or, for new locations, pass the following fields: address1*, address2, city*,
967 county, state*, zip*, country. (* = required in this case)
979 Service to order (see L<FS::part_svc>).
981 Normally optional; required only to provision a non-svc_acct service, or if the
982 package definition does not contain one svc_acct service definition with
983 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
984 also be specified to indicate that no initial service should be provisioned.
988 Fields used when provisioning an svc_acct service:
1002 Optional security phrase
1006 Optional Access number number
1010 Fields used when provisioning an svc_domain service:
1020 Fields used when provisioning an svc_phone service:
1038 Fields used when provisioning an svc_external service:
1044 External numeric ID.
1048 External text title.
1052 Fields used when provisioning an svc_pbx service:
1066 Returns a hash reference with a single key, B<error>, empty on success, or an
1067 error message on errors. The special error '_decline' is returned for
1068 declined transactions.
1072 Changes a package for this customer.
1074 Takes a hash reference as parameter with the following keys:
1084 Existing customer package.
1088 New package to order (see L<FS::part_pkg>).
1092 Quantity for this package order (default 1).
1096 Returns a hash reference with the following keys:
1102 Empty on success, or an error message on errors.
1106 On success, the new pkgnum
1113 Provides useful info for early renewals.
1115 Takes a hash reference as parameter with the following keys:
1125 Returns a hash reference. On errors, it contains a single key, B<error>, with
1126 the error message. Otherwise, contains a single key, B<dates>, pointing to
1127 an array refernce of hash references. Each hash reference contains the
1134 (Future) Bill date. Indicates a future date for which billing could be run.
1135 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1138 =item bill_date_pretty
1140 (Future) Bill date as a human-readable string. (Convenience for display;
1141 subject to change, so best not to parse for the date.)
1145 Base amount which will be charged if renewed early as of this date.
1149 Renewal date; i.e. even-futher future date at which the customer will be paid
1150 through if the early renewal is completed with the given B<bill-date>.
1151 Specified as a integer UNIX timestamp.
1153 =item renew_date_pretty
1155 Renewal date as a human-readable string. (Convenience for display;
1156 subject to change, so best not to parse for the date.)
1160 Package that will be renewed.
1164 Expiration date of the package that will be renewed.
1166 =item expire_date_pretty
1168 Expiration date of the package that will be renewed, as a human-readable
1169 string. (Convenience for display; subject to change, so best not to parse for
1176 Renews this customer early; i.e. runs billing for this customer in advance.
1178 Takes a hash reference as parameter with the following keys:
1188 Integer date as returned by the B<renew_info> function, indicating the advance
1189 date for which to run billing.
1193 Returns a hash reference with a single key, B<error>, empty on success, or an
1194 error message on errors.
1198 Cancels a package for this customer.
1200 Takes a hash reference as parameter with the following keys:
1210 pkgpart of package to cancel
1214 Returns a hash reference with a single key, B<error>, empty on success, or an
1215 error message on errors.
1217 =item provision_acct
1219 Provisions an account (svc_acct).
1221 Takes a hash references as parameter with the following keys:
1231 pkgnum of package into which this service is provisioned
1235 svcpart or service definition to provision
1245 =item provision_phone
1247 Provisions a phone number (svc_phone).
1249 Takes a hash references as parameter with the following keys:
1259 pkgnum of package into which this service is provisioned
1263 svcpart or service definition to provision
1283 E911 Address (optional)
1289 Provisions a customer PBX (svc_pbx).
1291 Takes a hash references as parameter with the following keys:
1301 pkgnum of package into which this service is provisioned
1305 svcpart or service definition to provision
1311 =item max_extensions
1313 =item max_simultaneous
1319 =item provision_external
1321 Provisions an external service (svc_external).
1323 Takes a hash references as parameter with the following keys:
1333 pkgnum of package into which this service is provisioned
1337 svcpart or service definition to provision
1347 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1349 All of these functions require the user to be logged in, and the 'session_id'
1350 key to be included in the argument hashref.`
1354 =item list_quotations HASHREF
1356 Returns a hashref listing this customer's active self-service quotations.
1359 - 'quotations', an arrayref containing an element for each quotation.
1360 - quotationnum, the primary key
1361 - _date, the date it was started
1362 - num_pkgs, the number of packages
1363 - total_setup, the sum of setup fees
1364 - total_recur, the sum of recurring charges
1366 =item quotation_new HASHREF
1368 Creates an empty quotation and returns a hashref containing 'quotationnum',
1369 the primary key of the new quotation.
1371 =item quotation_delete HASHREF
1373 Disables (does not really delete) a quotation. Takes the following arguments:
1379 =item quotationnum - the quotation to delete
1383 Returns 'error' => a string, which will be empty on success.
1385 =item quotation_info HASHREF
1387 Returns total and detailed pricing information on a quotation.
1389 Takes the following arguments:
1395 =item quotationnum - the quotation to return
1399 Returns a hashref containing:
1401 - total_setup, the total of setup fees (and their taxes)
1402 - total_recur, the total of all recurring charges (and their taxes)
1403 - sections, an arrayref containing an element for each quotation section.
1404 - description, a line of text describing the group of charges
1405 - subtotal, the total of charges in this group (if appropriate)
1406 - detail_items, an arrayref of line items
1407 - pkgnum, the reference number of the package
1408 - description, the package name (or tax name)
1410 - amount, the amount charged
1411 If the detail item represents a subtotal, it will instead contain:
1412 - total_item: description of the subtotal
1413 - total_amount: the subtotal amount
1416 =item quotation_print HASHREF
1418 Renders the quotation as HTML or PDF. Takes the following arguments:
1424 =item quotationnum - the quotation to return
1426 =item format - 'html' or 'pdf'
1430 Returns a hashref containing 'document', the contents of the file.
1432 =item quotation_add_pkg HASHREF
1434 Adds a package to a quotation. Takes the following arguments:
1440 =item pkgpart - the package to add
1442 =item quotationnum - the quotation to add it to
1444 =item quantity - the package quantity (defaults to 1)
1446 =item address1, address2, city, state, zip, country - address fields to set
1447 the service location
1451 Returns 'error' => a string, which will be empty on success.
1453 =item quotation_remove_pkg HASHREF
1455 Removes a package from a quotation. Takes the following arguments:
1461 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1463 =item quotationnum - the quotation to remove it from
1467 Returns 'error' => a string, which will be empty on success.
1471 =item quotation_order HASHREF
1473 Converts the packages in a quotation into real packages. Takes the following
1476 Takes the following arguments:
1482 =item quotationnum - the quotation to order
1488 =head1 SIGNUP FUNCTIONS
1492 =item signup_info HASHREF
1494 Takes a hash reference as parameter with the following keys:
1498 =item session_id - Optional agent/reseller interface session
1502 Returns a hash reference containing information that may be useful in
1503 displaying a signup page. The hash reference contains the following keys:
1507 =item cust_main_county
1509 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.
1513 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
1514 an agentnum specified explicitly via reseller interface session_id in the
1519 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.
1521 =item agentnum2part_pkg
1523 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.
1527 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.
1529 =item security_phrase
1531 True if the "security_phrase" feature is enabled
1535 Array reference of acceptable payment types for signup
1541 credit card - automatic
1545 credit card - on-demand - version 1.5+ only
1549 electronic check - automatic
1553 electronic check - on-demand - version 1.5+ only
1561 billing, not recommended for signups
1565 free, definitely not recommended for signups
1569 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1575 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1579 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".
1585 =item countrydefault
1591 =item new_customer_minimal HASHREF
1593 Creates a new customer.
1595 Current differences from new_customer: An address is not required. promo_code
1596 and reg_code are not supported. If invoicing_list and _password is passed, a
1597 contact will be created with self-service access (no pkgpart or username is
1598 necessary). No initial billing is run (this may change in a future version).
1600 Takes a hash reference as parameter with the following keys:
1606 first name (required)
1610 last name (required)
1614 (not typically collected; mostly used for ACH transactions)
1646 Daytime phone number
1650 Evening phone number
1658 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1662 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1666 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1670 Expiration date for CARD/DCRD
1674 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1676 =item invoicing_list
1678 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),
1680 =item referral_custnum
1682 referring customer number
1690 pkgpart of initial package
1706 Access number (index, not the literal number)
1710 Country code (to be provisioned as a service)
1714 Phone number (to be provisioned as a service)
1722 Returns a hash reference with the following keys:
1728 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)
1732 =item new_customer HASHREF
1734 Creates a new customer. Takes a hash reference as parameter with the
1741 first name (required)
1745 last name (required)
1749 (not typically collected; mostly used for ACH transactions)
1755 =item address1 (required)
1763 =item city (required)
1771 =item state (required)
1775 =item zip (required)
1781 Daytime phone number
1785 Evening phone number
1793 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1797 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1801 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1805 Expiration date for CARD/DCRD
1809 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1811 =item invoicing_list
1813 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),
1815 =item referral_custnum
1817 referring customer number
1825 pkgpart of initial package
1841 Access number (index, not the literal number)
1845 Country code (to be provisioned as a service)
1849 Phone number (to be provisioned as a service)
1857 Returns a hash reference with the following keys:
1863 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)
1867 =item regionselector HASHREF | LIST
1869 Takes as input a hashref or list of key/value pairs with the following keys:
1873 =item selected_county
1875 Currently selected county
1877 =item selected_state
1879 Currently selected state
1881 =item selected_country
1883 Currently selected country
1887 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1891 Specify a javascript subroutine to call on changes
1897 =item default_country
1903 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>.
1907 Returns a list consisting of three HTML fragments for county selection,
1908 state selection and country selection, respectively.
1912 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1913 sub regionselector {
1920 $param->{'selected_country'} ||= $param->{'default_country'};
1921 $param->{'selected_state'} ||= $param->{'default_state'};
1923 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1927 my %cust_main_county;
1929 # unless ( @cust_main_county ) { #cache
1930 #@cust_main_county = qsearch('cust_main_county', {} );
1931 #foreach my $c ( @cust_main_county ) {
1932 foreach my $c ( @{ $param->{'locales'} } ) {
1933 #$countyflag=1 if $c->county;
1934 $countyflag=1 if $c->{county};
1935 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1936 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1937 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1940 $countyflag=1 if $param->{selected_county};
1942 my $script_html = <<END;
1944 function opt(what,value,text) {
1945 var optionName = new Option(text, value, false, false);
1946 var length = what.length;
1947 what.options[length] = optionName;
1949 function ${prefix}country_changed(what) {
1950 country = what.options[what.selectedIndex].text;
1951 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1952 what.form.${prefix}state.options[i] = null;
1954 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1956 foreach my $country ( sort keys %cust_main_county ) {
1957 $script_html .= "\nif ( country == \"$country\" ) {\n";
1958 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1959 my $text = $state || '(n/a)';
1960 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1962 $script_html .= "}\n";
1965 $script_html .= <<END;
1967 function ${prefix}state_changed(what) {
1970 if ( $countyflag ) {
1971 $script_html .= <<END;
1972 state = what.options[what.selectedIndex].text;
1973 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1974 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1975 what.form.${prefix}county.options[i] = null;
1978 foreach my $country ( sort keys %cust_main_county ) {
1979 $script_html .= "\nif ( country == \"$country\" ) {\n";
1980 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1981 $script_html .= "\nif ( state == \"$state\" ) {\n";
1982 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1983 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1984 my $text = $county || '(n/a)';
1986 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1988 $script_html .= "}\n";
1990 $script_html .= "}\n";
1994 $script_html .= <<END;
1999 my $county_html = $script_html;
2000 if ( $countyflag ) {
2001 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2002 foreach my $county (
2003 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2005 my $text = $county || '(n/a)';
2006 $county_html .= qq!<OPTION VALUE="$county"!.
2007 ($county eq $param->{'selected_county'} ?
2014 $county_html .= '</SELECT>';
2017 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2020 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2021 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2022 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2023 my $text = $state || '(n/a)';
2024 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2025 $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2027 $state_html .= '</SELECT>';
2029 my $country_html = '';
2030 if ( scalar( keys %cust_main_county ) > 1 ) {
2032 $country_html = qq(<SELECT NAME="${prefix}country" ).
2033 qq(onChange="${prefix}country_changed(this); ).
2034 $param->{'onchange'}.
2037 my $countrydefault = $param->{default_country} || 'US';
2038 foreach my $country (
2039 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2040 keys %cust_main_county
2042 my $selected = $country eq $param->{'selected_country'}
2045 $country_html .= "\n<OPTION $selected>$country</OPTION>"
2047 $country_html .= '</SELECT>';
2050 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2051 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2055 ($county_html, $state_html, $country_html);
2059 sub regionselector_hashref {
2060 my ($county_html, $state_html, $country_html) = regionselector(@_);
2062 'county_html' => $county_html,
2063 'state_html' => $state_html,
2064 'country_html' => $country_html,
2068 =item location_form HASHREF | LIST
2070 Takes as input a hashref or list of key/value pairs with the following keys:
2076 Current customer session_id
2080 Omit red asterisks from required fields.
2082 =item address1_label
2084 Label for first address line.
2088 Returns an HTML fragment for a location form (address, city, state, zip,
2101 my $session_id = delete $param->{'session_id'};
2103 my $rv = mason_comp( 'session_id' => $session_id,
2104 'comp' => '/elements/location.html',
2105 'args' => [ %$param ],
2109 $rv->{'error'} || $rv->{'output'};
2114 #=item expselect HASHREF | LIST
2116 #Takes as input a hashref or list of key/value pairs with the following keys:
2120 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2122 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2126 =item expselect PREFIX [ DATE ]
2128 Takes as input a unique prefix string and the current expiration date, in
2129 yyyy-mm-dd or m-d-yyyy format
2131 Returns an HTML fragments for expiration date selection.
2137 #if ( ref($_[0]) ) {
2141 #my $prefix = $param->{'prefix'};
2142 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2143 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2145 my $date = scalar(@_) ? shift : '';
2147 my( $m, $y ) = ( 0, 0 );
2148 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2149 ( $m, $y ) = ( $2, $1 );
2150 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2151 ( $m, $y ) = ( $1, $3 );
2153 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2155 $return .= qq!<OPTION VALUE="$_"!;
2156 $return .= " SELECTED" if $_ == $m;
2159 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2161 my $thisYear = $t[5] + 1900;
2162 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2163 $return .= qq!<OPTION VALUE="$_"!;
2164 $return .= " SELECTED" if $_ == $y;
2167 $return .= "</SELECT>";
2172 =item popselector HASHREF | LIST
2174 Takes as input a hashref or list of key/value pairs with the following keys:
2180 Access number number
2184 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>.
2188 Returns an HTML fragment for access number selection.
2192 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2200 my $popnum = $param->{'popnum'};
2201 my $pops = $param->{'pops'};
2203 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2204 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2205 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2206 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2207 if scalar(@$pops) == 1;
2210 my %popnum2pop = ();
2212 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2213 $popnum2pop{$_->{popnum}} = $_;
2218 function opt(what,href,text) {
2219 var optionName = new Option(text, href, false, false)
2220 var length = what.length;
2221 what.options[length] = optionName;
2225 my $init_popstate = $param->{'init_popstate'};
2226 if ( $init_popstate ) {
2227 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2228 $init_popstate. '">';
2231 function acstate_changed(what) {
2232 state = what.options[what.selectedIndex].text;
2233 what.form.popac.options.length = 0
2234 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2238 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2239 foreach my $state ( sort { $a cmp $b } @states ) {
2240 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2242 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2243 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2244 if ($ac eq $param->{'popac'}) {
2245 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2248 $text .= "}\n" unless $init_popstate;
2250 $text .= "popac_changed(what.form.popac)}\n";
2253 function popac_changed(what) {
2254 ac = what.options[what.selectedIndex].text;
2255 what.form.popnum.options.length = 0;
2256 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2260 foreach my $state ( @states ) {
2261 foreach my $popac ( keys %{ $pop{$state} } ) {
2262 $text .= "\nif ( ac == \"$popac\" ) {\n";
2264 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2265 my $o_popnum = $pop->{popnum};
2266 my $poptext = $pop->{city}. ', '. $pop->{state}.
2267 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2269 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2270 if ($popnum == $o_popnum) {
2271 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2279 $text .= "}\n</SCRIPT>\n";
2281 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2284 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2285 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2286 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2287 ">$_" foreach sort { $a cmp $b } @states;
2288 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2291 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2292 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2294 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2297 #comment this block to disable initial list polulation
2298 my @initial_select = ();
2299 if ( scalar( @$pops ) > 100 ) {
2300 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2302 @initial_select = @$pops;
2304 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2305 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2306 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2307 $pop->{city}. ', '. $pop->{state}.
2308 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2311 $text .= qq!</SELECT></TD></TR></TABLE>!;
2317 =item domainselector HASHREF | LIST
2319 Takes as input a hashref or list of key/value pairs with the following keys:
2329 Service number of the selected item.
2333 Returns an HTML fragment for domain selection.
2337 sub domainselector {
2344 my $domsvc= $param->{'domsvc'};
2346 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2347 my $domains = $rv->{'domains'};
2348 $domsvc = $rv->{'domsvc'} unless $domsvc;
2350 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2351 unless scalar(keys %$domains);
2353 if (scalar(keys %$domains) == 1) {
2355 foreach(keys %$domains) {
2358 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2359 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2362 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2364 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2366 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2367 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2368 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2369 $domains->{$domain};
2372 $text .= qq!</SELECT></TD></TR>!;
2378 =item didselector HASHREF | LIST
2380 Takes as input a hashref or list of key/value pairs with the following keys:
2386 Field name for the returned HTML fragment.
2390 Service definition (see L<FS::part_svc>)
2394 Returns an HTML fragment for DID selection.
2406 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2407 'args'=>[ %$param ],
2411 $rv->{'error'} || $rv->{'output'};
2417 =head1 RESELLER FUNCTIONS
2419 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2420 with their active session, and the B<customer_info> and B<order_pkg> functions
2421 with their active session and an additional I<custnum> parameter.
2423 For the most part, development of the reseller web interface has been
2424 superceded by agent-virtualized access to the backend.
2436 =item agent_list_customers
2438 List agent's customers.
2446 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>