<?php

/**

* Centralized manager for WordPress backend functionality.

*

* @package WP_Stream

*/

namespace WP_Stream;

use DateTime;

use DateTimeZone;

use DateInterval;

use WP_CLI;

use WP_Roles;

/**

* Class - Admin

*/

class Admin {

/**

* The async deletion action for large sites.

*

* @const string

*/

const ASYNC_DELETION_ACTION = 'stream_erase_large_records_action';

/**

* Recurring Action Scheduler action that drives the TTL-based auto-purge.

*

* @const string

*/

const AUTO_PURGE_ACTION = 'stream_auto_purge_action';

/**

* Async batch worker scheduled by the recurring auto-purge action.

*

* @const string

*/

const AUTO_PURGE_BATCH_ACTION = 'stream_auto_purge_batch_action';

/**

* Terminal action that runs the orphan-meta reaper once per chain.

*

* @const string

*/

const AUTO_PURGE_REAPER_ACTION = 'stream_auto_purge_reaper_action';

/**

* Action Scheduler group string for all auto-purge actions.

*

* @const string

*/

const AUTO_PURGE_GROUP = 'stream-auto-purge';

/**

* Holds Instance of plugin object

*

* @var Plugin

*/

public $plugin;

/**

* Holds Network class

*

* @var Network

*/

public $network;

/**

* Holds Live Update class

*

* @var Live_Update

*/

public $live_update;

/**

* Holds Export class

*

* @var Export

*/

public $export;

/**

* Menu page screen id

*

* @var string

*/

public $screen_id = array();

/**

* List table object

*

* @var List_Table

*/

public $list_table = null;

/**

* Option to disable access to Stream

*

* @var bool

*/

public $disable_access = false;

/**

* Class applied to the body of the admin screen

*

* @var string

*/

public $admin_body_class = 'wp_stream_screen';

/**

* Slug of the records page

*

* @var string

*/

public $records_page_slug = 'wp_stream';

/**

* Slug of the settings page

*

* @var string

*/

public $settings_page_slug = 'wp_stream_settings';

/**

* Parent page of the records and settings pages

*

* @var string

*/

public $admin_parent_page = 'admin.php';

/**

* Capability name for viewing records

*

* @var string

*/

public $view_cap = 'view_stream';

/**

* Capability name for managing settings

*

* @var string

*/

public $settings_cap = WP_STREAM_SETTINGS_CAPABILITY;

/**

* Total amount of authors to pre-load

*

* @var int

*/

public $preload_users_max = 50;

/**

* Admin notices, collected and displayed on proper action

*

* @var array

*/

public $notices = array();

/**

* Class constructor.

*

* @param Plugin $plugin Instance of plugin object.

*/

public function __construct( $plugin ) {

$this->plugin = $plugin;

add_action( 'init', array( $this, 'init' ) );

// Ensure function used in various methods is pre-loaded.

if ( ! function_exists( 'is_plugin_active_for_network' ) ) {

require_once ABSPATH . '/wp-admin/includes/plugin.php';

}

// User and role caps.

add_filter( 'user_has_cap', array( $this, 'filter_user_caps' ), 10, 4 );

add_filter( 'role_has_cap', array( $this, 'filter_role_caps' ), 10, 3 );

if ( $this->plugin->is_multisite_network_activated() && ! is_network_admin() ) {

$options = (array) get_site_option( 'wp_stream_network', array() );

$option = isset( $options['general_site_access'] ) ? absint( $options['general_site_access'] ) : 1;

$this->disable_access = ( $option ) ? false : true;

}

// Register settings page.

if ( ! $this->disable_access ) {

add_action( 'admin_menu', array( $this, 'register_menu' ) );

}

// Admin notices.

add_action( 'admin_notices', array( $this, 'prepare_admin_notices' ) );

add_action( 'shutdown', array( $this, 'admin_notices' ) );

// Feature request notice.

add_action( 'admin_notices', array( $this, 'display_feature_request_notice' ) );

// Add admin body class.

add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );

// Plugin action links.

add_filter(

'plugin_action_links',

array(

$this,

'plugin_action_links',

),

10,

2

);

// Load admin scripts and styles.

add_action(

'admin_enqueue_scripts',

array(

$this,

'admin_enqueue_scripts',

)

);

add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );

