X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=fs_selfservice%2FFS-SelfService%2FSelfService.pm;h=3ede27cd9d0dda94976b60d7d770ef5eaed63020;hp=66037d162906650074d848eb006c17fb0cb4bae2;hb=32db3ad86bcf04e4f34705a396b718061d333f20;hpb=a0089f91a0d228b3f80d4e5d73cec93948813b1b diff --git a/fs_selfservice/FS-SelfService/SelfService.pm b/fs_selfservice/FS-SelfService/SelfService.pm index 66037d162..3ede27cd9 100644 --- a/fs_selfservice/FS-SelfService/SelfService.pm +++ b/fs_selfservice/FS-SelfService/SelfService.pm @@ -16,10 +16,6 @@ $VERSION = '0.03'; $DEBUG = 0; -#you can add BEGIN { $FS::SelfService::skip_uid_check = 1; } -#if you grant appropriate permissions to whatever user -$skip_uid_check = 0; - $dir = "/usr/local/freeside"; $socket = "$dir/selfservice_socket"; $socket .= '.'.$tag if defined $tag && length($tag); @@ -29,6 +25,7 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'passwd' => 'passwd/passwd', 'chfn' => 'passwd/passwd', 'chsh' => 'passwd/passwd', + 'login_info' => 'MyAccount/login_info', 'login' => 'MyAccount/login', 'logout' => 'MyAccount/logout', 'customer_info' => 'MyAccount/customer_info', @@ -40,7 +37,9 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'payment_info' => 'MyAccount/payment_info', 'process_payment' => 'MyAccount/process_payment', 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg', + 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew', 'process_prepay' => 'MyAccount/process_prepay', + 'realtime_collect' => 'MyAccount/realtime_collect', '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', @@ -48,6 +47,8 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi! 'change_pkg' => 'MyAccount/change_pkg', 'order_recharge' => 'MyAccount/order_recharge', + 'renew_info' => 'MyAccount/renew_info', + 'order_renew' => 'MyAccount/order_renew', 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi! 'charge' => 'MyAccount/charge', #? 'part_svc_info' => 'MyAccount/part_svc_info', @@ -58,16 +59,21 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'signup_info' => 'Signup/signup_info', 'domain_select_hash' => 'Signup/domain_select_hash', # expose? 'new_customer' => 'Signup/new_customer', + 'capture_payment' => 'Signup/capture_payment', 'agent_login' => 'Agent/agent_login', 'agent_logout' => 'Agent/agent_logout', 'agent_info' => 'Agent/agent_info', 'agent_list_customers' => 'Agent/agent_list_customers', 'mason_comp' => 'MasonComponent/mason_comp', 'call_time' => 'PrepaidPhone/call_time', - 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa' - 'phonenum_balance' => 'PrepaidPhone/phonenum_balance' + 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa', + 'phonenum_balance' => 'PrepaidPhone/phonenum_balance', +); +@EXPORT_OK = ( + keys(%autoload), + qw( regionselector regionselector_hashref + expselect popselector domainselector didselector ) ); -@EXPORT_OK = ( keys(%autoload), qw( regionselector expselect popselector domainselector didselector) ); $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin'; $ENV{'SHELL'} = '/bin/sh'; @@ -76,6 +82,8 @@ $ENV{'CDPATH'} = ''; $ENV{'ENV'} = ''; $ENV{'BASH_ENV'} = ''; +#you can add BEGIN { $FS::SelfService::skip_uid_check = 1; } +#if you grant appropriate permissions to whatever user my $freeside_uid = scalar(getpwnam('freeside')); die "not running as the freeside user\n" if $> != $freeside_uid && ! $skip_uid_check; @@ -466,10 +474,14 @@ Array reference of all states in the current default country. Hash reference of card types; keys are card types, values are the exact strings passed to the process_payment function -=item paybatch +=cut -Unique transaction identifier (prevents multiple charges), passed to the -process_payment function +#this doesn't actually work yet +# +#=item paybatch +# +#Unique transaction identifier (prevents multiple charges), passed to the +#process_payment function =back @@ -535,15 +547,37 @@ Card expiration month Card expiration year -=item paybatch +=cut -Unique transaction identifier, returned from the payment_info function. -Prevents multiple charges. +#this doesn't actually work yet +# +#=item paybatch +# +#Unique transaction identifier, returned from the payment_info function. +#Prevents multiple charges. =back Returns a hash reference with a single key, B, empty on success, or an -error message on errors +error message on errors. + +=item process_payment_order_pkg + +Combines the B and B functions in one step. If the +payment processes sucessfully, the package is ordered. Takes a hash reference +as parameter with the keys of both methods. + +Returns a hash reference with a single key, B, empty on success, or an +error message on errors. + +=item process_payment_order_renew + +Combines the B and B functions in one step. If +the payment processes sucessfully, the renewal is processed. Takes a hash +reference as parameter with the keys of both methods. + +Returns a hash reference with a single key, B, empty on success, or an +error message on errors. =item list_pkgs @@ -560,6 +594,10 @@ Returns a hash reference containing customer package information. The hash refe Customer number +=item error + +Empty on success, or an error message on errors. + =item cust_pkg HASHREF Array reference of hash references, each of which has the fields of a cust_pkg @@ -606,21 +644,7 @@ already provisioned for this specific cust_pkg. Each has the following keys: =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 +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. =back @@ -630,11 +654,11 @@ Primary key for this service =item svcpart -Service definition (part_pkg) +Service definition (see L) =item pkgnum -Customer package (cust_pkg) +Customer package (see L) =item overlimit @@ -644,12 +668,6 @@ Blank if the service is not over limit, or the date the service exceeded its usa =back -=item error - -Empty on success, or an error message on errors. - -=back - =item list_svcs Returns service information for this customer. @@ -688,6 +706,8 @@ mail alias). Account (svc_acct) services also have the following keys: +=over 4 + =item username Username @@ -750,13 +770,22 @@ Session identifier =item pkgpart -pkgpart of package to order +Package to order (see L). =item svcpart -optional svcpart, required only if the package definition does not contain -one svc_acct service definition with quantity 1 (it may contain others with -quantity >1) +Service to order (see L). + +Normally optional; required only to provision a non-svc_acct service, or if the +package definition does not contain one svc_acct service definition with +quantity 1 (it may contain others with quantity >1). A svcpart of "none" can +also be specified to indicate that no initial service should be provisioned. + +=back + +Fields used when provisioning an svc_acct service: + +=over 4 =item username @@ -776,10 +805,123 @@ Optional Access number number =back +Fields used when provisioning an svc_domain service: + +=over 4 + +=item domain + +Domain + +=back + +Fields used when provisioning an svc_phone service: + +=over 4 + +=item phonenum + +Phone number + +=item pin + +Voicemail PIN + +=item sip_password + +SIP password + +=back + +Fields used when provisioning an svc_external service: + +=over 4 + +=item id + +External numeric ID. + +=item title + +External text title. + +=back + Returns a hash reference with a single key, B, empty on success, or an error message on errors. The special error '_decline' is returned for declined transactions. +=item renew_info + +Provides useful info for early renewals. + +Takes a hash reference as parameter with the following keys: + +=over 4 + +=item session_id + +Session identifier + +=back + +Returns a hash reference. On errors, it contains a single key, B, with +the error message. Otherwise, contains a single key, B, pointing to +an array refernce of hash references. Each hash reference contains the +following keys: + +=over 4 + +=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 +function. + +=item bill_date_pretty + +(Future) Bill date as a human-readable string. (Convenience for display; +subject to change, so best not to parse for the date.) + +=item amount + +Base amount which will be charged if renewed early as of this date. + +=item renew_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. + +=item renew_date_pretty + +Renewal date as a human-readable string. (Convenience for display; +subject to change, so best not to parse for the date.) + +=back + +=item order_renew + +Renews this customer early; i.e. runs billing for this customer in advance. + +Takes a hash reference as parameter with the following keys: + +=over 4 + +=item session_id + +Session identifier + +=item date + +Integer date as returned by the B function, indicating the advance +date for which to run billing. + +=back + +Returns a hash reference with a single key, B, empty on success, or an +error message on errors. + =item cancel_pkg Cancels a package for this customer. @@ -1191,24 +1333,45 @@ END } $state_html .= ''; - $state_html .= ''; + my $country_html = ''; + if ( scalar( keys %cust_main_county ) > 1 ) { + + $country_html = qq('; + } else { + + $country_html = qq('; - my $country_html = qq!'; ($county_html, $state_html, $country_html); } +sub regionselector_hashref { + my ($county_html, $state_html, $country_html) = regionselector(@_); + { + 'county_html' => $county_html, + 'state_html' => $state_html, + 'country_html' => $country_html, + }; +} + #=item expselect HASHREF | LIST # #Takes as input a hashref or list of key/value pairs with the following keys: @@ -1478,8 +1641,12 @@ Takes as input a hashref or list of key/value pairs with the following keys: =item field +Field name for the returned HTML fragment. + =item svcpart +Service definition (see L) + =back Returns an HTML fragment for DID selection. @@ -1511,14 +1678,23 @@ Note: Resellers can also use the B and B functions with their active session, and the B and B functions with their active session and an additional I parameter. +For the most part, development of the reseller web interface has been +superceded by agent-virtualized access to the backend. + =over 4 =item agent_login +Agent login + =item agent_info +Agent info + =item agent_list_customers +List agent's customers. + =back =head1 BUGS