AyeCode / invoicing

includes/wpinv-gateway-functions.php

<?php
/**
 * Contains gateway functions.
 *
 */
defined( 'ABSPATH' ) || exit;

/**
 * Returns an array of payment gateways.
 *
 * @return array
 */
function wpinv_get_payment_gateways() {
    return apply_filters( 'wpinv_payment_gateways', array() );
}

function wpinv_payment_gateway_titles( $all_gateways ) {

    $options  = wpinv_get_options();
    $gateways = array();
    foreach ( $all_gateways as $key => $gateway ) {
        if ( ! empty( $options[ $key . '_title' ] ) ) {
            $all_gateways[ $key ]['checkout_label'] = __( $options[ $key . '_title' ], 'invoicing' );
        }

        $gateways[ $key ] = isset( $options[ $key . '_ordering' ] ) ? $options[ $key . '_ordering' ] : ( isset( $gateway['ordering'] ) ? $gateway['ordering'] : '' );
    }

    asort( $gateways );

    foreach ( $gateways as $gateway => $key ) {
        $gateways[ $gateway ] = $all_gateways[ $gateway ];
    }

    return $gateways;
}
add_filter( 'wpinv_payment_gateways', 'wpinv_payment_gateway_titles', 1000, 1 );

/**
 * Returns an array of enabled gateways.
 *
 * @param bool $sort
 * @return array
 */
function wpinv_get_enabled_payment_gateways( $sort = false ) {

    $enabled = array();

    foreach ( wpinv_get_payment_gateways() as $gateway => $data ) {

        if ( (int) wpinv_get_option( "{$gateway}_active", $gateway === 'manual' ) === 1 ) {
            $enabled[ $gateway ] = $data;
        }
}

    if ( true === $sort ) {
        uasort( $enabled, 'wpinv_sort_gateway_order' );

        // Reorder our gateways so the default is first
        $default_gateway_id = wpinv_get_default_gateway();
        if ( isset( $enabled[ $default_gateway_id ] ) ) {
            $default_gateway = array(
                $default_gateway_id => $enabled[ $default_gateway_id ],
            );

            unset( $enabled[ $default_gateway_id ] );
            $enabled = array_merge( $default_gateway, $enabled );
        }
}

    return apply_filters( 'wpinv_enabled_payment_gateways', $enabled );
}

function wpinv_sort_gateway_order( $a, $b ) {
    return $a['ordering'] - $b['ordering'];
}

/**
 * Checks if a given gateway is active.
 *
 * @param string $gateway
 * @return bool
 */
function wpinv_is_gateway_active( $gateway ) {
    $is_active = (int) wpinv_get_option( "{$gateway}_active", $gateway === 'manual' ) === 1;
    return apply_filters( 'wpinv_is_gateway_active', $is_active, $gateway );
}

/**
 * Retrieves the default gateway.
 *
 * @return string|false
 */
function wpinv_get_default_gateway() {
    $default  = wpinv_get_option( 'default_gateway' );
    $gateways = wpinv_get_enabled_payment_gateways();
    $default  = ! empty( $default ) && isset( $gateways[ $default ] ) ? $default : false;

    return apply_filters( 'wpinv_default_gateway', $default );
}

/**
 * Returns a gateway's name.
 *
 * @param string $gateway The gateway to key.
 * @return string
 */
function wpinv_get_gateway_admin_label( $gateway ) {

    if ( empty( $gateway ) || 'none' == $gateway ) {
        return esc_html__( 'No Gateway', 'invoicing' );
    }

    $gateways = wpinv_get_payment_gateways();
    $label    = isset( $gateways[ $gateway ] ) ? $gateways[ $gateway ]['admin_label'] : $gateway;
    $gateway  = apply_filters( 'wpinv_gateway_admin_label', $label, $gateway );

    return wpinv_clean( $gateway );

The expression return wpinv_clean($gateway) also could return the type array which is incompatible with the documented return type string.

}

/**
 * Retrieves the gateway description.
 *
 * @param string $gateway
 */
function wpinv_get_gateway_description( $gateway ) {

    $options     = wpinv_get_options();
    $description = ! empty( $options[ $gateway . '_desc' ] ) ? $options[ $gateway . '_desc' ] : '';

    return apply_filters( 'wpinv_gateway_description', $description, $gateway );
}

function wpinv_get_gateway_button_label( $gateway ) {
    return apply_filters( 'wpinv_gateway_' . $gateway . '_button_label', '' );
}

function wpinv_get_gateway_checkout_label( $gateway ) {
    $gateways = wpinv_get_payment_gateways();
    $label    = isset( $gateways[ $gateway ] ) ? $gateways[ $gateway ]['checkout_label'] : $gateway;

    if ( $gateway == 'none' ) {
        $label = __( 'None', 'invoicing' );
    }

    return apply_filters( 'wpinv_gateway_checkout_label', ucfirst( $label ), $gateway );
}