// Reset Streams database.

add_action(

'wp_ajax_wp_stream_reset',

array(

$this,

'wp_ajax_reset',

)

);

// Manual "Clean orphaned meta now" action (Settings → Advanced).

add_action(

'wp_ajax_wp_stream_clean_orphan_meta',

array( $this, 'wp_ajax_clean_orphan_meta' )

);

// Render confirmation notices keyed by the wp_stream_message query

// arg set on post-action redirects (e.g. orphan_meta_cleanup_scheduled).

add_action( 'admin_notices', array( $this, 'maybe_display_message' ) );

add_action( 'network_admin_notices', array( $this, 'maybe_display_message' ) );

// Auto purge setup (Action Scheduler).

add_action( 'wp_loaded', array( $this, 'purge_schedule_setup' ) );

add_action(

self::AUTO_PURGE_ACTION,

array( $this, 'purge_scheduled_action' )

);

add_action(

self::AUTO_PURGE_BATCH_ACTION,

array( $this, 'auto_purge_batch' ),

10,

3

);

add_action(

self::AUTO_PURGE_REAPER_ACTION,

array( $this, 'auto_purge_reaper' )

);

// Ajax users list.

add_action(

'wp_ajax_wp_stream_filters',

array(

$this,

'ajax_filters',

)

);

// Async action for erasing large log tables.

add_action(

self::ASYNC_DELETION_ACTION,

array(

$this,

'erase_large_records',

),

10,

4

);

}

/**

* Load admin classes

*

* @action init

*/

public function init() {

$this->network = new Network( $this->plugin );

$this->live_update = new Live_Update( $this->plugin );

$this->export = new Export( $this->plugin );

// Check if the host has configured the `REMOTE_ADDR` correctly.

$client_ip = $this->plugin->get_client_ip_address();

if ( empty( $client_ip ) && $this->is_stream_screen() ) {

$this->notice( __( 'Stream plugin can\'t determine a reliable client IP address! Please update the hosting environment to set the $_SERVER[\'REMOTE_ADDR\'] variable or use the wp_stream_client_ip_address filter to specify the verified client IP address!', 'stream' ) );

}

}

/**

* Output specific updates passed as URL parameters.

*

* @action admin_notices

*

* @return void

*/

public function prepare_admin_notices() {

$message = wp_stream_filter_input( INPUT_GET, 'message' );

switch ( $message ) {

case 'settings_reset':

$this->notice( esc_html__( 'All site settings have been successfully reset.', 'stream' ) );

break;

}

}

/**

* Handle notice messages according to the appropriate context (WP-CLI or the WP Admin)

*

* @param string $message Message to output.

* @param bool $is_error If the message is error_level (true) or warning (false).

*/

public function notice( $message, $is_error = true ) {

if ( defined( 'WP_CLI' ) && WP_CLI ) {

$message = wp_strip_all_tags( $message );

if ( $is_error ) {

WP_CLI::warning( $message );

} else {

WP_CLI::success( $message );

}

} else {

// Trigger admin notices late, so that any notices which occur during page load are displayed.

add_action( 'shutdown', array( $this, 'admin_notices' ) );

$notice = compact( 'message', 'is_error' );

if ( ! in_array( $notice, $this->notices, true ) ) {

$this->notices[] = $notice;

}

}

}

/**

* Show an error or other message in the WP Admin

*

* @action shutdown

*/

public function admin_notices() {

global $allowedposttags;

$custom = array(

'progress' => array(

'class' => true,

'id' => true,

'max' => true,

'style' => true,

'value' => true,

),

);

$allowed_html = array_merge( $allowedposttags, $custom );

ksort( $allowed_html );

foreach ( $this->notices as $notice ) {

$class_name = empty( $notice['is_error'] ) ? 'updated' : 'error';

$html_message = sprintf( '<div class="%s">%s</div>', esc_attr( $class_name ), wpautop( $notice['message'] ) );

echo wp_kses( $html_message, $allowed_html );

}

}

