Outbox: Add settings for Outbox retention (#1325)

* Outbox: Add settings for Outbox retention

* Update description with definition

* Add unit tests for retention option

* Add changelog

* Register new setting

Author: obenland

CHANGELOG.md

@@ -9,6 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Setting to adjust the number of days Outbox items are kept before being purged.
+
+### Fixed
+
+* The Outbox purging routine no longer is limited to deleting 5 items at a time.
 * Undo API for Outbox items.
 
 ## [5.2.0] - 2025-02-13

includes/class-activitypub.php

@@ -111,6 +111,7 @@ public static function uninstall() {
 		delete_option( 'activitypub_max_image_attachments' );
 		delete_option( 'activitypub_migration_lock' );
 		delete_option( 'activitypub_object_type' );
+		delete_option( 'activitypub_outbox_purge_days' );
 		delete_option( 'activitypub_support_post_types' );
 		delete_option( 'activitypub_use_hashtags' );
 		delete_option( 'activitypub_use_opengraph' );

includes/class-scheduler.php

@@ -31,12 +31,15 @@ public static function init() {
 		\add_action( 'activitypub_update_followers', array( self::class, 'update_followers' ) );
 		\add_action( 'activitypub_cleanup_followers', array( self::class, 'cleanup_followers' ) );
 
+		// Event callbacks.
 		\add_action( 'activitypub_async_batch', array( self::class, 'async_batch' ), 10, 99 );
 		\add_action( 'activitypub_reprocess_outbox', array( self::class, 'reprocess_outbox' ) );
 		\add_action( 'activitypub_outbox_purge', array( self::class, 'purge_outbox' ) );
 
 		\add_action( 'post_activitypub_add_to_outbox', array( self::class, 'schedule_outbox_activity_for_federation' ) );
 		\add_action( 'post_activitypub_add_to_outbox', array( self::class, 'schedule_announce_activity' ), 10, 4 );
+
+		\add_action( 'update_option_activitypub_outbox_purge_days', array( self::class, 'handle_outbox_purge_days_update' ), 10, 2 );
 	}
 
 	/**
@@ -214,7 +217,7 @@ public static function purge_outbox() {
 			return;
 		}
 
-		$days     = 180; // TODO: Replace with a setting.
+		$days     = (int) get_option( 'activitypub_outbox_purge_days', 180 );
 		$timezone = new \DateTimeZone( 'UTC' );
 		$date     = new \DateTime( 'now', $timezone );
 
@@ -225,6 +228,7 @@ public static function purge_outbox() {
 				'post_type'   => Outbox::POST_TYPE,
 				'post_status' => 'any',
 				'fields'      => 'ids',
+				'numberposts' => -1,
 				'date_query'  => array(
 					array(
 						'before' => $date->format( 'Y-m-d' ),
@@ -238,6 +242,20 @@ public static function purge_outbox() {
 		}
 	}
 
+	/**
+	 * Update schedules when outbox purge days settings change.
+	 *
+	 * @param int $old_value The old value.
+	 * @param int $value     The new value.
+	 */
+	public static function handle_outbox_purge_days_update( $old_value, $value ) {
+		if ( 0 === (int) $value ) {
+			wp_clear_scheduled_hook( 'activitypub_outbox_purge' );
+		} elseif ( ! wp_next_scheduled( 'activitypub_outbox_purge' ) ) {
+			wp_schedule_event( time(), 'daily', 'activitypub_outbox_purge' );
+		}
+	}
+
 	/**
 	 * Asynchronously runs batch processing routines.
 	 *

includes/help.php

@@ -69,7 +69,9 @@
 			'<p>' . \__( 'For more information please visit <a href="https://webfinger.net/" target="_blank">webfinger.net</a>', 'activitypub' ) . '</p>' .
 			'<p><h2>' . \__( 'NodeInfo', 'activitypub' ) . '</h2></p>' .
 			'<p>' . \__( 'NodeInfo is an effort to create a standardized way of exposing metadata about a server running one of the distributed social networks. The two key goals are being able to get better insights into the user base of distributed social networking and the ability to build tools that allow users to choose the best fitting software and server for their needs.', 'activitypub' ) . '</p>' .
-			'<p>' . \__( 'For more information please visit <a href="http://nodeinfo.diaspora.software/" target="_blank">nodeinfo.diaspora.software</a>', 'activitypub' ) . '</p>',
+			'<p>' . \__( 'For more information please visit <a href="http://nodeinfo.diaspora.software/" target="_blank">nodeinfo.diaspora.software</a>', 'activitypub' ) . '</p>' .
+			'<p><h2>' . \__( 'Outbox', 'activitypub' ) . '</h2></p>' .
+			'<p>' . \__( 'An "Outbox" is a virtual location on a user&#8217;s profile where all the activities (posts, likes, replies) they publish are stored, acting as a feed that other users can access to see their publicly shared content; it&#8217;s essentially how a user "sends" information to others on a decentralized social network following the ActivityPub standard.', 'activitypub' ) . '</p>',
 	)
 );
 

includes/wp-admin/class-settings-fields.php

@@ -125,6 +125,15 @@ public static function register_settings_fields() {
 			'activitypub_general'
 		);
 
+		add_settings_field(
+			'activitypub_outbox_purge_days',
+			__( 'Outbox Retention Period', 'activitypub' ),
+			array( self::class, 'render_outbox_purge_days_field' ),
+			'activitypub_settings',
+			'activitypub_general',
+			array( 'label_for' => 'activitypub_outbox_purge_days' )
+		);
+
 		if ( ! defined( 'ACTIVITYPUB_AUTHORIZED_FETCH' ) ) {
 			add_settings_section(
 				'activitypub_security',
@@ -255,7 +264,7 @@ public static function render_custom_post_content_field() {
 	public static function render_max_image_attachments_field() {
 		$value = get_option( 'activitypub_max_image_attachments', ACTIVITYPUB_MAX_IMAGE_ATTACHMENTS );
 		?>
-		<input id="activitypub_max_image_attachments" value="<?php echo esc_attr( $value ); ?>" name="activitypub_max_image_attachments" type="number" min="0" />
+		<input id="activitypub_max_image_attachments" value="<?php echo esc_attr( $value ); ?>" name="activitypub_max_image_attachments" type="number" min="0" class="small-text" />
 		<p class="description">
 			<?php
 			echo wp_kses(
@@ -361,6 +370,26 @@ public static function render_blocklist_field() {
 		<?php
 	}
 
+	/**
+	 * Render outbox purge days field.
+	 */
+	public static function render_outbox_purge_days_field() {
+		$value = get_option( 'activitypub_outbox_purge_days', 180 );
+		echo '<input type="number" id="activitypub_outbox_purge_days" name="activitypub_outbox_purge_days" value="' . esc_attr( $value ) . '" class="small-text" min="0" max="365" />';
+		echo '<p class="description">' . wp_kses(
+			sprintf(
+				// translators: 1: Definition of Outbox; 2: Default value (180).
+				__( 'Maximum number of days to keep items in the <abbr title="%1$s">Outbox</abbr>. A lower value might be better for sites with lots of activity to maintain site performance. Default: <code>%2$s</code>', 'activitypub' ),
+				esc_attr__( 'A virtual location on a user&#8217;s profile where all the activities (posts, likes, replies) they publish are stored, acting as a feed that other users can access to see their publicly shared content', 'activitypub' ),
+				esc_html( 180 )
+			),
+			array(
+				'abbr' => array( 'title' => array() ),
+				'code' => array(),
+			)
+		) . '</p>';
+	}
+
 	/**
 	 * Render use hashtags field.
 	 */

includes/wp-admin/class-settings.php

@@ -63,6 +63,16 @@ public static function register_settings() {
 			)
 		);
 
+		\register_setting(
+			'activitypub',
+			'activitypub_outbox_purge_days',
+			array(
+				'type'        => 'integer',
+				'description' => \__( 'Number of days to keep items in the Outbox.', 'activitypub' ),
+				'default'     => 180,
+			)
+		);
+
 		\register_setting(
 			'activitypub',
 			'activitypub_object_type',

readme.txt

@@ -132,6 +132,8 @@ For reasons of data protection, it is not possible to see the followers of other
 = Unreleased =
 
 * Added: Undo API for Outbox items.
+* Added: Setting to adjust the number of days Outbox items are kept before being purged.
+* Fixed: The Outbox purging routine no longer is limited to deleting 5 items at a time.
 
 = 5.2.0 =
 

tests/includes/class-test-scheduler.php

@@ -28,7 +28,7 @@ class Test_Scheduler extends WP_UnitTestCase {
 	/**
 	 * Create fake data before tests run.
 	 *
-	 * @param WP_UnitTest_Factory $factory Helper that creates fake data.
+	 * @param \WP_UnitTest_Factory $factory Helper that creates fake data.
 	 */
 	public static function wpSetUpBeforeClass( $factory ) {
 		self::$user_id = $factory->user->create(
@@ -248,4 +248,38 @@ public function test_purge_outbox_20_or_fewer_posts() {
 		// Assert that no posts were deleted.
 		$this->assertEquals( 20, wp_count_posts( Outbox::POST_TYPE )->publish );
 	}
+
+	/**
+	 * Test purge_outbox method with changing activitypub_outbox_purge_days option.
+	 *
+	 * @covers ::purge_outbox
+	 */
+	public function test_purge_outbox_with_different_purge_days() {
+		// Create posts older than initial_days.
+		self::factory()->post->create_many(
+			25,
+			array(
+				'post_type'   => Outbox::POST_TYPE,
+				'post_date'   => gmdate( 'Y-m-d H:i:s', strtotime( '-4 months' ) ),
+				'post_status' => 'publish',
+			)
+		);
+
+		// Run purge_outbox with initial_days.
+		Scheduler::purge_outbox();
+		wp_cache_delete( _count_posts_cache_key( Outbox::POST_TYPE ), 'counts' );
+
+		// Verify posts are not deleted.
+		$this->assertEquals( 25, wp_count_posts( Outbox::POST_TYPE )->publish );
+
+		// Change the purge days option.
+		update_option( 'activitypub_outbox_purge_days', 90 );
+
+		// Run purge_outbox with changed_days.
+		Scheduler::purge_outbox();
+		wp_cache_delete( _count_posts_cache_key( Outbox::POST_TYPE ), 'counts' );
+
+		// Verify posts are deleted.
+		$this->assertEquals( 0, wp_count_posts( Outbox::POST_TYPE )->publish );
+	}
 }