=== EU Withdrawal Button for WooCommerce ===
Contributors: riinagency
Tags: woocommerce, eu, withdrawal, consumer rights, returns
Requires at least: 6.2
Tested up to: 7.0
Requires PHP: 7.4
Requires Plugins: woocommerce
WC requires at least: 7.0
WC tested up to: 9.5
Stable tag: 2.1.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Helps WooCommerce store owners implement the withdrawal flow described in EU Directive 2023/2673.

== Description ==

EU Directive 2023/2673 introduces new requirements for online stores regarding consumer withdrawal rights, taking effect on **June 19, 2026**.

**EU Withdrawal Button for WooCommerce** helps you implement a clear, accessible withdrawal flow for your customers:

= The 4-Step Flow =

1. **Visible Button** — Sticky withdrawal bar (shown across your store by default, configurable per page type; always on My Account)
2. **Withdrawal Form** — Customer enters order number + email for verification; partial withdrawals supported
3. **Confirmation Step** — Order summary with a separate "Confirm withdrawal" button
4. **Notifications** — Confirmation email to customer + notification to merchant

= Free features =

* Sticky bar with configurable text and button, plus an optional footer link
* Modal popup or dedicated page mode
* Order validation (order number + email + withdrawal window check)
* Partial withdrawals: customers select the items and quantities to withdraw
* Optional refund IBAN field — stored encrypted, masked in lists and exports, auto-erased 30 days after completion
* Custom WooCommerce order statuses: "Withdrawal Requested" and "Withdrawal Closed"
* Withdrawals overview in the WordPress admin
* WooCommerce email integration (shows in WooCommerce → Settings → Emails)
* Guest-friendly withdrawal link in WooCommerce order emails — no account needed
* Return instructions link in the customer confirmation email
* WordPress privacy tools integration (GDPR data export and erasure)
* Support for custom order number plugins (Sequential Order Numbers, etc.)
* WCAG 2.1 AA accessible (keyboard navigation, focus trap, ARIA labels)
* Rate limiting for abuse prevention
* Translations bundled: Estonian, Finnish, French, Swedish, Italian, Dutch
* HPOS (High-Performance Order Storage) compatible

= Pro (paid) =

* One-click Complete/Reject actions with automatic customer emails
* My Account widgets: countdown badges and withdrawal status column
* Thank-You page and order-view withdrawal boxes
* Custom colors, styling and custom CSS
* Excluded categories and product-level exceptions
* GDPR consent checkbox on the withdrawal form
* Payment-method-aware IBAN field (hide for card payments)
* Statistics dashboard, CSV export, REST API
* Priority support

= Who Is This For? =

WooCommerce store owners who sell to EU consumers and want to provide a clear withdrawal process for their customers.

= Disclaimer =

This plugin is a technical tool that helps implement a withdrawal flow. It does not constitute legal advice and does not guarantee compliance with any specific regulation. Consult a legal professional to ensure your store meets all applicable requirements.

== Installation ==

1. Upload the `eu-withdrawal-button-for-woocommerce` folder to `/wp-content/plugins/`
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Go to WooCommerce → Settings → Withdrawal Button to configure
4. The withdrawal button will appear on your storefront

== Frequently Asked Questions ==

= What does this plugin do? =

It adds a visible withdrawal button to your store, along with a form where customers can submit withdrawal requests. The plugin validates the order, notifies both parties via email, and tracks the request.

= What happens when a customer submits a withdrawal? =

The customer receives a confirmation email, the merchant receives a notification, an order note is added, and the order status changes to "Withdrawal Requested" (configurable).

= Can I exclude certain products? =

Product category exclusions and per-product exceptions are available in the Pro version.

= What is the difference between the free and Pro versions? =

The free version covers the legal essentials: the withdrawal button, the form, order validation, notifications and a read-only withdrawals overview. Pro adds the merchant toolkit — one-click Complete/Reject with automatic customer emails, My Account widgets, styling, exclusions, GDPR consent checkbox, payment-method IBAN rules, statistics, CSV export and the REST API.

= Does it work with custom order number plugins? =

Yes, the plugin searches by WooCommerce order ID, custom order number meta fields, and order number output — compatible with Sequential Order Numbers and similar plugins.

= In which languages is the plugin available? =

English plus bundled translations for Estonian, Finnish, French, Swedish, Italian and Dutch. All texts are translation-ready (gettext), and merchant-entered texts can be translated per language with WPML/Polylang.

= Is my data sent to third parties? =

No. The plugin stores withdrawal data in your own WordPress database and makes no external requests. Refund IBANs are stored encrypted, shown masked, and erased automatically 30 days after a withdrawal is completed. The plugin integrates with the WordPress privacy tools (Tools → Export/Erase Personal Data).