/**

* Display a feature request notice.

*

* @return void

*/

public function display_feature_request_notice() {

$screen = get_current_screen();

// Display the notice only on the Stream settings page.

if ( empty( $this->screen_id['settings'] ) || $this->screen_id['settings'] !== $screen->id ) {

return;

}

printf(

'<div class="notice notice-info notice-stream-feature-request"><p>%1$s <a href="https://github.com/xwp/stream/issues/new/choose" target="_blank">%2$s <span class="dashicons dashicons-external"></span></a></p></div>',

esc_html__( 'Have suggestions or found a bug?', 'stream' ),

esc_html__( 'Click here to let us know!', 'stream' )

);

}

/**

* Register menu page

*

* @action admin_menu

*

* @return void

*/

public function register_menu() {

/**

* Filter the main admin menu title

*

* @return string

*/

$main_menu_title = apply_filters( 'wp_stream_admin_menu_title', esc_html__( 'Stream', 'stream' ) );

/**

* Filter the main admin menu position

*

* Note: Using longtail decimal string to reduce the chance of position conflicts, see Codex

*

* @return string

*/

$main_menu_position = apply_filters( 'wp_stream_menu_position', '2.999999' );

/**

* Filter the main admin page title

*

* @return string

*/

$main_page_title = apply_filters( 'wp_stream_admin_page_title', esc_html__( 'Stream Records', 'stream' ) );

$this->screen_id['main'] = add_menu_page(

$main_page_title,

$main_menu_title,

$this->view_cap,

$this->records_page_slug,

array( $this, 'render_list_table' ),

'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxMDI0IDEwMjQiIGZpbGw9IjAwMCI+Cgk8cGF0aCBkPSJNOTAzLjExNSA1MTUuNDEzYy00OS4zOTIgMC05MS40NzQgMzEuMzM3LTEwNy40NiA3NS4yMDNsLTEyNC40MTEtMS41MzJjLTExLjM3Ny0uMzQ2LTIyLjc1MS0uNjg5LTM0LjEyOS0uOTk4bC0uMjQxLjU3NC0yMi40MzYtLjI3OC0uMTUzLS45Mi0xNS4wNTYtODIuOTMzLTIwLjE0Ni0xMDguNDA1LTIwLjU0NC0xMDguMzM3TDUwMy45ODIgMGwtNTMuMTQxIDQyOS4wMTMtMTYuMjE0IDEzNy45MzUtMTIuMDE2IDEwNi45MjQtMTE3LjI4Ni0yODUuMjItMTguMzUzIDIwMi44MWMtNDIuNTYyIDEuNDU0LTg1LjEyNyAyLjkzNC0xMjcuNjg4IDQuNzM4LTUzLjA5NyAyLjI5Mi0xMDYuMTg3IDQuNDczLTE1OS4yODQgNy41MzZ2NDIuMDQyYzUzLjA5NyAzLjA2IDEwNi4xODcgNS4yNDcgMTU5LjI4NCA3LjUzMyA1My4wOTMgMi4yNDUgMTA2LjE4IDQuMTk0IDE1OS4yNzMgNS45MDNsMTQuMjQuNDY1IDE3LjM1MSA0OC4zOWMxOC44NDIgNTEuODc0IDM3LjU0MiAxMDMuODA2IDU2Ljc2NSAxNTUuNTQxTDQ2Ni41MiAxMDI0bDQxLjUxMi0zMDguMjkzIDE3LjYzMy0xMzYuNjg1IDEwLjc3NiA1MC4zMjkgNTQuODE1IDI0OC41NDQgNzIuNTE2LTIxNy4yMTdoMTI5LjI2MWMxMy40OTMgNDguMTIxIDU3LjY1NSA4My40MjkgMTEwLjA3NSA4My40MjkgNjMuMTYgMCAxMTQuMzUyLTUxLjIwNSAxMTQuMzUyLTExNC4zNDggMC02My4xMzktNTEuMTg5LTExNC4zNDUtMTE0LjM0OS0xMTQuMzQ1bC4wMDQtLjAwMVoiIC8+Cjwvc3ZnPgo=',

$main_menu_position

);

/**

* Fires before submenu items are added to the Stream menu

* allowing plugins to add menu items before Settings

*

* @return void

*/

do_action( 'wp_stream_admin_menu' );

/**

* Filter the Settings admin page title

*

* @return string

*/

$settings_page_title = apply_filters( 'wp_stream_settings_form_title', esc_html__( 'Stream Settings', 'stream' ) );

$this->screen_id['settings'] = add_submenu_page(

$this->records_page_slug,

$settings_page_title,

esc_html__( 'Settings', 'stream' ),

$this->settings_cap,

$this->settings_page_slug,

array( $this, 'render_settings_page' )

);

if ( isset( $this->screen_id['main'] ) ) {

/**

* Fires just before the Stream list table is registered.

*

* @return void

*/

do_action( 'wp_stream_admin_menu_screens' );

// Register the list table early, so it associates the column headers with 'Screen settings'.

add_action(

'load-' . $this->screen_id['main'],

array(

$this,

'register_list_table',

)

);

}

}

