Merge pull request #3973 from impress-org/issue/3964

fix: improve UX of "View in Browser" link #3964

assets/src/js/frontend/give-ajax.js

@@ -282,20 +282,16 @@ jQuery( document ).ready( function( $ ) {
 
 		let data        = {
 				action: 'get_receipt',
-				shortcode_atts: receiptContainer.getAttribute('data-shortcode')
-			},
-			donation_id = Give.fn.getParameterByName('donation_id');
+				shortcode_atts: receiptContainer.getAttribute('data-shortcode'),
+				donation_id: receiptContainer.getAttribute( 'data-donation-key'),
+				receipt_type: receiptContainer.getAttribute( 'data-receipt-type'),
+			};
 
 		const cookie_name = Give.fn.getGlobalVar( 'session_cookie_name' );
 
 		// Set cookie.
 		data[cookie_name] = Give.fn.__getCookie( Give.fn.getGlobalVar( 'session_cookie_name' ) );
 
-		// Set donation id, if exists.
-		if( null !== donation_id ) {
-			data['donation_id'] = donation_id;
-		}
-
 		$.ajax({
 			url: Give.fn.getGlobalVar('ajaxurl'),
 			method: 'GET',

includes/ajax-functions.php

@@ -768,11 +768,14 @@ function give_confirm_email_for_donation_access() {
  * @since 2.2.0
  */
 function __give_get_receipt(){
-	if( ! isset( $_GET['shortcode_atts'] ) ) {
+
+	$get_data = give_clean( filter_input_array( INPUT_GET ) );
+
+	if( ! isset( $get_data['shortcode_atts'] ) ) {
 		give_die();
 	}
 
-	$atts = urldecode_deep( give_clean( $_GET['shortcode_atts'] ) );
+	$atts = (array) json_decode( $get_data['shortcode_atts'] );
 	$data = give_receipt_shortcode( $atts );
 
 	wp_send_json( $data );

includes/emails/class-give-email-tags.php

@@ -1130,14 +1130,14 @@ function give_email_tag_receipt_link( $tag_args ) {
 	$tag_args = __give_20_bc_str_type_email_tag_param( $tag_args );
 
 	$donation_id = give_check_variable( $tag_args, 'empty', 0, 'payment_id' );
-	$receipt_url = give_get_receipt_url( $donation_id );
+	$receipt_url = give_get_view_receipt_url( $donation_id );
 
 	// Bailout.
 	if ( give_get_option( 'email_template' ) === 'none' ) {
 		return $receipt_url;
 	}
 
-	$formatted = give_get_receipt_link( $tag_args['payment_id'] );
+	$formatted = give_get_view_receipt_link( $tag_args['payment_id'] );
 
 	/**
 	 * Filter the {receipt_link} email template tag output.
@@ -1169,7 +1169,7 @@ function give_email_tag_receipt_link_url( $tag_args ) {
 	// Backward compatibility.
 	$tag_args = __give_20_bc_str_type_email_tag_param( $tag_args );
 
-	$receipt_link_url = give_get_receipt_url( give_check_variable( $tag_args, 'empty', 0, 'payment_id' ) );
+	$receipt_link_url = give_get_view_receipt_url( give_check_variable( $tag_args, 'empty', 0, 'payment_id' ) );
 
 	/**
 	 * Filter the {receipt_link_url} email template tag output.
@@ -1186,30 +1186,6 @@ function give_email_tag_receipt_link_url( $tag_args ) {
 	);
 }
 
-
-/**
- * Get receipt_url
- *
- * @since 2.0
- *
- * @param int $donation_id Donation ID.
- *
- * @return string
- */
-function give_get_receipt_url( $donation_id ) {
-
-	$receipt_url = esc_url(
-		add_query_arg(
-			array(
-				'donation_id' => $donation_id,
-			), give_get_history_page_uri()
-		)
-	);
-
-	return $receipt_url;
-}
-
-
 /**
  * Email template tag: {email_access_link}
  *

includes/misc-functions.php

@@ -2315,3 +2315,166 @@ function give_get_receipt_link( $donation_id ) {
 	);
 
 }
+
+/**
+ * Get receipt_url
+ *
+ * @since 2.0
+ *
+ * @param int $donation_id Donation ID.
+ *
+ * @return string
+ */
+function give_get_receipt_url( $donation_id ) {
+
+	$receipt_url = esc_url(
+		add_query_arg(
+			array(
+				'donation_id' => $donation_id,
+			), give_get_history_page_uri()
+		)
+	);
+
+	return $receipt_url;
+}
+
+/**
+ * Get "View in browser" Receipt Link for email.
+ *
+ * @param int $donation_id Donation ID.
+ *
+ * @since 2.4.1
+ *
+ * @return string
+ */
+function give_get_view_receipt_link( $donation_id ) {
+
+	return sprintf(
+		'<a href="%1$s">%2$s</a>',
+		esc_url( give_get_view_receipt_url( $donation_id ) ),
+		esc_html__( 'View the receipt in your browser &raquo;', 'give' )
+	);
+
+}
+
+/**
+ * Get "View in browser" Receipt URL for email.
+ *
+ * @since 2.4.1
+ *
+ * @param int $donation_id Donation ID.
+ *
+ * @return string
+ */
+function give_get_view_receipt_url( $donation_id ) {
+
+	$receipt_url = esc_url(
+		add_query_arg(
+			array(
+                'action'     => 'view_in_browser',
+				'_give_hash' => give_get_payment_key( $donation_id ),
+			), give_get_history_page_uri()
+		)
+	);
+
+	return $receipt_url;
+}
+
+/**
+ * This function is used to display donation receipt content based on the parameters.
+ *
+ * @param $args
+ *
+ * @since 2.4.1
+ *
+ * @return bool|mixed
+ */
+function give_display_donation_receipt( $args ) {
+
+	global $give_receipt_args;
+
+	$give_receipt_args = $args;
+
+	ob_start();
+
+	$get_data     = give_clean( filter_input_array( INPUT_GET ) );
+	$donation_id  = ! empty( $get_data['donation_id'] ) ? $get_data['donation_id'] : false;
+	$receipt_type = ! empty( $get_data['receipt_type'] ) ? $get_data['receipt_type'] : false;
+
+	$give_receipt_args['id'] = $donation_id;
+
+	if ( 'view_in_browser' !== $receipt_type ) {
+
+		$email_access = give_get_option( 'email_access' );
+		$is_email_access = give_is_setting_enabled( $email_access ) && ! Give()->email_access->token_exists;
+
+
+		// No donation id found & Email Access is Turned on.
+		if ( ! $donation_id ) {
+
+			if( $is_email_access ){
+				give_get_template_part( 'email-login-form' );
+			} else{
+				echo Give()->notices->print_frontend_notice( $args['error'], false, 'error' );
+			}
+
+			return ob_get_clean();
+		}
+
+		// Donation id provided, but user is logged out. Offer them the ability to login and view the receipt.
+		if ( ! ( $user_can_view = give_can_view_receipt( $donation_id ) ) ) {
+
+			if( true === Give()->session->get( 'donor_donation_mismatch' ) ) {
+
+				/**
+				 * This filter will be used to modify the donor mismatch text for front end error notice.
+				 *
+				 * @since 2.3.1
+				 */
+				$donor_mismatch_text = apply_filters( 'give_receipt_donor_mismatch_notice_text', __( 'You are trying to access invalid donation receipt. Please try again.', 'give' ) );
+
+				echo Give()->notices->print_frontend_notice(
+					$donor_mismatch_text,
+					false,
+					'error'
+				);
+
+			} elseif( $is_email_access ) {
+
+				give_get_template_part( 'email-login-form' );
+
+			}else{
+
+				global $give_login_redirect;
+
+				$give_login_redirect = give_get_current_page_url();
+
+				Give()->notices->print_frontend_notice(
+					apply_filters( 'give_must_be_logged_in_error_message',
+						__( 'You must be logged in to view this donation receipt.', 'give' )
+					)
+				);
+
+				give_get_template_part( 'shortcode', 'login' );
+			}
+
+			return ob_get_clean();
+		}
+
+		/**
+		 * Check if the user has permission to view the receipt.
+		 *
+		 * If user is logged in, user ID is compared to user ID of ID stored in payment meta
+		 * or if user is logged out and donation was made as a guest, the donation session is checked for
+		 * or if user is logged in and the user can view sensitive shop data.
+		 */
+		if ( ! apply_filters( 'give_user_can_view_receipt', $user_can_view, $args ) ) {
+			return Give()->notices->print_frontend_notice( $args['error'], false, 'error' );
+		}
+
+	}
+
+	give_get_template_part( 'shortcode', 'receipt' );
+
+	return ob_get_clean();
+}