skouat\ppde\controller\ipn_paypal

Complexity

Total Complexity

35

Size/Duplication

Total Lines	352
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	initiate_paypal_connection()	0	12	2
A	curl_post()	0	41	3
A	is_remote_detected()	0	12	2
A	set_u_paypal()	0	4	1
A	get_remote_used()	0	4	1
A	get_report_response()	0	4	1
A	get_response_status()	0	4	1
A	check_response_status()	0	4	1
A	is_curl_strcmp()	0	4	2
A	check_curl()	0	20	5
A	check_tls()	0	21	4
B	check_https()	0	20	6
A	set_remote_detected()	0	5	1
A	check_curl_info()	0	9	2
A	set_curl_info()	0	9	2

<?php
/**
 *
 * PayPal Donation extension for the phpBB Forum Software package.
 *
 * @copyright (c) 2015 Skouat
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 * Special Thanks to the following individuals for their inspiration:
 *    David Lewis (Highway of Life) http://startrekguide.com
 *    Micah Carrick (email@micahcarrick.com) http://www.micahcarrick.com
 */

namespace skouat\ppde\controller;

use phpbb\config\config;
use phpbb\language\language;
use phpbb\request\request;

class ipn_paypal
{
	protected $config;
	protected $language;
	protected $ppde_ext_manager;
	protected $ppde_ipn_log;
	protected $request;
	/**
	 * @var array
	 */
	private $curl_fsock = array('curl' => false,
								'none' => true);
	/**
	 * Full PayPal response for include in text report
	 *
	 * @var string
	 */
	private $report_response = '';
	/**
	 * PayPal response (VERIFIED or INVALID)
	 *
	 * @var string
	 */
	private $response = '';
	/**
	 * PayPal response status (code 200 or other)
	 *
	 * @var string
	 */
	private $response_status = '';
	/**
	 * PayPal URL
	 * Could be Sandbox URL ou normal PayPal URL.
	 *
	 * @var string
	 */
	private $u_paypal = '';

	/**
	 * Constructor
	 *
	 * @param config            $config           Config object
	 * @param language          $language         Language user object
	 * @param extension_manager $ppde_ext_manager Extension manager object
	 * @param ipn_log           $ppde_ipn_log     IPN log
	 * @param request           $request          Request object
	 *
	 * @access public
	 */
	public function __construct(config $config, language $language, extension_manager $ppde_ext_manager, ipn_log $ppde_ipn_log, request $request)
	{
		$this->config = $config;
		$this->language = $language;
		$this->ppde_ext_manager = $ppde_ext_manager;
		$this->ppde_ipn_log = $ppde_ipn_log;
		$this->request = $request;
	}

	/**
	 * Select the appropriate method to communicate with PayPal
	 * We use cURL. If it is not available we log an error
	 *
	 * @param string $args_return_uri
	 * @param array  $data
	 *
	 * @return void
	 * @access public
	 */
	public function initiate_paypal_connection($args_return_uri, $data)
	{
		if ($this->curl_fsock['curl'])
		{
			$this->curl_post($args_return_uri);
			$this->response;
		}
		else
		{
			$this->ppde_ipn_log->log_error($this->language->lang('NO_CONNECTION_DETECTED'), $this->ppde_ipn_log->is_use_log_error(), true, E_USER_ERROR, $data);
		}
	}

	/**
	 * Post Back Using cURL
	 *
	 * Sends the post back to PayPal using the cURL library. Called by
	 * the validate_transaction() method if the curl_fsock['curl'] property is true.
	 * Throws an exception if the post fails. Populates the response and response_status properties on success.
	 *
	 * @param  string $encoded_data The post data as a URL encoded string
	 *
	 * @return void
	 * @access private
	 */
	private function curl_post($encoded_data)
	{
		$ch = curl_init($this->u_paypal);
		curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
		curl_setopt($ch, CURLOPT_POST, true);
		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
		curl_setopt($ch, CURLOPT_POSTFIELDS, $encoded_data);
		curl_setopt($ch, CURLOPT_SSLVERSION, 6);
		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
		curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
		curl_setopt($ch, CURLOPT_FORBID_REUSE, true);
		curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 30);
		curl_setopt($ch, CURLOPT_HTTPHEADER, array(
			'User-Agent: PHP-IPN-Verification-Script',
			'Connection: Close',
		));

		if ($this->ppde_ipn_log->is_use_log_error())
		{
			curl_setopt($ch, CURLOPT_HEADER, true);
			curl_setopt($ch, CURLINFO_HEADER_OUT, true);
		}

		$this->report_response = $this->response = curl_exec($ch);
		if (curl_errno($ch) != 0)
		{
			// cURL error
			$this->ppde_ipn_log->log_error($this->language->lang('CURL_ERROR', curl_errno($ch) . ' (' . curl_error($ch) . ')'), $this->ppde_ipn_log->is_use_log_error());
			curl_close($ch);
		}
		else
		{
			$info = curl_getinfo($ch);
			$this->response_status = $info['http_code'];
			curl_close($ch);
		}