/**

* Enqueue scripts/styles for admin screen

*

* @action admin_enqueue_scripts

*

* @param string $hook Current hook.

*

* @return void

*/

public function admin_enqueue_scripts( $hook ) {

if ( in_array( $hook, $this->screen_id, true ) ) {

$this->plugin->enqueue_asset(

'admin',

array(

$this->plugin->with_select2(),

$this->plugin->with_jquery_timeago(),

),

array(

'i18n' => array(

'confirm_purge' => __( 'Are you sure you want to delete all Stream activity records from the database? This cannot be undone.', 'stream' ),

'confirm_defaults' => __( 'Are you sure you want to reset all site settings to default? This cannot be undone.', 'stream' ),

),

'locale' => strtolower( substr( get_locale(), 0, 2 ) ),

'gmt_offset' => get_option( 'gmt_offset' ),

)

);

$this->plugin->enqueue_asset(

'admin-exclude',

array(

$this->plugin->with_select2(),

)

);

$this->plugin->enqueue_asset(

'live-updates',

array( 'heartbeat' ),

array(

'current_screen' => $hook,

'current_page' => isset( $_GET['paged'] ) ? absint( wp_unslash( $_GET['paged'] ) ) : '1', // phpcs:ignore WordPress.Security.NonceVerification.Recommended

'current_order' => isset( $_GET['order'] ) && in_array( strtolower( $_GET['order'] ), array( 'asc', 'desc' ), true ) // phpcs:ignore WordPress.Security.NonceVerification.Recommended

? esc_js( $_GET['order'] ) // phpcs:ignore WordPress.Security.NonceVerification.Recommended

: 'desc',

'current_query' => wp_json_encode( $_GET ), // phpcs:ignore WordPress.Security.NonceVerification.Recommended

'current_query_count' => count( $_GET ), // phpcs:ignore WordPress.Security.NonceVerification.Recommended

)

);

}

/**

* The maximum number of items that can be updated in bulk without receiving a warning.

*

* Stream watches for bulk actions performed in the WordPress Admin (such as updating

* many posts at once) and warns the user before proceeding if the number of items they

* are attempting to update exceeds this threshold value. Since Stream will try to save

* a log for each item, it will take longer than usual to complete the operation.

*

* The default threshold is 100 items.

*

* @return int

*/

$bulk_actions_threshold = apply_filters( 'wp_stream_bulk_actions_threshold', 100 );

$this->plugin->enqueue_asset(

'global',

array(),

array(

'bulk_actions' => array(

'i18n' => array(

/* translators: %s: a number of items (e.g. "1,742") */

'confirm_action' => sprintf( __( 'Are you sure you want to perform bulk actions on over %s items? This process could take a while to complete.', 'stream' ), number_format( absint( $bulk_actions_threshold ) ) ),

),

'threshold' => absint( $bulk_actions_threshold ),

),

'plugins_screen_url' => self_admin_url( 'plugins.php#stream' ),

)

);

}

