Three things this repository could not do: prove the plugin still works on a
WordPress or WooCommerce released after it, get a fix onto a shop without
someone uploading a zip, and do either of those for the next plugin without
starting over.
ci/ is the test harness. ci/site-test.sh builds a throwaway WordPress +
WooCommerce in containers at any versions you name — including `nightly` and
`beta` — installs exactly the files the release zip will contain, and runs
tests/smoke.php inside it with wp eval-file. Real cart, real coupons, real
WC_Shipping_Rate objects: a mocked cart keeps passing after WooCommerce has
changed underneath it, which is the one failure worth catching here. WP_DEBUG
is on and any notice logged from this plugin's directory fails the build,
because that is the shape an upgrade actually breaks in — nothing fails, a
notice appears, and two releases later it is a fatal.
compat.yml runs that weekly against today's releases, the next WordPress and
the next WooCommerce, the oldest PHP the header promises and the newest PHP.
When it is green it opens a PR bumping "Tested up to" and "WC tested up to" —
only when green, because WooCommerce shows that second value to the shop owner
as an untested-plugin banner, and that banner is what they read before deciding
whether to press update.
includes/class-updater.php is the distribution half. It hooks
update_plugins_{hostname} for the host in the new "Update URI" header and reads
the Gitea release API, so WordPress handles the notice, the download, the
"Enable auto-updates" link and wp plugin update with no further code. Update
URI earns its place twice: since 5.8 a plugin that declares one is never asked
about on wordpress.org, so a .org plugin sharing this slug cannot be pushed
onto a shop running this one. The check sends nothing about the site and
overrides WordPress's default user agent, which carries the site's own URL.
release.yml tags, tests, builds, publishes — then reads the feed back with no
credentials. A private repository and a release with no zip attached both leave
a page that looks perfect to anyone logged in and an update no shop is ever
offered.
Measured before committing, all green: WP 7.1 + WC 11.1 on PHP 8.3 and 7.4,
WP 7.2-alpha on 8.3, and the beta cell falling back to stable on 8.4. No
deprecations from this plugin on any of them.
Three guards are there because the bug they catch is invisible without them:
the annotated tag is re-fetched before its message is read (checkout turns it
into a lightweight tag pointing at the merge commit), the two workflow roots
are kept in sync (.gitea/workflows hides .github/workflows entirely), and every
file the code loads must be in the release zip — which caught class-updater.php
being referenced and uncommitted while every local test passed.
docs/REUSE.md is the port to the next plugin: copy ci/, rewrite five lines.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
291 lines
7.9 KiB
PHP
291 lines
7.9 KiB
PHP
<?php
|
|
/**
|
|
* Plugin Name: WooCommerce Email Discount Manager
|
|
* Plugin URI: https://gitea.nolimit.dk/kw/woocommerce-email-discount-manager
|
|
* Update URI: https://gitea.nolimit.dk/kw/woocommerce-email-discount-manager
|
|
* Description: Apply discounts and show/hide shipping methods based on the customer's email address (full address, domain or partial match).
|
|
* Version: 1.4.0
|
|
* Author: WEDSMP
|
|
* License: GPL-2.0-or-later
|
|
* Text Domain: wc-email-discount
|
|
* Requires at least: 5.8
|
|
* Requires PHP: 7.4
|
|
* WC requires at least: 6.0
|
|
* WC tested up to: 11.1.0
|
|
* Requires Plugins: woocommerce
|
|
*/
|
|
|
|
/*
|
|
* "Update URI" is what makes updates work, and it is load-bearing in a second
|
|
* way that is easy to miss: since WordPress 5.8, a plugin that declares one is
|
|
* never asked about on wordpress.org. Remove the line and a .org plugin that
|
|
* happens to share this slug could be offered to every shop running this one.
|
|
* includes/class-updater.php reads it; nothing else configures the source.
|
|
*/
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit;
|
|
}
|
|
|
|
define( 'WC_EDM_VERSION', '1.4.0' );
|
|
define( 'WC_EDM_PLUGIN_FILE', __FILE__ );
|
|
define( 'WC_EDM_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
|
|
define( 'WC_EDM_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
|
|
|
|
/**
|
|
* Main plugin class (singleton).
|
|
*/
|
|
final class WC_Email_Discount_Manager {
|
|
|
|
/**
|
|
* Singleton instance.
|
|
*
|
|
* @var WC_Email_Discount_Manager|null
|
|
*/
|
|
private static $instance = null;
|
|
|
|
/**
|
|
* Admin controller.
|
|
*
|
|
* @var WC_EDM_Admin|null
|
|
*/
|
|
public $admin = null;
|
|
|
|
/**
|
|
* Frontend controller.
|
|
*
|
|
* @var WC_EDM_Frontend|null
|
|
*/
|
|
public $frontend = null;
|
|
|
|
/**
|
|
* REST API controller.
|
|
*
|
|
* @var WC_EDM_REST_API|null
|
|
*/
|
|
public $rest_api = null;
|
|
|
|
/**
|
|
* Audit log controller.
|
|
*
|
|
* @var WC_EDM_Audit_Log|null
|
|
*/
|
|
public $audit_log = null;
|
|
|
|
/**
|
|
* Update checker.
|
|
*
|
|
* @var WC_EDM_Updater|null
|
|
*/
|
|
public $updater = null;
|
|
|
|
/**
|
|
* Class files that could not be loaded.
|
|
*
|
|
* A plugin upgrade replaces files one by one, so a request landing
|
|
* mid-copy can see an incomplete plugin folder. Tracking what is missing
|
|
* lets the plugin degrade instead of taking the whole screen down.
|
|
*
|
|
* @var string[]
|
|
*/
|
|
private $missing_files = array();
|
|
|
|
/**
|
|
* Get the singleton instance.
|
|
*
|
|
* @return WC_Email_Discount_Manager
|
|
*/
|
|
public static function instance() {
|
|
if ( null === self::$instance ) {
|
|
self::$instance = new self();
|
|
}
|
|
return self::$instance;
|
|
}
|
|
|
|
/**
|
|
* Constructor. Private — use instance().
|
|
*/
|
|
private function __construct() {
|
|
add_action( 'plugins_loaded', array( $this, 'init' ) );
|
|
add_action( 'before_woocommerce_init', array( $this, 'declare_wc_compatibility' ) );
|
|
}
|
|
|
|
/**
|
|
* Prevent cloning.
|
|
*/
|
|
private function __clone() {}
|
|
|
|
/**
|
|
* Prevent unserializing.
|
|
*/
|
|
public function __wakeup() {
|
|
_doing_it_wrong( __FUNCTION__, 'Unserializing is not allowed.', '1.0.0' );
|
|
}
|
|
|
|
/**
|
|
* Bootstrap once all plugins are loaded.
|
|
*/
|
|
public function init() {
|
|
// Deliberately before the WooCommerce check. Everything else here
|
|
// needs WooCommerce, but updates do not — and a shop that has
|
|
// WooCommerce switched off for an afternoon must not quietly stop
|
|
// receiving fixes for this plugin.
|
|
$updater = WC_EDM_PLUGIN_DIR . 'includes/class-updater.php';
|
|
if ( is_readable( $updater ) ) {
|
|
require_once $updater;
|
|
$this->updater = new WC_EDM_Updater();
|
|
}
|
|
|
|
if ( ! class_exists( 'WooCommerce' ) ) {
|
|
add_action( 'admin_notices', array( $this, 'woocommerce_missing_notice' ) );
|
|
return;
|
|
}
|
|
|
|
load_plugin_textdomain( 'wc-email-discount', false, dirname( plugin_basename( WC_EDM_PLUGIN_FILE ) ) . '/languages' );
|
|
|
|
$this->includes();
|
|
|
|
if ( ! empty( $this->missing_files ) ) {
|
|
add_action( 'admin_notices', array( $this, 'incomplete_install_notice' ) );
|
|
}
|
|
|
|
// Everything else builds on these two, so without them the plugin
|
|
// stays dormant and shows the notice instead of erroring out.
|
|
if ( ! class_exists( 'WC_EDM_DB' ) || ! class_exists( 'WC_EDM_Helpers' ) ) {
|
|
return;
|
|
}
|
|
|
|
// Upgrade the DB schema after plugin updates that skip re-activation.
|
|
add_action( 'init', array( 'WC_EDM_DB', 'maybe_upgrade' ), 5 );
|
|
|
|
if ( is_admin() && class_exists( 'WC_EDM_Admin' ) ) {
|
|
$this->admin = new WC_EDM_Admin();
|
|
}
|
|
|
|
if ( class_exists( 'WC_EDM_Frontend' ) ) {
|
|
$this->frontend = new WC_EDM_Frontend();
|
|
}
|
|
|
|
if ( class_exists( 'WC_EDM_Audit_Log' ) ) {
|
|
$this->audit_log = new WC_EDM_Audit_Log();
|
|
}
|
|
|
|
if ( class_exists( 'WC_EDM_REST_API' ) ) {
|
|
$this->rest_api = new WC_EDM_REST_API();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Warn that the plugin folder is incomplete.
|
|
*/
|
|
public function incomplete_install_notice() {
|
|
if ( ! current_user_can( 'activate_plugins' ) ) {
|
|
return;
|
|
}
|
|
|
|
echo '<div class="notice notice-error"><p>';
|
|
echo esc_html__( 'WooCommerce Email Discount Manager could not load all of its files, so some features are unavailable. If you just updated the plugin, reload this page — the upload may still have been in progress. If the warning persists, upload the plugin again.', 'wc-email-discount' );
|
|
echo '</p><p><code>';
|
|
echo implode( '</code>, <code>', array_map( 'esc_html', $this->missing_files ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo '</code></p></div>';
|
|
}
|
|
|
|
/**
|
|
* Load class files.
|
|
*/
|
|
private function includes() {
|
|
$files = array(
|
|
'includes/class-db.php',
|
|
'includes/class-helpers.php',
|
|
'includes/class-frontend.php',
|
|
'includes/class-audit-log.php',
|
|
'includes/class-rate-limiter.php',
|
|
'includes/class-rest-api.php',
|
|
);
|
|
|
|
if ( is_admin() ) {
|
|
$files = array_merge(
|
|
$files,
|
|
array(
|
|
'includes/class-admin.php',
|
|
'includes/class-admin-groups.php',
|
|
'includes/class-admin-emails.php',
|
|
'includes/class-admin-shipping.php',
|
|
'includes/class-admin-audit.php',
|
|
)
|
|
);
|
|
}
|
|
|
|
foreach ( $files as $file ) {
|
|
$path = WC_EDM_PLUGIN_DIR . $file;
|
|
|
|
// A missing file is recorded rather than fatal, so a half-copied
|
|
// upgrade cannot take down wp-admin.
|
|
if ( is_readable( $path ) ) {
|
|
require_once $path;
|
|
} else {
|
|
$this->missing_files[] = $file;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Declare compatibility with WooCommerce HPOS.
|
|
*/
|
|
public function declare_wc_compatibility() {
|
|
if ( class_exists( '\Automattic\WooCommerce\Utilities\FeaturesUtil' ) ) {
|
|
\Automattic\WooCommerce\Utilities\FeaturesUtil::declare_compatibility( 'custom_order_tables', WC_EDM_PLUGIN_FILE, true );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Admin notice shown when WooCommerce is not active.
|
|
*/
|
|
public function woocommerce_missing_notice() {
|
|
echo '<div class="notice notice-error"><p>';
|
|
esc_html_e( 'WooCommerce Email Discount Manager requires WooCommerce to be installed and active.', 'wc-email-discount' );
|
|
echo '</p></div>';
|
|
}
|
|
|
|
/**
|
|
* Plugin activation: verify WooCommerce and create database tables.
|
|
*/
|
|
public static function activate() {
|
|
$active_plugins = apply_filters( 'active_plugins', get_option( 'active_plugins', array() ) );
|
|
|
|
if ( ! class_exists( 'WooCommerce' ) && ! in_array( 'woocommerce/woocommerce.php', $active_plugins, true ) ) {
|
|
deactivate_plugins( plugin_basename( WC_EDM_PLUGIN_FILE ) );
|
|
wp_die(
|
|
esc_html__( 'WooCommerce Email Discount Manager requires WooCommerce to be installed and active. Please activate WooCommerce first.', 'wc-email-discount' ),
|
|
esc_html__( 'Plugin activation error', 'wc-email-discount' ),
|
|
array( 'back_link' => true )
|
|
);
|
|
}
|
|
|
|
require_once WC_EDM_PLUGIN_DIR . 'includes/class-db.php';
|
|
WC_EDM_DB::create_tables();
|
|
}
|
|
|
|
/**
|
|
* Plugin deactivation: clear scheduled jobs. Data is left untouched.
|
|
*/
|
|
public static function deactivate() {
|
|
require_once WC_EDM_PLUGIN_DIR . 'includes/class-audit-log.php';
|
|
WC_EDM_Audit_Log::unschedule_prune();
|
|
}
|
|
}
|
|
|
|
register_activation_hook( __FILE__, array( 'WC_Email_Discount_Manager', 'activate' ) );
|
|
register_deactivation_hook( __FILE__, array( 'WC_Email_Discount_Manager', 'deactivate' ) );
|
|
|
|
/**
|
|
* Access the main plugin instance.
|
|
*
|
|
* @return WC_Email_Discount_Manager
|
|
*/
|
|
function wc_edm() {
|
|
return WC_Email_Discount_Manager::instance();
|
|
}
|
|
|
|
wc_edm();
|