* @copyright (C) 2008 - 2009 Eric.Wang
*
*/
/** filename of the IPN log */
define('LOG_FILE', '.ipn_results.log');
define('SSL_P_URL', 'https://www.paypal.com/cgi-bin/webscr');
define('SSL_SAND_URL','https://www.sandbox.paypal.com/cgi-bin/webscr');
class paypal_class {
private $ipn_status; // holds the last status
public $admin_mail; // receive the ipn status report pre transaction
public $paypal_mail; // paypal account, if set, class need to verify receiver
public $txn_id; // array: if the txn_id array existed, class need to verified the txn_id duplicate
public $ipn_log; // bool: log IPN results to text file?
private $ipn_response; // holds the IPN response from paypal
public $ipn_data = array(); // array contains the POST values for IPN
private $fields = array(); // array holds the fields to submit to paypal
private $ipn_debug; // ipn_debug
// initialization constructor. Called when class is created.
function __construct() {
$this->ipn_status = '';
$this->admin_mail = null;
$this->paypal_mail = null;
$this->txn_id = null;
$this->tax = null;
$this->ipn_log = true;
$this->ipn_response = '';
$this->ipn_debug = false;
}
// adds a key=>value pair to the fields array, which is what will be
// sent to paypal as POST variables.
public function add_field($field, $value) {
$this->fields["$field"] = $value;
}
// this function actually generates an entire HTML page consisting of
// a form with hidden elements which is submitted to paypal via the
// BODY element's onLoad attribute. We do this so that you can validate
// any POST vars from you custom form before submitting to paypal. So
// basically, you'll have your own form which is submitted to your script
// to validate the data, which in turn calls this function to create
// another hidden form and submit to paypal.
// The user will briefly see a message on the screen that reads:
// "Please wait, your order is being processed..." and then immediately
// is redirected to paypal.
public function submit_paypal_post() {
$paypal_url = ($_GET['sandbox'] == 1) ? SSL_SAND_URL : SSL_P_URL;
echo "\n";
}
/**
* validate the IPN
*
* @return bool IPN validation result
*/
public function validate_ipn() {
$hostname = gethostbyaddr ( $_SERVER ['REMOTE_ADDR'] );
if (! preg_match ( '/paypal\.com$/', $hostname )) {
$this->ipn_status = 'Validation post isn\'t from PayPal';
$this->log_ipn_results ( false );
return false;
}
if (isset($this->paypal_mail) && strtolower ( $_POST['receiver_email'] ) != strtolower(trim( $this->paypal_mail ))) {
$this->ipn_status = "Receiver Email Not Match";
$this->log_ipn_results ( false );
return false;
}
if (isset($this->txn_id)&& in_array($_POST['txn_id'],$this->txn_id)) {
$this->ipn_status = "txn_id have a duplicate";
$this->log_ipn_results ( false );
return false;
}
// parse the paypal URL
$paypal_url = ($_POST['test_ipn'] == 1) ? SSL_SAND_URL : SSL_P_URL;
$url_parsed = parse_url($paypal_url);
// generate the post string from the _POST vars aswell as load the
// _POST vars into an arry so we can play with them from the calling
// script.
$post_string = '';
foreach ($_POST as $field=>$value) {
$this->ipn_data["$field"] = $value;
$post_string .= $field.'='.urlencode(stripslashes($value)).'&';
}
$post_string.="cmd=_notify-validate"; // append ipn command
// open the connection to paypal
if (isset($_POST['test_ipn']) )
$fp = fsockopen ( 'ssl://www.sandbox.paypal.com', "443", $err_num, $err_str, 60 );
else
$fp = fsockopen ( 'ssl://www.paypal.com', "443", $err_num, $err_str, 60 );
if(!$fp) {
// could not open the connection. If loggin is on, the error message
// will be in the log.
$this->ipn_status = "fsockopen error no. $err_num: $err_str";
$this->log_ipn_results(false);
return false;
} else {
// Post the data back to paypal
fputs($fp, "POST $url_parsed[path] HTTP/1.1\r\n");
fputs($fp, "Host: $url_parsed[host]\r\n");
fputs($fp, "Content-type: application/x-www-form-urlencoded\r\n");
fputs($fp, "Content-length: ".strlen($post_string)."\r\n");
fputs($fp, "Connection: close\r\n\r\n");
fputs($fp, $post_string . "\r\n\r\n");
// loop through the response from the server and append to variable
while(!feof($fp)) {
$this->ipn_response .= fgets($fp, 1024);
}
fclose($fp); // close connection
}
// Invalid IPN transaction. Check the $ipn_status and log for details.
if (! eregi("VERIFIED",$this->ipn_response)) {
$this->ipn_status = 'IPN Validation Failed';
$this->log_ipn_results(false);
return false;
} else {
$this->ipn_status = "IPN VERIFIED";
$this->log_ipn_results(true);
return true;
}
}
private function log_ipn_results($success) {
$hostname = gethostbyaddr ( $_SERVER ['REMOTE_ADDR'] );
// Timestamp
$text = '[' . date ( 'm/d/Y g:i A' ) . '] - ';
// Success or failure being logged?
if ($success)
$this->ipn_status = $text . 'SUCCESS:' . $this->ipn_status . "!\n";
else
$this->ipn_status = $text . 'FAIL: ' . $this->ipn_status . "!\n";
// Log the POST variables
$this->ipn_status .= "[From:" . $hostname . "|" . $_SERVER ['REMOTE_ADDR'] . "]IPN POST Vars Received By Paypal_IPN Response API:\n";
foreach ( $this->ipn_data as $key => $value ) {
$this->ipn_status .= "$key=$value \n";
}
// Log the response from the paypal server
$this->ipn_status .= "IPN Response from Paypal Server:\n" . $this->ipn_response;
$this->write_to_log ();
}
private function write_to_log() {
if (! $this->ipn_log)
return; // is logging turned off?
// Write to log
$fp = fopen ( LOG_FILE , 'a' );
fwrite ( $fp, $this->ipn_status . "\n\n" );
fclose ( $fp ); // close file
chmod ( LOG_FILE , 0600 );
}
public function send_report($subject) {
$body .= "from " . $this->ipn_data ['payer_email'] . " on " . date ( 'm/d/Y' );
$body .= " at " . date ( 'g:i A' ) . "\n\nDetails:\n" . $this->ipn_status;
mail ( $this->admin_mail, $subject, $body );
}
public function print_report(){
$find [] = "\n";
$replace [] = '
';
$html_content = str_replace ( $find, $replace, $this->ipn_status );
echo $html_content;
}
public function dump_fields() {
// Used for debugging, this function will output all the field/value pairs
// that are currently defined in the instance of the class using the
// add_field() function.
echo "paypal_class->dump_fields() Output:
";
echo "
| Field Name |
Value |
";
ksort($this->fields);
foreach ($this->fields as $key => $value) {echo "| $key | ".urldecode($value)." |
";}
echo "
";
}
private function debug($msg) {
if (! $this->ipn_debug)
return;
$today = date ( "Y-m-d H:i:s " );
$myFile = ".ipn_debugs.log";
$fh = fopen ( $myFile, 'a' ) or die ( "Can't open debug file. Please manually create the 'debug.log' file and make it writable." );
$ua_simple = preg_replace ( "/(.*)\s\(.*/", "\\1", $_SERVER ['HTTP_USER_AGENT'] );
fwrite ( $fh, $today . " [from: " . $_SERVER ['REMOTE_ADDR'] . "|$ua_simple] - " . $msg . "\n" );
fclose ( $fh );
chmod ( $myFile, 0600 );
}
}