/**

* Check whether or not the current admin screen belongs to Stream

*

* @return bool

*/

public function is_stream_screen() {

if ( ! is_admin() ) {

return false;

}

$page = wp_stream_filter_input( INPUT_GET, 'page' );

if ( is_string( $page ) && false !== strpos( $page, $this->records_page_slug ) ) {

return true;

}

if ( is_admin() && function_exists( 'get_current_screen' ) ) {

$screen = get_current_screen();

return ( Alerts::POST_TYPE === $screen->post_type );

}

return false;

}

/**

* Add a specific body class to all Stream admin screens

*

* @param string $classes CSS classes to output to body.

*

* @filter admin_body_class

*

* @return string

*/

public function admin_body_class( $classes ) {

$stream_classes = array();

if ( $this->is_stream_screen() ) {

$stream_classes[] = $this->admin_body_class;

if ( isset( $_GET['page'] ) ) { // // phpcs:ignore WordPress.Security.NonceVerification.Recommended

$stream_classes[] = sanitize_key( $_GET['page'] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended

}

}

/**

* Filter the Stream admin body classes

*

* @return array

*/

$stream_classes = apply_filters( 'wp_stream_admin_body_classes', $stream_classes );

$stream_classes = implode( ' ', array_map( 'trim', $stream_classes ) );

return sprintf( '%s %s ', $classes, $stream_classes );

}

/**

* Add menu styles for various WP Admin skins.

*

* @action admin_enqueue_scripts

*/

public function admin_menu_css() {

// Make sure we're working off a clean version.

if ( ! file_exists( ABSPATH . WPINC . '/version.php' ) ) {

return;

}

include ABSPATH . WPINC . '/version.php';

if ( ! isset( $wp_version ) ) {

return;

}

$css = "

body.{$this->admin_body_class} #wpbody-content .wrap h1:nth-child(1):before {

content: '';

display: inline-block;

width: 24px;

height: 24px;

margin-right: 8px;

vertical-align: text-bottom;

background-image: url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxMDI0IDEwMjQiIGZpbGw9ImN1cnJlbnRjb2xvciI+Cgk8cGF0aCBkPSJNOTAzLjExNSA1MTUuNDEzYy00OS4zOTIgMC05MS40NzQgMzEuMzM3LTEwNy40NiA3NS4yMDNsLTEyNC40MTEtMS41MzJjLTExLjM3Ny0uMzQ2LTIyLjc1MS0uNjg5LTM0LjEyOS0uOTk4bC0uMjQxLjU3NC0yMi40MzYtLjI3OC0uMTUzLS45Mi0xNS4wNTYtODIuOTMzLTIwLjE0Ni0xMDguNDA1LTIwLjU0NC0xMDguMzM3TDUwMy45ODIgMGwtNTMuMTQxIDQyOS4wMTMtMTYuMjE0IDEzNy45MzUtMTIuMDE2IDEwNi45MjQtMTE3LjI4Ni0yODUuMjItMTguMzUzIDIwMi44MWMtNDIuNTYyIDEuNDU0LTg1LjEyNyAyLjkzNC0xMjcuNjg4IDQuNzM4LTUzLjA5NyAyLjI5Mi0xMDYuMTg3IDQuNDczLTE1OS4yODQgNy41MzZ2NDIuMDQyYzUzLjA5NyAzLjA2IDEwNi4xODcgNS4yNDcgMTU5LjI4NCA3LjUzMyA1My4wOTMgMi4yNDUgMTA2LjE4IDQuMTk0IDE1OS4yNzMgNS45MDNsMTQuMjQuNDY1IDE3LjM1MSA0OC4zOWMxOC44NDIgNTEuODc0IDM3LjU0MiAxMDMuODA2IDU2Ljc2NSAxNTUuNTQxTDQ2Ni41MiAxMDI0bDQxLjUxMi0zMDguMjkzIDE3LjYzMy0xMzYuNjg1IDEwLjc3NiA1MC4zMjkgNTQuODE1IDI0OC41NDQgNzIuNTE2LTIxNy4yMTdoMTI5LjI2MWMxMy40OTMgNDguMTIxIDU3LjY1NSA4My40MjkgMTEwLjA3NSA4My40MjkgNjMuMTYgMCAxMTQuMzUyLTUxLjIwNSAxMTQuMzUyLTExNC4zNDggMC02My4xMzktNTEuMTg5LTExNC4zNDUtMTE0LjM0OS0xMTQuMzQ1bC4wMDQtLjAwMVoiIC8+Cjwvc3ZnPgo=');

}

#menu-posts-feedback .wp-menu-image:before {

font-family: dashicons !important;

content: '\\f175';

}

