Give_Email_Access::check_for_token() - Code Metrics - Inspection of "Set appropriate cookie path using constant COOKIE_..." - WordImpress/Give - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#571)

by Devin

created 2016-04-08 23:50 UTC

Give_Email_Access::check_for_token() C

↳ Parent: Give_Email_Access

Complexity

Conditions	7
Paths	24

Size

Total Lines	22
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	22
ccs	0
cts	14
cp	0
rs	6.9811
cc	7
eloc	11
nc	24
nop	0
crap	56

<?php

/**
 * Class for allowing donors access to their donation w/o logging in;
 *
 * Based on the work from Matt Gibbs - https://github.com/FacetWP/edd-no-logins
 *
 * @package     Give
 * @copyright   Copyright (c) 2016, WordImpress
 * @license     http://opensource.org/licenses/gpl-2.0.php GNU Public License
 * @since       1.4
 */

defined( 'ABSPATH' ) or exit;
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);

/**
 * Class Give_Email_Access
 */
class Give_Email_Access {

	public $token_exists = false;
	public $token_email = false;
	public $token = false;
	public $error = '';

	private $verify_throttle;

	/**
	 * Give_Email_Access constructor.
	 */
	function __construct() {


		// get it started
		add_action( 'init', array( $this, 'init' ) );
	}


	/**
	 * Register defaults and filters
	 */
	function init() {


		$is_enabled = give_get_option( 'email_access' );

		//Non-logged in users only
		if ( is_user_logged_in() || $is_enabled !== 'on' || is_admin() ) {
			return;
		}

		//Are db columns setup?
		$is_setup = give_get_option( 'email_access_installed' );
		if ( empty( $is_setup ) ) {
			$this->create_columns();
		}

		// Timeouts
		$this->verify_throttle  = apply_filters( 'give_nl_verify_throttle', 300 );
		$this->token_expiration = apply_filters( 'give_nl_token_expiration', 7200 );
class MyClass { }

$x = new MyClass();
$x->foo = true;

		// Setup login
		$this->check_for_token();

		if ( $this->token_exists ) {
			add_filter( 'give_can_view_receipt', '__return_true' );
			add_filter( 'give_user_pending_verification', '__return_false' );
			add_filter( 'give_get_users_purchases_args', array( $this, 'users_purchases_args' ) );
		}
	}

	/**
	 * Prevent email spamming
	 *
	 * @param $customer_id
	 *
	 * @return bool
	 */
	function can_send_email( $customer_id ) {

		global $wpdb;
function myFunction($a, $b) {
    // Do something
}

		// Prevent multiple emails within X minutes
		$throttle = date( 'Y-m-d H:i:s', time() - $this->verify_throttle );

		// Does a user row exist?
		$exists = (int) $wpdb->get_var(
			$wpdb->prepare( "SELECT COUNT(*) FROM {$wpdb->prefix}give_customers WHERE id = %d", $customer_id )
		);

		if ( 0 < $exists ) {
			$row_id = (int) $wpdb->get_var(
				$wpdb->prepare( "SELECT id FROM {$wpdb->prefix}give_customers WHERE id = %d AND (verify_throttle < %s OR verify_key = '') LIMIT 1", $customer_id, $throttle )
			);

			if ( $row_id < 1 ) {
				give_set_error( 'give_email_access_attempts_exhausted', __( 'Please wait a few minutes before requesting a new email access link.', 'give' ) );

				return false;
			}
		}

		return true;
	}


	/**
	 * Send the user's token
	 *
	 * @param $customer_id
	 * @param $email
	 */
	function send_email( $customer_id, $email ) {


		$verify_key = wp_generate_password( 20, false );

		// Generate a new verify key
		$this->set_verify_key( $customer_id, $email, $verify_key );

		// Get the purchase history URL
		$page_id = give_get_option( 'history_page' );

		$access_url = add_query_arg( array(
			'give_nl' => $verify_key,
		), get_permalink( $page_id ) );

		//Nice subject and message
		$subject = apply_filters( 'give_email_access_token_subject', sprintf( __( 'Your Access Link to %1$s', 'give' ), get_bloginfo( 'name' ) ) );

		$message = __( 'You or someone in your organization requested an access link be sent to this email address. This is a temporary access link for you to view your donation information. Click on the link below to view:', 'give' ) . "\n\n";

		$message .= '<a href="' . esc_url( $access_url ) . '" target="_blank">' . __( 'Access My Donation Details', 'give' ) . ' &raquo;</a>';

		$message .= "\n\n";
		$message .= "\n\n";
		$message .= __( 'Sincerely,', 'give' );
		$message .= "\n" . get_bloginfo( 'name' ) . "\n";

		$message = apply_filters( 'give_email_access_token_message', $message );


		// Send the email
		Give()->emails->__set( 'heading', apply_filters( 'give_email_access_token_heading', __( 'Your Access Link', 'give' ) ) );
		Give()->emails->send( $email, $subject, $message );

	}


