sanitize_text_field( self::field( $posted, 'key_prefix' ) ),
'base_url' => esc_url_raw( self::field( $posted, 'base_url' ) ),
'pixel_url' => esc_url_raw( self::field( $posted, 'pixel_url' ) ),
'program_id' => (int) self::field( $posted, 'program_id' ),
'store_ref' => sanitize_text_field( self::field( $posted, 'store_ref' ) ),
'test_mode' => empty( $posted['test_mode'] ) ? 0 : 1,
'enabled' => empty( $posted['enabled'] ) ? 0 : 1,
'beacon' => empty( $posted['beacon'] ) ? 0 : 1,
'pixel' => empty( $posted['pixel'] ) ? 0 : 1,
'report_all' => empty( $posted['report_all'] ) ? 0 : 1,
'cookie_days' => max( 1, min( 365, (int) self::field( $posted, 'cookie_days' ) ) ),
'timeout' => max( 1, min( 30, (int) self::field( $posted, 'timeout' ) ) ),
'paid_statuses' => self::posted_statuses( $posted ),
);
// A secret is only overwritten when a new one is typed. The field is
// rendered empty with a placeholder, so saving the page without
// touching it must not wipe the key.
$api_key = trim( self::field( $posted, 'api_key' ) );
if ( '' !== $api_key ) {
$values['api_key'] = sanitize_text_field( $api_key );
}
$secret = trim( self::field( $posted, 'signing_secret' ) );
if ( '' !== $secret ) {
$values['signing_secret'] = sanitize_text_field( $secret );
}
Affiliatant_Settings::save( $values );
self::back( 'saved' );
}
/**
* The connection test.
*
* It round-trips a REAL test conversion against a reserved reference, so
* it proves the key, the base URL, the programme id, the signature and
* the network in one go rather than only that a hostname resolves.
*
* is_test is always set, whatever the test-mode setting says, so pressing
* a button on a settings page can never create a real commission.
*
* @return void
*/
public static function handle_test() {
self::guard( 'affiliatant_test' );
if ( ! Affiliatant_Settings::configured() ) {
self::back( 'test_failed', __( 'Enter an API key and a programme id first.', 'affiliatant-for-woocommerce' ) );
}
$reference = 'AFFTEST-' . gmdate( 'ymd-His' );
try {
$payload = Affiliatant_Payload::connection_test(
(int) Affiliatant_Settings::get( 'program_id' ),
(string) Affiliatant_Settings::get( 'store_ref' ),
function_exists( 'get_woocommerce_currency' ) ? get_woocommerce_currency() : 'GBP',
$reference,
gmdate( 'c' )
);
$response = Affiliatant_Settings::client()->createConversion( $payload, $payload['event_id'] );
$detail = $reference;
if ( isset( $response['status'] ) && is_string( $response['status'] ) ) {
$detail .= ' (' . $response['status'] . ')';
}
Affiliatant_Settings::note_event( 'connection_test', $payload['event_id'], 0 );
self::back( 'test_ok', $detail );
} catch ( \Throwable $e ) {
// The message is Affiliatant's own error text. It never contains
// the key: the SDK keeps it out of exception messages and URLs.
Affiliatant_Settings::note_error( $e->getMessage(), 0 );
self::back( 'test_failed', $e->getMessage() );
}
}
/**
* Drain the queue now.
*
* @return void
*/
public static function handle_retry() {
self::guard( 'affiliatant_retry' );
$result = Affiliatant_Sender::drain( 50, 20 );
self::back(
'retried',
sprintf(
/* translators: 1: events sent, 2: events that failed */
__( '%1$d sent, %2$d still failing.', 'affiliatant-for-woocommerce' ),
(int) $result['sent'],
(int) $result['failed']
)
);
}
/**
* Delete the failed rows.
*
* @return void
*/
public static function handle_clear() {
self::guard( 'affiliatant_clear' );
$deleted = Affiliatant_Queue::clear_failed();
self::back(
'cleared',
sprintf(
/* translators: %d: rows removed */
__( '%d failed event removed.', 'affiliatant-for-woocommerce' ),
(int) $deleted
)
);
}
/**
* Attach a referral to an order by hand, and report it.
*
* The back-office case: the order was taken over the telephone, or
* created in wp-admin, so there was never a browser with an aftid in it.
*
* This is a form on THIS page rather than a field on the order screen,
* because WooCommerce's own save hook for the order screen,
* woocommerce_process_shop_order_meta, RETURNS EARLY WITHOUT FIRING WHEN
* HPOS IS ENABLED. Hanging the save off it would work on a legacy install
* and silently do nothing on a modern one, which is the worst of the two.
*
* @return void
*/
public static function handle_set_click() {
self::guard( 'affiliatant_set_click' );
$order_id = isset( $_POST['order_id'] ) ? (int) $_POST['order_id'] : 0; // phpcs:ignore WordPress.Security.NonceVerification.Missing -- guard() ran check_admin_referer.
$click_id = isset( $_POST['click_id'] ) ? Affiliatant_Capture::clean_click_id( sanitize_text_field( wp_unslash( $_POST['click_id'] ) ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Missing
$order = $order_id > 0 ? wc_get_order( $order_id ) : false;
if ( ! is_a( $order, 'WC_Order' ) ) {
self::back( 'manual_failed', __( 'No such order.', 'affiliatant-for-woocommerce' ) );
}
if ( '' === $click_id ) {
self::back( 'manual_failed', __( 'That is not a valid referral id.', 'affiliatant-for-woocommerce' ) );
}
Affiliatant_Order::set_click( $order, $click_id );
$queued = Affiliatant_Reporter::report_sale( $order );
self::back(
'manual_ok',
$queued
? sprintf(
/* translators: %d: order id */
__( 'Order %d is now attributed and has been queued.', 'affiliatant-for-woocommerce' ),
$order_id
)
: sprintf(
/* translators: %d: order id */
__( 'Order %d is now attributed. It was already reported, so nothing new was queued.', 'affiliatant-for-woocommerce' ),
$order_id
)
);
}
// -----------------------------------------------------------------
// The page
// -----------------------------------------------------------------
/**
* Render the settings page.
*
* @return void
*/
public static function render() {
if ( ! current_user_can( self::CAP ) ) {
wp_die( esc_html__( 'You do not have permission to see this page.', 'affiliatant-for-woocommerce' ) );
}
Affiliatant_Settings::flush();
$settings = Affiliatant_Settings::all();
$counts = Affiliatant_Queue::counts();
$events = Affiliatant_Queue::recent( 20 );
$action = esc_url( admin_url( 'admin-post.php' ) );
echo '
' . esc_html__( 'Attribute an order by hand', 'affiliatant-for-woocommerce' ) . '
';
echo '
' . esc_html__( 'For an order taken over the telephone or created in the admin, where there was never a browser carrying a referral.', 'affiliatant-for-woocommerce' ) . '
' . esc_html__( 'Enter the secret API key, the signing secret and the programme id above, and save.', 'affiliatant-for-woocommerce' ) . '
';
echo '
' . esc_html__( 'Press Send a test conversion. It should name an AFFTEST- reference, and that reference should appear in the Affiliatant console flagged as test data.', 'affiliatant-for-woocommerce' ) . '
';
echo '
' . esc_html__( 'Visit any page of the shop with ?aftid= and a referral id on it, then place a test order and check it appears here as sent.', 'affiliatant-for-woocommerce' ) . '
';
echo '
' . esc_html__( 'If the shop is behind a page cache, check the referral still records with the page served from cache. That is what the beacon is for and it is the one thing worth testing twice.', 'affiliatant-for-woocommerce' ) . '
';
echo '';
echo '
';
}
/**
* An informational panel on the order screen.
*
* Read only. The merchant attributes an order from the Affiliatant page,
* for the HPOS reason given on handle_set_click().
*
* The order screen id differs between the legacy post table and HPOS,
* and wc_get_page_screen_id() does not exist on every version that can
* run this plugin. All three are offered, so the panel appears on
* whichever the store actually uses and is simply absent otherwise.
*
* @return void
*/
public static function meta_box() {
$screens = array( 'shop_order', 'woocommerce_page_wc-orders' );
if ( function_exists( 'wc_get_page_screen_id' ) ) {
$screens[] = wc_get_page_screen_id( 'shop-order' );
}
add_meta_box(
'affiliatant-order',
__( 'Affiliatant', 'affiliatant-for-woocommerce' ),
array( __CLASS__, 'render_meta_box' ),
array_values( array_unique( array_filter( $screens ) ) ),
'side',
'default'
);
}
/**
* Render the order panel.
*
* @param WP_Post|WC_Order $post_or_order Whatever the screen handed us.
* @return void
*/
public static function render_meta_box( $post_or_order ) {
$order = is_a( $post_or_order, 'WC_Order' ) ? $post_or_order : wc_get_order( $post_or_order );
if ( ! is_a( $order, 'WC_Order' ) ) {
return;
}
$context = Affiliatant_Order::context( $order );
echo '
';
}
/**
* A one-button form, so every action is a POST with its own nonce.
*
* @param string $action Form action URL, already escaped.
* @param string $name admin_post action name.
* @param string $label Button text.
* @param string $class CSS classes.
* @return void
*/
private static function button( $action, $name, $label, $class ) {
echo '';
}
/**
* One row of the status table.
*
* @param string $label Label.
* @param string $value Value.
* @return void
*/
private static function status_row( $label, $value ) {
echo '
' . esc_html( $label ) . '
' . esc_html( $value ) . '
';
}
/**
* A text input row.
*
* @param string $name Field name.
* @param string $label Label.
* @param string $value Current value.
* @param string $description Help text.
* @return void
*/
private static function text_field( $name, $label, $value, $description ) {
echo '
';
echo '';
if ( '' !== $description ) {
echo '
' . esc_html( $description ) . '
';
}
echo '
';
}
/**
* A secret input row. The stored value is NEVER rendered.
*
* @param string $name Field name.
* @param string $label Label.
* @param string $stored Stored value, used only to say whether one is set.
* @param string $description Help text.
* @return void
*/
private static function password_field( $name, $label, $stored, $description ) {
echo '
';
echo '';
if ( '' !== $description ) {
echo '
' . esc_html( $description ) . '
';
}
echo '
';
}
/**
* A checkbox row.
*
* @param string $name Field name.
* @param string $label Label.
* @param int $value 1 or 0.
* @param string $description Help text.
* @return void
*/
private static function checkbox( $name, $label, $value, $description ) {
echo '
' . esc_html( $label ) . '
';
echo '';
echo '
';
}
/**
* Is HPOS the authoritative store?
*
* Through WooCommerce's own feature check, not by reading the option, so
* it stays right if the option name ever changes.
*
* @return bool
*/
private static function hpos_enabled() {
if ( ! class_exists( '\Automattic\WooCommerce\Utilities\OrderUtil' ) ) {
return false;
}
return \Automattic\WooCommerce\Utilities\OrderUtil::custom_orders_table_usage_is_enabled();
}
/**
* A timestamp in the site's own timezone and format.
*
* @param int $timestamp Unix time.
* @return string
*/
private static function when( $timestamp ) {
if ( $timestamp <= 0 ) {
return '-';
}
return wp_date( get_option( 'date_format' ) . ' ' . get_option( 'time_format' ), $timestamp );
}
/**
* One posted field as a string.
*
* @param array $posted Unslashed POST.
* @param string $key Key.
* @return string
*/
private static function field( array $posted, $key ) {
return isset( $posted[ $key ] ) && is_scalar( $posted[ $key ] ) ? (string) $posted[ $key ] : '';
}
/**
* The posted paid statuses, cleaned.
*
* @param array $posted Unslashed POST.
* @return array
*/
private static function posted_statuses( array $posted ) {
if ( ! isset( $posted['paid_statuses'] ) || ! is_array( $posted['paid_statuses'] ) ) {
return array();
}
$clean = array();
foreach ( $posted['paid_statuses'] as $status ) {
$status = sanitize_key( (string) $status );
if ( '' !== $status ) {
$clean[] = $status;
}
}
return array_values( array_unique( $clean ) );
}
}