Add: Shared Inbox setting (#1553)

Author: pfefferle

.github/changelog/1553-from-description

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Add option to enable/disable the "shared inbox" to the "Advanced Settings".

includes/class-activitypub.php

@@ -51,6 +51,7 @@ public static function init() {
 		\add_action( 'added_post_meta', array( self::class, 'updated_postmeta' ), 10, 4 );
 		\add_filter( 'pre_option_activitypub_actor_mode', array( self::class, 'pre_option_activitypub_actor_mode' ) );
 		\add_filter( 'pre_option_activitypub_authorized_fetch', array( self::class, 'pre_option_activitypub_authorized_fetch' ) );
+		\add_filter( 'pre_option_activitypub_shared_inbox', array( self::class, 'pre_option_activitypub_shared_inbox' ) );
 
 		\add_action( 'init', array( self::class, 'register_user_meta' ), 11 );
 
@@ -121,6 +122,7 @@ public static function uninstall() {
 		delete_option( 'activitypub_migration_lock' );
 		delete_option( 'activitypub_object_type' );
 		delete_option( 'activitypub_outbox_purge_days' );
+		delete_option( 'activitypub_shared_inbox' );
 		delete_option( 'activitypub_support_post_types' );
 		delete_option( 'activitypub_use_hashtags' );
 		delete_option( 'activitypub_use_opengraph' );
@@ -436,6 +438,26 @@ public static function pre_option_activitypub_authorized_fetch( $pre ) {
 		return '0';
 	}
 
+	/**
+	 * Pre-get option filter for the Shared Inbox.
+	 *
+	 * @param string $pre The pre-get option value.
+	 *
+	 * @return string If the constant is defined, return the value, otherwise return the pre-get option value.
+	 */
+	public static function pre_option_activitypub_shared_inbox( $pre ) {
+		if ( ! \defined( 'ACTIVITYPUB_SHARED_INBOX_FEATURE' ) ) {
+			return $pre;
+		}
+
+		if ( ACTIVITYPUB_SHARED_INBOX_FEATURE ) {
+			return '1';
+		}
+
+		return '0';
+	}
+
+
 	/**
 	 * Store permalink in meta, to send delete Activity.
 	 *

includes/constants.php

@@ -19,7 +19,6 @@
 \defined( 'ACTIVITYPUB_DISABLE_REWRITES' ) || \define( 'ACTIVITYPUB_DISABLE_REWRITES', false );
 \defined( 'ACTIVITYPUB_DISABLE_INCOMING_INTERACTIONS' ) || \define( 'ACTIVITYPUB_DISABLE_INCOMING_INTERACTIONS', false );
 \defined( 'ACTIVITYPUB_DISABLE_OUTGOING_INTERACTIONS' ) || \define( 'ACTIVITYPUB_DISABLE_OUTGOING_INTERACTIONS', false );
-\defined( 'ACTIVITYPUB_SHARED_INBOX_FEATURE' ) || \define( 'ACTIVITYPUB_SHARED_INBOX_FEATURE', false );
 \defined( 'ACTIVITYPUB_SEND_VARY_HEADER' ) || \define( 'ACTIVITYPUB_SEND_VARY_HEADER', false );
 \defined( 'ACTIVITYPUB_DEFAULT_OBJECT_TYPE' ) || \define( 'ACTIVITYPUB_DEFAULT_OBJECT_TYPE', 'wordpress-post-format' );
 \defined( 'ACTIVITYPUB_OUTBOX_PROCESSING_BATCH_SIZE' ) || \define( 'ACTIVITYPUB_OUTBOX_PROCESSING_BATCH_SIZE', 100 );

includes/model/class-blog.php

@@ -419,7 +419,7 @@ public function get_following() {
 	public function get_endpoints() {
 		$endpoints = null;
 
-		if ( ACTIVITYPUB_SHARED_INBOX_FEATURE ) {
+		if ( \get_option( 'activitypub_shared_inbox' ) ) {
 			$endpoints = array(
 				'sharedInbox' => get_rest_url_by_path( 'inbox' ),
 			);

includes/model/class-user.php

@@ -295,7 +295,7 @@ public function get_featured() {
 	public function get_endpoints() {
 		$endpoints = null;
 
-		if ( ACTIVITYPUB_SHARED_INBOX_FEATURE ) {
+		if ( \get_option( 'activitypub_shared_inbox' ) ) {
 			$endpoints = array(
 				'sharedInbox' => get_rest_url_by_path( 'inbox' ),
 			);

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

@@ -49,6 +49,17 @@ public static function register_advanced_fields() {
 				array( 'label_for' => 'activitypub_authorized_fetch' )
 			);
 		}
+
+		if ( ! defined( 'ACTIVITYPUB_SHARED_INBOX_FEATURE' ) ) {
+			\add_settings_field(
+				'activitypub_shared_inbox',
+				\__( 'Shared Inbox (beta)', 'activitypub' ),
+				array( self::class, 'render_shared_inbox_field' ),
+				'activitypub_advanced_settings',
+				'activitypub_advanced_settings',
+				array( 'label_for' => 'activitypub_shared_inbox' )
+			);
+		}
 	}
 
 	/**
@@ -110,4 +121,22 @@ public static function render_authorized_fetch_field() {
 		</p>
 		<?php
 	}
+
+	/**
+	 * Render shared inbox field.
+	 */
+	public static function render_shared_inbox_field() {
+		$value = \get_option( 'activitypub_shared_inbox', '0' );
+		?>
+		<p>
+			<label>
+				<input type="checkbox" id="activitypub_shared_inbox" name="activitypub_shared_inbox" value="1" <?php checked( '1', $value ); ?> />
+				<?php \esc_html_e( 'Use a shared inbox for incoming messages.', 'activitypub' ); ?>
+			</label>
+		</p>
+		<p class="description">
+			<?php \esc_html_e( 'Allows your site to handle incoming ActivityPub messages more efficiently, especially helpful for busy or multi-user sites. This feature is still in beta and may encounter issues.', 'activitypub' ); ?>
+		</p>
+		<?php
+	}
 }

includes/wp-admin/class-health-check.php

@@ -326,6 +326,12 @@ public static function debug_information( $info ) {
 			'private' => false,
 		);
 
+		$info['activitypub']['fields']['shared_inbox'] = array(
+			'label'   => \__( 'Shared Inbox', 'activitypub' ),
+			'value'   => \esc_attr( (int) \get_option( 'activitypub_shared_inbox', '0' ) ),
+			'private' => false,
+		);
+
 		$consts = get_defined_constants( true );
 
 		if ( ! isset( $consts['user'] ) ) {

includes/wp-admin/class-settings.php

@@ -187,6 +187,16 @@ public static function register_settings() {
 			)
 		);
 
+		\register_setting(
+			'activitypub_advanced',
+			'activitypub_shared_inbox',
+			array(
+				'type'        => 'boolean',
+				'description' => \__( 'Enable the shared inbox.', 'activitypub' ),
+				'default'     => false,
+			)
+		);
+
 		\register_setting(
 			'activitypub',
 			'activitypub_relays',