X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=fs_selfservice%2FFS-SelfService%2FSelfService.pm;h=cbe7b72f68314e987d90f1202785f7b6c5bd13b8;hp=6e3ca3b5a445ee04b92ad29b267f63ecb52b7066;hb=7588be4eb948426b972d0238dcdbb1537dc6a72a;hpb=f7fd2a3e34da751cbc02bbf215e99c6dc89adc15 diff --git a/fs_selfservice/FS-SelfService/SelfService.pm b/fs_selfservice/FS-SelfService/SelfService.pm index 6e3ca3b5a..cbe7b72f6 100644 --- a/fs_selfservice/FS-SelfService/SelfService.pm +++ b/fs_selfservice/FS-SelfService/SelfService.pm @@ -1,7 +1,7 @@ package FS::SelfService; use strict; -use vars qw($VERSION @ISA @EXPORT_OK $socket %autoload $tag); +use vars qw($VERSION @ISA @EXPORT_OK $DEBUG $dir $socket %autoload $tag); use Exporter; use Socket; use FileHandle; @@ -13,39 +13,52 @@ $VERSION = '0.03'; @ISA = qw( Exporter ); -$socket = "/usr/local/freeside/selfservice_socket"; +$DEBUG = 0; + +$dir = "/usr/local/freeside"; +$socket = "$dir/selfservice_socket"; $socket .= '.'.$tag if defined $tag && length($tag); #maybe should ask ClientAPI for this list %autoload = ( - 'passwd' => 'passwd/passwd', - 'chfn' => 'passwd/passwd', - 'chsh' => 'passwd/passwd', - 'login' => 'MyAccount/login', - 'logout' => 'MyAccount/logout', - 'customer_info' => 'MyAccount/customer_info', - 'edit_info' => 'MyAccount/edit_info', #add to ss cgi! - 'invoice' => 'MyAccount/invoice', - 'list_invoices' => 'MyAccount/list_invoices', #? - 'cancel' => 'MyAccount/cancel', #add to ss cgi! - 'payment_info' => 'MyAccount/payment_info', - 'process_payment' => 'MyAccount/process_payment', - 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss cgi! - 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi! - 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi! - 'charge' => 'MyAccount/charge', #? - 'part_svc_info' => 'MyAccount/part_svc_info', - 'provision_acct' => 'MyAccount/provision_acct', - 'provision_external' => 'MyAccount/provision_external', - 'unprovision_svc' => 'MyAccount/unprovision_svc', - 'signup_info' => 'Signup/signup_info', - 'new_customer' => 'Signup/new_customer', - 'agent_login' => 'Agent/agent_login', - 'agent_logout' => 'Agent/agent_logout', - 'agent_info' => 'Agent/agent_info', - 'agent_list_customers' => 'Agent/agent_list_customers', + 'passwd' => 'passwd/passwd', + 'chfn' => 'passwd/passwd', + 'chsh' => 'passwd/passwd', + 'login' => 'MyAccount/login', + 'logout' => 'MyAccount/logout', + 'customer_info' => 'MyAccount/customer_info', + 'edit_info' => 'MyAccount/edit_info', #add to ss cgi! + 'invoice' => 'MyAccount/invoice', + 'invoice_logo' => 'MyAccount/invoice_logo', + 'list_invoices' => 'MyAccount/list_invoices', #? + 'cancel' => 'MyAccount/cancel', #add to ss cgi! + 'payment_info' => 'MyAccount/payment_info', + 'process_payment' => 'MyAccount/process_payment', + 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg', + 'process_prepay' => 'MyAccount/process_prepay', + 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?) + 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?) + 'list_svc_usage' => 'MyAccount/list_svc_usage', + 'list_support_usage' => 'MyAccount/list_support_usage', + 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi! + 'change_pkg' => 'MyAccount/change_pkg', + 'order_recharge' => 'MyAccount/order_recharge', + 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi! + 'charge' => 'MyAccount/charge', #? + 'part_svc_info' => 'MyAccount/part_svc_info', + 'provision_acct' => 'MyAccount/provision_acct', + 'provision_external' => 'MyAccount/provision_external', + 'unprovision_svc' => 'MyAccount/unprovision_svc', + 'myaccount_passwd' => 'MyAccount/myaccount_passwd', + 'signup_info' => 'Signup/signup_info', + 'domain_select_hash' => 'Signup/domain_select_hash', # expose? + 'new_customer' => 'Signup/new_customer', + 'agent_login' => 'Agent/agent_login', + 'agent_logout' => 'Agent/agent_logout', + 'agent_info' => 'Agent/agent_info', + 'agent_list_customers' => 'Agent/agent_list_customers', ); -@EXPORT_OK = ( keys(%autoload), qw( regionselector expselect popselector ) ); +@EXPORT_OK = ( keys(%autoload), qw( regionselector expselect popselector domainselector didselector) ); $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin'; $ENV{'SHELL'} = '/bin/sh'; @@ -57,6 +70,11 @@ $ENV{'BASH_ENV'} = ''; my $freeside_uid = scalar(getpwnam('freeside')); die "not running as the freeside user\n" if $> != $freeside_uid; +-e $dir or die "FATAL: $dir doesn't exist!"; +-d $dir or die "FATAL: $dir isn't a directory!"; +-r $dir or die "FATAL: Can't read $dir as freeside user!"; +-x $dir or die "FATAL: $dir not searchable (executable) as freeside user!"; + foreach my $autoload ( keys %autoload ) { my $eval = @@ -65,6 +83,7 @@ foreach my $autoload ( keys %autoload ) { if ( ref($_[0]) ) { $param = shift; } else { + #warn scalar(@_). ": ". join(" / ", @_); $param = { @_ }; } @@ -80,8 +99,10 @@ foreach my $autoload ( keys %autoload ) { 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: $!"; + connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!"; nstore_fd($packet, \*SOCK) or die "can't send packet: $!"; SOCK->flush; @@ -91,9 +112,16 @@ sub simple_packet { # my $w = new IO::Select; # $w->add(\*SOCK); # my @wait = $w->can_read; + + warn "reading message from server" + if $DEBUG; + my $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; } @@ -156,6 +184,10 @@ FS::SelfService - Freeside self-service API 'payby' => $payby, 'payinfo' => $payinfo, 'paycvv' => $paycvv, + 'paystart_month' => $paystart_month + 'paystart_year' => $paystart_year, + 'payissue' => $payissue, + 'payip' => $payip 'paydate' => $paydate, 'payname' => $payname, 'invoicing_list' => $invoicing_list, @@ -209,10 +241,16 @@ following keys: =item username +Username + =item domain +Domain + =item password +Password + =back Returns a hash reference with the following keys: @@ -256,7 +294,9 @@ the following keys: invnum, date, owed An HTML fragment containing shipping and billing addresses. -=item The following fields are also returned: 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 +=item The following fields are also returned + +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 =back @@ -360,14 +400,24 @@ Exact name on credit card (CARD/DCRD) =item address1 +Address line one + =item address2 +Address line two + =item city +City + =item state +State + =item zip +Zip or postal code + =item payby Customer's current default payment type. @@ -417,6 +467,12 @@ hash reference as parameter with the following keys: =item session_id +Session identifier + +=item amount + +Amount + =item save If true, address and card information entered will be saved for subsequent @@ -430,16 +486,28 @@ payby to DCRD). This option only has meaning if B is set true. =item payname +Name on card + =item address1 +Address line one + =item address2 +Address line two + =item city +City + =item state +State + =item zip +Zip or postal code + =item payinfo Card number @@ -464,7 +532,8 @@ error message on errors =item list_pkgs -Returns package information for this customer. +Returns package information for this customer. For more detail on services, +see L. Takes a hash reference as parameter with a single key: B @@ -472,6 +541,9 @@ Returns a hash reference containing customer package information. The hash refe =over 4 +=item custnum + +Customer number =item cust_pkg HASHREF @@ -479,15 +551,75 @@ Array reference of hash references, each of which has the fields of a cust_pkg record (see L) as well as the fields below. Note these are not the internal FS:: objects, but hash references of columns and values. -=item all fields of part_pkg (XXXpare this down to a secure subset) +=over 4 + +=item part_pkg fields + +All fields of part_pkg for this specific cust_pkg (be careful with this +information - it may reveal more about your available packages than you would +like users to know in aggregate) + +=cut + +#XXX pare part_pkg fields down to a more secure subset + +=item part_svc + +An array of hash references indicating information on unprovisioned services +available for provisioning for this specific cust_pkg. Each has the following +keys: + +=over 4 + +=item part_svc fields + +All fields of part_svc (be careful with this information - it may reveal more +about your available packages than you would like users to know in aggregate) + +=cut + +#XXX pare part_svc fields down to a more secure subset + +=back + +=item cust_svc -=item part_svc - An array of hash references, each of which has the following keys: +An array of hash references indicating information on the customer services +already provisioned for this specific cust_pkg. Each has the following keys: =over 4 -=item all fields of part_svc (XXXpare this down to a secure subset) +=item label + +Array reference with three elements: + +=over 4 + +=item Name of this service + +=item Meaningful user-specific identifier for the service (i.e. username, domain or mail alias) + +=item Table name of this service + +=back + +=item svcnum + +Primary key for this service + +=item svcpart + +Service definition (part_pkg) + +=item pkgnum -=item avail +Customer package (cust_pkg) + +=item overlimit + +Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp). + +=back =back @@ -497,6 +629,92 @@ Empty on success, or an error message on errors. =back +=item list_svcs + +Returns service information for this customer. + +Takes a hash reference as parameter with a single key: B + +Returns a hash reference containing customer package information. The hash reference contains the following keys: + +=over 4 + +=item custnum + +Customer number + +=item svcs + +An array of hash references indicating information on all of this customer's +services. Each has the following keys: + +=over 4 + +=item svcnum + +Primary key for this service + +=item label + +Name of this service + +=item value + +Meaningful user-specific identifier for the service (i.e. username, domain, or +mail alias). + +=back + +Account (svc_acct) services also have the following keys: + +=item username + +Username + +=item email + +username@domain + +=item seconds + +Seconds remaining + +=item upbytes + +Upload bytes remaining + +=item downbytes + +Download bytes remaining + +=item totalbytes + +Total bytes remaining + +=item recharge_amount + +Cost of a recharge + +=item recharge_seconds + +Number of seconds gained by recharge + +=item recharge_upbytes + +Number of upload bytes gained by recharge + +=item recharge_downbytes + +Number of download bytes gained by recharge + +=item recharge_totalbytes + +Number of total bytes gained by recharge + +=back + +=back + =item order_pkg Orders a package for this customer. @@ -507,8 +725,12 @@ Takes a hash reference as parameter with the following keys: =item session_id +Session identifier + =item pkgpart +pkgpart of package to order + =item svcpart optional svcpart, required only if the package definition does not contain @@ -517,12 +739,20 @@ quantity >1) =item username +Username + =item _password +Password + =item sec_phrase +Optional security phrase + =item popnum +Optional Access number number + =back Returns a hash reference with a single key, B, empty on success, or an @@ -539,8 +769,12 @@ Takes a hash reference as parameter with the following keys: =item session_id +Session identifier + =item pkgpart +pkgpart of package to cancel + =back Returns a hash reference with a single key, B, empty on success, or an @@ -599,21 +833,37 @@ Array reference of acceptable payment types for signup =over 4 -=item CARD (credit card - automatic) +=item CARD + +credit card - automatic + +=item DCRD + +credit card - on-demand - version 1.5+ only + +=item CHEK + +electronic check - automatic + +=item DCHK + +electronic check - on-demand - version 1.5+ only + +=item LECB -=item DCRD (credit card - on-demand - version 1.5+ only) +Phone bill billing -=item CHEK (electronic check - automatic) +=item BILL -=item DCHK (electronic check - on-demand - version 1.5+ only) +billing, not recommended for signups -=item LECB (Phone bill billing) +=item COMP -=item BILL (billing, not recommended for signups) +free, definitely not recommended for signups -=item COMP (free, definately not recommended for signups) +=item PREPAY -=item PREPAY (special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL) +special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL =back @@ -642,57 +892,109 @@ following keys: =over 4 -=item first - first name (required) +=item first -=item last - last name (required) +first name (required) -=item ss (not typically collected; mostly used for ACH transactions) +=item last + +last name (required) + +=item ss + +(not typically collected; mostly used for ACH transactions) =item company +Company name + =item address1 (required) +Address line one + =item address2 +Address line two + =item city (required) +City + =item county +County + =item state (required) +State + =item zip (required) -=item daytime - phone +Zip or postal code + +=item daytime + +Daytime phone number + +=item night + +Evening phone number + +=item fax -=item night - phone +Fax number -=item fax - phone +=item payby + +CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L (required) + +=item payinfo + +Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL + +=item paycvv + +Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch) -=item payby - CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L (required) +=item paydate -=item payinfo - Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL +Expiration date for CARD/DCRD -=item paycvv - Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch) +=item payname + +Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK -=item paydate - Expiration date for CARD/DCRD +=item invoicing_list -=item payname - Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK +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), -=item invoicing_list - 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), +=item referral_custnum -=item referral_custnum - referring customer number +referring customer number + +=item pkgpart -=item pkgpart - pkgpart of initial package +pkgpart of initial package =item username +Username + =item _password -=item sec_phrase - security phrase +Password + +=item sec_phrase + +Security phrase + +=item popnum + +Access number (index, not the literal number) -=item popnum - access number (index, not the literal number) +=item agentnum -=item agentnum - agent number +Agent number =back @@ -700,7 +1002,9 @@ Returns a hash reference with the following keys: =over 4 -=item error 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 Sysadmin | View/Edit message catalog) +=item error + +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) =back @@ -712,19 +1016,35 @@ Takes as input a hashref or list of key/value pairs with the following keys: =item selected_county +Currently selected county + =item selected_state +Currently selected state + =item selected_country -=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page. +Currently selected country + +=item prefix + +Specify a unique prefix string if you intend to use the HTML output multiple time son one page. + +=item onchange -=item onchange - Specify a javascript subroutine to call on changes +Specify a javascript subroutine to call on changes =item default_state +Default state + =item default_country -=item locales - An arrayref of hash references specifying regions. Normally you can just pass the value of the I field returned by B. +Default country + +=item locales + +An arrayref of hash references specifying regions. Normally you can just pass the value of the I field returned by B. =back @@ -897,15 +1217,15 @@ sub expselect { } my $return = qq!!; my @t = localtime; my $thisYear = $t[5] + 1900; - for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. 2037 ) { - $return .= " $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) { + $return .= qq!