function wpinv_settings_sections_gateways( $settings ) {
    $gateways = wpinv_get_payment_gateways();
    ksort( $gateways );

    foreach ( $gateways as $key => $gateway ) {
        $settings[ $key ] = $gateway['admin_label'];
    }

    return $settings;
}
add_filter( 'wpinv_settings_sections_gateways', 'wpinv_settings_sections_gateways', 10, 1 );

/**
 * Adds GateWay settings.
 */
function wpinv_settings_gateways( $settings ) {

    // Loop through each gateway.
    foreach ( wpinv_get_payment_gateways() as $key => $gateway ) {

        $gateway_settings = array(

            // Header.
            "{$key}_header"   => array(

                'id'     => "{$key}_gateway_header",
                'name'   => '<h3>' . wp_sprintf( __( '%s Settings', 'invoicing' ), $gateway['admin_label'] ) . '</h3>',
                'custom' => $key,
                'type'   => 'gateway_header',

            ),

            // Activate/Deactivate a gateway.
            "{$key}_active"   => array(
                'id'   => $key . '_active',
                'name' => __( 'Activate', 'invoicing' ),
                'desc' => wp_sprintf( __( 'Enable %s', 'invoicing' ), $gateway['admin_label'] ),
                'type' => 'checkbox',
                'std'  => $key === 'manual' ? '1' : '0',
            ),

            // Activate/Deactivate sandbox.
            "{$key}_sandbox"  => array(
                'id'   => $key . '_sandbox',
                'name' => __( 'Sandbox', 'invoicing' ),
                'desc' => __( 'Enable sandbox to test payments', 'invoicing' ),
                'type' => 'checkbox',
                'std'  => '1',
            ),

            // Checkout title.
            "{$key}_title"    => array(
                'id'   => $key . '_title',
                'name' => __( 'Checkout Title', 'invoicing' ),
                'std'  => isset( $gateway['checkout_label'] ) ? $gateway['checkout_label'] : '',
                'type' => 'text',
            ),

            // Checkout description.
            "{$key}_desc"     => array(
                'id'   => $key . '_desc',
                'name' => __( 'Checkout Description', 'invoicing' ),
                'std'  => apply_filters( "getpaid_default_{$key}_checkout_description", '' ),
                'type' => 'text',
            ),

            // Checkout order.
            "{$key}_ordering" => array(
                'id'   => $key . '_ordering',
                'name' => __( 'Priority', 'invoicing' ),
                'std'  => apply_filters( "getpaid_default_{$key}_checkout_description", '' ),
                'type' => 'number',
                'step' => '1',
                'min'  => '0',
                'max'  => '100000',
                'std'  => isset( $gateway['ordering'] ) ? $gateway['ordering'] : '10',
            ),

        );

        // Maybe remove the sandbox.
        if ( ! getpaid_payment_gateway_supports( $key, 'sandbox' ) ) {
            unset( $gateway_settings[ "{$key}_sandbox" ] );
        }

        $gateway_settings = apply_filters( 'wpinv_gateway_settings', $gateway_settings, $key, $gateway );
        $gateway_settings = apply_filters( 'wpinv_gateway_settings_' . $key, $gateway_settings, $gateway );

        $settings[ $key ] = $gateway_settings;
    }

    do_action( 'getpaid_after_gateway_settings', $settings );
    return $settings;

}
add_filter( 'wpinv_settings_gateways', 'wpinv_settings_gateways', 10, 1 );

function wpinv_gateway_header_callback( $args ) {
    echo '<input type="hidden" id="wpinv_settings[save_gateway]" name="wpinv_settings[save_gateway]" value="' . esc_attr( $args['custom'] ) . '" />';
}

/**
 * Checks if a given gateway supports a given feature.
 *
 * @param string $gateway
 * @param string $feature
 * @return bool
 * @since 2.3.0
 */
function getpaid_payment_gateway_supports( $gateway, $feature ) {

    $supports = false;

The assignment to $supports is dead and can be removed.

    $supports = apply_filters( "getpaid_{$gateway}_supports_{$feature}", false );

    // Backwards compatibility.
    $supports = apply_filters( "wpinv_{$gateway}_supports_{$feature}", $supports );
    $supports = apply_filters( "wpinv_{$gateway}_support_{$feature}", $supports );

    $supports = apply_filters( "getpaid_gateway_supports_{$feature}", $supports, $gateway );
    $supports = apply_filters( 'getpaid_payment_gateway_supports', $supports, $feature, $gateway );

    return $supports;
}