#adminmenu #menu-posts-feedback div.wp-menu-image {

background: none !important;

background-repeat: no-repeat;

}

";

wp_add_inline_style( 'wp-admin', $css );

}

/**

* Handle the reset AJAX request to reset logs.

*

* @return bool

*/

public function wp_ajax_reset() {

check_ajax_referer( 'stream_nonce_reset', 'wp_stream_nonce_reset' );

if ( ! current_user_can( $this->settings_cap ) ) {

wp_die(

esc_html__( "You don't have sufficient privileges to do this action.", 'stream' )

);

}

// Ensure the database tables exist before attempting to clear records.

// Install::check() short-circuits on DOING_AJAX, so call install()

// directly. dbDelta is idempotent and safe to run when tables already

// exist.

$this->plugin->install->install( $this->plugin->get_version() );

$this->erase_stream_records();

if ( defined( 'WP_STREAM_TESTS' ) && WP_STREAM_TESTS ) {

return true;

}

wp_safe_redirect(

add_query_arg(

array(

'page' => is_network_admin() ? $this->network->network_settings_page_slug : $this->settings_page_slug,

'message' => 'data_erased',

),

self_admin_url( $this->admin_parent_page )

)

);

exit;

}

/**

* Clears stream records from the database.

*

* @return void

*/

private function erase_stream_records() {

global $wpdb;

// If this is a multisite and it's not network activated,

// only delete the entries from the blog which made the request.

if ( $this->plugin->is_multisite_not_network_activated() ) {

// First check the log size.

$stream_log_size = self::get_blog_record_table_size();

// If this is a large log and we need to delete only the entries

// pertaining to an individual site, we will need to do those in batches.

if ( $this->plugin->is_large_records_table( $stream_log_size ) ) {

$this->schedule_erase_large_records( $stream_log_size );

return;

}

$wpdb->query(

$wpdb->prepare(

"DELETE `stream`, `meta`

FROM {$wpdb->stream} AS `stream`

LEFT JOIN {$wpdb->streammeta} AS `meta`

ON `meta`.`record_id` = `stream`.`ID`

WHERE `blog_id`=%d;",

get_current_blog_id()

)

);

} else {

// If we are deleting all the entries, we can truncate the tables.

$wpdb->query( "TRUNCATE {$wpdb->streammeta};" );

$wpdb->query( "TRUNCATE {$wpdb->stream};" );

// Tidy up any meta which may have been added in between the two truncations.

$this->delete_orphaned_meta();

}

}

/**

* Schedule the initial event to start erasing the logs from now.

*

* @param int $log_size The number of rows which will be affected.

* @return void

*/

private function schedule_erase_large_records( int $log_size ) {

global $wpdb;

$last_entry = $wpdb->get_var(

$wpdb->prepare(

"SELECT ID FROM {$wpdb->stream} WHERE `blog_id`=%d ORDER BY ID DESC LIMIT 1",

get_current_blog_id()

)

);

// If there are no entries to erase, don't try to erase them.

if ( empty( $last_entry ) ) {

return;

}

// We are going to delete this many and this many only.

// This is to avoid the situation where rows keep getting added

// between the Action Scheduler runs and they never stop.

$args = array(

'total' => (int) $log_size,

'done' => 0,

'last_entry' => (int) $last_entry,

'blog_id' => (int) get_current_blog_id(),

);

as_enqueue_async_action( self::ASYNC_DELETION_ACTION, $args );

}

