1 package FS::SelfService;
4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
5 $skip_uid_check $dir $socket %autoload $tag );
11 use Storable 2.09 qw(nstore_fd fd_retrieve);
15 @ISA = qw( Exporter );
19 $dir = "/usr/local/freeside";
20 $socket = "$dir/selfservice_socket";
21 $socket .= '.'.$tag if defined $tag && length($tag);
23 #maybe should ask ClientAPI for this list
25 'passwd' => 'passwd/passwd',
26 'chfn' => 'passwd/passwd',
27 'chsh' => 'passwd/passwd',
28 'login_info' => 'MyAccount/login_info',
29 'login_banner_image' => 'MyAccount/login_banner_image',
30 'login' => 'MyAccount/login',
31 'logout' => 'MyAccount/logout',
32 'switch_acct' => 'MyAccount/switch_acct',
33 'customer_info' => 'MyAccount/customer_info',
34 'customer_info_short' => 'MyAccount/customer_info_short',
35 'billing_history' => 'MyAccount/billing_history',
36 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
37 'invoice' => 'MyAccount/invoice',
38 'invoice_pdf' => 'MyAccount/invoice_pdf',
39 'legacy_invoice' => 'MyAccount/legacy_invoice',
40 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
41 'invoice_logo' => 'MyAccount/invoice_logo',
42 'list_invoices' => 'MyAccount/list_invoices', #?
43 'cancel' => 'MyAccount/cancel', #add to ss cgi!
44 'payment_info' => 'MyAccount/payment_info',
45 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
46 'process_payment' => 'MyAccount/process_payment',
47 'store_payment' => 'MyAccount/store_payment',
48 'process_stored_payment' => 'MyAccount/process_stored_payment',
49 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
50 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
51 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
52 'process_prepay' => 'MyAccount/process_prepay',
53 'realtime_collect' => 'MyAccount/realtime_collect',
54 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
55 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
56 'list_svc_usage' => 'MyAccount/list_svc_usage',
57 'svc_status_html' => 'MyAccount/svc_status_html',
58 'svc_status_hash' => 'MyAccount/svc_status_hash',
59 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
60 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
61 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
62 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
63 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
64 'acct_forward_info' => 'MyAccount/acct_forward_info',
65 'process_acct_forward' => 'MyAccount/process_acct_forward',
66 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
67 'add_dsl_device' => 'MyAccount/add_dsl_device',
68 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
69 'port_graph' => 'MyAccount/port_graph',
70 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
71 'list_support_usage' => 'MyAccount/list_support_usage',
72 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
73 'change_pkg' => 'MyAccount/change_pkg',
74 'order_recharge' => 'MyAccount/order_recharge',
75 'renew_info' => 'MyAccount/renew_info',
76 'order_renew' => 'MyAccount/order_renew',
77 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
78 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
79 'charge' => 'MyAccount/charge', #?
80 'part_svc_info' => 'MyAccount/part_svc_info',
81 'provision_acct' => 'MyAccount/provision_acct',
82 'provision_phone' => 'MyAccount/provision_phone',
83 'provision_pbx' => 'MyAccount/provision_pbx',
84 'provision_external' => 'MyAccount/provision_external',
85 'unprovision_svc' => 'MyAccount/unprovision_svc',
86 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
87 'reset_passwd' => 'MyAccount/reset_passwd',
88 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
89 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
90 'list_tickets' => 'MyAccount/list_tickets',
91 'create_ticket' => 'MyAccount/create_ticket',
92 'get_ticket' => 'MyAccount/get_ticket',
93 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
94 'did_report' => 'MyAccount/did_report',
95 'signup_info' => 'Signup/signup_info',
96 'skin_info' => 'MyAccount/skin_info',
97 'access_info' => 'MyAccount/access_info',
98 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
99 'new_customer' => 'Signup/new_customer',
100 'new_customer_minimal' => 'Signup/new_customer_minimal',
101 'capture_payment' => 'Signup/capture_payment',
102 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
103 'new_agent' => 'Agent/new_agent',
104 'agent_login' => 'Agent/agent_login',
105 'agent_logout' => 'Agent/agent_logout',
106 'agent_info' => 'Agent/agent_info',
107 'agent_list_customers' => 'Agent/agent_list_customers',
108 'check_username' => 'Agent/check_username',
109 'suspend_username' => 'Agent/suspend_username',
110 'unsuspend_username' => 'Agent/unsuspend_username',
111 'mason_comp' => 'MasonComponent/mason_comp',
112 'call_time' => 'PrepaidPhone/call_time',
113 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
114 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
116 'start_thirdparty' => 'MyAccount/start_thirdparty',
117 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
119 'list_quotations' => 'MyAccount/quotation/list_quotations',
120 'quotation_new' => 'MyAccount/quotation/quotation_new',
121 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
122 'quotation_info' => 'MyAccount/quotation/quotation_info',
123 'quotation_print' => 'MyAccount/quotation/quotation_print',
124 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
125 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
126 'quotation_order' => 'MyAccount/quotation/quotation_order',
131 qw( regionselector regionselector_hashref location_form
132 expselect popselector domainselector didselector
136 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
137 $ENV{'SHELL'} = '/bin/sh';
138 $ENV{'IFS'} = " \t\n";
141 $ENV{'BASH_ENV'} = '';
143 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
144 #if you grant appropriate permissions to whatever user
145 my $freeside_uid = scalar(getpwnam('freeside'));
146 die "not running as the freeside user\n"
147 if $> != $freeside_uid && ! $skip_uid_check;
149 -e $dir or die "FATAL: $dir doesn't exist!";
150 -d $dir or die "FATAL: $dir isn't a directory!";
151 -r $dir or die "FATAL: Can't read $dir as freeside user!";
152 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
154 foreach my $autoload ( keys %autoload ) {
157 "sub $autoload { ". '
162 #warn scalar(@_). ": ". join(" / ", @_);
166 $param->{_packet} = \''. $autoload{$autoload}. '\';
168 simple_packet($param);
178 warn "sending ". $packet->{_packet}. " to server"
180 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
181 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
182 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
185 #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
187 #block until there is a message on socket
188 # my $w = new IO::Select;
190 # my @wait = $w->can_read;
192 warn "reading message from server"
195 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
196 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
198 warn "returning message to client"
206 FS::SelfService - Freeside self-service API
210 # password and shell account changes
211 use FS::SelfService qw(passwd chfn chsh);
213 # "my account" functionality
214 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
216 #new-style login with an email address and password
217 # can also be used for svc_acct login, set $emailaddress to username@domain
218 my $rv = login ( { 'email' => $emailaddress,
219 'password' => $password,
222 if ( $rv->{'error'} ) {
223 #handle login error...
226 $session_id = $rv->{'session_id'};
229 #classic svc_acct-based login with separate username and password
230 my $rv = login( { 'username' => $username,
232 'password' => $password,
235 if ( $rv->{'error'} ) {
236 #handle login error...
239 $session_id = $rv->{'session_id'};
242 #svc_phone login with phone number and PIN
243 my $rv = login( { 'username' => $phone_number,
244 'domain' => 'svc_phone',
248 if ( $rv->{'error'} ) {
249 #handle login error...
252 $session_id = $rv->{'session_id'};
255 my $customer_info = customer_info( { 'session_id' => $session_id } );
257 #payment_info and process_payment are available in 1.5+ only
258 my $payment_info = payment_info( { 'session_id' => $session_id } );
260 #!!! process_payment example
262 #!!! list_pkgs example
264 #!!! order_pkg example
266 #quoting a package, then ordering after confirmation
268 my $rv = quotation_new({ 'session_id' => $session_id });
269 my $qnum = $rv->{quotationnum};
270 # add packages to the quotation
271 $rv = quotation_add_pkg({ 'session_id' => $session_id,
272 'quotationnum' => $qnum,
273 'pkgpart' => $pkgpart,
274 'quantity' => $quantity, # defaults to 1
276 # repeat until all packages are added
277 # view the pricing information
278 $rv = quotation_info({ 'session_id' => $session_id,
279 'quotationnum' => $qnum,
281 print "Total setup charges: ".$rv->{total_setup}."\n".
282 "Total recurring charges: ".$rv->{total_recur}."\n";
283 # quotation_info also provides a detailed breakdown of charges, in
286 # ask customer for confirmation, then:
287 $rv = quotation_order({ 'session_id' => $session_id,
288 'quotationnum' => $qnum,
291 #!!! cancel_pkg example
293 # signup functionality
294 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
296 my $signup_info = signup_info;
298 $rv = new_customer( {
301 'company' => $company,
302 'address1' => $address1,
303 'address2' => $address2,
307 'country' => $country,
308 'daytime' => $daytime,
312 'payinfo' => $payinfo,
314 'paystart_month' => $paystart_month
315 'paystart_year' => $paystart_year,
316 'payissue' => $payissue,
318 'paydate' => $paydate,
319 'payname' => $payname,
320 'invoicing_list' => $invoicing_list,
321 'referral_custnum' => $referral_custnum,
322 'agentnum' => $agentnum,
323 'pkgpart' => $pkgpart,
325 'username' => $username,
326 '_password' => $password,
330 'phonenum' => $phonenum,
335 my $error = $rv->{'error'};
336 if ( $error eq '_decline' ) {
346 Use this API to implement your own client "self-service" module.
348 If you just want to customize the look of the existing "self-service" module,
351 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
357 Changes the password for an existing user in svc_acct. Takes a hash
358 reference with the following keys:
364 Username of the account (required)
368 Domain of the account (required)
372 Old password (required)
376 New password (required)
394 =head1 "MY ACCOUNT" FUNCTIONS
400 Creates a user session. Takes a hash reference as parameter with the
407 Email address (username@domain), instead of username and domain. Required for
408 contact-based self-service login, can also be used for svc_acct-based login.
424 Returns a hash reference with the following keys:
430 Empty on success, or an error message on errors.
434 Session identifier for successful logins
438 =item customer_info HASHREF
440 Returns general customer information.
442 Takes a hash reference as parameter with a single key: B<session_id>
444 Returns a hash reference with the following keys:
458 Array reference of hash references of open inoices. Each hash reference has
459 the following keys: invnum, date, owed
463 An HTML fragment containing shipping and billing addresses.
465 =item The following fields are also returned
467 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
471 =item edit_info HASHREF
473 Takes a hash reference as parameter with any of the following keys:
475 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo paycvv payname month year invoicing_list postal_invoicing
477 If a field exists, the customer record is updated with the new value of that
478 field. If a field does not exist, that field is not changed on the customer
481 Returns a hash reference with a single key, B<error>, empty on success, or an
482 error message on errors
484 =item invoice HASHREF
486 Returns an invoice. Takes a hash reference as parameter with two keys:
487 session_id and invnum
489 Returns a hash reference with the following keys:
495 Empty on success, or an error message on errors
507 =item list_invoices HASHREF
509 Returns a list of all customer invoices. Takes a hash references with a single
512 Returns a hash reference with the following keys:
518 Empty on success, or an error message on errors
522 Reference to array of hash references with the following keys:
532 Invoice date, in UNIX epoch time
540 Cancels this customer.
542 Takes a hash reference as parameter with a single key: B<session_id>
544 Returns a hash reference with a single key, B<error>, which is empty on
545 success or an error message on errors.
547 =item payment_info HASHREF
549 Returns information that may be useful in displaying a payment page.
551 Takes a hash reference as parameter with a single key: B<session_id>.
553 Returns a hash reference with the following keys:
559 Empty on success, or an error message on errors
567 Exact name on credit card (CARD/DCRD)
591 Customer's current default payment type.
595 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
599 For CARD/DCRD payment types, the card number
603 For CARD/DCRD payment types, expiration month
607 For CARD/DCRD payment types, expiration year
609 =item cust_main_county
611 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.
615 Array reference of all states in the current default country.
619 Hash reference of card types; keys are card types, values are the exact strings
620 passed to the process_payment function
624 #this doesn't actually work yet
628 #Unique transaction identifier (prevents multiple charges), passed to the
629 #process_payment function
633 =item process_payment HASHREF
635 Processes a payment and possible change of address or payment type. Takes a
636 hash reference as parameter with the following keys:
650 If true, address and card information entered will be saved for subsequent
655 If true, future credit card payments will be done automatically (sets payby to
656 CARD). If false, future credit card payments will be done on-demand (sets
657 payby to DCRD). This option only has meaning if B<save> is set true.
685 Two-letter country code
693 Card expiration month
701 #this doesn't actually work yet
705 #Unique transaction identifier, returned from the payment_info function.
706 #Prevents multiple charges.
710 Returns a hash reference with a single key, B<error>, empty on success, or an
711 error message on errors.
713 =item process_payment_order_pkg
715 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
716 payment processes sucessfully, the package is ordered. Takes a hash reference
717 as parameter with the keys of both methods.
719 Returns a hash reference with a single key, B<error>, empty on success, or an
720 error message on errors.
722 =item process_payment_change_pkg
724 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
725 payment processes sucessfully, the package is ordered. Takes a hash reference
726 as parameter with the keys of both methods.
728 Returns a hash reference with a single key, B<error>, empty on success, or an
729 error message on errors.
732 =item process_payment_order_renew
734 Combines the B<process_payment> and B<order_renew> functions in one step. If
735 the payment processes sucessfully, the renewal is processed. Takes a hash
736 reference as parameter with the keys of both methods.
738 Returns a hash reference with a single key, B<error>, empty on success, or an
739 error message on errors.
743 Returns package information for this customer. For more detail on services,
746 Takes a hash reference as parameter with a single key: B<session_id>
748 Returns a hash reference containing customer package information. The hash reference contains the following keys:
758 Empty on success, or an error message on errors.
760 =item cust_pkg HASHREF
762 Array reference of hash references, each of which has the fields of a cust_pkg
763 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
764 the internal FS:: objects, but hash references of columns and values.
768 =item part_pkg fields
770 All fields of part_pkg for this specific cust_pkg (be careful with this
771 information - it may reveal more about your available packages than you would
772 like users to know in aggregate)
776 #XXX pare part_pkg fields down to a more secure subset
780 An array of hash references indicating information on unprovisioned services
781 available for provisioning for this specific cust_pkg. Each has the following
786 =item part_svc fields
788 All fields of part_svc (be careful with this information - it may reveal more
789 about your available packages than you would like users to know in aggregate)
793 #XXX pare part_svc fields down to a more secure subset
799 An array of hash references indicating information on the customer services
800 already provisioned for this specific cust_pkg. Each has the following keys:
806 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.
812 Primary key for this service
816 Service definition (see L<FS::part_svc>)
820 Customer package (see L<FS::cust_pkg>)
824 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
832 Returns service information for this customer.
834 Takes a hash reference as parameter with a single key: B<session_id>
836 Returns a hash reference containing customer package information. The hash reference contains the following keys:
846 An array of hash references indicating information on all of this customer's
847 services. Each has the following keys:
853 Primary key for this service
861 Meaningful user-specific identifier for the service (i.e. username, domain, or
866 Account (svc_acct) services also have the following keys:
884 Upload bytes remaining
888 Download bytes remaining
892 Total bytes remaining
894 =item recharge_amount
898 =item recharge_seconds
900 Number of seconds gained by recharge
902 =item recharge_upbytes
904 Number of upload bytes gained by recharge
906 =item recharge_downbytes
908 Number of download bytes gained by recharge
910 =item recharge_totalbytes
912 Number of total bytes gained by recharge
920 Orders a package for this customer.
922 Takes a hash reference as parameter with the following keys:
932 Package to order (see L<FS::part_pkg>).
936 Quantity for this package order (default 1).
940 Optional locationnum for this package order, for existing locations.
942 Or, for new locations, pass the following fields: address1*, address2, city*,
943 county, state*, zip*, country. (* = required in this case)
955 Service to order (see L<FS::part_svc>).
957 Normally optional; required only to provision a non-svc_acct service, or if the
958 package definition does not contain one svc_acct service definition with
959 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
960 also be specified to indicate that no initial service should be provisioned.
964 Fields used when provisioning an svc_acct service:
978 Optional security phrase
982 Optional Access number number
986 Fields used when provisioning an svc_domain service:
996 Fields used when provisioning an svc_phone service:
1014 Fields used when provisioning an svc_external service:
1020 External numeric ID.
1024 External text title.
1028 Fields used when provisioning an svc_pbx service:
1042 Returns a hash reference with a single key, B<error>, empty on success, or an
1043 error message on errors. The special error '_decline' is returned for
1044 declined transactions.
1048 Changes a package for this customer.
1050 Takes a hash reference as parameter with the following keys:
1060 Existing customer package.
1064 New package to order (see L<FS::part_pkg>).
1068 Quantity for this package order (default 1).
1072 Returns a hash reference with the following keys:
1078 Empty on success, or an error message on errors.
1082 On success, the new pkgnum
1089 Provides useful info for early renewals.
1091 Takes a hash reference as parameter with the following keys:
1101 Returns a hash reference. On errors, it contains a single key, B<error>, with
1102 the error message. Otherwise, contains a single key, B<dates>, pointing to
1103 an array refernce of hash references. Each hash reference contains the
1110 (Future) Bill date. Indicates a future date for which billing could be run.
1111 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1114 =item bill_date_pretty
1116 (Future) Bill date as a human-readable string. (Convenience for display;
1117 subject to change, so best not to parse for the date.)
1121 Base amount which will be charged if renewed early as of this date.
1125 Renewal date; i.e. even-futher future date at which the customer will be paid
1126 through if the early renewal is completed with the given B<bill-date>.
1127 Specified as a integer UNIX timestamp.
1129 =item renew_date_pretty
1131 Renewal date as a human-readable string. (Convenience for display;
1132 subject to change, so best not to parse for the date.)
1136 Package that will be renewed.
1140 Expiration date of the package that will be renewed.
1142 =item expire_date_pretty
1144 Expiration date of the package that will be renewed, as a human-readable
1145 string. (Convenience for display; subject to change, so best not to parse for
1152 Renews this customer early; i.e. runs billing for this customer in advance.
1154 Takes a hash reference as parameter with the following keys:
1164 Integer date as returned by the B<renew_info> function, indicating the advance
1165 date for which to run billing.
1169 Returns a hash reference with a single key, B<error>, empty on success, or an
1170 error message on errors.
1174 Cancels a package for this customer.
1176 Takes a hash reference as parameter with the following keys:
1186 pkgpart of package to cancel
1190 Returns a hash reference with a single key, B<error>, empty on success, or an
1191 error message on errors.
1193 =item provision_acct
1195 Provisions an account (svc_acct).
1197 Takes a hash references as parameter with the following keys:
1207 pkgnum of package into which this service is provisioned
1211 svcpart or service definition to provision
1221 =item provision_phone
1223 Provisions a phone number (svc_phone).
1225 Takes a hash references as parameter with the following keys:
1235 pkgnum of package into which this service is provisioned
1239 svcpart or service definition to provision
1259 E911 Address (optional)
1265 Provisions a customer PBX (svc_pbx).
1267 Takes a hash references as parameter with the following keys:
1277 pkgnum of package into which this service is provisioned
1281 svcpart or service definition to provision
1287 =item max_extensions
1289 =item max_simultaneous
1295 =item provision_external
1297 Provisions an external service (svc_external).
1299 Takes a hash references as parameter with the following keys:
1309 pkgnum of package into which this service is provisioned
1313 svcpart or service definition to provision
1323 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1325 All of these functions require the user to be logged in, and the 'session_id'
1326 key to be included in the argument hashref.`
1330 =item list_quotations HASHREF
1332 Returns a hashref listing this customer's active self-service quotations.
1335 - 'quotations', an arrayref containing an element for each quotation.
1336 - quotationnum, the primary key
1337 - _date, the date it was started
1338 - num_pkgs, the number of packages
1339 - total_setup, the sum of setup fees
1340 - total_recur, the sum of recurring charges
1342 =item quotation_new HASHREF
1344 Creates an empty quotation and returns a hashref containing 'quotationnum',
1345 the primary key of the new quotation.
1347 =item quotation_delete HASHREF
1349 Disables (does not really delete) a quotation. Takes the following arguments:
1355 =item quotationnum - the quotation to delete
1359 Returns 'error' => a string, which will be empty on success.
1361 =item quotation_info HASHREF
1363 Returns total and detailed pricing information on a quotation.
1365 Takes the following arguments:
1371 =item quotationnum - the quotation to return
1375 Returns a hashref containing:
1377 - total_setup, the total of setup fees (and their taxes)
1378 - total_recur, the total of all recurring charges (and their taxes)
1379 - sections, an arrayref containing an element for each quotation section.
1380 - description, a line of text describing the group of charges
1381 - subtotal, the total of charges in this group (if appropriate)
1382 - detail_items, an arrayref of line items
1383 - pkgnum, the reference number of the package
1384 - description, the package name (or tax name)
1386 - amount, the amount charged
1387 If the detail item represents a subtotal, it will instead contain:
1388 - total_item: description of the subtotal
1389 - total_amount: the subtotal amount
1392 =item quotation_print HASHREF
1394 Renders the quotation as HTML or PDF. Takes the following arguments:
1400 =item quotationnum - the quotation to return
1402 =item format - 'html' or 'pdf'
1406 Returns a hashref containing 'document', the contents of the file.
1408 =item quotation_add_pkg HASHREF
1410 Adds a package to a quotation. Takes the following arguments:
1416 =item pkgpart - the package to add
1418 =item quotationnum - the quotation to add it to
1420 =item quantity - the package quantity (defaults to 1)
1422 =item address1, address2, city, state, zip, country - address fields to set
1423 the service location
1427 Returns 'error' => a string, which will be empty on success.
1429 =item quotation_remove_pkg HASHREF
1431 Removes a package from a quotation. Takes the following arguments:
1437 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1439 =item quotationnum - the quotation to remove it from
1443 Returns 'error' => a string, which will be empty on success.
1447 =item quotation_order HASHREF
1449 Converts the packages in a quotation into real packages. Takes the following
1452 Takes the following arguments:
1458 =item quotationnum - the quotation to order
1464 =head1 SIGNUP FUNCTIONS
1468 =item signup_info HASHREF
1470 Takes a hash reference as parameter with the following keys:
1474 =item session_id - Optional agent/reseller interface session
1478 Returns a hash reference containing information that may be useful in
1479 displaying a signup page. The hash reference contains the following keys:
1483 =item cust_main_county
1485 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.
1489 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
1490 an agentnum specified explicitly via reseller interface session_id in the
1495 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.
1497 =item agentnum2part_pkg
1499 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.
1503 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.
1505 =item security_phrase
1507 True if the "security_phrase" feature is enabled
1511 Array reference of acceptable payment types for signup
1517 credit card - automatic
1521 credit card - on-demand - version 1.5+ only
1525 electronic check - automatic
1529 electronic check - on-demand - version 1.5+ only
1537 billing, not recommended for signups
1541 free, definitely not recommended for signups
1545 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1551 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1555 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".
1561 =item countrydefault
1567 =item new_customer_minimal HASHREF
1569 Creates a new customer.
1571 Current differences from new_customer: An address is not required. promo_code
1572 and reg_code are not supported. If invoicing_list and _password is passed, a
1573 contact will be created with self-service access (no pkgpart or username is
1574 necessary). No initial billing is run (this may change in a future version).
1576 Takes a hash reference as parameter with the following keys:
1582 first name (required)
1586 last name (required)
1590 (not typically collected; mostly used for ACH transactions)
1622 Daytime phone number
1626 Evening phone number
1634 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1638 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1642 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1646 Expiration date for CARD/DCRD
1650 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1652 =item invoicing_list
1654 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),
1656 =item referral_custnum
1658 referring customer number
1666 pkgpart of initial package
1682 Access number (index, not the literal number)
1686 Country code (to be provisioned as a service)
1690 Phone number (to be provisioned as a service)
1698 Returns a hash reference with the following keys:
1704 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)
1708 =item new_customer HASHREF
1710 Creates a new customer. Takes a hash reference as parameter with the
1717 first name (required)
1721 last name (required)
1725 (not typically collected; mostly used for ACH transactions)
1731 =item address1 (required)
1739 =item city (required)
1747 =item state (required)
1751 =item zip (required)
1757 Daytime phone number
1761 Evening phone number
1769 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1773 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1777 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1781 Expiration date for CARD/DCRD
1785 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1787 =item invoicing_list
1789 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),
1791 =item referral_custnum
1793 referring customer number
1801 pkgpart of initial package
1817 Access number (index, not the literal number)
1821 Country code (to be provisioned as a service)
1825 Phone number (to be provisioned as a service)
1833 Returns a hash reference with the following keys:
1839 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)
1843 =item regionselector HASHREF | LIST
1845 Takes as input a hashref or list of key/value pairs with the following keys:
1849 =item selected_county
1851 Currently selected county
1853 =item selected_state
1855 Currently selected state
1857 =item selected_country
1859 Currently selected country
1863 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
1867 Specify a javascript subroutine to call on changes
1873 =item default_country
1879 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>.
1883 Returns a list consisting of three HTML fragments for county selection,
1884 state selection and country selection, respectively.
1888 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
1889 sub regionselector {
1896 $param->{'selected_country'} ||= $param->{'default_country'};
1897 $param->{'selected_state'} ||= $param->{'default_state'};
1899 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
1903 my %cust_main_county;
1905 # unless ( @cust_main_county ) { #cache
1906 #@cust_main_county = qsearch('cust_main_county', {} );
1907 #foreach my $c ( @cust_main_county ) {
1908 foreach my $c ( @{ $param->{'locales'} } ) {
1909 #$countyflag=1 if $c->county;
1910 $countyflag=1 if $c->{county};
1911 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
1912 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
1913 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
1916 $countyflag=1 if $param->{selected_county};
1918 my $script_html = <<END;
1920 function opt(what,value,text) {
1921 var optionName = new Option(text, value, false, false);
1922 var length = what.length;
1923 what.options[length] = optionName;
1925 function ${prefix}country_changed(what) {
1926 country = what.options[what.selectedIndex].text;
1927 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
1928 what.form.${prefix}state.options[i] = null;
1930 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
1932 foreach my $country ( sort keys %cust_main_county ) {
1933 $script_html .= "\nif ( country == \"$country\" ) {\n";
1934 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1935 my $text = $state || '(n/a)';
1936 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
1938 $script_html .= "}\n";
1941 $script_html .= <<END;
1943 function ${prefix}state_changed(what) {
1946 if ( $countyflag ) {
1947 $script_html .= <<END;
1948 state = what.options[what.selectedIndex].text;
1949 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
1950 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
1951 what.form.${prefix}county.options[i] = null;
1954 foreach my $country ( sort keys %cust_main_county ) {
1955 $script_html .= "\nif ( country == \"$country\" ) {\n";
1956 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
1957 $script_html .= "\nif ( state == \"$state\" ) {\n";
1958 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
1959 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
1960 my $text = $county || '(n/a)';
1962 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
1964 $script_html .= "}\n";
1966 $script_html .= "}\n";
1970 $script_html .= <<END;
1975 my $county_html = $script_html;
1976 if ( $countyflag ) {
1977 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
1978 foreach my $county (
1979 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
1981 my $text = $county || '(n/a)';
1982 $county_html .= qq!<OPTION VALUE="$county"!.
1983 ($county eq $param->{'selected_county'} ?
1990 $county_html .= '</SELECT>';
1993 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
1996 my $state_html = qq!<SELECT NAME="${prefix}state" !.
1997 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
1998 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
1999 my $text = $state || '(n/a)';
2000 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2001 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
2003 $state_html .= '</SELECT>';
2005 my $country_html = '';
2006 if ( scalar( keys %cust_main_county ) > 1 ) {
2008 $country_html = qq(<SELECT NAME="${prefix}country" ).
2009 qq(onChange="${prefix}country_changed(this); ).
2010 $param->{'onchange'}.
2013 my $countrydefault = $param->{default_country} || 'US';
2014 foreach my $country (
2015 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2016 keys %cust_main_county
2018 my $selected = $country eq $param->{'selected_country'}
2021 $country_html .= "\n<OPTION$selected>$country</OPTION>"
2023 $country_html .= '</SELECT>';
2026 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2027 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2031 ($county_html, $state_html, $country_html);
2035 sub regionselector_hashref {
2036 my ($county_html, $state_html, $country_html) = regionselector(@_);
2038 'county_html' => $county_html,
2039 'state_html' => $state_html,
2040 'country_html' => $country_html,
2044 =item location_form HASHREF | LIST
2046 Takes as input a hashref or list of key/value pairs with the following keys:
2052 Current customer session_id
2056 Omit red asterisks from required fields.
2058 =item address1_label
2060 Label for first address line.
2064 Returns an HTML fragment for a location form (address, city, state, zip,
2077 my $session_id = delete $param->{'session_id'};
2079 my $rv = mason_comp( 'session_id' => $session_id,
2080 'comp' => '/elements/location.html',
2081 'args' => [ %$param ],
2085 $rv->{'error'} || $rv->{'output'};
2090 #=item expselect HASHREF | LIST
2092 #Takes as input a hashref or list of key/value pairs with the following keys:
2096 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2098 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2102 =item expselect PREFIX [ DATE ]
2104 Takes as input a unique prefix string and the current expiration date, in
2105 yyyy-mm-dd or m-d-yyyy format
2107 Returns an HTML fragments for expiration date selection.
2113 #if ( ref($_[0]) ) {
2117 #my $prefix = $param->{'prefix'};
2118 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2119 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2121 my $date = scalar(@_) ? shift : '';
2123 my( $m, $y ) = ( 0, 0 );
2124 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2125 ( $m, $y ) = ( $2, $1 );
2126 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2127 ( $m, $y ) = ( $1, $3 );
2129 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2131 $return .= qq!<OPTION VALUE="$_"!;
2132 $return .= " SELECTED" if $_ == $m;
2135 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2137 my $thisYear = $t[5] + 1900;
2138 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2139 $return .= qq!<OPTION VALUE="$_"!;
2140 $return .= " SELECTED" if $_ == $y;
2143 $return .= "</SELECT>";
2148 =item popselector HASHREF | LIST
2150 Takes as input a hashref or list of key/value pairs with the following keys:
2156 Access number number
2160 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>.
2164 Returns an HTML fragment for access number selection.
2168 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2176 my $popnum = $param->{'popnum'};
2177 my $pops = $param->{'pops'};
2179 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2180 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2181 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2182 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2183 if scalar(@$pops) == 1;
2186 my %popnum2pop = ();
2188 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2189 $popnum2pop{$_->{popnum}} = $_;
2194 function opt(what,href,text) {
2195 var optionName = new Option(text, href, false, false)
2196 var length = what.length;
2197 what.options[length] = optionName;
2201 my $init_popstate = $param->{'init_popstate'};
2202 if ( $init_popstate ) {
2203 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2204 $init_popstate. '">';
2207 function acstate_changed(what) {
2208 state = what.options[what.selectedIndex].text;
2209 what.form.popac.options.length = 0
2210 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2214 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2215 foreach my $state ( sort { $a cmp $b } @states ) {
2216 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2218 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2219 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2220 if ($ac eq $param->{'popac'}) {
2221 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2224 $text .= "}\n" unless $init_popstate;
2226 $text .= "popac_changed(what.form.popac)}\n";
2229 function popac_changed(what) {
2230 ac = what.options[what.selectedIndex].text;
2231 what.form.popnum.options.length = 0;
2232 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2236 foreach my $state ( @states ) {
2237 foreach my $popac ( keys %{ $pop{$state} } ) {
2238 $text .= "\nif ( ac == \"$popac\" ) {\n";
2240 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2241 my $o_popnum = $pop->{popnum};
2242 my $poptext = $pop->{city}. ', '. $pop->{state}.
2243 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2245 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2246 if ($popnum == $o_popnum) {
2247 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2255 $text .= "}\n</SCRIPT>\n";
2257 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2260 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2261 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2262 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2263 ">$_" foreach sort { $a cmp $b } @states;
2264 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2267 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2268 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2270 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2273 #comment this block to disable initial list polulation
2274 my @initial_select = ();
2275 if ( scalar( @$pops ) > 100 ) {
2276 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2278 @initial_select = @$pops;
2280 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2281 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2282 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2283 $pop->{city}. ', '. $pop->{state}.
2284 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2287 $text .= qq!</SELECT></TD></TR></TABLE>!;
2293 =item domainselector HASHREF | LIST
2295 Takes as input a hashref or list of key/value pairs with the following keys:
2305 Service number of the selected item.
2309 Returns an HTML fragment for domain selection.
2313 sub domainselector {
2320 my $domsvc= $param->{'domsvc'};
2322 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2323 my $domains = $rv->{'domains'};
2324 $domsvc = $rv->{'domsvc'} unless $domsvc;
2326 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2327 unless scalar(keys %$domains);
2329 if (scalar(keys %$domains) == 1) {
2331 foreach(keys %$domains) {
2334 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2335 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2338 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2340 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2342 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2343 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2344 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2345 $domains->{$domain};
2348 $text .= qq!</SELECT></TD></TR>!;
2354 =item didselector HASHREF | LIST
2356 Takes as input a hashref or list of key/value pairs with the following keys:
2362 Field name for the returned HTML fragment.
2366 Service definition (see L<FS::part_svc>)
2370 Returns an HTML fragment for DID selection.
2382 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2383 'args'=>[ %$param ],
2387 $rv->{'error'} || $rv->{'output'};
2393 =head1 RESELLER FUNCTIONS
2395 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2396 with their active session, and the B<customer_info> and B<order_pkg> functions
2397 with their active session and an additional I<custnum> parameter.
2399 For the most part, development of the reseller web interface has been
2400 superceded by agent-virtualized access to the backend.
2412 =item agent_list_customers
2414 List agent's customers.
2422 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>