` cannot reach a remote host or a local file — but that is * the only guarantee. Everything else about the returned markup is * trusted, so only ever return escaped content. * * @param string $html Receipt HTML. * @param array $donation Donation data. * @param array|null $donor Donor data. * @since 1.0.0 */ $html = apply_filters( 'suredonation_receipt_html', $html, $donation, $donor ); // Ensure receipts directory exists. Pdf_Utils::ensure_receipts_dir(); $receipts_dir = Pdf_Utils::get_receipts_dir(); $default_filename = sprintf( 'suredonation-receipt-%d-%s.pdf', $donation_id, wp_generate_password( 8, false ) ); /** * Filter the receipt PDF filename. * * The default filename carries a random suffix; the receipts directory * is access-protected, but the suffix keeps individual filenames * unguessable as defense in depth. The filtered value is passed through * sanitize_file_name() and forced to a .pdf extension; an empty result * falls back to the default. * * @param string $default_filename Generated filename. * @param array $donation Donation data. * @param array|null $donor Donor data. * @since 1.5.0 */ $filename = apply_filters( 'suredonation_receipt_filename', $default_filename, $donation, $donor ); $filename = sanitize_file_name( Helper::get_string_value( $filename ) ); if ( '' === $filename ) { $filename = $default_filename; } elseif ( 'pdf' !== strtolower( pathinfo( $filename, PATHINFO_EXTENSION ) ) ) { $filename .= '.pdf'; } $filepath = $receipts_dir . '/' . $filename; try { $mpdf = new \Mpdf\Mpdf( self::get_mpdf_config( $donation, $donor ) ); /** * Fires after the mPDF instance is created, before the receipt HTML is written. * * Allows instance-level configuration the constructor config cannot * express — e.g. SetProtection() for password-protected receipts or * SetTitle()/SetAuthor() document metadata. * * @param \Mpdf\Mpdf $mpdf mPDF instance. * @param array $donation Donation data. * @param array|null $donor Donor data. * @since 1.5.0 */ do_action( 'suredonation_receipt_mpdf_instance', $mpdf, $donation, $donor ); $mpdf->WriteHTML( $html ); $mpdf->Output( $filepath, \Mpdf\Output\Destination::FILE ); } catch ( \Exception $e ) { return false; } // Store the relative path in the donation record (portable across domain changes). $upload_dir = wp_upload_dir(); $relative_path = str_replace( $upload_dir['basedir'] . '/', '', $filepath ); Donations::update( $donation_id, [ 'receipt_pdf_url' => $relative_path ] ); /** * Fires after a receipt PDF has been generated and stored. * * @param int $donation_id Donation ID. * @param string $filepath Absolute path to the generated PDF. * @param array $donation Donation data. * @since 1.5.0 */ do_action( 'suredonation_receipt_generated', $donation_id, $filepath, $donation ); return $filepath; } /** * Whether a receipt should be generated or served for a donation. * * @param array $donation Donation data. * @return bool * @since 1.5.0 */ private static function should_generate( $donation ) { /** * Short-circuit filter to disable receipt generation for a donation. * * Return false to prevent generating a new receipt PDF and to stop a * previously cached one from being served. Lets extensions disable * receipts selectively — e.g. a per-form "disable PDF receipt" * setting keyed on the donation's form_id. * * @param bool $should_generate Whether to generate/serve the receipt. Default true. * @param array $donation Donation data. * @since 1.5.0 */ return (bool) apply_filters( 'suredonation_should_generate_receipt', true, $donation ); } /** * Delete a receipt PDF file by its stored uploads-relative path. * * Used by the personal-data eraser: the receipt is generated from the donor's * name/email/address, so an erasure must remove the file from disk, not just * the database columns. * * @since 1.2.0 * @param string $relative_path Relative path within the uploads directory. * @return bool True when no file remains (deleted or never existed), false when it survived deletion. */ public static function delete_receipt( $relative_path ) { $filepath = self::relative_to_path( $relative_path ); if ( false === $filepath || ! file_exists( $filepath ) ) { return true; } wp_delete_file( $filepath ); // Re-check with is_file() (not file_exists()) — wp_delete_file() has a // filesystem side effect PHPStan can't see, so re-calling the already // narrowed file_exists() reads as always-false to it. clearstatcache( true, $filepath ); return ! is_file( $filepath ); } /** * Get the mPDF configuration. * * @param array $donation Donation data. * @param array|null $donor Donor data. * @return array * @since 1.0.0 */ private static function get_mpdf_config( $donation = [], $donor = null ) { $config = [ 'mode' => 'utf-8', 'format' => 'A4', 'orientation' => 'P', 'margin_left' => 15, 'margin_right' => 15, 'margin_top' => 15, 'margin_bottom' => 15, 'default_font' => 'dejavusans', 'tempDir' => Pdf_Utils::get_temp_dir(), // mPDF resolves `` and CSS url() through stream wrappers, // and its default whitelist is ['http', 'https', 'file'] — so out of // the box a src can reach an internal host (SSRF) or read a local // file into the PDF (LFI). The receipt HTML is server-templated with // escaped fields, but the suredonation_receipt_html filter and the // Pro receipt templates both put author-controlled HTML through // WriteHTML(), and wp_kses_post() permits

. // // Emptying the whitelist is the actual control: Mpdf\File\ // StreamWrapperChecker then rejects every `scheme://` src before a // fetch happens. Nothing legitimate needs one — the logo is // embedded as a data: URI (no `://`, so the check never fires) and // local font/temp paths are plain paths. A blocked degrades to // mPDF's own imageError() handling rather than failing the render. 'whitelistStreamWrappers' => [], // Kept as defence in depth: if a filter callback ever re-whitelists // http(s), requests still verify SSL. This is not what stops the // fetch — the whitelist above is. 'curlAllowUnsafeSslRequests' => false, ]; /** * Filter the mPDF configuration used for receipt generation. * * SECURITY NOTE: 'whitelistStreamWrappers' is emptied deliberately. * Restoring any entry lets HTML that reaches WriteHTML() fetch that * scheme, which is SSRF for http(s) and LFI for file://. It is * force-reset to [] after this filter runs, so callbacks cannot widen * it; resolve trusted assets (e.g. a logo attachment) to a data: URI or * a validated local path server-side instead. * * @param array $config mPDF configuration. * @param array $donation Donation data. * @param array|null $donor Donor data. * @since 1.5.0 */ $config = apply_filters( 'suredonation_receipt_mpdf_config', $config, $donation, $donor ); $config = is_array( $config ) ? $config : []; // Enforced post-filter: an empty stream-wrapper whitelist is what gates // LFI/SSRF in mPDF, so it stays empty regardless of what filter // callbacks return. $config['whitelistStreamWrappers'] = []; $config['curlAllowUnsafeSslRequests'] = false; return $config; } /** * Build the receipt HTML template. * * @param array $donation Donation data. * @param array|null $donor Donor data. * @param string $campaign_title Campaign title. * @return string HTML content. * @since 1.0.0 */ private static function build_receipt_html( $donation, $donor, $campaign_title ) { $site_name = esc_html( get_bloginfo( 'name' ) ); $site_url = esc_url( site_url() ); $donation_id = Helper::get_integer_value( $donation['id'] ?? 0 ); // Prefer the name captured on this specific donation — it is the correct // identity for a tax receipt and is unaffected by the donor record being // set-once. Fall back to the donor record only when the donation itself // carries no name. $donation_donor_name = Helper::get_string_value( $donation['donor_name'] ?? '' ); $donor_name = esc_html( '' !== $donation_donor_name ? $donation_donor_name : Helper::get_string_value( $donor['name'] ?? '' ) ); $donor_email = esc_html( Helper::get_string_value( $donor['email'] ?? '' ) ); $payment_status = esc_html( ucfirst( Helper::get_string_value( $donation['payment_status'] ?? '' ) ) ); $payment_method = esc_html( ucfirst( Helper::get_string_value( $donation['gateway'] ?? '' ) ) ); $transaction_id = esc_html( Helper::get_string_value( $donation['transaction_id'] ?? '' ) ); $currency = Helper::get_string_value( $donation['currency'] ?? 'USD' ); $total = Helper::get_float_value( $donation['amount'] ?? 0 ); $fees_covered = Helper::get_float_value( $donation['fees_covered'] ?? 0 ); $amount = $total - $fees_covered; $date = Helper::get_string_value( $donation['created_at'] ?? '' ); if ( ! empty( $date ) ) { $date_format = Helper::get_string_value( get_option( 'date_format' ) ); $timestamp = strtotime( $date ); $formatted_date = false !== $timestamp ? wp_date( $date_format, $timestamp ) : false; $date = is_string( $formatted_date ) ? $formatted_date : $date; } $campaign_title = esc_html( $campaign_title ); // Format amounts. $formatted_amount = self::format_currency( $amount, $currency ); $formatted_fees = self::format_currency( $fees_covered, $currency ); $formatted_total = self::format_currency( $total, $currency ); // Build transaction ID row. $transaction_row = ''; if ( ! empty( $transaction_id ) ) { $transaction_row = sprintf( '%s %s', esc_html__( 'Transaction ID', 'suredonation' ), $transaction_id ); } // Build fees row. $fees_row = ''; if ( $fees_covered > 0 ) { $fees_row = sprintf( '%s %s', esc_html__( 'Fees Covered', 'suredonation' ), $formatted_fees ); } return '