/**

* Checks if the async deletion process is running.

*

* @return bool True if the async deletion process is running, false otherwise.

*/

public static function is_running_async_deletion() {

return as_has_scheduled_action( self::ASYNC_DELETION_ACTION );

}

/**

* Checks if any auto-purge action is currently scheduled or in-flight.

*

* Returns true when either the batched chain worker or the terminal

* orphan reaper is pending OR running. The recurring scheduler is

* intentionally excluded — it is always pending under normal operation,

* so including it here would make the probe useless. Used by the

* Settings → Advanced UI to render an "Auto-purge currently running"

* notice and by the recurring callback as an overlap guard.

*

* Checks both PENDING and IN-PROGRESS statuses so a chain that is

* mid-execution (e.g. the batch worker is currently running and has not

* yet enqueued the next batch) still reports as running. Without the

* RUNNING check the overlap guard can let a second parallel chain stack

* against the same rows.

*

* @return bool

*/

public static function is_running_auto_purge() {

if ( ! function_exists( 'as_get_scheduled_actions' ) ) {

return false;

}

foreach ( array( self::AUTO_PURGE_BATCH_ACTION, self::AUTO_PURGE_REAPER_ACTION ) as $hook ) {

$found = as_get_scheduled_actions(

array(

'hook' => $hook,

'status' => array(

\ActionScheduler_Store::STATUS_PENDING,

\ActionScheduler_Store::STATUS_RUNNING,

),

'per_page' => 1,

),

'ids'

);

if ( ! empty( $found ) ) {

return true;

}

}

return false;

}

/**

* Erases large records from the stream table.

*

* This function deletes records from the stream table in batches, starting from a given entry ID.

* It deletes records in reverse chronological order, starting from the largest ID and going back.

* The number of records deleted in each batch is determined by the batch size, which can be filtered

* using the 'wp_stream_batch_size' hook.

*

* @param int $total The total number of records to be deleted.

* @param int $done The number of records that have already been deleted.

* @param int $last_entry The ID of the last entry that was deleted.

* @param int $blog_id The ID of the blog for which the records should be deleted.

* @return void

*/

public function erase_large_records( int $total, int $done, int $last_entry, int $blog_id ) {

global $wpdb;

$start_from = $wpdb->get_var(

$wpdb->prepare(

"SELECT ID FROM {$wpdb->stream} WHERE ID < %d AND `blog_id`=%d ORDER BY ID DESC LIMIT 1",

$last_entry + 1, // A tweak to get it correct the first time through.

get_current_blog_id()

)

);

if ( empty( $start_from ) ) {

return;

}

/**

* Filters the number of records in the {$wpdb->stream} table to do at a time.

*

* @since 4.1.0

*

* @param int $batch_size The batch size, default 250000.

*/

$batch_size = apply_filters( 'wp_stream_batch_size', 250000 );

// This will tend to erase them in reverse chronological order,

// ie it will start from the largest ID and go back from there.

$wpdb->query(

$wpdb->prepare(

"DELETE `stream`, `meta`

FROM {$wpdb->stream} AS `stream`

LEFT JOIN {$wpdb->streammeta} AS `meta`

ON `meta`.`record_id` = `stream`.`ID`

WHERE ID <= %d AND ID >= %d AND `blog_id`=%d;",

$start_from,

$start_from - $batch_size,

get_current_blog_id()

)

);

$remaining = $wpdb->get_var(

$wpdb->prepare( "SELECT COUNT(ID) FROM {$wpdb->stream} WHERE `blog_id`=%d", $blog_id )

);

$done = $total - $remaining;

as_enqueue_async_action(

self::ASYNC_DELETION_ACTION,

array(

'total' => (int) $total,

'done' => (int) $done,

'last_entry' => (int) $start_from - $batch_size, // The last ID checked.

'blog_id' => (int) $blog_id,

)

);

}

