X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=fs_selfservice%2FFS-SelfService%2FSelfService.pm;h=af989ed8a420351bdf45b42b5141c92f61cf6f99;hp=847222d72d21c26f969be5c62df8e0d6f63a1956;hb=f5481d63043954fa6fa8a34a5820b23408192f8b;hpb=3846acae1c2a7ecb275e400cf3802ada6bc89ed2 diff --git a/fs_selfservice/FS-SelfService/SelfService.pm b/fs_selfservice/FS-SelfService/SelfService.pm index 847222d72..af989ed8a 100644 --- a/fs_selfservice/FS-SelfService/SelfService.pm +++ b/fs_selfservice/FS-SelfService/SelfService.pm @@ -9,6 +9,7 @@ use FileHandle; #use IO::Handle; use IO::Select; use Storable 2.09 qw(nstore_fd fd_retrieve); +use Time::HiRes; $VERSION = '0.03'; @@ -33,6 +34,14 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'switch_cust' => 'MyAccount/switch_cust', 'customer_info' => 'MyAccount/customer_info', 'customer_info_short' => 'MyAccount/customer_info_short', + 'customer_recurring' => 'MyAccount/customer_recurring', + + 'contact_passwd' => 'MyAccount/contact/contact_passwd', + 'list_contacts' => 'MyAccount/contact/list_contacts', + 'edit_contact' => 'MyAccount/contact/edit_contact', + 'delete_contact' => 'MyAccount/contact/delete_contact', + 'new_contact' => 'MyAccount/contact/new_contact', + 'billing_history' => 'MyAccount/billing_history', 'edit_info' => 'MyAccount/edit_info', #add to ss cgi! 'invoice' => 'MyAccount/invoice', @@ -41,6 +50,12 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf', 'invoice_logo' => 'MyAccount/invoice_logo', 'list_invoices' => 'MyAccount/list_invoices', #? + 'list_payments' => 'MyAccount/list_payments', + 'payment_receipt' => 'MyAccount/payment_receipt', + 'list_payby' => 'MyAccount/list_payby', + 'insert_payby' => 'MyAccount/insert_payby', + 'update_payby' => 'MyAccount/update_payby', + 'delete_payby' => 'MyAccount/delete_payby', 'cancel' => 'MyAccount/cancel', #add to ss cgi! 'payment_info' => 'MyAccount/payment_info', 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info', @@ -53,6 +68,7 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'process_prepay' => 'MyAccount/process_prepay', 'realtime_collect' => 'MyAccount/realtime_collect', 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?) + 'pkg_info' => 'MyAccount/pkg_info', 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?) 'list_svc_usage' => 'MyAccount/list_svc_usage', 'svc_status_html' => 'MyAccount/svc_status_html', @@ -89,6 +105,7 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'reset_passwd' => 'MyAccount/reset_passwd', 'check_reset_passwd' => 'MyAccount/check_reset_passwd', 'process_reset_passwd' => 'MyAccount/process_reset_passwd', + 'validate_passwd' => 'MyAccount/validate_passwd', 'list_tickets' => 'MyAccount/list_tickets', 'create_ticket' => 'MyAccount/create_ticket', 'get_ticket' => 'MyAccount/get_ticket', @@ -101,6 +118,7 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'new_customer' => 'Signup/new_customer', 'new_customer_minimal' => 'Signup/new_customer_minimal', 'capture_payment' => 'Signup/capture_payment', + 'new_prospect' => 'Signup/new_prospect', #N/A 'clear_signup_cache' => 'Signup/clear_cache', 'new_agent' => 'Agent/new_agent', 'agent_login' => 'Agent/agent_login', @@ -127,6 +145,8 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg', 'quotation_order' => 'MyAccount/quotation/quotation_order', + 'freesideinc_service' => 'Freeside/freesideinc_service', + ); @EXPORT_OK = ( keys(%autoload), @@ -179,28 +199,57 @@ sub simple_packet { my $packet = shift; warn "sending ". $packet->{_packet}. " to server" if $DEBUG; - socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!"; - connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!"; - nstore_fd($packet, \*SOCK) or die "can't send packet: $!"; - SOCK->flush; - #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 + # Retry socket operation 5 times per second + # until successful or $max_retry + my $max_retry = 25; + my $sock_timeout = 5; + my $enable_sock_timeout = 0; - #block until there is a message on socket -# my $w = new IO::Select; -# $w->add(\*SOCK); -# my @wait = $w->can_read; + for my $try ( 1..$max_retry ) { + local $@; - warn "reading message from server" - if $DEBUG; + my $return; - my $return = fd_retrieve(\*SOCK) or die "error reading result: $!"; - die $return->{'_error'} if defined $return->{_error} && $return->{_error}; + eval { + local $SIG{ALRM} = sub{die "socket $socket: timeout ${sock_timeout}s"}; + alarm $sock_timeout + if $enable_sock_timeout; - warn "returning message to client" - if $DEBUG; + socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!"; + connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!"; + nstore_fd($packet, \*SOCK) or die "can't send packet: $!"; + SOCK->flush; - $return; + # 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 + # block until there is a message on socket + # my $w = new IO::Select; + # $w->add(\*SOCK); + # my @wait = $w->can_read; + + warn "reading message from server" + if $DEBUG; + + $return = fd_retrieve(\*SOCK) or die "error reading result: $!"; + die $return->{'_error'} if defined $return->{_error} && $return->{_error}; + + warn "returning message to client" + if $DEBUG; + + return $return; + }; + + return $return + unless $@; + + die "(Attempt $try) $@" + if $try == $max_retry; + + warn "(Attempt $try) $@" + if $DEBUG; + + Time::HiRes::sleep(0.2); + } } =head1 NAME @@ -256,7 +305,6 @@ FS::SelfService - Freeside self-service API my $customer_info = customer_info( { 'session_id' => $session_id } ); - #payment_info and process_payment are available in 1.5+ only my $payment_info = payment_info( { 'session_id' => $session_id } ); #!!! process_payment example @@ -493,6 +541,31 @@ first last company address1 address2 city county state zip country daytime night =back +=item customer_recurring HASHREF + +Takes a hash reference as parameter with a single key B +or keys B and B. + +Returns a hash reference with the keys error, custnum and display_recurring. + +display_recurring is an arrayref of hashrefs with the following keys: + +=over 4 + +=item freq + +frequency of charge, in months unless units are specified + +=item freq_pretty + +frequency of charge, suitable for display + +=item amount + +amount charged at this frequency + +=back + =item edit_info HASHREF Takes a hash reference as parameter with any of the following keys: @@ -531,7 +604,7 @@ Invoice text =item list_invoices HASHREF -Returns a list of all customer invoices. Takes a hash references with a single +Returns a list of all customer invoices. Takes a hash reference with a single key, session_id. Returns a hash reference with the following keys: @@ -560,6 +633,197 @@ Invoice date, in UNIX epoch time =back +=item list_payments HASHREF + +Returns a list of all customer payments. Takes a hash reference with a single +key, session_id. + +Returns a hash reference with the following keys: + +=over 4 + +=item error + +Empty on success, or an error message on errors + +=item payments + +Reference to array of hash references with the following keys: + +=over 4 + +=item paynum + +Payment # + +=item _date + +Payument date, in UNIX epoch time + +=item date + +Payment date, in a human-readable format + +=item date_short + +Payment date, in a shorter human-readable format + +=item paid + +Amount paid + +=item payby + +Payment method: CARD, CHEK (electronic check), or BILL (physical check). + +=item paycardtype + +Payment card type + +=item paymask + +Payment card mask + +=item processor + +Processor for cards and electronic checks + +=item auth + +Authorization number + +=item order_number + +Order number + +=back + +=back + +=item list_payby HASHREF + +Returns a list of all stored customer payment information (credit cards and +electronic check accounts). Takes a hash reference with a single key, +session_id. + +Returns a hash reference with the following keys: + +=over 4 + +=item error + +Empty on success, or an error message on errors + +=item payby + +Reference to array of hash references with the following keys: + +=over 4 + +=item custpaybynum + +=item weight + +Numeric weighting. Stored payment information with a lower weight is attempted +first. + +=item payby + +CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD +(on-demand credit card) or DCHK (on-demand electronic check). + +=item paymask + +Masked credit card number (or, masked account and routing numbers) + +=item paydate + +Credit card expiration date + +=item payname + +Exact name on card (or bank name, for electronic checks) + +=item paystate + +For electronic checks, bank state + +=item paytype + +For electronic checks, account type (Personal/Business, Checking/Savings) + +=back + +=back + +=item insert_payby HASHREF + +Adds new stored payment information for this customer. Takes a hash reference +with the following keys: + +=over 4 + +=item session_id + +=item weight + +Numeric weighting. Stored payment information with a lower weight is attempted +first. + +=item payby + +CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD +(on-demand credit card) or DCHK (on-demand electronic check). + +=item payinfo + +Credit card number (or electronic check "account@routing") + +=item paycvv + +CVV2 number / security code + +=item paydate + +Credit card expiration date + +=item payname + +Exact name on card (or bank name, for electronic checks) + +=item paystate + +For electronic checks, bank state + +=item paytype + +For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A + +=item payip + +Optional IP address from which payment was submitted + +=back + +If there is an error, returns a hash reference with a single key, B, +otherwise returns a hash reference with a single key, B. + +=item update_payby HASHREF + +Updates stored payment information. Takes a hash reference with the same +keys as insert_payby, as well as B to specify which record +to update. All keys except B and B are optional; +if omitted, the previous values in the record will be preserved. + +If there is an error, returns a hash reference with a single key, B, +otherwise returns a hash reference with a single key, B. + +=item delete_payby HASHREF + +Removes stored payment information. Takes a hash reference with two keys, +B and B. Returns a hash reference with a single key, +B, which is an error message or empty for successful removal. + =item cancel HASHREF Cancels this customer. @@ -573,7 +837,21 @@ success or an error message on errors. Returns information that may be useful in displaying a payment page. -Takes a hash reference as parameter with a single key: B. +Takes a hash reference as parameter with the following keys: + +=over 4 + +=item session_id + +Required session ID + +=item payment_payby + +=item omit_cust_main_county + +Optional, pass a true value to omit cust_main_county data for performance. + +=back Returns a hash reference with the following keys: @@ -852,6 +1130,46 @@ Blank if the service is not over limit, or the date the service exceeded its usa =back +=item pkg_info + +Returns package information for package. + +Takes a hash reference as parameter with the following keys: + +=over 4 + +=item session_id + +Session identifier + +=item pkgnum + +Package Number + +=back + +Returns a hash reference containing customer package information. The hash reference contains the following keys: + +=over 4 + +=item pkg_label + +Name of this package + +=item pkgpart + +Part package primary key + +=item classnum + +Package class number + +=item error + +error message if errror. + +=back + =item list_svcs Returns service information for this customer. @@ -944,6 +1262,10 @@ Number of total bytes gained by recharge Orders a package for this customer. +If signup_server-realtime is set, bills the new package, attemps to collect +payment and (for auto-payment customers) cancels the package if the payment is +declined. + Takes a hash reference as parameter with the following keys: =over 4 @@ -960,6 +1282,11 @@ Package to order (see L). Quantity for this package order (default 1). +=item run_bill_events + +If true, runs billing events for the customer after ordering and billing the +package (signup_server-realtime must be set). + =item locationnum Optional locationnum for this package order, for existing locations. @@ -967,13 +1294,22 @@ Optional locationnum for this package order, for existing locations. Or, for new locations, pass the following fields: address1*, address2, city*, county, state*, zip*, country. (* = required in this case) +(None of this is required at all if you are just ordering a package +at the customer's existing default service location.) + =item address1 -=item address 2 +=item address2 =item city -=item +=item county + +=item state + +=item zip + +=item country =item svcpart @@ -1133,7 +1469,7 @@ following keys: =item bill_date (Future) Bill date. Indicates a future date for which billing could be run. -Specified as a integer UNIX timestamp. Pass this value to the B +Specified as an integer UNIX timestamp. Pass this value to the B function. =item bill_date_pretty @@ -1149,7 +1485,7 @@ Base amount which will be charged if renewed early as of this date. Renewal date; i.e. even-futher future date at which the customer will be paid through if the early renewal is completed with the given B. -Specified as a integer UNIX timestamp. +Specified as an integer UNIX timestamp. =item renew_date_pretty @@ -1210,6 +1546,11 @@ Session identifier pkgpart of package to cancel +=item date + +Optional date, for future cancellation (expiration) instead of immediate +cancellation. Specified as an integer UNIX timestamp ("epoch time"). + =back Returns a hash reference with a single key, B, empty on success, or an @@ -1219,7 +1560,7 @@ error message on errors. Provisions an account (svc_acct). -Takes a hash references as parameter with the following keys: +Takes a hash reference as parameter with the following keys: =over 4 @@ -1247,7 +1588,7 @@ svcpart or service definition to provision Provisions a phone number (svc_phone). -Takes a hash references as parameter with the following keys: +Takes a hash reference as parameter with the following keys: =over 4 @@ -1289,7 +1630,7 @@ E911 Address (optional) Provisions a customer PBX (svc_pbx). -Takes a hash references as parameter with the following keys: +Takes a hash reference as parameter with the following keys: =over 4 @@ -1321,7 +1662,7 @@ svcpart or service definition to provision Provisions an external service (svc_external). -Takes a hash references as parameter with the following keys: +Takes a hash reference as parameter with the following keys: =over 4 @@ -1345,6 +1686,148 @@ svcpart or service definition to provision =back +=head2 "MY ACCOUNT" CONTACT FUNCTIONS + +=over 4 + +=item contact_passwd + +Changes the password for the currently-logged in contact. + +Takes a hash reference as parameter with the following keys: + +=over 4 + +=item session_id + +=item new_password + +=back + +Returns a hash reference with a single parameter, B, which contains an +error message, or empty on success. + +=item list_contacts + +Takes a hash reference as parameter with a single key, B. + +Returns a hash reference with two parameters: B, which contains an error +message, or empty on success, and B, a list of contacts. + +B is an array reference of hash references (i.e. an array of structs, + in XML-RPC). Each hash reference (struct) has the following keys: + +=over 4 + +=item contactnum + +=item class + +Contact class name (contact type). + +=item first + +First name + +=item last + +Last name + +=item title + +Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.") + +=item emailaddress + +Comma-separated list of email addresses + +=item comment + +=item selfservice_access + +Y when enabled + +=back + +=item edit_contact + +Updates information for the currently-logged in contact, or (optionally) the +specified contact. + +Takes a hash reference as parameter with the following keys: + +=over 4 + +=item session_id + +=item contactnum + +If already logged in as a contact, this is optional. + +=item first + +=item last + +=item emailaddress + +=back + +Returns a hash reference with a single parameter, B, which contains an +error message, or empty on success. + +=item new_contact + +Creates a new contact. + +Takes a hash reference as parameter with the following keys: + +=over 4 + +=item session_id + +=item first + +=item last + +=item emailaddress + +=item classnum + +Optional contact classnum (TODO: or name) + +=item comment + +=item selfservice_access + +Y to enable self-service access + +=item _password + +=back + +Returns a hash reference with a single parameter, B, which contains an +error message, or empty on success. + +=item delete_contact + +Deletes a contact. (Note: Cannot at this time delete the currently-logged in +contact.) + +Takes a hash reference as parameter with the following keys: + +=over 4 + +=item session_id + +=item contactnum + +=back + +Returns a hash reference with a single parameter, B, which contains an +error message, or empty on success. + +=back + =head2 "MY ACCOUNT" QUOTATION FUNCTIONS All of these functions require the user to be logged in, and the 'session_id' @@ -1357,12 +1840,33 @@ key to be included in the argument hashref.` Returns a hashref listing this customer's active self-service quotations. Contents are: -- 'quotations', an arrayref containing an element for each quotation. - - quotationnum, the primary key - - _date, the date it was started - - num_pkgs, the number of packages - - total_setup, the sum of setup fees - - total_recur, the sum of recurring charges +=over 4 + +=item quotations + +an arrayref containing an element for each quotation. + +=item quotationnum + +the primary key + +=item _date + +the date it was started + +=item num_pkgs + +the number of packages + +=item total_setup + +the sum of setup fees + +=item total_recur + +the sum of recurring charges + +=back =item quotation_new HASHREF @@ -1467,8 +1971,6 @@ Removes a package from a quotation. Takes the following arguments: Returns 'error' => a string, which will be empty on success. -=back - =item quotation_order HASHREF Converts the packages in a quotation into real packages. Takes the following @@ -1777,6 +2279,21 @@ State Zip or postal code +=item ship_address1 + +=item ship_address2 + +=item ship_city + +=item ship_county + +=item ship_state + +=item ship_zip + +Optional shipping address fields. If sending an optional shipping address, +ship_address1, ship_city, ship_state and ship_zip are required. + =item daytime Daytime phone number @@ -1923,7 +2440,10 @@ sub regionselector { my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : ''; - my $countyflag = 0; + my $disabled = $param->{'disabled'}; + + my $countyflag = $param->{selected_county} ? 1 : 0; + my $cityflag = $param->{selected_city} ? 1 : 0; my %cust_main_county; @@ -1933,17 +2453,17 @@ sub regionselector { foreach my $c ( @{ $param->{'locales'} } ) { #$countyflag=1 if $c->county; $countyflag=1 if $c->{county}; + $cityflag=1 if ($c->{city} && $cityflag); #push @{$cust_main_county{$c->country}{$c->state}}, $c->county; #$cust_main_county{$c->country}{$c->state}{$c->county} = 1; - $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1; + $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}}{$c->{city}} = 1; } # } - $countyflag=1 if $param->{selected_county}; my $script_html = < - function opt(what,value,text) { - var optionName = new Option(text, value, false, false); + function opt(what,value,text,selected) { + var optionName = new Option(text, value, false, selected); var length = what.length; what.options[length] = optionName; } @@ -1983,8 +2503,37 @@ END #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) { foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) { my $text = $county || '(n/a)'; - $script_html .= - qq!opt(what.form.${prefix}county, "$county", "$text");\n!; + if (!$county) { + if ( $cityflag) { + $script_html .= qq!what.form.${prefix}city.style.display='';\n + what.form.${prefix}city_select.style.display='none';\n! + } + $script_html .= qq!opt(what.form.${prefix}county, "$county", "$text");\n! + #$script_html .= qq!what.form.${prefix}county.style.display='none';\n! + } + else { + $script_html .= qq!var countySelected = false; if ("$param->{selected_county}" == "$text") { countySelected = true; }\n + opt(what.form.${prefix}county, "$county", "$text", countySelected);\n + what.form.${prefix}county.style.display='';\n + county = what.form.${prefix}county.options[what.form.${prefix}county.selectedIndex].text;\n!; + if ( $cityflag) { + $script_html .= qq!\nif ( county == \"$county\" ) {\n!; + foreach my $city ( sort keys %{$cust_main_county{$country}{$state}{$county}} ) { + my $text = $city || '(n/a)'; + if (!$city) { + $script_html .= qq!what.form.${prefix}city.style.display='';\n + what.form.${prefix}city_select.style.display='none';\n! + } + else { + $script_html .= qq!var citySelected = false; if ("$param->{selected_city}" == "$text") { citySelected = true; }\n + opt(what.form.${prefix}city_select, "$city", "$text", citySelected);\n + what.form.${prefix}city.style.display='none';\n + what.form.${prefix}city_select.style.display='';\n! + } + } + $script_html .= "}\n"; + } + } } $script_html .= "}\n"; } @@ -1994,12 +2543,89 @@ END $script_html .= <= 0; i-- ) + what.form.${prefix}city_select.options[i] = null; +END + + foreach my $country ( sort keys %cust_main_county ) { + $script_html .= "\nif ( country == \"$country\" ) {\n"; + foreach my $state ( sort keys %{$cust_main_county{$country}} ) { + $script_html .= "\nif ( state == \"$state\" ) {\n"; + #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) { + foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) { + $script_html .= "\nif ( county == \"$county\" ) {\n"; + foreach my $city ( sort keys %{$cust_main_county{$country}{$state}{$county}} ) { + my $text = $city || '(n/a)'; + if (!$city) { + $script_html .= qq!what.form.${prefix}city.style.display='';\n + what.form.${prefix}city_select.style.display='none';\n! + } + else { + $script_html .= qq!var citySelected = false; if (saved_city == "$text") { citySelected = true; }\n + opt(what.form.${prefix}city_select, "$city", "$text", citySelected);\n + what.form.${prefix}city.style.display='none';\n + what.form.${prefix}city_select.style.display='';\n! + } + } + $script_html .= "}\n"; + } + $script_html .= "}\n"; + } + $script_html .= "}\n"; + } + } + + $script_html .= < END + my $city_html = ''; + if ( $cityflag ) { + if ( scalar (keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}}{$param->{'selected_county'}} }) > 1 ) { + $city_html .= qq!!; + } else { + $city_html .= qq! + !; + } + } + my $county_html = $script_html; if ( $countyflag ) { - $county_html .= qq!!; foreach my $county ( sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} } ) { @@ -2053,7 +2679,7 @@ END } - ($county_html, $state_html, $country_html); + ($county_html, $state_html, $country_html, $city_html); }