collaboration.php

<?php
/**
 * Bootstraps collaborative editing.
 *
 * @package WordPress
 * @since 7.0.0
 */

/**
 * Determines whether real-time collaboration is enabled.
 *
 * If the WP_ALLOW_COLLABORATION constant is false,
 * collaboration is always disabled regardless of the database option.
 *
 * @since 7.0.0
 *
 * @return bool Whether real-time collaboration is enabled.
 */
function wp_is_collaboration_enabled(): bool {
	return (
		wp_is_collaboration_allowed() &&
		get_option( 'wp_collaboration_enabled' )
	);
}

/**
 * Determines whether real-time collaboration is allowed.
 *
 * If the WP_ALLOW_COLLABORATION constant is false,
 * collaboration is not allowed and cannot be enabled.
 * The constant defaults to true, unless the WP_ALLOW_COLLABORATION
 * environment variable is set to string "false".
 *
 * Also requires the database schema introduced in db_version 62282.
 *
 * @since 7.0.0
 *
 * @return bool Whether real-time collaboration is allowed.
 */
function wp_is_collaboration_allowed(): bool {
	if ( get_option( 'db_version' ) < 62282 ) {
		return false;
	}

	if ( ! defined( 'WP_ALLOW_COLLABORATION' ) ) {
		$env_value = getenv( 'WP_ALLOW_COLLABORATION' );
		if ( false === $env_value ) {
			// Environment variable is not defined, default to allowing collaboration.
			define( 'WP_ALLOW_COLLABORATION', true );
		} else {
			/*
			 * Environment variable is defined, let's confirm it is actually set to
			 * "true" as it may still have a string value "false" – the preceding
			 * `if` branch only tests for the boolean `false`.
			 */
			define( 'WP_ALLOW_COLLABORATION', 'true' === $env_value );
		}
	}

	return (bool) WP_ALLOW_COLLABORATION;
}

/**
 * Injects the real-time collaboration setting into a global variable.
 *
 * @since 7.0.0
 *
 * @access private
 *
 * @global string $pagenow The filename of the current screen.
 */
function wp_collaboration_inject_setting(): void {
	global $pagenow;

	if ( ! wp_is_collaboration_enabled() ) {
		return;
	}

	// Disable real-time collaboration on the site editor.
	$enabled = true;
	if ( 'site-editor.php' === $pagenow ) {
		$enabled = false;
	}

	wp_add_inline_script(
		'wp-core-data',
		'window._wpCollaborationEnabled = ' . wp_json_encode( $enabled ) . ';',
		'after'
	);
}

/**
 * Deletes stale collaboration data from the collaboration table.
 *
 * Removes non-awareness rows older than 7 days and awareness rows older
 * than 60 seconds. Rows left behind by abandoned collaborative editing
 * sessions are cleaned up to prevent unbounded table growth.
 *
 * @since 7.0.0
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 */
function wp_delete_old_collaboration_data(): void {
	global $wpdb;

	if ( ! wp_is_collaboration_enabled() ) {
		/*
		 * Collaboration was enabled in the past but has since been disabled.
		 * Unschedule the cron job prior to clean up so this callback does not
		 * continue to run.
		 */
		wp_clear_scheduled_hook( 'wp_delete_old_collaboration_data' );
	}

	// Clean up rows older than 7 days.
	$wpdb->query(
		$wpdb->prepare(
			"DELETE FROM {$wpdb->collaboration} WHERE date_gmt < %s",
			gmdate( 'Y-m-d H:i:s', time() - WEEK_IN_SECONDS )
		)
	);

	// Clean up awareness rows older than 60 seconds.
	$wpdb->query(
		$wpdb->prepare(
			"DELETE FROM {$wpdb->collaboration} WHERE type = 'awareness' AND date_gmt < %s",
			gmdate( 'Y-m-d H:i:s', time() - 60 )
		)
	);
}