== Translations ==

Bundled translations and their contributors:

* Estonian (et) — Riin Agency
* Finnish (fi) — Riin Agency
* French (fr_FR) — Riin Agency (community review welcome)
* Swedish (sv_SE) — Riin Agency (community review welcome)
* Italian (it_IT) — contributed by [Cristina Gregolin (Artilabio)](https://www.artilabio.com/)
* Dutch (nl_NL) — contributed by [Mark Govaerts (Bepos)](https://bepos.support/)

Want to contribute a translation? Email plugin@riin.eu — you will be credited here.

== Screenshots ==

1. Sticky bar with withdrawal button on the storefront
2. Withdrawal form modal
3. Confirmation step with order summary
4. WooCommerce settings page

== Changelog ==

= 2.1.0 =
* **New pricing model**: one free edition + one Pro plan (€79/year) with every paid feature. Existing Basic licenses purchased earlier remain fully valid.
* **New: withdrawals overview for everyone** — the free edition now shows the full withdrawals list in the admin (read-only; one-click management actions are Pro).
* **New: GDPR consent checkbox (Pro)** — optional privacy notice + required checkbox on the confirmation step, with a `{privacy_policy}` placeholder linking to your privacy policy page.
* **New: payment-method-aware IBAN field (Pro)** — optionally show the refund IBAN field only for offline payments (COD, bank transfer, cheque); card payments are refunded via the gateway.
* **New: IBAN protection (all plans)** — refund IBANs are now stored encrypted, displayed masked (EE38****5877) with an explicit reveal action, masked in CSV exports and REST responses, and automatically erased 30 days after the withdrawal is completed (with an audit note).
* **New: return instructions page** — select the page with your return instructions; the customer confirmation email links to it (falls back to your WooCommerce Terms page).
* **New: WordPress privacy tools integration** — withdrawal records are included in the built-in personal data export and erasure (Tools → Export/Erase Personal Data).
* **New translations: Italian and Dutch.** Italian contributed by Cristina Gregolin (Artilabio), Dutch contributed by Mark Govaerts (Bepos) — thank you!
* Fix: bundled translations now actually load — the `load_plugin_textdomain()` call was lost in the 2.0.0 refactor, so Estonian/Finnish/French/Swedish stores saw English.
* Fix: the Export CSV button (Pro) did nothing — its AJAX handler was never registered.
* Fix: the My Account countdown badge replaced the order number link; the linked order number is now always shown with the badge next to it.
* Fix: bulk "Mark as completed/rejected" now performs the complete flow (order status, order note, customer email, previous-status restore) exactly like the row actions; the REST API complete/reject endpoints too (previously the REST reject restored the wrong status and re-sent WooCommerce status emails).
* Fix: products in excluded categories (and Pro product-level exceptions) can no longer be selected in a partial withdrawal — exempt lines are shown unselectable and filtered server-side.
* Fix: the withdrawal form no longer fails on sites with full-page caching (the security nonce baked into cached HTML expired; the public endpoints now rely on rate limiting + order/email verification).
* Fix: the customer confirmation email no longer promises a refund deadline tied to the (possibly extended) withdrawal window, and only mentions the "withdrawal closed" email when that email actually exists and is enabled.
* Fix: fresh installs now show the sticky bar on all page types by default (existing installations keep their settings).
* Fix: plain-text emails no longer contain raw HTML; the merchant email order link is HPOS-safe.
* Fix: the "Require order validation" setting is now labelled accurately ("Require email match") — the order number was always verified regardless of the toggle.
* Performance: frontend CSS/JS and the modal markup now load only on pages with a withdrawal entry point; the admin orders list and My Account column no longer run one query per row.
* Developer: `ra_euwb_confirmation_before_actions` action in the form template; `ra_euwb_offline_payment_methods` filter; shared `set_withdrawal_status()` service behind admin, bulk and REST status changes.

= 2.0.2 =
* Fix: the optional footer "Right of withdrawal" link is now always visible — it previously inherited the theme's footer text colour and could blend into the background. It now sits on a light strip with a clearly coloured link.
* New: French (fr_FR), Finnish (fi) and Swedish (sv_SE) translations bundled.

= 2.0.1 =
* Fix: the withdrawal total on the confirmation step now updates live as the customer checks/unchecks items or changes quantities, instead of always showing the full order total.
* Fix: the withdrawal total now reflects only the selected line items — shipping, fees and other order lines are no longer included.
* Tweak: the confirmation total is now labelled "Withdrawal total" for clarity.
* Compatibility: tested up to WordPress 7.0.

= 2.0.0 =
* **WordPress.org edition**. First release published on the WordPress.org plugin directory. Feature parity with 1.5.x, Lite tier only. Paid upgrades continue to be distributed via riin.eu.
* Code: Full prefix refactor to `ra_euwb_` / `RA_EUWB_` / `ra-euwb-` across options, hooks, CSS classes, JS globals, nonces and admin menu slugs, to comply with the WordPress.org guidelines on unique prefixes. Existing WC order status slugs (`wc-ewb-withdrawn`, `wc-ewb-completed`), the database table (`{prefix}ewb_withdrawals`) and the `_ra_euwb_deactivated_withdrawal` order meta key are preserved so existing installations continue to work without data migration.
* Code: Removed all inline `<style>` and `<script>` output. Admin order-status colours and the frontend `ra-euwb-hidden` utility class are now part of the enqueued stylesheets. Frontend button colours are static (overridable via theme CSS) instead of dynamic option-backed inline styles.
* Code: Custom CSS setting removed from the free build (WordPress.org guideline: plugins must not execute arbitrary user-supplied CSS from options).
* Code: Text domain updated from `eu-withdrawal-button` to `eu-withdrawal-button-for-woocommerce` to match the WordPress.org plugin slug.
* Misc: Removed the now-unused `class-ewb-i18n.php` helper (text domain is loaded directly via `load_plugin_textdomain()` on `init`).

= 1.5.0 =
* **Compliance Update — EU Directive 2023/2673**. All compliance-critical features are available in the free version.
* **Guest-friendly direct link in order emails**: The WooCommerce customer "processing" and "completed" order emails now include a "Withdraw from this order" button. The link opens the withdrawal form pre-verified against the order — no login required. Solves the guest-checkout compliance gap (the directive explicitly requires that withdrawal must not depend on having a customer account).
* **Dismissible sticky bar**: Visitors can close the sticky bar with an X button. Dismissal is remembered for a configurable number of days (default 7, configurable 0–30) via `localStorage`. My Account pages ignore the dismissal and always show the bar (EU compliance — customer must be able to request a withdrawal there).
* **Partial withdrawal support**: Customers can now select specific items and quantities to withdraw instead of the whole order. The confirmation step shows per-item checkboxes and quantity inputs, pre-filled with the full order.
* **Optional IBAN field**: Customers can provide a bank account for the refund (useful when they paid by card or want the refund sent to a different account). Leaving it empty tells the merchant to refund to the original payment method. The IBAN is shown prominently in the merchant notification email and in the admin withdrawals list.
* **Configurable sticky bar display**: New "Show sticky bar on" multiselect under Withdrawal Button → General lets merchants pick which page types show the sticky bar (Homepage, Shop & product pages, Cart & checkout, Other). The My Account pages always show the sticky bar (EU compliance — customer must be able to request a withdrawal there). Existing installations default to **My Account pages only** after the upgrade, so update your settings if you want the sticky bar elsewhere.
* **Discreet footer link**: Optional small "Right of withdrawal" link can be shown in the footer (useful when the sticky bar is disabled on most pages).
* Admin: Withdrawals list now shows a Full / Partial badge and a hoverable list of the selected items per request, plus a dedicated IBAN column.
* Emails: Customer confirmation and merchant notification emails now list only the selected withdrawn items (with a partial-withdrawal notice when applicable) and show the IBAN. Legacy rows from pre-1.5.0 fall back to the full-order view.
* Database: New `withdrawn_items` (JSON) and `iban` columns on `{prefix}ewb_withdrawals`. The upgrade runs automatically on plugin load via `dbDelta()` — no manual action required.
* Security: Submitted item selections are re-validated server-side against the actual order (quantities clamped, unknown items rejected) to prevent tampering.
* Security hardening (CIA audit pass): (a) CSV export now escapes spreadsheet formula injection (leading `=`, `+`, `-`, `@`, tab, CR) and includes the `Withdrawn Items` + `IBAN` columns that were previously silently misaligned. (b) Client IP detection no longer trusts `HTTP_X_FORWARDED_FOR` / `HTTP_CLIENT_IP` by default — sites behind a trusted reverse proxy (e.g. Cloudflare) can opt in via the `ewb_trust_forwarded_ip` filter. (c) Submission now holds a MySQL advisory lock per order around the duplicate check + insert, closing the race window that allowed two simultaneous clicks to create duplicate withdrawal rows. (d) The public `ewb_validate_order` and `ewb_lookup_by_key` endpoints are now rate-limited (30 requests per 5 minutes per IP). (e) "Order not found" and "email does not match the order" are collapsed into a single generic verification error to prevent order enumeration. (f) Support form Reply-To header explicitly strips CR/LF defending against header injection.

= 1.4.0 =
* IMPORTANT: Clarified "Withdrawal Completed" semantics. Renamed the user-facing label to "Withdrawal Closed" everywhere it appeared (order status, emails, order notes, My Account box, admin). The status no longer implies that an automatic refund has been issued — merchants must refund manually via WooCommerce → Orders. Automatic `wc_create_refund()` integration is planned for a future Pro release. Internal status slug (`wc-ewb-completed`) is unchanged so existing orders continue to work.
* IMPORTANT FIX: The sticky bar, withdrawal form, confirmation email, "closed" email and admin information guide previously hardcoded "14 days" even when merchants configured a different `ewb_withdrawal_days` value. All texts now reflect the configured value dynamically with proper single/plural handling. Merchants can also use the `{days}` placeholder in the custom Bar text field.
* Updated customer closed-request email to clearly state that the merchant will issue the refund manually, instead of claiming the refund has already been processed.
* Added a "Heads up" admin notice on every plugin settings tab explaining the manual refund workflow.
* Performance & reliability: Order number lookup fallback (step 3) now filters by the configured withdrawal window (days + 2 buffer) instead of the arbitrary "last 500 orders" limit, and is capped at 1000 orders scanned. Both bounds are adjustable via the `ewb_order_lookup_cutoff_date` and `ewb_order_lookup_max_scan` filters. A warning is logged if the fallback triggers — this helps merchants spot custom order number plugins that don't use the standard `_order_number` meta key.
* Code quality: Custom CSS (Basic+) now uses `wp_add_inline_style()` attached to the main `ewb-frontend` stylesheet handle instead of printing a raw `<style>` tag on `wp_head`. This integrates with minify/cache plugins and follows WordPress standards.

= 1.3.3 =
* Fix: Removed the `parent => woocommerce` menu setting so the Freemius SDK can properly register its own admin pages (connect/opt-in, account, pricing). Previously the activation flow tried to redirect users to `admin.php?page=ewb-withdrawal` which WordPress rejected with "Sorry, you are not allowed to access this page." because the submenu was never registered. Plugin Settings link still opens WooCommerce → Settings → Withdrawal Button via `first-path`.

= 1.3.2 =
* Fix: Freemius "Opt In" and Account/Pricing pages now work correctly. Previously the menu used an embedded WooCommerce settings URL as its slug, which prevented the Freemius SDK from rendering its own admin pages (opt-in form, account, pricing, checkout)
* Added a dedicated `ewb-withdrawal` plugin page for Freemius SDK, with `first-path` redirecting Settings link to the WooCommerce → Settings → Withdrawal Button tab (existing UX preserved)

= 1.3.1 =
* Fix: "Get Basic" and "Get Pro" buttons in the Upgrade tab now open the Freemius in-admin checkout (iframe) instead of redirecting to the marketing site
* Fix: Restored the "License" / "Activate License" link on the Plugins page by registering the Freemius account page (`ewb-account`)
* Added dedicated Freemius pricing page (`ewb-pricing`) for in-admin checkout flow
* Updated Upgrade tab FAQ to reflect the new in-admin checkout experience

= 1.3.0 =
* Freemius: Premium code is now properly marked with `is__premium_only()` gates so Freemius can auto-generate a clean free build without premium features
* Renamed `class-ewb-rest-api.php` to `class-ewb-rest-api__premium_only.php` so Freemius excludes it from the free build
* Added `Requires Plugins: woocommerce` header (WordPress 6.5+ plugin dependencies)
* readme.txt: added `nalut` to contributors

= 1.2.1 =
* Fix: Plugin text domain is now properly loaded, enabling translations via WPML / Loco Translate / .mo files
* Add wpml-config.xml for admin text translation support

= 1.2.0 =
* Switched to Freemius-only distribution (independent of WordPress.org)
* Disabled WordPress.org compliance mode in Freemius SDK

= 1.1.0 =
* Added tier system (Lite / Basic / Pro)
* Freemius integration for license management
* Support tab with contact info
* Upgrade tab with plan comparison
* Improved custom order number compatibility
* Various bug fixes and improvements

= 1.0.0 =
* Initial release
* 4-step withdrawal flow
* Sticky bar with configurable text
* Modal popup and page display modes
* WooCommerce email integration
* Custom order status: Withdrawal Requested
* Rate limiting
* HPOS compatibility
* WCAG 2.1 AA accessibility
* Translation-ready

== Upgrade Notice ==

= 1.1.0 =
New tier system with Freemius licensing. Improved compatibility with custom order number plugins.

= 1.0.0 =
Initial release.