wp-sentry.php

<?php

/**
 * Plugin Name:       WordPress Sentry
 * Plugin URI:        https://github.com/stayallive/wp-sentry
 * Description:       A (unofficial) WordPress plugin to report PHP and JavaScript errors to Sentry.
 * Version:           8.2.0
 * Requires at least: 4.4
 * Requires PHP:      7.2.5
 * Author:            Alex Bouma
 * Author URI:        https://alex.bouma.dev
 * License:           MIT
 * License URI:       https://github.com/stayallive/wp-sentry/blob/v8.2.0/LICENSE.md
 */

// Exit if accessed directly
defined( 'ABSPATH' ) || exit;

// If the plugin was already loaded as a mu-plugin or from somewhere else do not load again
if ( defined( 'WP_SENTRY_MU_LOADED' ) || defined( 'WP_SENTRY_LOADED' ) ) {
	return;
}

define( 'WP_SENTRY_LOADED', true );

define( 'WP_SENTRY_WPINC', ABSPATH . ( defined( 'WPINC' ) ? WPINC : 'wp-includes' ) );
define( 'WP_SENTRY_WPADMIN', ABSPATH . 'wp-admin' );

// Load the WordPress plugin API early so hooks can be used even if Sentry is loaded before WordPress
if ( ! function_exists( 'add_action' ) ) {
	require_once WP_SENTRY_WPINC . '/plugin.php';
}

// Make sure the PHP version is at least 7.2
if ( ! defined( 'PHP_VERSION_ID' ) || PHP_VERSION_ID < 70200 ) {
	function wp_sentry_php_version_notice() { ?>
		<div class="error below-h2">
			<p>
				<?php printf(
					'The WordPress Sentry plugin requires at least PHP 7.2. You have %s. WordPress Sentry will not be active unless this is resolved!',
					PHP_VERSION
				); ?>
			</p>
		</div>
	<?php }

	add_action( 'admin_notices', 'wp_sentry_php_version_notice' );

	return;
}

// Resolve the sentry plugin file
define( 'WP_SENTRY_PLUGIN_FILE', call_user_func( static function () {
	global $wp_plugin_paths;

	$plugin_file = __FILE__;

	if ( ! empty( $wp_plugin_paths ) ) {
		$wp_plugin_real_paths = array_flip( $wp_plugin_paths );
		$plugin_path          = wp_normalize_path( dirname( $plugin_file ) );

		if ( isset( $wp_plugin_real_paths[ $plugin_path ] ) ) {
			$plugin_file = str_replace( $plugin_path, $wp_plugin_real_paths[ $plugin_path ], $plugin_file );
		}
	}

	return $plugin_file;
} ) );

// Load dependencies
if ( ! class_exists( WP_Sentry_Version::class ) ) {
	$scopedAutoloaderExists = file_exists(
		$scopedAutoloaderPath = __DIR__ . '/build/vendor/scoper-autoload.php'
	);

	// If ther is a scoped autoloader we use that version, otherwise we use the normal autoloader
	require_once $scopedAutoloaderExists
		? $scopedAutoloaderPath
		: __DIR__ . '/vendor/autoload.php';

	define( 'WP_SENTRY_SCOPED_AUTOLOADER', $scopedAutoloaderExists );
}

// Define the default version if none was set
if ( ! defined( 'WP_SENTRY_VERSION' ) && function_exists( 'add_action' ) ) {
	// We need to wait until the theme is loaded and setup to get the version
	add_action( 'after_setup_theme', function () {
		// It makes no sense to set a version based on the theme version if the plugin is enabled for the network since every site can have a different theme
		if ( function_exists( 'is_plugin_active_for_network' ) && is_plugin_active_for_network( __DIR__ ) ) {
			return;
		}

		// The JS client has not been initialized yet so we can just set the `WP_SENTRY_VERSION` constant
		define( 'WP_SENTRY_VERSION', wp_get_theme()->get( 'Version' ) ?: 'unknown' );

		// The PHP client has probably already been initialized so we need to update the release on the options directly
		add_filter( 'wp_sentry_options', static function ( Sentry\Options $options ) {
			$options->setRelease( WP_SENTRY_VERSION );

			return $options;
		} );
	}, /* priority: */ 1 );
}

// Load the PHP tracker if we have a PHP DSN
if ( defined( 'WP_SENTRY_PHP_DSN' ) || defined( 'WP_SENTRY_DSN' ) || defined( 'WP_SENTRY_SPOTLIGHT' ) ) {
	$sentry_php_tracker_dsn = defined( 'WP_SENTRY_PHP_DSN' )
		? WP_SENTRY_PHP_DSN
		: null;

	if ( $sentry_php_tracker_dsn === null ) {
		$sentry_php_tracker_dsn = defined( 'WP_SENTRY_DSN' )
			? WP_SENTRY_DSN
			: null;
	}

	if ( ! empty( $sentry_php_tracker_dsn ) || WP_Sentry_Php_Tracker::get_spotlight_enabled() ) {
		WP_Sentry_Php_Tracker::get_instance();
		WP_Sentry_Php_Tracing::get_instance();
	}
}

// Load the JavaScript tracker if we have a browser/public DSN
if ( defined( 'WP_SENTRY_BROWSER_DSN' ) || defined( 'WP_SENTRY_PUBLIC_DSN' ) ) {
	$sentry_js_tracker_dsn = defined( 'WP_SENTRY_BROWSER_DSN' )
		? WP_SENTRY_BROWSER_DSN
		: WP_SENTRY_PUBLIC_DSN;

	if ( ! empty( $sentry_js_tracker_dsn ) ) {
		WP_Sentry_Js_Tracker::get_instance();
	}
}

// Load the admin page
WP_Sentry_Admin_Page::get_instance();

/**
 * Register a "safe" function to call Sentry functions safer in your own code,
 * the callback only executed if a DSN was set and thus the client is able to sent events.
 *
 * Usage:
 * if ( function_exists( 'wp_sentry_safe' ) ) {
 *     wp_sentry_safe( function ( \Sentry\State\HubInterface $client ) {
 *         $client->captureMessage( 'This is a test message!', \Sentry\Severity::debug() );
 *     } );
 * }
 */
if ( ! function_exists( 'wp_sentry_safe' ) ) {
	/**
	 * Call the callback with the Sentry client, or not at all if there is no client.
	 *
	 * @param callable $callback
	 */
	function wp_sentry_safe( callable $callback ) {
		if ( class_exists( 'WP_Sentry_Php_Tracker' ) ) {
			$tracker = WP_Sentry_Php_Tracker::get_instance();

			if ( ! empty( $tracker->get_dsn() ) ) {
				$callback( $tracker->get_client() );
			}
		}
	}
}