@@ -40,13 +40,13 @@ These platforms create public event calendars by pulling in events from various
Even platforms that don’t yet fully support events, like [Mastodon](https://joinmastodon.org), will still receive a detailed, well-composed summary of your event. -The Event Federation Plugin ensures that users from those platforms are provided with all important information about an event. +The Event Federation plugin ensures that users from those platforms are provided with all important information about an event. ## Installation -This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). Additionally, you need to use one of the supported Event Plugins. See below. +This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). Additionally, you need to use one of the supported event plugins. See below. -### Supported Event Plugins +### Supported Event plugins * [The Events Calendar](https://de.wordpress.org/plugins/the-events-calendar/) * [VS Event List](https://de.wordpress.org/plugins/very-simple-event-list/) @@ -58,12 +58,12 @@ If you’re new to the [ActivityPub plugin](https://wordpress.org/plugins/activi ## Frequently Asked Questions -### Do I need to install another event plugin to use the Event Federation Plugin? +### Do I need to install another event plugin to use the Event Federation plugin? Yes, this plugin works needs a supported event plugin such as The Events Calendar, VS Event List, or Events Manager to manage your events. It just fills the missing gap between event plugins and the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). ### What platforms can follow my events? -Your events can be followed on platforms that support ActivityPub like [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). Even other applications like [Mastodon](https://joinmastodon.org), which don’t fully support events yet, will display a all important information about the events. +Your events can be followed on platforms that support ActivityPub like [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). Even other applications like [Mastodon](https://joinmastodon.org), which don’t fully support events yet, will display all important information about the events. ### How much extra work is required to maintain my events across the decentralized Web? @@ -75,15 +75,15 @@ Yes, you can still use traditional social media if you wish. However, this plugi ### Will this plugin work if I don't use the ActivityPub plugin? -No, the Event Federation Plugin depends on the ActivityPub plugin to deliver your events across decentralized platforms, so it's essential to have it installed and configured. +No, the Event Federation plugin depends on the ActivityPub plugin to deliver your events across decentralized platforms, so it's essential to have it installed and configured. ### My event plugin is not supported, what can I do? -If you know about coding have a look at the documentation of how to add your plugin or open an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-extensions/issues), if we can spare some free hours we might add it. +If you know about coding have a look at the documentation of how to add your plugin or open an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge/issues), if we can spare some free hours we might add it. ### What if I experience problems? -We're always interested in your feedback. Feel free to reach out to us via [E-Mail](https://event-federation.eu/contact/) or create an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-extensions/issues). +We're always interested in your feedback. Feel free to reach out to us via [E-Mail](https://event-federation.eu/contact/) or create an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge/issues). ## Changelog diff --git a/activitypub-event-extensions.php b/activitypub-event-extensions.php index da80a3b..1c78b49 100644 --- a/activitypub-event-extensions.php +++ b/activitypub-event-extensions.php @@ -1,39 +1,39 @@ = 3.2.2. ActivityPub plugin tested up to: 3.2.2. * - * @package Activitypub_Event_Extensions + * @package ActivityPub_Event_Bridge * @license AGPL-3.0-or-later */ // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore -define( 'ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_DIR', plugin_dir_path( __FILE__ ) ); -define( 'ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_BASENAME', plugin_basename( __FILE__ ) ); -define( 'ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_FILE', plugin_dir_path( __FILE__ ) . '/' . basename( __FILE__ ) ); -define( 'ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_URL', plugin_dir_url( __FILE__ ) ); -define( 'ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_VERSION', current( get_file_data( __FILE__, array( 'Version' ), 'plugin' ) ) ); -define( 'ACTIVITYPUB_EVENT_EXTENSIONS_DOMAIN', 'activitypub-event-extensions' ); -define( 'ACTIVITYPUB_EVENT_EXTENSIONS_ACTIVITYPUB_PLUGIN_MIN_VERSION', '3.2.2' ); +define( 'ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_DIR', plugin_dir_path( __FILE__ ) ); +define( 'ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_BASENAME', plugin_basename( __FILE__ ) ); +define( 'ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE', plugin_dir_path( __FILE__ ) . '/' . basename( __FILE__ ) ); +define( 'ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_URL', plugin_dir_url( __FILE__ ) ); +define( 'ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_VERSION', current( get_file_data( __FILE__, array( 'Version' ), 'plugin' ) ) ); +define( 'ACTIVITYPUB_EVENT_BRIDGE_DOMAIN', 'activitypub-event-bridge' ); +define( 'ACTIVITYPUB_EVENT_BRIDGE_ACTIVITYPUB_PLUGIN_MIN_VERSION', '3.2.2' ); // Include and register the autoloader class for automatic loading of plugin classes. -require_once ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_DIR . '/includes/class-autoloader.php'; -Activitypub_Event_Extensions\Autoloader::register(); +require_once ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_DIR . '/includes/class-autoloader.php'; +ActivityPub_Event_Bridge\Autoloader::register(); // Initialize the plugin. -Activitypub_Event_Extensions\Setup::get_instance(); +ActivityPub_Event_Bridge\Setup::get_instance(); // BeforeFirstRelease: Remove everything after this after here. @@ -42,7 +42,7 @@ Activitypub_Event_Extensions\Setup::get_instance(); * * BeforeFirstRelease: Remove this for release. */ -add_filter( 'http_request_host_is_external', 'activitypub_event_extensions_custom_http_request_host_is_external', 10, 3 ); +add_filter( 'http_request_host_is_external', 'activitypub_event_bridge_custom_http_request_host_is_external', 10, 3 ); /** * Add a filter for http_request_host_is_external @@ -51,7 +51,7 @@ add_filter( 'http_request_host_is_external', 'activitypub_event_extensions_custo * * @param bool $is_external Whether the request is external. */ -function activitypub_event_extensions_custom_http_request_host_is_external( $is_external ) { +function activitypub_event_bridge_custom_http_request_host_is_external( $is_external ) { $is_external = true; return $is_external; @@ -62,11 +62,11 @@ function activitypub_event_extensions_custom_http_request_host_is_external( $is_ * * BeforeFirstRelease: Remove this for release. */ -add_filter( 'https_ssl_verify', 'activitypub_event_extensions_dont_verify_local_dev_https', 10, 3 ); +add_filter( 'https_ssl_verify', 'activitypub_event_bridge_dont_verify_local_dev_https', 10, 3 ); /** * BeforeFirstRelease: remove it. */ -function activitypub_event_extensions_dont_verify_local_dev_https() { +function activitypub_event_bridge_dont_verify_local_dev_https() { return false; } diff --git a/assets/css/activitypub-event-extensions-admin.css b/assets/css/activitypub-event-extensions-admin.css index c43ea1d..c59d1a1 100644 --- a/assets/css/activitypub-event-extensions-admin.css +++ b/assets/css/activitypub-event-extensions-admin.css @@ -1,4 +1,4 @@ -.activitypub-event-extensions-settings-page .box { +.activitypub-event-bridge-settings-page .box { border: 1px solid #c3c4c7; background-color: #fff; padding: 1em 1.5em; diff --git a/composer.json b/composer.json index 28fb046..44b5406 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { - "name": "menrath/wordpress-activitypub-event-extensions", - "description": "The ActivityPub Event Extensions help for event custom post types to federate properly.", + "name": "menrath/wordpress-activitypub-event-bridge", + "description": "The ActivityPub Event Bridge help for event custom post types to federate properly.", "type": "wordpress-plugin", "require": { "php": ">=8.1.0", @@ -32,7 +32,7 @@ } ], "extra": { - "installer-name": "activitypub-event-extensions" + "installer-name": "activitypub-event-bridge" }, "scripts": { "lint": [ diff --git a/docker-compose.yml b/docker-compose.yml index 78aacdd..dc71501 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -13,7 +13,7 @@ version: '3' # "request": "launch", # "port": 9003, # "pathMappings": { -# "/app/": "${workspaceRoot}/wp-content/plugins/activitypub-event-extensions/", +# "/app/": "${workspaceRoot}/wp-content/plugins/activitypub-event-bridge/", # "/tmp/wordpress/": "${workspaceRoot}/" # }, # }, diff --git a/docs/add_your_event_plugin.md b/docs/add_your_event_plugin.md index 1ec0b16..a7c8883 100644 --- a/docs/add_your_event_plugin.md +++ b/docs/add_your_event_plugin.md @@ -29,7 +29,7 @@ The Plugin takes care of applying the transformer, so you can jump right into im If you are writing a transformer for a custom post type it is recommended to start by extending the provided [event transformer](./includes/activitypub/transformer/class-event.php). It is an extension of the default generic post transformer and inherits useful default implementations for generating the [attachments](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attachment), rendering a proper [content](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-content) in HTML from either blocks or the classic editor, extracting [tags](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-tag) and more. ```php -namespace Activitypub_Event_Extensions\Activitypub\Transformer; +namespace ActivityPub_Event_Bridge\Activitypub\Transformer; /** * ActivityPub Transformer for my_event_post_type. diff --git a/includes/activitypub/transformer/class-event.php b/includes/activitypub/transformer/class-event.php index a2e1056..1730950 100644 --- a/includes/activitypub/transformer/class-event.php +++ b/includes/activitypub/transformer/class-event.php @@ -2,11 +2,11 @@ /** * Replace the default ActivityPub Transformer * - * @package Activitypub_Event_Extensions + * @package ActivityPub_Event_Bridge * @license AGPL-3.0-or-later */ -namespace Activitypub_Event_Extensions\Activitypub\Transformer; +namespace ActivityPub_Event_Bridge\Activitypub\Transformer; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore @@ -118,7 +118,7 @@ abstract class Event extends Post { if ( is_null( $this->wp_taxonomy ) ) { return null; } - $current_category_mapping = \get_option( 'activitypub_event_extensions_event_category_mappings', array() ); + $current_category_mapping = \get_option( 'activitypub_event_bridge_event_category_mappings', array() ); $terms = \get_the_terms( $this->wp_object, $this->wp_taxonomy ); // Check if the event has a category set and if that category has a specific mapping return that one. @@ -126,7 +126,7 @@ abstract class Event extends Post { return sanitize_text_field( $current_category_mapping[ $terms[0]->slug ] ); } else { // Return the default event category. - return sanitize_text_field( \get_option( 'activitypub_event_extensions_default_event_category', 'MEETING' ) ); + return sanitize_text_field( \get_option( 'activitypub_event_bridge_default_event_category', 'MEETING' ) ); } } @@ -228,10 +228,10 @@ abstract class Event extends Post { $categories = array(); // Add the federated category string. - require_once ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_DIR . '/includes/event-categories.php'; + require_once ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_DIR . '/includes/event-categories.php'; $federated_category = $this->get_category(); - if ( array_key_exists( $federated_category, ACTIVITYPUB_EVENT_EXTENSIONS_EVENT_CATEGORIES ) ) { - $categories[] = ACTIVITYPUB_EVENT_EXTENSIONS_EVENT_CATEGORIES[ $federated_category ]; + if ( array_key_exists( $federated_category, ACTIVITYPUB_EVENT_BRIDGE_EVENT_CATEGORIES ) ) { + $categories[] = ACTIVITYPUB_EVENT_BRIDGE_EVENT_CATEGORIES[ $federated_category ]; } // Add all category terms. @@ -273,19 +273,19 @@ abstract class Event extends Post { $formatted_items = array(); if ( ! empty( $category ) ) { - $formatted_items[] = '🏷️ ' . __( 'Category', 'activitypub-event-extensions' ) . ': ' . $category; + $formatted_items[] = '🏷️ ' . __( 'Category', 'activitypub-event-bridge' ) . ': ' . $category; } if ( ! empty( $start_time ) ) { - $formatted_items[] = '🗓️ ' . __( 'Start', 'activitypub-event-extensions' ) . ': ' . $start_time; + $formatted_items[] = '🗓️ ' . __( 'Start', 'activitypub-event-bridge' ) . ': ' . $start_time; } if ( ! empty( $end_time ) ) { - $formatted_items[] = '⏳ ' . __( 'End', 'activitypub-event-extensions' ) . ': ' . $end_time; + $formatted_items[] = '⏳ ' . __( 'End', 'activitypub-event-bridge' ) . ': ' . $end_time; } if ( ! empty( $address ) ) { - $formatted_items[] = '📍 ' . __( 'Address', 'activitypub-event-extensions' ) . ': ' . $address; + $formatted_items[] = '📍 ' . __( 'Address', 'activitypub-event-bridge' ) . ': ' . $address; } // Compose the summary based on the number of meta items. diff --git a/includes/activitypub/transformer/class-events-manager.php b/includes/activitypub/transformer/class-events-manager.php index a760d2e..3acf6aa 100644 --- a/includes/activitypub/transformer/class-events-manager.php +++ b/includes/activitypub/transformer/class-events-manager.php @@ -2,18 +2,18 @@ /** * ActivityPub Transformer for the plugin Very Simple Event List. * - * @package Activitypub_Event_Extensions + * @package ActivityPub_Event_Bridge * @license AGPL-3.0-or-later */ -namespace Activitypub_Event_Extensions\Activitypub\Transformer; +namespace ActivityPub_Event_Bridge\Activitypub\Transformer; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore use Activitypub\Activity\Extended_Object\Event; use Activitypub\Activity\Extended_Object\Place; -use Activitypub_Event_Extensions\Activitypub\Transformer\Event as Event_Transformer; +use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer; use DateTime; use DateTimeZone; use EM_Event; diff --git a/includes/activitypub/transformer/class-gatherpress.php b/includes/activitypub/transformer/class-gatherpress.php index bfe1e92..e3ec013 100644 --- a/includes/activitypub/transformer/class-gatherpress.php +++ b/includes/activitypub/transformer/class-gatherpress.php @@ -2,11 +2,11 @@ /** * ActivityPub Transformer for the plugin Very Simple Event List. * - * @package Activitypub_Event_Extensions + * @package ActivityPub_Event_Bridge * @license AGPL-3.0-or-later */ -namespace Activitypub_Event_Extensions\Activitypub\Transformer; +namespace ActivityPub_Event_Bridge\Activitypub\Transformer; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore @@ -14,7 +14,7 @@ defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore use Activitypub\Activity\Extended_Object\Event as Event_Object; use Activitypub\Activity\Extended_Object\Place; use Activitypub\Model\Blog; -use Activitypub_Event_Extensions\Activitypub\Transformer\Event; +use ActivityPub_Event_Bridge\Activitypub\Transformer\Event; use GatherPress\Core\Event as GatherPress_Event; /** diff --git a/includes/activitypub/transformer/class-the-events-calendar.php b/includes/activitypub/transformer/class-the-events-calendar.php index b83cd40..d6eb7fa 100644 --- a/includes/activitypub/transformer/class-the-events-calendar.php +++ b/includes/activitypub/transformer/class-the-events-calendar.php @@ -2,18 +2,18 @@ /** * ActivityPub Tribe Transformer * - * @package Activitypub_Event_Extensions + * @package ActivityPub_Event_Bridge * @license AGPL-3.0-or-later */ -namespace Activitypub_Event_Extensions\Activitypub\Transformer; +namespace ActivityPub_Event_Bridge\Activitypub\Transformer; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore use Activitypub\Activity\Extended_Object\Event as Event_Object; use Activitypub\Activity\Extended_Object\Place; -use Activitypub_Event_Extensions\Activitypub\Transformer\Event; +use ActivityPub_Event_Bridge\Activitypub\Transformer\Event; use WP_Post; use function Activitypub\esc_hashtag; diff --git a/includes/activitypub/transformer/class-vs-event-list.php b/includes/activitypub/transformer/class-vs-event-list.php index dc0ae7b..35d33a2 100644 --- a/includes/activitypub/transformer/class-vs-event-list.php +++ b/includes/activitypub/transformer/class-vs-event-list.php @@ -2,18 +2,18 @@ /** * ActivityPub Transformer for the plugin Very Simple Event List. * - * @package Activitypub_Event_Extensions + * @package ActivityPub_Event_Bridge * @license AGPL-3.0-or-later */ -namespace Activitypub_Event_Extensions\Activitypub\Transformer; +namespace ActivityPub_Event_Bridge\Activitypub\Transformer; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore use Activitypub\Activity\Extended_Object\Event; use Activitypub\Activity\Extended_Object\Place; -use Activitypub_Event_Extensions\Activitypub\Transformer\Event as Event_Transformer; +use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer; /** * ActivityPub Transformer for VS Event. diff --git a/includes/admin/class-event-plugin-admin-notices.php b/includes/admin/class-event-plugin-admin-notices.php index 2f9459c..73ed33c 100644 --- a/includes/admin/class-event-plugin-admin-notices.php +++ b/includes/admin/class-event-plugin-admin-notices.php @@ -4,17 +4,17 @@ * * Notices for guiding to proper configuration of ActivityPub with event plugins. * - * @package Activitypub_Event_Extensions + * @package ActivityPub_Event_Bridge * @since 1.0.0 * @license AGPL-3.0-or-later */ -namespace Activitypub_Event_Extensions\Admin; +namespace ActivityPub_Event_Bridge\Admin; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore -use Activitypub_Event_Extensions\Plugins\Event_Plugin; +use ActivityPub_Event_Bridge\Plugins\Event_Plugin; /** * Class responsible for Event Plugin related admin notices. @@ -76,7 +76,7 @@ class Event_Plugin_Admin_Notices { _x( 'You have installed the %1$s plugin, but the event post type of the plugin %2$s is not enabled in the %1$s settings.', 'admin notice', - 'activitypub-event-extensions' + 'activitypub-event-bridge' ), esc_html( $activitypub_plugin_data['Name'] ), esc_html( $event_plugin_data['Name'] ), diff --git a/includes/admin/class-general-admin-notices.php b/includes/admin/class-general-admin-notices.php index 5a26fb5..43cb4f3 100644 --- a/includes/admin/class-general-admin-notices.php +++ b/includes/admin/class-general-admin-notices.php @@ -4,12 +4,12 @@ * * Notices for guiding to proper configuration of this plugin. * - * @package Activitypub_Event_Extensions + * @package ActivityPub_Event_Bridge * @since 1.0.0 * @license AGPL-3.0-or-later */ -namespace Activitypub_Event_Extensions\Admin; +namespace ActivityPub_Event_Bridge\Admin; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore @@ -29,7 +29,7 @@ class General_Admin_Notices { */ const ACTIVITYPUB_PLUGIN_URL = 'https://wordpress.org/plugins/activitypub'; - const ACTIVITYPUB_EVENT_EXTENSIONS_SUPPORTED_EVENT_PLUGINS_URL = 'https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-extensions#events-plugin-that-will-be-supported-at-first'; + const ACTIVITYPUB_EVENT_BRIDGE_SUPPORTED_EVENT_PLUGINS_URL = 'https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge#events-plugin-that-will-be-supported-at-first'; /** * Allowed HTML for admin notices. @@ -54,9 +54,9 @@ class General_Admin_Notices { return sprintf( /* translators: 1: An URL that points to the ActivityPub plugin. */ _x( - 'For the ActivityPub Event Extensions to work, you will need to install and activate the ActivityPub plugin.', + 'For the ActivityPub Event Bridge to work, you will need to install and activate the ActivityPub plugin.', 'admin notice', - 'activitypub-event-extensions' + 'activitypub-event-bridge' ), esc_html( self::ACTIVITYPUB_PLUGIN_URL ) ); @@ -71,12 +71,12 @@ class General_Admin_Notices { return sprintf( /* translators: 1: The name of the ActivityPub plugin. 2: The minimum required version number of the ActivityPub plugin. */ _x( - 'Please upgrade your ActivityPub plugin. At least version %2$s is required for the ActivityPub event extensions to work.', + 'Please upgrade your ActivityPub plugin. At least version %2$s is required for the ActivityPub Event Bridge to work.', 'admin notice', - 'activitypub-event-extensions' + 'activitypub-event-bridge' ), esc_html( self::ACTIVITYPUB_PLUGIN_URL ), - esc_html( ACTIVITYPUB_EVENT_EXTENSIONS_ACTIVITYPUB_PLUGIN_MIN_VERSION ) + esc_html( ACTIVITYPUB_EVENT_BRIDGE_ACTIVITYPUB_PLUGIN_MIN_VERSION ) ); } @@ -89,12 +89,12 @@ class General_Admin_Notices { return sprintf( /* translators: 1: An URL to the list of supported event plugins. */ _x( - 'The Plugin ActivityPub Event Extensions is of no use, because you do not have installed and activated a supported Event Plugin. + 'The Plugin ActivityPub Event Bridge is of no use, because you do not have installed and activated a supported Event Plugin.