' . $site_name . '

' . esc_html__( 'Donation Receipt', 'suredonation' ) . '

' . esc_html__( 'Receipt', 'suredonation' ) . ' #' . $donation_id . '

' . esc_html__( 'Donor Name', 'suredonation' ) . '	' . $donor_name . '
' . esc_html__( 'Donor Email', 'suredonation' ) . '	' . $donor_email . '

' . $transaction_row . ' ' . $fees_row . '

' . esc_html__( 'Campaign Name', 'suredonation' ) . '	' . $campaign_title . '
' . esc_html__( 'Payment Status', 'suredonation' ) . '	' . $payment_status . '
' . esc_html__( 'Payment Method', 'suredonation' ) . '	' . $payment_method . '
' . esc_html__( 'Donation Amount', 'suredonation' ) . '	' . $formatted_amount . '
' . esc_html__( 'Donation Total', 'suredonation' ) . '	' . $formatted_total . '

' . esc_html__( 'Date', 'suredonation' ) . ': ' . esc_html( $date ) . '

' . sprintf( /* translators: 1: Site name, 2: Site URL. */ esc_html__( 'Generated by %1$s · %2$s', 'suredonation' ), $site_name, $site_url ) . '

'; } /** * Format a monetary amount with currency symbol. * * @param float $amount Amount to format. * @param string $currency Currency code. * @return string Formatted amount. * @since 1.0.0 */ private static function format_currency( $amount, $currency = 'USD' ) { // Delegate to the single source of truth so the currency symbol, // decimal handling and sign position match every other surface // (this replaces a divergent local symbol map). return Payment_Helper::format_amount( $amount, $currency ); } /** * Convert a relative path to an absolute file path. * * @param string $relative_path Relative path within the uploads directory. * @return string|false Absolute file path or false. * @since 1.0.0 */ private static function relative_to_path( $relative_path ) { if ( empty( $relative_path ) ) { return false; } $upload_dir = wp_upload_dir(); return $upload_dir['basedir'] . '/' . $relative_path; } }