function wpinv_get_chosen_gateway( $invoice_id = 0 ) {
	$gateways = array_keys( wpinv_get_enabled_payment_gateways() );

    $chosen = false;
    if ( $invoice_id > 0 && $invoice = wpinv_get_invoice( $invoice_id ) ) {
        $chosen = $invoice->get_gateway();
    }

	$chosen   = isset( $_REQUEST['payment-mode'] ) ? sanitize_text_field( $_REQUEST['payment-mode'] ) : $chosen;

	if ( false !== $chosen ) {
		$chosen = preg_replace( '/[^a-zA-Z0-9-_]+/', '', $chosen );
	}

	if ( ! empty( $chosen ) ) {
		$enabled_gateway = urldecode( $chosen );
	} elseif ( ! empty( $invoice ) && (float)$invoice->get_subtotal() <= 0 ) {
		$enabled_gateway = 'manual';
	} else {
		$enabled_gateway = wpinv_get_default_gateway();
	}

    if ( ! wpinv_is_gateway_active( $enabled_gateway ) && ! empty( $gateways ) ) {

It seems like $enabled_gateway can also be of type false; however, parameter $gateway of wpinv_is_gateway_active() does only seem to accept string, maybe add an additional type check?

        if ( wpinv_is_gateway_active( wpinv_get_default_gateway() ) ) {
            $enabled_gateway = wpinv_get_default_gateway();
        } else {
            $enabled_gateway = $gateways[0];
        }
}

	return apply_filters( 'wpinv_chosen_gateway', $enabled_gateway );
}

function wpinv_record_gateway_error( $title = '', $message = '' ) {
    return wpinv_error_log( $message, $title );

Are you sure the usage of wpinv_error_log($message, $title) is correct as it seems to always return null.

}

function wpinv_count_sales_by_gateway( $gateway_id = 'paypal', $status = 'publish' ) {
	$ret  = 0;
	$args = array(
		'meta_key'    => '_wpinv_gateway',
		'meta_value'  => $gateway_id,
		'nopaging'    => true,
		'post_type'   => 'wpi_invoice',
		'post_status' => $status,
		'fields'      => 'ids',
	);

	$payments = new WP_Query( $args );

	if ( $payments ) {

$payments is of type WP_Query, thus it always evaluated to true.

		$ret = $payments->post_count;
    }
	return $ret;
}

/**
 * Displays the ipn url field.
 */
function wpinv_ipn_url_callback( $args ) {
    $sanitize_id = esc_attr( wpinv_sanitize_key( $args['id'] ) );

    echo '<input class="regular-text" type="text" ' . ( $args['readonly'] ? ' readonly' : '' ) . ' value="' . esc_attr( $args['std'] ) . '" name="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" id="wpinv_settings[' . esc_attr( $sanitize_id ) . ']" onClick="this.select()">';
    echo '<label for="wpinv_settings[' . esc_attr( $sanitize_id ) . ']">' . wp_kses_post( $args['desc'] ) . '</label>';

}

/**
 * Checks if a gateway is in test mode.
 *
 * @param string $gateway The gateway to check for.
 *
 * @return bool
 */
function wpinv_is_test_mode( $gateway = '' ) {
    $sandbox  = empty( $gateway ) ? false : wpinv_get_option( "{$gateway}_sandbox", true );
    $supports = getpaid_payment_gateway_supports( $gateway, 'sandbox' );
    return apply_filters( 'wpinv_is_test_mode', $sandbox && $supports, $gateway );
}

/**
 * Retrieves the ipn url.
 *
 * @param string $gateway The gateway whose IPN url we should retrieve.
 * @param array $args extra args to add to the url.
 *
 * @return string
 */
function wpinv_get_ipn_url( $gateway = false, $args = array() ) {
    $args = wp_parse_args(
        array(
            'wpi-listener' => 'IPN',
            'wpi-gateway'  => $gateway,
        ),
        $args
    );

    return apply_filters( 'wpinv_ipn_url', add_query_arg( $args, home_url( 'index.php' ) ), $gateway, $args );

}

/**
 * Retrieves the non-query string ipn url.
 *
 * @param string $gateway The gateway whose IPN url we should retrieve.
 *
 * @return string
 */
function getpaid_get_non_query_string_ipn_url( $gateway ) {
    $gateway = wpinv_sanitize_key( $gateway );
    return home_url( "getpaid-ipn/$gateway" );
}


/**
 * Retrieves request data with slashes removed slashes.
 */
function wpinv_get_post_data( $method = 'request' ) {

    if ( $method == 'post' ) {
        return wp_kses_post_deep( wp_unslash( $_POST ) );
    }

    if ( $method == 'get' ) {
        return wp_kses_post_deep( wp_unslash( $_GET ) );
    }

    return wp_kses_post_deep( wp_unslash( $_REQUEST ) );

}

/**
 * Checks if a given gateway supports subscription payments.
 */
function wpinv_gateway_support_subscription( $gateway ) {
    return getpaid_payment_gateway_supports( $gateway, 'subscription' );
}

/**
 * Filters payment form gateways.
 *
 * @param array $gateways an array of gateways.
 * @param GetPaid_Payment_Form $form payment form.
 */
function wpinv_payment_gateways_on_cart( $gateways, $form ) {

    if ( $form->is_recurring() ) {

        foreach ( array_keys( $gateways ) as $gateway ) {

            if ( ! wpinv_gateway_support_subscription( $gateway ) ) {
                unset( $gateways[ $gateway ] );
            }
}
}

    return $gateways;
}
add_filter( 'getpaid_payment_form_gateways', 'wpinv_payment_gateways_on_cart', 10, 2 );