		// Split response headers and payload, a better way for strcmp
		$tokens = explode("\r\n\r\n", trim($this->response));
		$this->response = trim(end($tokens));
	}

	/**
	 * Set property 'curl_fsock' to use cURL.
	 * If cURL is not available we use default value of the property 'curl_fsock'.
	 *
	 * @return bool

Should the return type not be false|integer|string?

	 * @access public
	 */
	public function is_remote_detected()
	{
		if ($this->config['ppde_curl_detected'])
		{
			$this->curl_fsock = array(
				'curl' => (bool) true,
				'none' => (bool) false,
			);
		}

		return array_search(true, $this->curl_fsock);
	}

	/**
	 * Set the property '$u_paypal'
	 *
	 * @param string $u_paypal
	 *
	 * @return void
	 * @access public
	 */
	public function set_u_paypal($u_paypal)
	{
		$this->u_paypal = (string) $u_paypal;
	}

	/**
	 * Get the service that will be used to contact PayPal
	 * Returns the name of the key that is set to true.
	 *
	 * @return string
	 * @access public
	 */
	public function get_remote_used()
	{
		return array_search(true, $this->curl_fsock);
	}

	/**
	 * Full PayPal response for include in text report
	 *
	 * @return string
	 * @access public
	 */
	public function get_report_response()
	{
		return $this->report_response;
	}

	/**
	 * PayPal response status
	 *
	 * @return string
	 * @access public
	 */
	public function get_response_status()
	{
		return $this->response_status;
	}

	/**
	 * Check if the response status is equal to "200".
	 *
	 * @return bool
	 * @access public
	 */
	public function check_response_status()
	{
		return $this->response_status != 200;
	}

	/**
	 * If cURL is available we use strcmp() to get the Pay
	 *
	 * @param string $arg
	 *
	 * @return bool
	 * @access public
	 */
	public function is_curl_strcmp($arg)
	{
		return $this->curl_fsock['curl'] && (strcmp($this->response, $arg) === 0);
	}

	/**
	 * Check if cURL is available
	 *
	 * @return bool
	 * @access public
	 */
	public function check_curl()
	{
		if (function_exists('curl_init') && function_exists('curl_exec'))
		{
			$ext_meta = $this->ppde_ext_manager->get_ext_meta();

			$ch = curl_init($ext_meta['extra']['version-check']['host']);

			curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

			$this->response = curl_exec($ch);
			$this->response_status = strval(curl_getinfo($ch, CURLINFO_HTTP_CODE));

			curl_close($ch);

			return ($this->response !== false || $this->response_status !== '0') ? true : false;
		}

		return false;
	}

	/**
	 * Check if PayPal connection use TLS 1.2 and HTTP 1.1
	 *
	 * @access public
	 */
	public function check_tls()
	{
		// Reset settings to false
		$this->config->set('ppde_tls_detected', false);

		if (function_exists('curl_init') && function_exists('curl_exec'))
		{
			$ch = curl_init('https://tlstest.paypal.com/');

			curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

			$response = curl_exec($ch);

			curl_close($ch);

			if ($response === 'PayPal_Connection_OK')
			{
				$this->config->set('ppde_tls_detected', true);
			}
		}
	}

	/**
	 * Check if HTTPS Protocol is enabled
	 *
	 * @return array|bool
	 * @access public
	 */
	public function check_https()
	{
		if ($this->request->is_set('HTTPS', \phpbb\request\request_interface::SERVER))
		{
			if ('on' == strtolower($this->request->variable('HTTPS', \phpbb\request\request_interface::SERVER)))
			{
				return true;
			}

			if ('1' == $this->request->variable('HTTPS', \phpbb\request\request_interface::SERVER))
			{
				return true;
			}
		}
		else if ($this->request->is_set('SERVER_PORT', \phpbb\request\request_interface::SERVER) && ('443' == $this->request->variable('SERVER_PORT', \phpbb\request\request_interface::SERVER)))
		{
			return true;
		}
		return false;
	}


	/**
	 * Set config value for cURL and HTTPS
	 *
	 * @return void
	 * @access public
	 */
	public function set_remote_detected()
	{
		$this->config->set('ppde_curl_detected', $this->check_curl());
		$this->config->set('ppde_https_detected', $this->check_https());
	}

	/**
	 * Get cURL version if available
	 *
	 * @return array|bool

Consider making the return type a bit more specific; maybe use array|false.

	 * @access public
	 */
	public function check_curl_info()
	{
		if (function_exists('curl_version'))
		{
			return curl_version();
		}

		return false;
	}

	/**
	 * Set config value for cURL version
	 *
	 * @return void
	 * @access public
	 */
	public function set_curl_info()
	{
		// Get cURL version informations
		if ($curl_info = $this->check_curl_info())
		{
			$this->config->set('ppde_curl_version', $curl_info['version']);
			$this->config->set('ppde_curl_ssl_version', $curl_info['ssl_version']);
		}
	}
}