	/**
	 * Has the user authenticated?
	 */
	function check_for_token() {


		$token = isset( $_GET['give_nl'] ) ? $_GET['give_nl'] : '';

		// Check for cookie
		if ( empty( $token ) ) {
			$token = isset( $_COOKIE['give_nl'] ) ? $_COOKIE['give_nl'] : '';
		}

		if ( ! empty( $token ) ) {
			if ( ! $this->is_valid_token( $token ) ) {
				if ( ! $this->is_valid_verify_key( $token ) ) {
					return;
				}
			}

			$this->token_exists = true;
			// Set cookie
			$lifetime = current_time( 'timestamp' ) + Give()->session->set_expiration_time();
			@setcookie( 'give_nl', $token, $lifetime, COOKIEPATH, COOKIE_DOMAIN, false );
		}
	}

	/**
	 * Is this a valid token?
	 *
	 * @param $token
	 *
	 * @return bool
	 */
	function is_valid_token( $token ) {


		global $wpdb;
function myFunction($a, $b) {
    // Do something
}

		// Make sure token isn't expired
		$expires = date( 'Y-m-d H:i:s', time() - $this->token_expiration );

		$email = $wpdb->get_var(
			$wpdb->prepare( "SELECT email FROM {$wpdb->prefix}give_customers WHERE token = %s AND verify_throttle >= %s LIMIT 1", $token, $expires )
		);

		if ( ! empty( $email ) ) {
			$this->token_email = $email;
			$this->token       = $token;

			return true;
		}

		//Set error only if email access form isn't being submitted
		if ( ! isset( $_POST['give_email'] ) && ! isset( $_POST['_wpnonce'] ) ) {
			give_set_error( 'give_email_token_expired', apply_filters( 'give_email_token_expired_message', 'Sorry, your access token has expired. Please request a new one below:', 'give' ) );
		}


		return false;

	}

	/**
	 * Add the verify key to DB
	 *
	 * @param $customer_id
	 * @param $email
	 * @param $verify_key
	 */
	function set_verify_key( $customer_id, $email, $verify_key ) {

		global $wpdb;
function myFunction($a, $b) {
    // Do something
}

		$now = date( 'Y-m-d H:i:s' );

		// Insert or update?
		$row_id = (int) $wpdb->get_var(
			$wpdb->prepare( "SELECT id FROM {$wpdb->prefix}give_customers WHERE id = %d LIMIT 1", $customer_id )
		);

		// Update
		if ( ! empty( $row_id ) ) {
			$wpdb->query(
				$wpdb->prepare( "UPDATE {$wpdb->prefix}give_customers SET verify_key = %s, verify_throttle = %s WHERE id = %d LIMIT 1", $verify_key, $now, $row_id )
			);
		} // Insert
		else {
			$wpdb->query(
				$wpdb->prepare( "INSERT INTO {$wpdb->prefix}give_customers ( verify_key, verify_throttle) VALUES (%s, %s)", $verify_key, $now )
			);
		}
	}

	/**
	 * Is this a valid verify key?
	 *
	 * @param $token
	 *
	 * @return bool
	 */
	function is_valid_verify_key( $token ) {

		global $wpdb;
function myFunction($a, $b) {
    // Do something
}

		// See if the verify_key exists
		$row = $wpdb->get_row(
			$wpdb->prepare( "SELECT id, email FROM {$wpdb->prefix}give_customers WHERE verify_key = %s LIMIT 1", $token )
		);

		$now = date( 'Y-m-d H:i:s' );

		// Set token
		if ( ! empty( $row ) ) {
			$wpdb->query(
				$wpdb->prepare( "UPDATE {$wpdb->prefix}give_customers SET verify_key = '', token = %s, verify_throttle = %s WHERE id = %d LIMIT 1", $token, $now, $row->id )
			);

			$this->token_email = $row->email;
			$this->token       = $token;

			return true;
		}

		return false;
	}

	/**
	 * Force Give to find transactions by donation email, not user ID
	 *
	 * @param $args
	 *
	 * @return mixed
	 */
	function users_purchases_args( $args ) {

		$args['user'] = $this->token_email;

		return $args;
	}


	/**
	 * Create Columns
	 *
	 * @description Create the necessary columns for email access
	 */
	function create_columns() {


		global $wpdb;
function myFunction($a, $b) {
    // Do something
}

		//Create columns in customers table
		$query = $wpdb->query( "ALTER TABLE {$wpdb->prefix}give_customers ADD `token` VARCHAR(255) CHARACTER SET utf8 NOT NULL, ADD `verify_key` VARCHAR(255) CHARACTER SET utf8 NOT NULL AFTER `token`, ADD `verify_throttle` DATETIME NOT NULL AFTER `verify_key`" );

		//Columns added properly
		if ( $query ) {
			give_update_option( 'email_access_installed', 1 );
		}

	}


}

Pull Request — master (#571)

Give_Email_Access::check_for_token() C

Complexity

Size

Duplication

Code Coverage

Importance

Logical Operators are used for Control-Flow

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

WordImpress / Give

Pull Request — master (#571)

Give_Email_Access::check_for_token() C

Complexity

Size

Duplication

Code Coverage

Importance

Logical Operators are used for Control-Flow

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like