skouat\ppde\actions\core

Complexity

Total Complexity

53

Size/Duplication

Total Lines	501
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	1

31 Methods

Rating	Name	Duplication	Size	Complexity
A	get_ipn_suffix()	0	3	2
A	is_donor_anonymous()	0	3	2
A	set_ipn_test()	0	3	1
A	is_donor_is_member()	0	10	2
A	set_ipn_suffix()	0	3	2
A	check_donors_status()	0	5	1
A	get_ipn_test()	0	3	1
A	set_ipn_test_properties()	0	4	1
A	get_donor_is_member()	0	3	1
A	__construct()	0	20	1
A	update_user_stats()	0	8	2
A	log_to_db()	0	5	1
A	autogroup_is_enabled()	0	3	2
A	donors_group_user_add()	0	42	3
A	extract_user_id()	0	3	1
A	set_transaction_data()	0	3	1
A	update_donor_stats()	0	5	2
A	can_use_autogroup()	0	7	4
A	minimum_donation_raised()	0	6	1
A	check_donor_status_based_on_email()	0	3	2
A	validate_user_id()	0	5	3
A	update_raised_amount()	0	10	2
A	merge_transaction_data()	0	5	2
A	get_count_result()	0	8	2
A	do_transactions_actions()	0	10	2
A	net_amount()	0	3	1
A	is_in_admin()	0	3	3
A	validate_and_set_transaction_data()	0	21	1
A	get_payer_data()	0	3	2
A	payment_status_is_completed()	0	3	1
A	update_overview_stats()	0	5	1

