André Menrath
984973e18d
All checks were successful
PHP Code Checker / PHP Code Checker (pull_request) Successful in 3m47s
PHPUnit / PHPUnit – PHP 7.4 (pull_request) Successful in 4m7s
PHPUnit / PHPUnit – PHP 8.0 (pull_request) Successful in 1m12s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Successful in 1m9s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Successful in 1m7s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Successful in 1m6s
PHPUnit / PHPUnit – PHP 8.4 (pull_request) Successful in 1m8s
450 lines
16 KiB
PHP
450 lines
16 KiB
PHP
<?php
|
|
/**
|
|
* Class responsible for initializing Event Bridge for ActivityPub.
|
|
*
|
|
* The setup class provides function for checking if this plugin should be activated.
|
|
* It detects supported event plugins and provides all setup hooks and filters.
|
|
*
|
|
* @package Event_Bridge_For_ActivityPub
|
|
* @since 1.0.0
|
|
* @license AGPL-3.0-or-later
|
|
*/
|
|
|
|
namespace Event_Bridge_For_ActivityPub;
|
|
|
|
// Exit if accessed directly.
|
|
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
|
|
|
|
use Event_Bridge_For_ActivityPub\ActivityPub\Transmogrifier\Base as Transmogrifier;
|
|
use Event_Bridge_For_ActivityPub\Admin\Event_Plugin_Admin_Notices;
|
|
use Event_Bridge_For_ActivityPub\Admin\General_Admin_Notices;
|
|
use Event_Bridge_For_ActivityPub\Admin\Health_Check;
|
|
use Event_Bridge_For_ActivityPub\Admin\Settings_Page;
|
|
use Event_Bridge_For_ActivityPub\Integrations\Event_Plugin;
|
|
use Event_Bridge_For_ActivityPub\Integrations\Feature_Event_Sources;
|
|
|
|
use function Activitypub\is_user_type_disabled;
|
|
|
|
require_once ABSPATH . 'wp-admin/includes/plugin.php';
|
|
|
|
/**
|
|
* Class Setup.
|
|
|
|
* This class is responsible for initializing Event Bridge for ActivityPub.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
class Setup {
|
|
/**
|
|
* Keep the information whether the ActivityPub plugin is active.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
protected $activitypub_plugin_is_active = false;
|
|
|
|
/**
|
|
* Keep the current version of the current ActivityPub plugin.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $activitypub_plugin_version = '';
|
|
|
|
/**
|
|
* Holds an array of the currently activated supported event plugins.
|
|
*
|
|
* @var Event_Plugin[]
|
|
*/
|
|
protected $active_event_plugins = array();
|
|
|
|
/**
|
|
* Constructor for the Setup class.
|
|
*
|
|
* Initializes and sets up various components of the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
protected function __construct() {
|
|
add_action( 'plugins_loaded', array( $this, 'setup_hooks' ) );
|
|
}
|
|
|
|
/**
|
|
* The single instance of the class.
|
|
*
|
|
* @since 1.0.0
|
|
* @var ?self|null The instance of the class.
|
|
*/
|
|
private static $instance = null;
|
|
|
|
/**
|
|
* Get the instance of the Singleton class.
|
|
*
|
|
* If an instance does not exist, it creates one; otherwise, it returns the existing instance.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return self The instance of the class.
|
|
*/
|
|
public static function get_instance(): self {
|
|
if ( null === self::$instance ) {
|
|
self::$instance = new self();
|
|
}
|
|
|
|
return self::$instance;
|
|
}
|
|
|
|
/**
|
|
* LooksUp the current version of the ActivityPub.
|
|
*
|
|
* @return string The semantic Version.
|
|
*/
|
|
private static function get_activitypub_plugin_version(): string {
|
|
if ( defined( 'ACTIVITYPUB_PLUGIN_VERSION' ) ) {
|
|
return constant( 'ACTIVITYPUB_PLUGIN_VERSION' );
|
|
}
|
|
return '0.0.0';
|
|
}
|
|
|
|
/**
|
|
* Getter function for the active event plugins.
|
|
*
|
|
* @return \Event_Bridge_For_ActivityPub\Integrations\Event_Plugin_Integration[]
|
|
*/
|
|
public function get_active_event_plugins() {
|
|
return $this->active_event_plugins;
|
|
}
|
|
|
|
/**
|
|
* Holds all the classes for the supported event plugins.
|
|
*
|
|
* @var \Event_Bridge_For_ActivityPub\Integrations\Event_Plugin_Integration[]
|
|
*/
|
|
private const EVENT_PLUGIN_INTEGRATIONS = array(
|
|
\Event_Bridge_For_ActivityPub\Integrations\Events_Manager::class,
|
|
\Event_Bridge_For_ActivityPub\Integrations\GatherPress::class,
|
|
\Event_Bridge_For_ActivityPub\Integrations\The_Events_Calendar::class,
|
|
\Event_Bridge_For_ActivityPub\Integrations\VS_Event_List::class,
|
|
\Event_Bridge_For_ActivityPub\Integrations\WP_Event_Manager::class,
|
|
\Event_Bridge_For_ActivityPub\Integrations\Eventin::class,
|
|
\Event_Bridge_For_ActivityPub\Integrations\Modern_Events_Calendar_Lite::class,
|
|
\Event_Bridge_For_ActivityPub\Integrations\EventPrime::class,
|
|
\Event_Bridge_For_ActivityPub\Integrations\Event_Organiser::class,
|
|
);
|
|
|
|
/**
|
|
* Force the re-scan for active event plugins without using the cached transient.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function redetect_active_event_plugins(): void {
|
|
delete_transient( 'event_bridge_for_activitypub_active_event_plugins' );
|
|
$this->detect_active_event_plugins();
|
|
}
|
|
|
|
/**
|
|
* Function that checks for supported activated event plugins.
|
|
*
|
|
* @return array List of supported event plugins as keys from the SUPPORTED_EVENT_PLUGINS const.
|
|
*/
|
|
public function detect_active_event_plugins(): array {
|
|
$active_event_plugins = get_transient( 'event_bridge_for_activitypub_active_event_plugins' );
|
|
|
|
if ( $active_event_plugins ) {
|
|
$this->active_event_plugins = $active_event_plugins;
|
|
return $active_event_plugins;
|
|
}
|
|
|
|
if ( ! function_exists( 'get_plugins' ) ) {
|
|
require_once ABSPATH . 'wp-admin/includes/plugin.php';
|
|
}
|
|
|
|
$all_plugins = array_merge( get_plugins(), get_mu_plugins() );
|
|
|
|
$active_event_plugins = array();
|
|
foreach ( self::EVENT_PLUGIN_INTEGRATIONS as $event_plugin_integration ) {
|
|
// Get the filename of the main plugin file of the event plugin (relative to the plugin dir).
|
|
$event_plugin_file = $event_plugin_integration::get_relative_plugin_file();
|
|
|
|
// Check if plugin is present on disk and is activated.
|
|
if ( array_key_exists( $event_plugin_file, $all_plugins ) && \is_plugin_active( $event_plugin_file ) ) {
|
|
$active_event_plugins[ $event_plugin_file ] = new $event_plugin_integration();
|
|
}
|
|
}
|
|
set_transient( 'event_bridge_for_activitypub_active_event_plugins', $active_event_plugins );
|
|
$this->active_event_plugins = $active_event_plugins;
|
|
return $active_event_plugins;
|
|
}
|
|
|
|
/**
|
|
* Function that checks which event plugins support the event sources feature.
|
|
*
|
|
* @return array List of supported event plugins as keys from the SUPPORTED_EVENT_PLUGINS const.
|
|
*/
|
|
public static function detect_event_plugins_supporting_event_sources(): array {
|
|
$plugins_supporting_event_sources = array();
|
|
|
|
foreach ( self::EVENT_PLUGIN_INTEGRATIONS as $event_plugin_integration ) {
|
|
if ( $event_plugin_integration instanceof Feature_Event_Sources ) {
|
|
$plugins_supporting_event_sources[] = new $event_plugin_integration();
|
|
}
|
|
}
|
|
return $plugins_supporting_event_sources;
|
|
}
|
|
|
|
/**
|
|
* Main setup function of the plugin "Event Bridge For ActivityPub".
|
|
*
|
|
* This method adds hooks for different purposes as needed.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function setup_hooks(): void {
|
|
// Detect the presence of the ActivityPub plugin.
|
|
$this->activitypub_plugin_is_active = defined( 'ACTIVITYPUB_PLUGIN_VERSION' ) || \is_plugin_active( 'activitypub/activitypub.php' );
|
|
$this->activitypub_plugin_version = self::get_activitypub_plugin_version();
|
|
|
|
// Detect active supported event plugins.
|
|
$this->detect_active_event_plugins();
|
|
|
|
// Register hook that runs when this plugin gets activated.
|
|
register_activation_hook( EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_FILE, array( $this, 'activate' ) );
|
|
|
|
// Register listeners whenever any plugin gets activated or deactivated.
|
|
add_action( 'activated_plugin', array( $this, 'redetect_active_event_plugins' ) );
|
|
add_action( 'deactivated_plugin', array( $this, 'redetect_active_event_plugins' ) );
|
|
|
|
// Add hook that takes care of all notices in the Admin UI.
|
|
add_action( 'admin_init', array( $this, 'do_admin_notices' ) );
|
|
|
|
// Add hook that registers all settings of this plugin to WordPress.
|
|
add_action( 'admin_init', array( Settings::class, 'register_settings' ) );
|
|
|
|
// Add hook that loads CSS and JavaScript files for the Admin UI.
|
|
add_action( 'admin_enqueue_scripts', array( self::class, 'enqueue_styles' ) );
|
|
|
|
// Register the settings page(s) of this plugin to the WordPress admin menu.
|
|
add_action( 'admin_menu', array( Settings_Page::class, 'admin_menu' ) );
|
|
add_filter(
|
|
'plugin_action_links_' . EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_BASENAME,
|
|
array( Settings_Page::class, 'settings_link' )
|
|
);
|
|
|
|
// If we don't have any active event plugins, or the ActivityPub plugin is not enabled, abort here.
|
|
if ( empty( $this->active_event_plugins ) || ! $this->activitypub_plugin_is_active ) {
|
|
return;
|
|
}
|
|
|
|
// Register health checks and status reports to the WordPress status report site.
|
|
add_action( 'init', array( Health_Check::class, 'init' ) );
|
|
|
|
// Check if the minimum required version of the ActivityPub plugin is installed, if not abort.
|
|
if ( ! version_compare( $this->activitypub_plugin_version, EVENT_BRIDGE_FOR_ACTIVITYPUB_ACTIVITYPUB_PLUGIN_MIN_VERSION ) ) {
|
|
return;
|
|
}
|
|
|
|
// If the Event-Sources feature is enabled and all requirements are met, initialize it.
|
|
if ( ! is_user_type_disabled( 'blog' ) && get_option( 'event_bridge_for_activitypub_event_sources_active' ) ) {
|
|
Event_Sources::init();
|
|
}
|
|
|
|
// Lastly but most importantly: register the ActivityPub transformers for events to the ActivityPub plugin.
|
|
add_filter( 'activitypub_transformer', array( $this, 'register_activitypub_event_transformer' ), 10, 3 );
|
|
}
|
|
|
|
/**
|
|
* Add the CSS for the admin pages.
|
|
*
|
|
* @param string $hook_suffix The suffix of the hook.
|
|
*
|
|
* @return void
|
|
*/
|
|
public static function enqueue_styles( $hook_suffix ): void {
|
|
if ( false !== strpos( $hook_suffix, 'event-bridge-for-activitypub' ) ) {
|
|
wp_enqueue_style(
|
|
'event-bridge-for-activitypub-admin-styles',
|
|
plugins_url(
|
|
'assets/css/event-bridge-for-activitypub-admin.css',
|
|
EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_FILE
|
|
),
|
|
array(),
|
|
EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_VERSION
|
|
);
|
|
wp_enqueue_script(
|
|
'event-bridge-for-activitypub-admin-script',
|
|
plugins_url(
|
|
'assets/js/event-bridge-for-activitypub-admin.js',
|
|
EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_FILE
|
|
),
|
|
array( 'jquery' ),
|
|
EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_VERSION,
|
|
false
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Fires the initialization of admin notices.
|
|
*/
|
|
public function do_admin_notices(): void {
|
|
foreach ( $this->active_event_plugins as $event_plugin ) {
|
|
new Event_Plugin_Admin_Notices( $event_plugin );
|
|
}
|
|
// Check if any general admin notices are needed and add actions to insert the needed admin notices.
|
|
if ( ! $this->activitypub_plugin_is_active ) {
|
|
// The ActivityPub plugin is not active.
|
|
add_action( 'admin_notices', array( 'Event_Bridge_For_ActivityPub\Admin\General_Admin_Notices', 'activitypub_plugin_not_enabled' ), 10, 1 );
|
|
}
|
|
if ( ! version_compare( $this->activitypub_plugin_version, EVENT_BRIDGE_FOR_ACTIVITYPUB_ACTIVITYPUB_PLUGIN_MIN_VERSION ) ) {
|
|
// The ActivityPub plugin is too old.
|
|
add_action( 'admin_notices', array( 'Event_Bridge_For_ActivityPub\Admin\General_Admin_Notices', 'activitypub_plugin_version_too_old' ), 10, 1 );
|
|
}
|
|
if ( empty( $this->active_event_plugins ) ) {
|
|
// No supported Event Plugin is active.
|
|
add_action( 'admin_notices', array( 'Event_Bridge_For_ActivityPub\Admin\General_Admin_Notices', 'no_supported_event_plugin_active' ), 10, 1 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add the custom transformers for the events of several WordPress event plugins.
|
|
*
|
|
* @param Activitypub\Transformer\Base $transformer The transformer to use.
|
|
* @param mixed $wp_object The WordPress object to transform.
|
|
* @param string $object_class The class of the object to transform.
|
|
*
|
|
* @return \Activitypub\Transformer\Base|null
|
|
*/
|
|
public function register_activitypub_event_transformer( $transformer, $wp_object, $object_class ): ?\Activitypub\Transformer\Base {
|
|
// If the current WordPress object is not a post (e.g., a WP_Comment), don't change the transformer.
|
|
if ( 'WP_Post' !== $object_class ) {
|
|
return $transformer;
|
|
}
|
|
|
|
// Get the transformer for a specific event plugins event-post type.
|
|
foreach ( $this->active_event_plugins as $event_plugin ) {
|
|
if ( $wp_object->post_type === $event_plugin->get_post_type() ) {
|
|
return $event_plugin::get_activitypub_event_transformer( $wp_object, $event_plugin::get_event_category_taxonomy() );
|
|
}
|
|
}
|
|
|
|
// Return the default transformer.
|
|
return $transformer;
|
|
}
|
|
|
|
/**
|
|
* Activates ActivityPub support for all active event plugins event post-types.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function activate_activitypub_support_for_active_event_plugins(): void {
|
|
// If someone installs this plugin, we simply enable ActivityPub support for all currently active event post types.
|
|
$activitypub_supported_post_types = get_option( 'activitypub_support_post_types', array() );
|
|
foreach ( $this->active_event_plugins as $event_plugin ) {
|
|
if ( ! in_array( $event_plugin->get_post_type(), $activitypub_supported_post_types, true ) ) {
|
|
$activitypub_supported_post_types[] = $event_plugin->get_post_type();
|
|
add_post_type_support( $event_plugin->get_post_type(), 'activitypub' );
|
|
}
|
|
}
|
|
update_option( 'activitypub_support_post_types', $activitypub_supported_post_types );
|
|
}
|
|
|
|
/**
|
|
* Activates the Event Bridge for ActivityPub plugin.
|
|
*
|
|
* This method handles the activation of the Event Bridge for ActivityPub plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @see register_activation_hook()
|
|
* @return void
|
|
*/
|
|
public function activate(): void {
|
|
$this->redetect_active_event_plugins();
|
|
// Don't allow plugin activation, when the ActivityPub plugin is not activated yet.
|
|
if ( ! $this->activitypub_plugin_is_active ) {
|
|
deactivate_plugins( plugin_basename( EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_FILE ) );
|
|
$notice = General_Admin_Notices::get_admin_notice_activitypub_plugin_not_enabled();
|
|
wp_die(
|
|
wp_kses( $notice, General_Admin_Notices::ALLOWED_HTML ),
|
|
'Plugin dependency check',
|
|
array( 'back_link' => true ),
|
|
);
|
|
}
|
|
|
|
if ( empty( $this->active_event_plugins ) ) {
|
|
deactivate_plugins( plugin_basename( EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_FILE ) );
|
|
$notice = General_Admin_Notices::get_admin_notice_no_supported_event_plugin_active();
|
|
wp_die(
|
|
wp_kses( $notice, General_Admin_Notices::ALLOWED_HTML ),
|
|
'Plugin dependency check',
|
|
array( 'back_link' => true ),
|
|
);
|
|
}
|
|
|
|
self::activate_activitypub_support_for_active_event_plugins();
|
|
}
|
|
|
|
/**
|
|
* Get the event plugin integration class name used for the event sources feature.
|
|
*
|
|
* @return string The class name of the event plugin integration class.
|
|
*/
|
|
public static function get_event_plugin_integration_used_for_event_sources_feature() {
|
|
// Get plugin option.
|
|
$event_plugin_integration = get_option( 'event_bridge_for_activitypub_integration_used_for_event_sources_feature', '' );
|
|
|
|
// Exit if event sources are not active or no plugin is specified.
|
|
if ( empty( $event_plugin_integration ) ) {
|
|
return null;
|
|
}
|
|
|
|
// Validate if setting is actual existing class.
|
|
if ( ! class_exists( $event_plugin_integration ) ) {
|
|
return null;
|
|
}
|
|
|
|
return $event_plugin_integration;
|
|
}
|
|
|
|
/**
|
|
* Get the transmogrifier class.
|
|
*
|
|
* Retrieves the appropriate transmogrifier class based on the active event plugins and settings.
|
|
*
|
|
* @return ?Transmogrifier The transmogrifier class name or null if not available.
|
|
*/
|
|
public static function get_transmogrifier(): ?Transmogrifier {
|
|
$event_plugin_integration = self::get_event_plugin_integration_used_for_event_sources_feature();
|
|
|
|
if ( ! $event_plugin_integration ) {
|
|
return null;
|
|
}
|
|
|
|
// Validate if get_transformer method exists in event plugin integration.
|
|
if ( ! method_exists( $event_plugin_integration, 'get_transmogrifier' ) ) {
|
|
return null;
|
|
}
|
|
|
|
$transmogrifier = $event_plugin_integration::get_transmogrifier();
|
|
|
|
return $transmogrifier;
|
|
}
|
|
|
|
/**
|
|
* Get the full class name of the first event plugin integration that is active and supports the event source feature.
|
|
*
|
|
* @return string The full class name of the event plugin integration.
|
|
*/
|
|
public static function get_default_integration_class_name_used_for_event_sources_feature(): string {
|
|
$setup = self::get_instance();
|
|
|
|
$event_plugin_integrations = $setup->get_active_event_plugins();
|
|
foreach ( $event_plugin_integrations as $event_plugin_integration ) {
|
|
if ( $event_plugin_integration instanceof Feature_Event_Sources ) {
|
|
get_class( $event_plugin_integration );
|
|
}
|
|
}
|
|
return '';
|
|
}
|
|
}
|