X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=fs_selfservice%2FFS-SelfService%2FSelfService.pm;h=a516a97199f6df38cf5a7a9fb780be0d7ffa7229;hb=0b9b6fcb36c8d69e4d8f900449ed29f19c5ca55d;hp=3be4ebd8b741ee533adf319640ff1c7e9dab9c50;hpb=a2ecb1cf6a6c084c521710f1256da082f70ba9e5;p=freeside.git diff --git a/fs_selfservice/FS-SelfService/SelfService.pm b/fs_selfservice/FS-SelfService/SelfService.pm index 3be4ebd8b..a516a9719 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,7 @@ $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', @@ -48,6 +50,8 @@ $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', @@ -64,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', @@ -194,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 @@ -271,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 @@ -508,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: @@ -575,6 +633,73 @@ 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 @@ -712,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: @@ -991,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. @@ -2100,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