order ); if ( ! is_null( $existing_receipt_filename ) ) { return $existing_receipt_filename; } } $expiration_date ??= $this->legacy_proxy->call_function( 'gmdate', 'Y-m-d', $this->legacy_proxy->call_function( 'strtotime', '+1 days' ) ); // phpcs:ignore WordPress.PHP.DontExtract.extract_extract extract( $this->get_order_data( $order ) ); ob_start(); include __dir__ . '/Templates/order-receipt.php'; $rendered_template = ob_get_contents(); ob_end_clean(); $file_name = $this->transient_files_engine->create_transient_file( $rendered_template, $expiration_date ); $order->update_meta_data( self::RECEIPT_FILE_NAME_META_KEY, $file_name ); $order->save_meta_data(); return $file_name; } /** * Get the file name of an existing receipt file for an order. * * A receipt is considered to be available for the order if there's an order meta entry with key * RECEIPT_FILE_NAME_META_KEY AND the transient file it points to exists AND it has not expired. * * @param WC_Order $order The order object or order id to get the receipt for. * @return string|null The receipt file name, or null if no receipt is currently available for the order. * @throws Exception Thrown if a wrong file path is passed. */ public function get_existing_receipt( $order ): ?string { if ( ! $order instanceof WC_Order ) { $order = wc_get_order( $order ); if ( false === $order ) { return null; } } $existing_receipt_filename = $order->get_meta( self::RECEIPT_FILE_NAME_META_KEY, true ); if ( '' === $existing_receipt_filename ) { return null; } $file_path = $this->transient_files_engine->get_transient_file_path( $existing_receipt_filename ); if ( is_null( $file_path ) ) { return null; } return $this->transient_files_engine->file_has_expired( $file_path ) ? null : $existing_receipt_filename; } /** * Get the order data that the receipt template will use. * * @param WC_Order $order The order to get the data from. * @return array The order data as an associative array. */ private function get_order_data( WC_Order $order ): array { $store_name = get_bloginfo( 'name' ); if ( $store_name ) { /* translators: %s = store name */ $receipt_title = sprintf( __( 'Receipt from %s', 'woocommerce' ), $store_name ); } else { $receipt_title = __( 'Receipt', 'woocommerce' ); } $order_id = $order->get_id(); if ( $order_id ) { /* translators: %d = order id */ $summary_title = sprintf( __( 'Summary: Order #%d', 'woocommerce' ), $order->get_id() ); } else { $summary_title = __( 'Summary', 'woocommerce' ); } $get_price_args = array( 'currency' => $order->get_currency() ); $line_items_info = array(); $line_items = $order->get_items( 'line_item' ); foreach ( $line_items as $line_item ) { $line_item_product = $line_item->get_product(); $line_item_title = ( $line_item_product instanceof \WC_Product_Variation ) ? ( wc_get_product( $line_item_product->get_parent_id() )->get_name() ) . '. ' . $line_item_product->get_attribute_summary() : $line_item_product->get_name(); $line_items_info[] = array( 'title' => wp_kses( $line_item_title, array() ), 'quantity' => $line_item->get_quantity(), 'amount' => wc_price( $line_item->get_subtotal(), $get_price_args ), ); } $line_items_info[] = array( 'title' => __( 'Subtotal', 'woocommerce' ), 'amount' => wc_price( $order->get_subtotal(), $get_price_args ), ); $coupon_names = ArrayUtil::select( $order->get_coupons(), 'get_name', ArrayUtil::SELECT_BY_OBJECT_METHOD ); if ( ! empty( $coupon_names ) ) { $line_items_info[] = array( /* translators: %s = comma-separated list of coupon codes */ 'title' => sprintf( __( 'Discount (%s)', 'woocommerce' ), join( ', ', $coupon_names ) ), 'amount' => wc_price( -$order->get_total_discount(), $get_price_args ), ); } foreach ( $order->get_fees() as $fee ) { $name = $fee->get_name(); $line_items_info[] = array( 'title' => '' === $name ? __( 'Fee', 'woocommerce' ) : $name, 'amount' => wc_price( $fee->get_total(), $get_price_args ), ); } $shipping_total = (float) $order->get_shipping_total(); if ( $shipping_total ) { $line_items_info[] = array( 'title' => __( 'Shipping', 'woocommerce' ), 'amount' => wc_price( $order->get_shipping_total(), $get_price_args ), ); } $total_taxes = 0; foreach ( $order->get_taxes() as $tax ) { $total_taxes += (float) $tax->get_tax_total() + (float) $tax->get_shipping_tax_total(); } if ( $total_taxes ) { $line_items_info[] = array( 'title' => __( 'Taxes', 'woocommerce' ), 'amount' => wc_price( $total_taxes, $get_price_args ), ); } $line_items_info[] = array( 'title' => __( 'Amount Paid', 'woocommerce' ), 'amount' => wc_price( $order->get_total(), $get_price_args ), ); return array( 'constants' => array( 'font_size' => self::FONT_SIZE, 'margin' => self::MARGIN, 'title_font_size' => self::TITLE_FONT_SIZE, 'footer_font_size' => self::FOOTER_FONT_SIZE, 'line_height' => self::LINE_HEIGHT, 'icon_height' => self::ICON_HEIGHT, 'icon_width' => self::ICON_WIDTH, ), 'texts' => array( 'receipt_title' => $receipt_title, 'amount_paid_section_title' => __( 'Amount Paid', 'woocommerce' ), 'date_paid_section_title' => __( 'Date Paid', 'woocommerce' ), 'payment_method_section_title' => __( 'Payment method', 'woocommerce' ), 'summary_section_title' => $summary_title, 'order_notes_section_title' => __( 'Notes', 'woocommerce' ), 'app_name' => __( 'Application Name', 'woocommerce' ), 'aid' => __( 'AID', 'woocommerce' ), 'account_type' => __( 'Account Type', 'woocommerce' ), ), 'formatted_amount' => wc_price( $order->get_total(), $get_price_args ), 'formatted_date' => wc_format_datetime( $order->get_date_paid() ), 'line_items' => $line_items_info, 'payment_method' => $order->get_payment_method_title(), 'notes' => array_map( 'get_comment_text', $order->get_customer_order_notes() ), 'payment_info' => $this->get_woo_pay_data( $order ), ); } /** * Get the order data related to WooCommerce Payments. * * It will return null if any of these is true: * * - Payment method is not 'woocommerce_payments". * - WooCommerce Payments is not installed. * - No intent id is stored for the order. * - Retrieving the payment information from Stripe API (providing the intent id) fails. * - The received data set doesn't contain the expected information. * * @param WC_Order $order The order to get the data from. * @return array|null An array of payment information for the order, or null if not available. */ private function get_woo_pay_data( WC_Order $order ): ?array { // For testing purposes: if WooCommerce Payments development mode is enabled, // an order meta item with key '_wcpay_payment_details' will be used if it exists as a replacement // for the call to the Stripe API's 'get intent' endpoint. // The value must be the JSON encoding of an array simulating the "payment_details" part of the response from the endpoint // (at the very least it must contain the "card_present" key). $payment_details = json_decode( defined( 'WCPAY_DEV_MODE' ) && WCPAY_DEV_MODE ? $order->get_meta( '_wcpay_payment_details' ) : false, true ); if ( ! $payment_details ) { if ( 'woocommerce_payments' !== $order->get_payment_method() ) { return null; } if ( ! class_exists( \WC_Payments::class ) ) { return null; } $intent_id = $order->get_meta( '_intent_id' ); if ( ! $intent_id ) { return null; } try { $payment_details = \WC_Payments::get_payments_api_client()->get_intent( $intent_id )->get_charge()->get_payment_method_details(); } catch ( Exception $ex ) { $order_id = $order->get_id(); $message = $ex->getMessage(); wc_get_logger()->error( StringUtil::class_name_without_namespace( static::class ) . " - retrieving info for charge {$intent_id} for order {$order_id}: {$message}" ); return null; } } $card_data = $payment_details['card_present'] ?? null; if ( is_null( $card_data ) ) { return null; } $card_brand = $card_data['brand'] ?? ''; if ( ! in_array( $card_brand, self::KNOWN_CARD_TYPES, true ) ) { $card_brand = 'unknown'; } // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode, WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents $card_svg = base64_encode( file_get_contents( __DIR__ . "/CardIcons/{$card_brand}.svg" ) ); return array( 'card_icon' => $card_svg, 'card_last4' => wp_kses( $card_data['last4'] ?? '', array() ), 'app_name' => wp_kses( $card_data['receipt']['application_preferred_name'] ?? null, array() ), 'aid' => wp_kses( $card_data['receipt']['dedicated_file_name'] ?? null, array() ), 'account_type' => wp_kses( $card_data['receipt']['account_type'] ?? null, array() ), ); } }