/**

* Retrieves the size of the blog record table for a specific blog.

*

* @param int|null $blog_id The ID of the blog. If not provided, the current blog ID will be used.

* @return int The size of the blog record table.

*/

public static function get_blog_record_table_size( $blog_id = null ): int {

global $wpdb;

$blog_id = empty( $blog_id ) ? get_current_blog_id() : $blog_id;

$blog_size = $wpdb->get_var(

$wpdb->prepare(

"SELECT COUNT(ID) FROM {$wpdb->stream} WHERE `blog_id`=%d",

$blog_id

)

);

return (int) $blog_size;

}

/**

* Schedules a purge of records.

*

* @return void

*/

public function purge_schedule_setup() {

// Clear the legacy WP-Cron event scheduled by Stream <= 4.1.x so it

// cannot double-fire alongside the new AS recurring action.

if ( wp_next_scheduled( 'wp_stream_auto_purge' ) ) {

wp_clear_scheduled_hook( 'wp_stream_auto_purge' );

}

if ( ! function_exists( 'as_schedule_recurring_action' ) ) {

// Action Scheduler not yet loaded (e.g. very early hook); bail.

// Plugin::__construct() loads it before init, so this should be unreachable.

return;

}

if ( false === as_next_scheduled_action( self::AUTO_PURGE_ACTION ) ) {

// 12 hours == old `twicedaily` interval.

as_schedule_recurring_action(

time(),

12 * HOUR_IN_SECONDS,

self::AUTO_PURGE_ACTION,

array(),

self::AUTO_PURGE_GROUP

);

}

}

/**

* Deletes orphaned meta records from the database.

*

* Deletes meta records from the stream meta table where the corresponding

* stream record no longer exists.

*

* @global wpdb $wpdb The WordPress database object.

*/

protected function delete_orphaned_meta() {

global $wpdb;

$wpdb->query(

"DELETE `meta` FROM {$wpdb->streammeta} as `meta` LEFT JOIN {$wpdb->stream} as `stream` ON `stream`.`ID`=`meta`.`record_id` WHERE `stream`.`ID` IS NULL"

);

}

/**

* Executes a scheduled purge

*

* @return void

*/

public function purge_scheduled_action() {

// Don't purge when in Network Admin unless Stream is network activated.

if (

$this->plugin->is_multisite_not_network_activated()

&&

is_network_admin()

) {

return;

}

$defaults = $this->plugin->settings->get_defaults();

if ( $this->plugin->is_multisite_network_activated() ) {

$options = wp_parse_args( (array) get_site_option( 'wp_stream_network', array() ), $defaults );

} else {

$options = wp_parse_args( (array) get_option( 'wp_stream', array() ), $defaults );

}

// TTL fallback. Settings::get_defaults() runs every settings field

// through the `wp_stream_settings_option_fields` filter, which

// Network::get_network_admin_fields() uses to strip the `records_ttl`

// field from the per-site option's defaults set. When this callback runs

// outside any admin context (Action Scheduler, WP-CLI, system cron), the

// per-site option_key is in effect, so the filtered defaults array does

// not contain general_records_ttl at all. Apply the documented 30-day

// default (classes/class-settings.php, `records_ttl` field) only when

// the key is genuinely missing, so an operator who set the value via

// CLI/SQL keeps their explicit choice.

if ( ! isset( $options['general_records_ttl'] ) ) {

$options['general_records_ttl'] = 30;

}

if ( ! empty( $options['general_keep_records_indefinitely'] ) ) {

return;

}

// Refuse to purge with a non-positive TTL. The UI enforces min=1, but

// CLI/SQL can set 0 or a negative integer. Honoring those would mean

// "delete every record on every cycle", which has no legitimate use

// case (keep_records_indefinitely covers the opposite extreme).

// Bailing out makes operator error visible (records stop being purged)

// instead of catastrophic (records get wiped repeatedly).

if ( (int) $options['general_records_ttl'] < 1 ) {

return;

}