<?php
/**
 *
 * PayPal Donation extension for the phpBB Forum Software package.
 *
 * @copyright (c) 2015-2024 Skouat
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace skouat\ppde\actions;

use phpbb\config\config;
use phpbb\event\dispatcher_interface;
use phpbb\language\language;
use phpbb\path_helper;
use phpbb\user;

class core
{
	public $notification;

	protected $config;
	protected $dispatcher;
	protected $language;
	protected $php_ext;
	protected $transaction_data;
	protected $transaction_entity;
	protected $transaction_operator;
	protected $user;

	private $donor_is_member = false;
	private $ipn_suffix;
	private $is_ipn_test = false;
	private $payer_data = [];
	private $root_path;

	/**
	 * Constructor
	 *
	 * @param config                              $config                    Config object
	 * @param language                            $language                  Language user object
	 * @param \skouat\ppde\notification\core      $notification              PPDE Notification object
	 * @param path_helper                         $path_helper               Path helpers object
	 * @param \skouat\ppde\entity\transactions    $ppde_entity_transaction   Transaction entity object
	 * @param \skouat\ppde\operators\transactions $ppde_operator_transaction Transaction operator object
	 * @param dispatcher_interface                $dispatcher                Dispatcher object
	 * @param user                                $user                      User object
	 * @param string                              $php_ext                   phpEx
	 *
	 * @access public
	 */
	public function __construct(
		config $config,
		language $language,
		\skouat\ppde\notification\core $notification,
		path_helper $path_helper,
		\skouat\ppde\entity\transactions $ppde_entity_transaction,
		\skouat\ppde\operators\transactions $ppde_operator_transaction,
		dispatcher_interface $dispatcher,
		user $user,
		string $php_ext)
	{
		$this->config = $config;
		$this->dispatcher = $dispatcher;
		$this->language = $language;
		$this->notification = $notification;
		$this->transaction_entity = $ppde_entity_transaction;
		$this->transaction_operator = $ppde_operator_transaction;
		$this->php_ext = $php_ext;
		$this->root_path = $path_helper->get_phpbb_root_path();
		$this->user = $user;
	}

	/**
	 * Sets properties related to ipn tests
	 *
	 * @param bool $ipn_test
	 *
	 * @return void
	 * @access public
	 */
	public function set_ipn_test_properties(bool $ipn_test): void
	{
		$this->set_ipn_test($ipn_test);
		$this->set_ipn_suffix();
	}

	/**
	 * Sets the property $this->is_ipn_test
	 *
	 * @param bool $ipn_test
	 *
	 * @return void
	 * @access private
	 */
	private function set_ipn_test($ipn_test): void
	{
		$this->is_ipn_test = (bool) $ipn_test;
	}

	/**
	 * Sets the property $this->ipn_suffix
	 *
	 * @return void
	 * @access private
	 */
	private function set_ipn_suffix(): void
	{
		$this->ipn_suffix = $this->is_ipn_test ? '_ipn' : '';
	}

	/**
	 * Gets the property $this->ipn_suffix
	 *
	 * @return string
	 * @access private
	 */
	public function get_ipn_suffix(): string
	{
		return $this->get_ipn_test() ? $this->ipn_suffix : '';
	}

	/**
	 * @return boolean
	 * @access private
	 */
	public function get_ipn_test(): bool
	{
		return $this->is_ipn_test;
	}

	/**
	 * Checks if the donor is a member then gets payer_data values
	 *
	 * @return void
	 * @access public
	 */

	public function is_donor_is_member(): void
	{
		if ($this->is_donor_anonymous())
		{
			$this->donor_is_member = $this->check_donor_status_based_on_email($this->transaction_data['payer_email']);

		}
		else
		{
			$this->donor_is_member = $this->check_donors_status('user', $this->transaction_data['user_id']);
		}
	}

	/**
	 * @return boolean
	 */
	public function get_donor_is_member(): bool
	{
		return $this->donor_is_member;
	}

	/**
	 * Determine if the donor is anonymous.
	 *
	 * @return bool True if the donor is anonymous, false otherwise.
	 */
	private function is_donor_anonymous(): bool
	{
		return (int) $this->transaction_data['user_id'] === ANONYMOUS || !$this->check_donors_status('user', $this->transaction_data['user_id']);
	}

	/**
	 * Gets donor informations (user id, username, amount donated) and returns if exists
	 *
	 * @param string     $type Allowed value : 'user' or 'email'
	 * @param string|int $args If $type is set to 'user', $args must be a user id.
	 *                         If $type is set to 'email', $args must be an email address
	 *
	 * @return bool
	 * @access private
	 */
	private function check_donors_status($type, $args): bool
	{
		$this->payer_data = $this->transaction_operator->query_donor_user_data($type, $args);

		return (bool) count($this->payer_data);
	}

	/**
	 * Checks the donor status based on email.
	 *
	 * @param string $email The email of the donor.
	 * @return bool Returns true if the status of the donor is active, false otherwise.
	 */
	private function check_donor_status_based_on_email($email): bool
	{
		return !empty($email) && !empty($this->check_donors_status('email', $email));
	}

	/**
	 * @return array
	 */
	public function get_payer_data(): array
	{
		return (count($this->payer_data) != 0) ? $this->payer_data : [];
	}

	/**
	 * Log the transaction to the database
	 *
	 * @param array $data Transaction data array
	 *
	 * @return void
	 * @access public
	 */
	public function log_to_db($data): void
	{
		$this->set_transaction_data($data);
		$this->validate_and_set_transaction_data();
		$this->transaction_entity->add_edit_data();
	}

	/**
	 * Set Transaction Data array
	 *
	 * @param array $transaction_data Array of the donation transaction.
	 *
	 * @return void
	 * @access public
	 */
	public function set_transaction_data(array $transaction_data): void
	{
		$this->transaction_data = $this->merge_transaction_data($transaction_data);
	}

	/**
	 * Merge transaction data if existing transaction data is not empty, else return passed transaction data
	 *
	 * @param array $transaction_data Array of the donation transaction.
	 *
	 * @return array Merged or original transaction data
	 * @access private
	 */
	private function merge_transaction_data(array $transaction_data): array
	{
		return !empty($this->transaction_data)
			? array_merge($this->transaction_data, $transaction_data)
			: $transaction_data;
	}

	private function validate_and_set_transaction_data(): void
	{
		// Handle user_id data
		$this->extract_user_id();
		$this->validate_user_id();

		// Set username in extra_data property in $entity
		$user_ary = $this->transaction_operator->query_donor_user_data('user', $this->transaction_data['user_id']);
		$this->transaction_entity->set_username($user_ary['username']);

		// Set 'net_amount' in $this->transaction_data
		$this->transaction_data['net_amount'] = $this->net_amount(
			$this->transaction_data['mc_gross'],
			$this->transaction_data['mc_fee']
		);

		$data = $this->transaction_operator->build_transaction_data_ary($this->transaction_data);

		// Load data in the entity
		$this->transaction_entity->set_entity_data($data);
		$this->transaction_entity->set_id($this->transaction_entity->transaction_exists());
	}

	/**
	 * Retrieve user_id from custom args
	 *
	 * @return void
	 * @access private
	 */
	private function extract_user_id(): void
	{
		$this->transaction_data['user_id'] = (int) explode('_', substr($this->transaction_data['custom'], 4), -1)[0];
	}

	/**
	 * Avoid the user_id to be set to 0
	 *
	 * @return void
	 * @access private
	 */
	private function validate_user_id(): void
	{
		if (empty($this->transaction_data['user_id']) || !is_numeric($this->transaction_data['user_id']))
		{
			$this->transaction_data['user_id'] = ANONYMOUS;
		}
	}

	/**
	 * Returns the net amount of a donation
	 *
	 * @param float  $amount
	 * @param float  $fee
	 * @param string $dec_point
	 * @param string $thousands_sep
	 *
	 * @return string
	 * @access public
	 */
	public function net_amount($amount, $fee, $dec_point = '.', $thousands_sep = ''): string
	{
		return number_format((float) $amount - (float) $fee, 2, $dec_point, $thousands_sep);
	}

	/**
	 * Check we are in the ACP
	 *
	 * @return bool
	 * @access public
	 */
	public function is_in_admin(): bool
	{
		return defined('IN_ADMIN') && isset($this->user->data['session_admin']) && $this->user->data['session_admin'];
	}

	/**
	 * Perform actions for validated transaction
	 *
	 * @param bool $is_member
	 */
	public function do_transactions_actions($is_member): void
	{
		$this->update_overview_stats();
		$this->update_raised_amount();

		if ($is_member)
		{
			$this->update_donor_stats();
			$this->donors_group_user_add();
			$this->notification->notify_donor_donation_received();
		}
	}

	/**
	 * Updates the Overview module statistics
	 *
	 * @return void
	 * @access public
	 */
	public function update_overview_stats(): void
	{
		$this->config->set('ppde_anonymous_donors_count' . $this->ipn_suffix, $this->get_count_result('ppde_anonymous_donors_count' . $this->ipn_suffix));
		$this->config->set('ppde_known_donors_count' . $this->ipn_suffix, $this->get_count_result('ppde_known_donors_count' . $this->ipn_suffix));
		$this->config->set('ppde_transactions_count' . $this->ipn_suffix, $this->get_count_result('ppde_transactions_count' . $this->ipn_suffix));
	}

	/**
	 * Returns count result for updating stats
	 *
	 * @param string $config_name
	 *
	 * @return int
	 * @access private
	 */
	private function get_count_result($config_name): int
	{
		if (!$this->config->offsetExists($config_name))
		{
			trigger_error($this->language->lang('EXCEPTION_INVALID_CONFIG_NAME', $config_name), E_USER_WARNING);
		}

		return $this->transaction_operator->sql_query_count_result($config_name, $this->is_ipn_test);
	}

	/**
	 * Updates the amount of donation raised
	 *
	 * @return void
	 * @access public
	 */
	public function update_raised_amount(): void
	{
		$net_amount = (float) $this->net_amount($this->transaction_data['mc_gross'], $this->transaction_data['mc_fee']);

		if (!empty($this->transaction_data['settle_amount']))
		{
			$net_amount = $this->transaction_data['settle_amount'];
		}

		$this->config->set('ppde_raised' . $this->ipn_suffix, (float) $this->config['ppde_raised' . $this->ipn_suffix] + $net_amount);
	}

	/**
	 * Updates donor member stats
	 *
	 * @return void
	 * @access public
	 */
	public function update_donor_stats(): void
	{
		if ($this->donor_is_member)
		{
			$this->update_user_stats((int) $this->payer_data['user_id'], (float) $this->payer_data['user_ppde_donated_amount'] + (float) $this->transaction_data['mc_gross']);
		}
	}

	/**
	 * @param int   $user_id
	 * @param float $amount
	 */
	public function update_user_stats(int $user_id, float $amount): void
	{
		if (!$user_id)
		{
			trigger_error($this->language->lang('EXCEPTION_INVALID_USER_ID', $user_id), E_USER_WARNING);
		}

		$this->transaction_operator->sql_update_user_stats($user_id, $amount);
	}

	/**
	 * Add donor to the donors group
	 *
	 * @return void
	 * @access public
	 */
	public function donors_group_user_add(): void
	{
		// We add the user to the donors group
		$can_use_autogroup = $this->can_use_autogroup();
		$group_id = (int) $this->config['ppde_ipn_group_id'];
		$payer_id = (int) $this->payer_data['user_id'];
		$payer_username = $this->payer_data['username'];
		$default_group = $this->config['ppde_ipn_group_as_default'];
		$payer_donated_amount = $this->payer_data['user_ppde_donated_amount'];

		/**
		 * Event to modify data before a user is added to the donors group
		 *
		 * @event skouat.ppde.donors_group_user_add_before
		 * @var bool    can_use_autogroup      Whether or not to add the user to the group
		 * @var int     group_id               The ID of the group to which the user will be added
		 * @var int     payer_id               The ID of the user who will we added to the group
		 * @var string  payer_username         The user name
		 * @var bool    default_group          Whether or not the group should be made default for the user
		 * @var float   payer_donated_amount   The user donated amount
		 * @since 1.0.3
		 * @changed 2.1.2 Added var $payer_donated_amount
		 */
		$vars = [
			'can_use_autogroup',
			'group_id',
			'payer_id',
			'payer_username',
			'default_group',
			'payer_donated_amount',
		];
		extract($this->dispatcher->trigger_event('skouat.ppde.donors_group_user_add_before', compact($vars)));

		if ($can_use_autogroup)
		{
			if (!function_exists('group_user_add'))
			{
				include($this->root_path . 'includes/functions_user.' . $this->php_ext);
			}

			// Adds the user to the donors group and set as default.
			group_user_add($group_id, [$payer_id], [$payer_username], get_group_name($group_id), $default_group);
		}
	}

	/**
	 * Checks if all required settings are meet for adding the donor to the group of donors
	 *
	 * @return bool
	 * @access private
	 */
	private function can_use_autogroup(): bool
	{
		return
			$this->autogroup_is_enabled() &&
			$this->donor_is_member &&
			$this->payment_status_is_completed() &&
			$this->minimum_donation_raised();
	}

	/**
	 * Checks if Autogroup could be used
	 *
	 * @return bool
	 * @access private
	 */
	private function autogroup_is_enabled(): bool
	{
		return $this->config['ppde_ipn_enable'] && $this->config['ppde_ipn_autogroup_enable'];
	}

	/**
	 * Checks if payment_status is completed
	 *
	 * @return bool
	 * @access public
	 */
	public function payment_status_is_completed(): bool
	{
		return $this->transaction_data['payment_status'] === 'Completed';
	}

	/**
	 * Checks if member's donation is upper or equal to the minimum defined
	 *
	 * @return bool
	 * @access public
	 */
	public function minimum_donation_raised(): bool
	{
		// Updates payer_data info before checking values
		$this->check_donors_status('user', $this->payer_data['user_id']);

		return (float) $this->payer_data['user_ppde_donated_amount'] >= (float) $this->config['ppde_ipn_min_before_group'];
	}
}