diff --git a/.distignore b/.distignore index 471f8fb..4754d34 100644 --- a/.distignore +++ b/.distignore @@ -4,7 +4,6 @@ .wordpress-org .wp-env.json bin -CHANGELOG.md CODE_OF_CONDUCT.md composer.json composer.lock diff --git a/.forgejo/workflows/assets.yml b/.forgejo/workflows/assets.yml new file mode 100644 index 0000000..2541206 --- /dev/null +++ b/.forgejo/workflows/assets.yml @@ -0,0 +1,27 @@ +name: Plugin asset/readme update on WordPress.org + +on: + push: + branches: + - main + +jobs: + trunk: + name: Push assets to trunk on WordPress.org + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: https://code.forgejo.org/actions/checkout@v4 + + - name: Install and cache rsync + uses: https://github.com/awalsh128/cache-apt-pkgs-action@latest + with: + packages: rsync subversion + version: 1.0 + + - name: WordPress.org plugin asset/readme update + uses: https://github.com/10up/action-wordpress-plugin-asset-update@stable + env: + SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }} + SVN_USERNAME: ${{ secrets.SVN_USERNAME }} + SLUG: event-bridge-for-activitypub diff --git a/.forgejo/workflows/deploy.yml b/.forgejo/workflows/deploy.yml new file mode 100644 index 0000000..55e9192 --- /dev/null +++ b/.forgejo/workflows/deploy.yml @@ -0,0 +1,27 @@ +name: Deploy to WordPress.org + +on: + push: + tags: + - "*" + +jobs: + tag: + name: New tag + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: https://code.forgejo.org/actions/checkout@v4 + + - name: Install and cache rsync + uses: https://github.com/awalsh128/cache-apt-pkgs-action@latest + with: + packages: rsync subversion + version: 1.0 + + - name: WordPress Plugin Deploy + uses: https://github.com/10up/action-wordpress-plugin-deploy@stable + env: + SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }} + SVN_USERNAME: ${{ secrets.SVN_USERNAME }} + SLUG: event-bridge-for-activitypub diff --git a/.forgejo/workflows/phpunit.yml b/.forgejo/workflows/phpunit.yml index f8e08ac..afb653e 100644 --- a/.forgejo/workflows/phpunit.yml +++ b/.forgejo/workflows/phpunit.yml @@ -21,7 +21,7 @@ jobs: MYSQL_ROOT_PASSWORD: root strategy: matrix: - php-version: ['7.4', '8.0', '8.1', '8.2', '8.3'] + php-version: ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4'] wordpress-version: ['6.7'] name: PHPUnit – PHP ${{ matrix.php-version }} env: @@ -38,7 +38,7 @@ jobs: path: | ${{ env.WP_CORE_DIR }} ${{ env.WP_TESTS_DIR }} - key: cache-wordpress-67-2 + key: cache-wordpress-67-4 - name: Cache Composer id: cache-composer-phpunit @@ -75,37 +75,47 @@ jobs: if: steps.cache-wordpress.outputs.cache-hit != 'false' run: bash bin/install-wp-tests.sh wordpress_test root root 127.0.0.1 ${{ matrix.wordpress-version }} false true true true + - name: Run General Tests + run: cd /workspace/Event-Federation/wordpress-event-bridge-for-activitypub/ && ./vendor/bin/phpunit --filter=event_bridge_for_activitypub + env: + PHP_VERSION: ${{ matrix.php-version }} + - name: Run Integration tests for The Events Calendar - run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./vendor/bin/phpunit --filter=the_events_calendar + run: cd /workspace/Event-Federation/wordpress-event-bridge-for-activitypub/ && ./vendor/bin/phpunit --filter=the_events_calendar env: PHP_VERSION: ${{ matrix.php-version }} - name: Run Integration tests for VS Event List - run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./vendor/bin/phpunit --filter=vs_event_list + run: cd /workspace/Event-Federation/wordpress-event-bridge-for-activitypub/ && ./vendor/bin/phpunit --filter=vs_event_list env: PHP_VERSION: ${{ matrix.php-version }} - name: Run Integration tests for GatherPress - run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./vendor/bin/phpunit --filter=gatherpress + run: cd /workspace/Event-Federation/wordpress-event-bridge-for-activitypub/ && ./vendor/bin/phpunit --filter=gatherpress env: PHP_VERSION: ${{ matrix.php-version }} - name: Run Integration tests for Events Manager - run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./vendor/bin/phpunit --filter=events_manager + run: cd /workspace/Event-Federation/wordpress-event-bridge-for-activitypub/ && ./vendor/bin/phpunit --filter=events_manager env: PHP_VERSION: ${{ matrix.php-version }} - name: Run Integration tests for WP Event Manager - run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./vendor/bin/phpunit --filter=wp_event_manager + run: cd /workspace/Event-Federation/wordpress-event-bridge-for-activitypub/ && ./vendor/bin/phpunit --filter=wp_event_manager env: PHP_VERSION: ${{ matrix.php-version }} - name: Run Integration tests for Eventin (WP Event Solution) - run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./vendor/bin/phpunit --filter=eventin + run: cd /workspace/Event-Federation/wordpress-event-bridge-for-activitypub/ && ./vendor/bin/phpunit --filter=eventin env: PHP_VERSION: ${{ matrix.php-version }} - name: Run Integration tests for Modern Events Calendar Lite - run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./vendor/bin/phpunit --filter=modern_events_calendar_lite + run: cd /workspace/Event-Federation/wordpress-event-bridge-for-activitypub/ && ./vendor/bin/phpunit --filter=modern_events_calendar_lite env: - PHP_VERSION: ${{ matrix.php-version }} \ No newline at end of file + PHP_VERSION: ${{ matrix.php-version }} + + - name: Run Integration tests for Event Organiser + run: cd /workspace/Event-Federation/wordpress-event-bridge-for-activitypub/ && ./vendor/bin/phpunit --filter=event_organiser + env: + PHP_VERSION: ${{ matrix.php-version }} diff --git a/.wordpress-org/acknowledgement-NGI0Entrust.png b/.wordpress-org/acknowledgement-NGI0Entrust.png new file mode 100644 index 0000000..e5e722a Binary files /dev/null and b/.wordpress-org/acknowledgement-NGI0Entrust.png differ diff --git a/.wordpress-org/acknowledgement-NGI0Entrust.svg b/.wordpress-org/acknowledgement-NGI0Entrust.svg new file mode 100644 index 0000000..0d211b3 --- /dev/null +++ b/.wordpress-org/acknowledgement-NGI0Entrust.svg @@ -0,0 +1,121 @@ + + + +image/svg+xml + + + + + + +NGI Zero Entrust + + + + diff --git a/.wordpress-org/acknowledgement-NLnet.png b/.wordpress-org/acknowledgement-NLnet.png new file mode 100644 index 0000000..983998b Binary files /dev/null and b/.wordpress-org/acknowledgement-NLnet.png differ diff --git a/.wordpress-org/acknowledgement-NLnet.svg b/.wordpress-org/acknowledgement-NLnet.svg new file mode 100644 index 0000000..7980346 --- /dev/null +++ b/.wordpress-org/acknowledgement-NLnet.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index b1f6405..6bf47e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,18 +5,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [0.2.1] - 2024-11-16 - -### Added +## [0.3.4] - 2024-12-21 * Initial release on WordPress.org -### Fixed - -* Applied some WordPress best practices - -## [0.2.0] - 2024-10-20 - -### Added - -* Initial submission to WordPress.org diff --git a/Gruntfile.js b/Gruntfile.js index df4eb26..4b2c893 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -4,7 +4,7 @@ module.exports = function (grunt) { { checktextdomain: { options:{ - text_domain: 'activitypub-event-bridge', + text_domain: 'event-bridge-for-activitypub', keywords: [ '__:1,2d', '_e:1,2d', diff --git a/README.md b/README.md index 023e5c2..80aa096 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# ActivityPub Event Bridge # +# Event Bridge for ActivityPub # **Contributors:** [andremenrath](https://profiles.wordpress.org/andremenrath/) **Tags:** events, fediverse, activitypub, calendar **Requires at least:** 6.5 **Tested up to:** 6.7 -**Stable tag:** 0.2.1 +**Stable tag:** 0.3.4 **Requires PHP:** 7.4 **License:** AGPL-3.0-or-later **License URI:** https://www.gnu.org/licenses/agpl-3.0.html @@ -14,27 +14,38 @@ Integrating popular event plugins with the ActivityPub plugin. ## Description ## Make your events more discoverable, expand your reach effortlessly while being independent of other (commercial) platforms, and be a part of the growing decentralized web (the Fediverse). -With the ActivityPub Event Bridge Plugin for WordPress, your events can be automatically followed, aggregated and displayed across decentralized platforms like [Mastodon](https://joinmastodon.org) or [Gancio](https://gancio.org), without any extra work. +With the Event Bridge for ActivityPub Plugin for WordPress, your events can be automatically followed, aggregated and displayed across decentralized platforms like [Mastodon](https://joinmastodon.org) or [Gancio](https://gancio.org), without any extra work. Forget the hassle of managing multiple social media accounts just to keep your audience informed. This plugin is not an event managing plugin but an add-on to popular event plugins. It extends their functionality to fully support the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). With the ActivityPub plugin people can follow your website directly and engage with your events just as they would on social media: liking, boosting and even commenting if you enable it. You retain full ownership of your content. By integrating into your existing setup, it ensures no extra work is needed while enhancing your events' visibility across the web. +### 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/) +* [Events Manager](https://de.wordpress.org/plugins/events-manager/) +* [WP Event Manager](https://de.wordpress.org/plugins/wp-event-manager/) +* [Eventin](https://de.wordpress.org/plugins/wp-event-solution/) +* [Modern Events Calendar Lite](https://webnus.net/modern-events-calendar/) +* [GatherPress](https://gatherpress.org/) +* [Event Organiser](https://wordpress.org/plugins/event-organiser/) + ### How It Works ### -With the ActivityPub Event Bridge WordPress plugin, sharing your events is effortless and automatic! +With the Event Bridge for ActivityPub WordPress plugin, sharing your events is effortless and automatic! Once you create an event on your WordPress site, it is seamlessly shared across the decentralized web using the ActivityPub protocol.

- Logo + An animation that shows how WordPress events federate to users of different applications via ActivityPub.

Your events can be automatically delivered to platforms that fully support events, such as [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). These platforms create public event calendars by pulling in events from various sources, including your website. Any updates you make to your events are synced across these platforms—so you only need to manage your events on your own site, with no extra work required.

- Logo + An animation that shows how a decentralized event calendar gets build via ActivityPub including an WordPress site as a source of events.

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. @@ -44,7 +55,7 @@ The Event Federation plugin ensures that users from those platforms are provided **ActivityPub-Enabled Event Sharing:** Your WordPress events are now compatible with the Fediverse, using the ActivityStreams format. This means your events can be easily discovered and followed by users on platforms like Mastodon and other ActivityPub-compatible services. -**Automatic Event Summaries:** When your event is shared on the Fediverse, platforms like Mastodon that don't fully support events will display a brief HTML summary of key details — such as the event's title, start time, and location. This ensures that even if someone can't view the full event on their platform, they still get the important info at a glance, with a link to your WordPress event page. +**Automatic Event Summaries:** When your event is shared on the Fediverse, platforms like Mastodon that don't fully support events will display a brief HTML summary of key details — such as the event's title, start time, and location. This ensures that even if someone can't view the full event on their platform, they still get the important info at a glance, with a link to your WordPress event page. Advanced users can create custom summaries via a set of shortcodes. **Improved Event Discoverability:** Your custom event categories are mapped to a set of default categories used in the Fediverse, helping your events reach a wider audience. This improves the chances that users searching for similar events on other platforms will find yours. @@ -54,16 +65,6 @@ The Event Federation plugin ensures that users from those platforms are provided This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). Additionally, you need to use one of the 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/) -* [Events Manager](https://de.wordpress.org/plugins/events-manager/) -* [WP Event Manager](https://de.wordpress.org/plugins/wp-event-manager/) -* [Eventin](https://de.wordpress.org/plugins/wp-event-solution/) -* [Modern Events Calendar Lite](https://webnus.net/modern-events-calendar/) -* [GatherPress](https://gatherpress.org/) - ## Configuration ## If you're new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), it’s recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality. @@ -92,18 +93,21 @@ No, the Event Federation Plugin depends on the [ActivityPub plugin](https://word ### 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-bridge/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-event-bridge-for-activitypub/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-bridge/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-event-bridge-for-activitypub/issues). + +## Acknowledgement + +[NLnet foundation logo](https://nlnet.nl) +[NGI Zero Logo](https://nlnet.nl/entrust) + +The development of this WordPress plugin was funded through the [NGI0 Entrust](https://NLnet.nl/entrust) Fund, a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) programme, under the aegis of [Communications Networks, Content and Technology](https://commission.europa.eu/about-european-commission/departments-and-executive-agencies/communications-networks-content-and-technology_en) under grant agreement number 101069594. ## Changelog ## -### [0.2.1] 2024-11-16 ### +### [0.3.4] 2024-12-21 ### * Initial release on https://wordpress.org/ - -### [0.2.0] 2024-10-29 ### - -* Initial submission to https://wordpress.org/ diff --git a/activitypub-event-bridge.php b/activitypub-event-bridge.php deleted file mode 100644 index 961af39..0000000 --- a/activitypub-event-bridge.php +++ /dev/null @@ -1,36 +0,0 @@ -= 3.2.2. ActivityPub plugin tested up to: 4.2.0. - * - * @package ActivityPub_Event_Bridge - * @license AGPL-3.0-or-later - */ - -// Exit if accessed directly. -defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore - -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_BRIDGE_PLUGIN_DIR . '/includes/class-autoloader.php'; -ActivityPub_Event_Bridge\Autoloader::register(); - -// Initialize the plugin. -ActivityPub_Event_Bridge\Setup::get_instance(); diff --git a/assets/css/activitypub-event-bridge-admin.css b/assets/css/event-bridge-for-activitypub-admin.css similarity index 55% rename from assets/css/activitypub-event-bridge-admin.css rename to assets/css/event-bridge-for-activitypub-admin.css index c89ec6e..2862063 100644 --- a/assets/css/activitypub-event-bridge-admin.css +++ b/assets/css/event-bridge-for-activitypub-admin.css @@ -1,19 +1,24 @@ -.settings_page_activitypub-event-bridge #wpcontent { +.settings_page_event-bridge-for-activitypub #wpcontent { padding-left: 0; } -.activitypub-event-bridge-settings-page .box { +.event-bridge-for-activitypub-settings-page .box { border: 1px solid #c3c4c7; background-color: #fff; padding: 1em 1.5em; margin-bottom: 1.5em; } -.activitypub-event-bridge-settings-page .box ul.activitypub-event-bridge-list { +.event-bridge-for-activitypub-settings-page .logo-center { + width: 25%; + margin: 10px 5% 10px 5%; +} + +.event-bridge-for-activitypub-settings-page .box ul.event-bridge-for-activitypub-list { margin-left: 0.6em; } -.activitypub-event-bridge-settings-page .box pre { +.event-bridge-for-activitypub-settings-page .box pre { padding: 1rem; min-height: 200px; box-shadow: none; @@ -22,19 +27,19 @@ background-color: #f7f7f7; } -.activitypub-event-bridge-settings { +.event-bridge-for-activitypub-settings { max-width: 800px; margin: 0 auto; } -.activitypub-event-bridge-settings-header { +.event-bridge-for-activitypub-settings-header { text-align: center; margin: 0 0 1rem; background: #fff; border-bottom: 1px solid #dcdcde; } -.activitypub-event-bridge-settings-title-section { +.event-bridge-for-activitypub-settings-title-section { display: flex; align-items: center; justify-content: center; @@ -42,7 +47,7 @@ padding-top: 8px; } -.activitypub-event-bridge-settings-tabs-wrapper { +.event-bridge-for-activitypub-settings-tabs-wrapper { display: -ms-inline-grid; -ms-grid-columns: auto auto auto auto; vertical-align: top; @@ -50,12 +55,12 @@ grid-template-columns: auto auto auto auto; } -.activitypub-event-bridge-settings-tab.active { +.event-bridge-for-activitypub-settings-tab.active { box-shadow: inset 0 -3px #3582c4; font-weight: 600; } -.activitypub-event-bridge-settings-tab { +.event-bridge-for-activitypub-settings-tab { display: block; text-decoration: none; color: inherit; @@ -64,21 +69,21 @@ transition: box-shadow .5s ease-in-out; } -.activitypub-event-bridge-settings .box h3 { +.event-bridge-for-activitypub-settings .box h3 { font-size: 1.15em; margin-bottom: 0em; } -#activitypub_event_bridge_initially_activated { +#event_bridge_for_activitypub_initially_activated { display: hidden; } /* Accordions for admin pages */ -.activitypub-event-bridge-settings-accordion { +.event-bridge-for-activitypub-settings-accordion { border: 1px solid #c3c4c7; } -.activitypub-event-bridge-settings-accordion-heading { +.event-bridge-for-activitypub-settings-accordion-heading { margin: 0; border-top: 1px solid #c3c4c7; font-size: inherit; @@ -87,17 +92,17 @@ color: inherit; } -.activitypub-event-bridge-settings-accordion-heading:first-child { +.event-bridge-for-activitypub-settings-accordion-heading:first-child { border-top: none; } -.activitypub-event-bridge-settings-accordion-panel { +.event-bridge-for-activitypub-settings-accordion-panel { margin: 0; padding: 1em 1.5em; background: #fff; } -.activitypub-event-bridge-settings-accordion-trigger { +.event-bridge-for-activitypub-settings-accordion-trigger { background: #fff; border: 0; color: #2c3338; @@ -116,21 +121,21 @@ user-select: auto; } -.activitypub-event-bridge-settings-accordion-trigger { +.event-bridge-for-activitypub-settings-accordion-trigger { color: #2c3338; cursor: pointer; font-weight: 400; text-align: left; } -.activitypub-event-bridge-settings-accordion-trigger .title { +.event-bridge-for-activitypub-settings-accordion-trigger .title { pointer-events: none; font-weight: 600; flex-grow: 1; } -.activitypub-event-bridge-settings-accordion-trigger .icon, -.activitypub-event-bridge-settings-accordion-viewed .icon { +.event-bridge-for-activitypub-settings-accordion-trigger .icon, +.event-bridge-for-activitypub-settings-accordion-viewed .icon { border: solid #50575e medium; border-width: 0 2px 2px 0; height: .5rem; @@ -142,16 +147,16 @@ width: .5rem; } -.activitypub-event-bridge-settings-accordion-trigger[aria-expanded="true"] .icon { +.event-bridge-for-activitypub-settings-accordion-trigger[aria-expanded="true"] .icon { transform: translateY(-30%) rotate(-135deg); } -.activitypub-event-bridge-settings-accordion-trigger:active, -.activitypub-event-bridge-settings-accordion-trigger:hover { +.event-bridge-for-activitypub-settings-accordion-trigger:active, +.event-bridge-for-activitypub-settings-accordion-trigger:hover { background: #f6f7f7; } -.activitypub-event-bridge-settings-accordion-trigger:focus { +.event-bridge-for-activitypub-settings-accordion-trigger:focus { color: #1d2327; border: none; box-shadow: none; @@ -160,14 +165,14 @@ background-color: #f6f7f7; } -.activitypub-event-bridge-settings-inline-icon { +.event-bridge-for-activitypub-settings-inline-icon { width: 1.5em; height: 1.5em; vertical-align: middle; margin: 0 0.3em; } -code.activitypub-event-bridge-settings-example-url { +code.event-bridge-for-activitypub-settings-example-url { display: block; background: rgb(28, 29, 33); padding: 8px; @@ -177,3 +182,11 @@ code.activitypub-event-bridge-settings-example-url { overflow-x: auto; word-break: break-all; } + +#event_bridge_for_activitypub_summary_type_custom-details { + display: none; +} + +#event_bridge_for_activitypub_summary_type_custom-details > details { + padding: 0.5em; +} diff --git a/assets/js/activitypub-event-bridge-admin.js b/assets/js/activitypub-event-bridge-admin.js deleted file mode 100644 index bf00a1c..0000000 --- a/assets/js/activitypub-event-bridge-admin.js +++ /dev/null @@ -1,14 +0,0 @@ -jQuery( function( $ ) { - // Accordion handling in various areas. - $( '.activitypub-event-bridge-settings-accordion' ).on( 'click', '.activitypub-event-bridge-settings-accordion-trigger', function() { - var isExpanded = ( 'true' === $( this ).attr( 'aria-expanded' ) ); - - if ( isExpanded ) { - $( this ).attr( 'aria-expanded', 'false' ); - $( '#' + $( this ).attr( 'aria-controls' ) ).attr( 'hidden', true ); - } else { - $( this ).attr( 'aria-expanded', 'true' ); - $( '#' + $( this ).attr( 'aria-controls' ) ).attr( 'hidden', false ); - } - } ); -} ); diff --git a/assets/js/event-bridge-for-activitypub-admin.js b/assets/js/event-bridge-for-activitypub-admin.js new file mode 100644 index 0000000..93c64e3 --- /dev/null +++ b/assets/js/event-bridge-for-activitypub-admin.js @@ -0,0 +1,34 @@ +jQuery( function( $ ) { + // Accordion handling in various areas. + $( '.event-bridge-for-activitypub-settings-accordion' ).on( 'click', '.event-bridge-for-activitypub-settings-accordion-trigger', function() { + var isExpanded = ( 'true' === $( this ).attr( 'aria-expanded' ) ); + + if ( isExpanded ) { + $( this ).attr( 'aria-expanded', 'false' ); + $( '#' + $( this ).attr( 'aria-controls' ) ).attr( 'hidden', true ); + } else { + $( this ).attr( 'aria-expanded', 'true' ); + $( '#' + $( this ).attr( 'aria-controls' ) ).attr( 'hidden', false ); + } + } ); + + // Function to toggle visibility of custom details based on selected radio button. + function toggleCustomDetailsForSummary() { + if ($("#event_bridge_for_activitypub_summary_type_custom").is(':checked')) { + $("#event_bridge_for_activitypub_summary_type_custom-details").show(); + } else { + $("#event_bridge_for_activitypub_summary_type_custom-details").hide(); + } + } + + // Run the toggle function on page load. + $(document).ready(function() { + window.console.log("test"); + toggleCustomDetailsForSummary(); // Set the correct state on load. + + // Listen for changes on the radio buttons + $("input[name=event_bridge_for_activitypub_summary_type]").change(function() { + toggleCustomDetailsForSummary(); // Update visibility on change. + }); + }); +} ); diff --git a/bin/install-wp-tests.sh b/bin/install-wp-tests.sh index 3cc440f..95fc2e5 100755 --- a/bin/install-wp-tests.sh +++ b/bin/install-wp-tests.sh @@ -257,9 +257,11 @@ install_wp_plugins() { install_wp_plugin the-events-calendar "6.8.1" install_wp_plugin very-simple-event-list install_wp_plugin gatherpress + install_wp_plugin eventprime-event-calendar-management install_wp_plugin events-manager "6.6.3" install_wp_plugin wp-event-manager "3.1.45.1" install_wp_plugin wp-event-solution "4.0.14" + install_wp_plugin event-organiser "3.12.8" # Mec is not installable via wordpress.org, we use our own mirror. install_wp_plugin_mec } diff --git a/composer.json b/composer.json index 4da8b48..01cb90e 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { - "name": "menrath/wordpress-activitypub-event-bridge", + "name": "menrath/wordpress-event-bridge-for-activitypub", "version": "1.0.0", - "description": "The ActivityPub Event Bridge help for event custom post types to federate properly.", + "description": "The Event Bridge for ActivityPub help for event custom post types to federate properly.", "type": "wordpress-plugin", "require": { "php": ">=7.4.0", @@ -33,7 +33,7 @@ } ], "extra": { - "installer-name": "activitypub-event-bridge" + "installer-name": "event-bridge-for-activitypub" }, "scripts": { "lint": [ @@ -54,11 +54,13 @@ "@test-events-manager", "@test-wp-event-manager", "@test-eventin", - "@test-modern-events-calendar-lite" + "@test-modern-events-calendar-lite", + "@test-eventprime", + "@test-event-organiser" ], "test-debug": [ "@prepare-test", - "@test-gatherpress" + "@test-event-bridge-for-activitypub-shortcodes" ], "test-vs-event-list": "phpunit --filter=vs_event_list", "test-the-events-calendar": "phpunit --filter=the_events_calendar", @@ -67,6 +69,9 @@ "test-wp-event-manager": "phpunit --filter=wp_event_manager", "test-eventin": "phpunit --filter=eventin", "test-modern-events-calendar-lite": "phpunit --filter=modern_events_calendar_lite", + "test-eventprime": "phpunit --filter=eventprime", + "test-event-organiser": "phpunit --filter=event_organiser", + "test-event-bridge-for-activitypub-shortcodes": "phpunit --filter=event_bridge_for_activitypub_shortcodes", "test-all": "phpunit" } } diff --git a/docker-compose.yml b/docker-compose.yml index d39760b..c95f996 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -16,7 +16,7 @@ version: '3' # "request": "launch", # "port": 9003, # "pathMappings": { -# "/app/": "${workspaceRoot}/wp-content/plugins/activitypub-event-bridge/", +# "/app/": "${workspaceRoot}/wp-content/plugins/event-bridge-for-activitypub/", # "/tmp/wordpress/": "${workspaceRoot}/" # }, # }, diff --git a/docs/add_your_event_plugin.md b/docs/add_your_event_plugin.md index 165f285..e104340 100644 --- a/docs/add_your_event_plugin.md +++ b/docs/add_your_event_plugin.md @@ -13,7 +13,7 @@ To make the WordPress ActivityPub plugin use a custom transformer simply add a f First you need to add some basic information about your event plugin. Just create a new file in `./includes/plugins/my-event-plugin.php`. Implement at least all abstract functions of the `Event_Plugin` class. ```php - namespace ActivityPub_Event_Bridge\Plugins; + namespace Event_Bridge_For_ActivityPub\Integrations; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore @@ -28,16 +28,16 @@ First you need to add some basic information about your event plugin. Just creat final class My_Event_Plugin extends Event_Plugin { ``` -Then you need to tell the ActivityPub Event Bridge about that class by adding it to the `EVENT_PLUGIN_CLASSES` constant in the `includes/setup.php` file: +Then you need to tell the Event Bridge for ActivityPub about that class by adding it to the `EVENT_PLUGIN_CLASSES` constant in the `includes/setup.php` file: ```php private const EVENT_PLUGIN_CLASSES = array( ... - '\ActivityPub_Event_Bridge\Plugins\My_Event_Plugin', + '\Event_Bridge_For_ActivityPub\Integrations\My_Event_Plugin', ); ``` -The ActivityPub Event Bridge then takes care of applying the transformer, so you can jump right into implementing it. +The Event Bridge for ActivityPub then takes care of applying the transformer, so you can jump right into implementing it. ## Writing an event transformer class @@ -48,9 +48,9 @@ If you are writing a transformer for your event post type we recommend to start So create a new file at `./includes/activitypub/transformer/my-event-plugin.php`. ```php -namespace ActivityPub_Event_Bridge\Activitypub\Transformer; +namespace Event_Bridge_For_ActivityPub\Activitypub\Transformer; -use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer; +use Event_Bridge_For_ActivityPub\Activitypub\Transformer\Event as Event_Transformer; /** * ActivityPub Transformer for My Event Plugin' event post type. @@ -142,7 +142,7 @@ Implement a check whether your event plugin is active in the `set_up` function. } // Make sure that ActivityPub support is enabled for The Events Calendar. - $aec = \ActivityPub_Event_Bridge\Setup::get_instance(); + $aec = \Event_Bridge_For_ActivityPub\Setup::get_instance(); $aec->activate_activitypub_support_for_active_event_plugins(); // Delete all posts afterwards. @@ -180,7 +180,7 @@ In the pipeline we want to run each event plugins integration tests in a single To activate/load your plugin add it to the switch statement within the function `_manually_load_plugin()` within `tests/bootstrap.php`. ```php - switch ( $activitypub_event_bridge_integration_filter ) { + switch ( $event_bridge_for_activitypub_integration_filter ) { ... case 'my_event_plugin': $plugin_file = 'my-event-plugin/my-event-plugin.php'; @@ -213,7 +213,7 @@ If you are using Visual Studio Code or VSCodium you can step-debug within the te "request": "launch", "port": 9003, "pathMappings": { - "/app/": "${workspaceRoot}/wp-content/plugins/activitypub-event-bridge/", + "/app/": "${workspaceRoot}/wp-content/plugins/event-bridge-for-activitypub/", "/tmp/wordpress/": "${workspaceRoot}/" }, } diff --git a/event-bridge-for-activitypub.php b/event-bridge-for-activitypub.php new file mode 100644 index 0000000..72a0a89 --- /dev/null +++ b/event-bridge-for-activitypub.php @@ -0,0 +1,38 @@ += 3.2.2. ActivityPub plugin tested up to: 4.3.0. + * + * @package Event_Bridge_For_ActivityPub + * @license AGPL-3.0-or-later + */ + +// Exit if accessed directly. +defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore + +define( 'EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_DIR', plugin_dir_path( __FILE__ ) ); +define( 'EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_BASENAME', plugin_basename( __FILE__ ) ); +define( 'EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_FILE', plugin_dir_path( __FILE__ ) . '/' . basename( __FILE__ ) ); +define( 'EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_URL', plugin_dir_url( __FILE__ ) ); +define( 'EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_VERSION', current( get_file_data( __FILE__, array( 'Version' ), 'plugin' ) ) ); +define( 'EVENT_BRIDGE_FOR_ACTIVITYPUB_DOMAIN', 'event-bridge-for-activitypub' ); +define( 'EVENT_BRIDGE_FOR_ACTIVITYPUB_ACTIVITYPUB_PLUGIN_MIN_VERSION', '3.2.2' ); +define( 'EVENT_BRIDGE_FOR_ACTIVITYPUB_CUSTOM_SUMMARY', "\n[ap_hashcats] [ap_hashtags]" ); +define( 'EVENT_BRIDGE_FOR_ACTIVITYPUB_DEFAULT_SUMMARY_TYPE', 'preset' ); + +// Include and register the autoloader class for automatic loading of plugin classes. +require_once EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_DIR . '/includes/class-autoloader.php'; +Event_Bridge_For_ActivityPub\Autoloader::register(); + +// Initialize the plugin. +Event_Bridge_For_ActivityPub\Setup::get_instance(); diff --git a/includes/activitypub/handler/class-join.php b/includes/activitypub/handler/class-join.php index 03c5dc1..cb59c53 100644 --- a/includes/activitypub/handler/class-join.php +++ b/includes/activitypub/handler/class-join.php @@ -2,17 +2,17 @@ /** * Join handler file. * - * @package ActivityPub_Event_Bridge + * @package Event_Bridge_For_ActivityPub * @license AGPL-3.0-or-later */ -namespace ActivityPub_Event_Bridge\Activitypub\Handler; +namespace Event_Bridge_For_ActivityPub\Activitypub\Handler; use Activitypub\Activity\Activity; use Activitypub\Collection\Actors; use Activitypub\Http; use Activitypub\Transformer\Factory; -use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer; +use Event_Bridge_For_ActivityPub\Activitypub\Transformer\Event as Event_Transformer; use function Activitypub\is_same_domain; use function Activitypub\object_to_uri; diff --git a/includes/activitypub/transformer/class-event-organiser.php b/includes/activitypub/transformer/class-event-organiser.php new file mode 100644 index 0000000..6574f54 --- /dev/null +++ b/includes/activitypub/transformer/class-event-organiser.php @@ -0,0 +1,99 @@ +wp_object = get_posts( + array( + 'ID' => $wp_object->ID, + 'post_type' => 'event', + 'suppress_filters' => false, + ) + )[0]; + } + + /** + * Get the end time from the event object. + */ + public function get_end_time(): ?string { + return eo_get_the_end( 'Y-m-d\TH:i:s\Z', $this->wp_object->ID, $this->wp_object->occurrence_id ); + } + + /** + * Get the end time from the event object. + */ + public function get_start_time(): string { + return eo_get_the_start( 'Y-m-d\TH:i:s\Z', $this->wp_object->ID, $this->wp_object->occurrence_id ); + } + + /** + * Get location from the event object. + */ + public function get_location(): ?Place { + $venue_id = eo_get_venue( $this->wp_object->ID ); + + if ( ! $venue_id ) { + return null; + } + + $address = eo_get_venue_address( $venue_id ); + + $venue_name = eo_get_venue_name( $venue_id ); + + $address['streetAddress'] = $address['address']; + unset( $address['address'] ); + + $address['postalCode'] = $address['postcode']; + unset( $address['postcode'] ); + + $address['addressRegion'] = $address['state']; + unset( $address['state'] ); + + $address['addressLocality'] = $address['city']; + unset( $address['city'] ); + + $address['addressCountry'] = $address['country']; + unset( $address['country'] ); + + $address['type'] = 'PostalAddress'; + + $location = new Place(); + $location->set_name( eo_get_venue_name( $this->wp_object->ID ) ); + $location->set_latitude( eo_get_venue_lat( $this->wp_object->ID ) ?? null ); + $location->set_longitude( eo_get_venue_lng( $this->wp_object->ID ) ?? null ); + $location->set_address( $address ); + $location->set_name( $venue_name ); + $location->set_content( eo_get_venue_description( $venue_id ) ); + + return $location; + } +} diff --git a/includes/activitypub/transformer/class-event.php b/includes/activitypub/transformer/class-event.php index babf2b9..cb388c2 100644 --- a/includes/activitypub/transformer/class-event.php +++ b/includes/activitypub/transformer/class-event.php @@ -2,18 +2,20 @@ /** * Replace the default ActivityPub Transformer * - * @package ActivityPub_Event_Bridge + * @package Event_Bridge_For_ActivityPub * @license AGPL-3.0-or-later */ -namespace ActivityPub_Event_Bridge\Activitypub\Transformer; +namespace Event_Bridge_For_ActivityPub\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\Shortcodes; use Activitypub\Transformer\Post; + use DateTime; /** @@ -118,7 +120,7 @@ abstract class Event extends Post { if ( is_null( $this->wp_taxonomy ) ) { return null; } - $current_category_mapping = \get_option( 'activitypub_event_bridge_event_category_mappings', array() ); + $current_category_mapping = \get_option( 'event_bridge_for_activitypub_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 +128,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_bridge_default_event_category', 'MEETING' ) ); + return sanitize_text_field( \get_option( 'event_bridge_for_activitypub_default_event_category', 'MEETING' ) ); } } @@ -148,14 +150,14 @@ abstract class Event extends Post { * * This is mandatory and must be implemented in the final event transformer class. */ - abstract protected function get_start_time(): string; + abstract public function get_start_time(): string; /** * Get the end time. * * This is not mandatory and therefore just return null by default. */ - protected function get_end_time(): ?string { + public function get_end_time(): ?string { return null; } @@ -164,14 +166,14 @@ abstract class Event extends Post { * * This should be overridden in the actual event transformer. */ - protected function get_location(): ?Place { + public function get_location(): ?Place { return null; } /** * Default value for the event status. */ - protected function get_status(): ?string { + public function get_status(): ?string { return 'CONFIRMED'; } @@ -194,7 +196,7 @@ abstract class Event extends Post { * * @param ?string $time The time which needs to be formatted. */ - private static function format_time( $time ) { + protected static function format_time( $time ) { if ( is_null( $time ) ) { return ''; } @@ -205,24 +207,160 @@ abstract class Event extends Post { } /** - * Format a human readable address. + * Generates output for the 'ap_start_time' shortcode. + * + * @param ?array $atts The shortcode's attributes. + * @return string The formatted start date and time of the event. */ - protected function format_address(): string { + public function shortcode_start_time( $atts ) { + $start_timestamp = $this->get_start_time(); + return $this->generate_time_output( $start_timestamp, $atts, '🗓️', __( 'Start', 'event-bridge-for-activitypub' ) ); + } + + /** + * Generates output for the 'ap_end_time' shortcode. + * + * @param ?array $atts The shortcode's attributes. + * @return string The formatted end date and time of the event. + */ + public function shortcode_end_time( $atts ) { + $end_timestamp = $this->get_end_time(); + return $this->generate_time_output( $end_timestamp, $atts, '⏳', __( 'End', 'event-bridge-for-activitypub' ) ); + } + + /** + * Generates the formatted time output for a shortcode. + * + * @param int|null $timestamp The timestamp for the event time. + * @param array $atts The shortcode attributes. + * @param string $icon The icon to display. + * @param string $label The label to display (e.g., 'Start', 'End'). + * @return string The formatted date and time, or an empty string if the timestamp is invalid. + */ + private function generate_time_output( $timestamp, $atts, $icon, $label ) { + if ( ! $timestamp ) { + return ''; + } + + $args = shortcode_atts( + array( + 'icon' => 'true', + 'label' => 'true', + ), + $atts + ); + + $args['icon'] = filter_var( $args['icon'], FILTER_VALIDATE_BOOLEAN ); + $args['label'] = filter_var( $args['label'], FILTER_VALIDATE_BOOLEAN ); + + $output = array(); + + if ( $args['icon'] ) { + $output[] = $icon; + } + + if ( $args['label'] ) { + $output[] = $label . ':'; + } + + $output[] = self::format_time( $timestamp ); + + return implode( ' ', $output ); + } + + /** + * Generates output for the 'ap_location' shortcode. + * + * @param ?array $atts The shortcode's attributes. + * @return string The formatted location/address of the event. + */ + public function shortcode_location( $atts ) { + $args = shortcode_atts( + array( + 'icon' => 'true', + 'label' => 'true', + 'country' => 'true', + 'zip' => 'true', + 'city' => 'true', + 'street' => 'true', + 'name' => 'true', + ), + $atts, + 'ap_location' + ); + + // Convert attributes to booleans. + $args = array_map( + function ( $value ) { + return filter_var( $value, FILTER_VALIDATE_BOOLEAN ); + }, + $args + ); + $location = $this->get_location(); - if ( is_null( $location ) ) { + if ( ! $location ) { return ''; } - $address = $location->get_address(); - if ( ! $address ) { - return $location->get_name(); + + $output = array(); + if ( $args['icon'] ) { + $output[] = '📍'; } + if ( $args['label'] ) { + $output[] = esc_html__( 'Location', 'event-bridge-for-activitypub' ) . ':'; + } + + $output[] = self::format_address( $location->get_address(), $args ); + + // Join output array into a single string with spaces and return. + return implode( ' ', array_filter( $output ) ); + } + + /** + * Formats the address based on provided arguments. + * + * @param mixed $address The address data, either as a string or an array. + * @param array $args The arguments for which components to include. + * @return string The formatted address. + */ + protected static function format_address( $address, $args = null ) { if ( is_string( $address ) ) { - return $address; + return esc_html( $address ); } - if ( ! is_array( $address ) ) { - return ''; + + if ( is_null( $args ) ) { + $args = array( + 'icon' => 'true', + 'title' => 'true', + 'country' => 'true', + 'zip' => 'true', + 'city' => 'true', + 'street' => 'true', + 'name' => 'true', + ); } - return isset( $address['locality'] ) ? $address['locality'] : ''; + + if ( is_array( $address ) ) { + $address_parts = array(); + + $components = array( + 'name' => 'name', + 'street' => 'streetAddress', + 'zip' => 'postalCode', + 'city' => 'addressLocality', + 'country' => 'addressCountry', + ); + + foreach ( $components as $arg_key => $address_key ) { + if ( $args[ $arg_key ] && ! empty( $address[ $address_key ] ) ) { + $address_parts[] = esc_html( $address[ $address_key ] ); + } + } + + return implode( ', ', $address_parts ); + } + + return ''; } /** @@ -235,10 +373,10 @@ abstract class Event extends Post { $categories = array(); // Add the federated category string. - require_once ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_DIR . '/includes/event-categories.php'; + require_once EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_DIR . '/includes/event-categories.php'; $federated_category = $this->get_category(); - if ( array_key_exists( $federated_category, ACTIVITYPUB_EVENT_BRIDGE_EVENT_CATEGORIES ) ) { - $categories[] = ACTIVITYPUB_EVENT_BRIDGE_EVENT_CATEGORIES[ $federated_category ]; + if ( array_key_exists( $federated_category, EVENT_BRIDGE_FOR_ACTIVITYPUB_EVENT_CATEGORIES ) ) { + $categories[] = EVENT_BRIDGE_FOR_ACTIVITYPUB_EVENT_CATEGORIES[ $federated_category ]; } // Add all category terms. @@ -255,6 +393,68 @@ abstract class Event extends Post { return ''; } + /** + * Register the shortcodes. + */ + public function register_shortcodes() { + foreach ( get_class_methods( self::class ) as $function ) { + if ( 'shortcode_' === substr( $function, 0, 10 ) ) { + add_shortcode( 'ap_' . substr( $function, 10, strlen( $function ) ), array( $this, $function ) ); + } + } + } + + /** + * Register the shortcodes. + */ + public function unregister_shortcodes() { + foreach ( get_class_methods( self::class ) as $function ) { + if ( 'shortcode_' === substr( $function, 0, 10 ) ) { + remove_shortcode( 'ap_' . substr( $function, 10, strlen( $function ) ), array( $this, $function ) ); + } + } + } + + /** + * Get the summary. + */ + public function get_summary(): ?string { + if ( 'preset' === get_option( 'event_bridge_for_activitypub_summary_type', 'preset' ) ) { + return $this->format_preset_summary(); + } + + // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited + $post = $this->wp_object; + $summary = $this->get_event_summary_template(); + + // It seems that shortcodes are only applied to published posts. + if ( is_preview() ) { + $post->post_status = 'publish'; + } + + // Register our shortcodes just in time. + + Shortcodes::register(); + $this->register_shortcodes(); + + // Fill in the shortcodes. + \setup_postdata( $post ); + $summary = \do_shortcode( $summary ); + \wp_reset_postdata(); + + $summary = \wpautop( $summary ); + $summary = \preg_replace( '/[\n\r\t]/', '', $summary ); + $summary = \trim( $summary ); + + $summary = \apply_filters( 'event_bridge_for_activitypub_the_summary', $summary, $post ); + + // Unregister the shortcodes. + Shortcodes::unregister(); + $this->unregister_shortcodes(); + + return $summary; + } + /** * Create a custom summary. * @@ -263,7 +463,7 @@ abstract class Event extends Post { * * @return string $summary The custom event summary. */ - public function get_summary(): ?string { + public function format_preset_summary(): ?string { add_filter( 'activitypub_object_content_template', array( self::class, 'remove_ap_permalink_from_template' ), 2, 2 ); $excerpt = $this->retrieve_excerpt(); // BeforeFirstRelease: decide whether this should be a admin setting. @@ -274,25 +474,29 @@ abstract class Event extends Post { remove_filter( 'activitypub_object_content_template', array( self::class, 'remove_ap_permalink_from_template' ) ); $category = $this->format_categories(); - $start_time = $this->format_start_time(); - $end_time = $this->format_end_time(); - $address = $this->format_address(); + $start_time = $this->get_start_time(); + $end_time = $this->get_end_time(); + $address = $this->format_address( $this->get_location() ); + $time_atts = array( + 'icon' => true, + 'label' => true, + ); $formatted_items = array(); if ( ! empty( $category ) ) { - $formatted_items[] = '🏷️ ' . __( 'Category', 'activitypub-event-bridge' ) . ': ' . $category; + $formatted_items[] = '🏷️ ' . __( 'Category', 'event-bridge-for-activitypub' ) . ': ' . $category; } if ( ! empty( $start_time ) ) { - $formatted_items[] = '🗓️ ' . __( 'Start', 'activitypub-event-bridge' ) . ': ' . $start_time; + $formatted_items[] = $this->generate_time_output( $start_time, $time_atts, '🗓️', __( 'Start', 'event-bridge-for-activitypub' ) ); } if ( ! empty( $end_time ) ) { - $formatted_items[] = '⏳ ' . __( 'End', 'activitypub-event-bridge' ) . ': ' . $end_time; + $formatted_items[] = $this->generate_time_output( $end_time, $time_atts, '⏳', __( 'End', 'event-bridge-for-activitypub' ) ); } if ( ! empty( $address ) ) { - $formatted_items[] = '📍 ' . __( 'Address', 'activitypub-event-bridge' ) . ': ' . $address; + $formatted_items[] = '📍 ' . __( 'Address', 'event-bridge-for-activitypub' ) . ': ' . $address; } // Compose the summary based on the number of meta items. @@ -308,6 +512,18 @@ abstract class Event extends Post { return $summary; } + /** + * Gets the template to use to generate the summary of the ActivityStreams representation of an event post. + * + * @return string The Template. + */ + protected function get_event_summary_template() { + $summary = \get_option( 'event_bridge_for_activitypub_custom_summary', EVENT_BRIDGE_FOR_ACTIVITYPUB_CUSTOM_SUMMARY ); + $template = $summary ?? EVENT_BRIDGE_FOR_ACTIVITYPUB_CUSTOM_SUMMARY; + + return apply_filters( 'event_bridge_for_activitypub_summary_template', $template, $this->wp_object ); + } + /** * By default set the timezone of the WordPress site. * diff --git a/includes/activitypub/transformer/class-eventin.php b/includes/activitypub/transformer/class-eventin.php index b47d93e..7b4131d 100644 --- a/includes/activitypub/transformer/class-eventin.php +++ b/includes/activitypub/transformer/class-eventin.php @@ -4,17 +4,17 @@ * * @link https://support.themewinter.com/docs/plugins/docs-category/eventin/ * - * @package ActivityPub_Event_Bridge + * @package Event_Bridge_For_ActivityPub * @license AGPL-3.0-or-later */ -namespace ActivityPub_Event_Bridge\Activitypub\Transformer; +namespace Event_Bridge_For_ActivityPub\Activitypub\Transformer; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore use Activitypub\Activity\Extended_Object\Place; -use ActivityPub_Event_Bridge\Activitypub\Transformer\Event; +use Event_Bridge_For_ActivityPub\Activitypub\Transformer\Event; use DateTime; use DateTimeZone; use Etn\Core\Event\Event_Model; diff --git a/includes/activitypub/transformer/class-events-manager.php b/includes/activitypub/transformer/class-events-manager.php index 1def3f7..92fbad2 100644 --- a/includes/activitypub/transformer/class-events-manager.php +++ b/includes/activitypub/transformer/class-events-manager.php @@ -2,17 +2,17 @@ /** * ActivityPub Transformer for the plugin Very Simple Event List. * - * @package ActivityPub_Event_Bridge + * @package Event_Bridge_For_ActivityPub * @license AGPL-3.0-or-later */ -namespace ActivityPub_Event_Bridge\Activitypub\Transformer; +namespace Event_Bridge_For_ActivityPub\Activitypub\Transformer; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore use Activitypub\Activity\Extended_Object\Place; -use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer; +use Event_Bridge_For_ActivityPub\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 756524a..79eb601 100644 --- a/includes/activitypub/transformer/class-gatherpress.php +++ b/includes/activitypub/transformer/class-gatherpress.php @@ -1,19 +1,19 @@ gp_event->get_datetime_end( 'Y-m-d\TH:i:s\Z' ); } /** * Get the end time from the event object. */ - protected function get_start_time(): string { + public function get_start_time(): string { return $this->gp_event->get_datetime_start( 'Y-m-d\TH:i:s\Z' ); } diff --git a/includes/activitypub/transformer/class-modern-events-calendar-lite.php b/includes/activitypub/transformer/class-modern-events-calendar-lite.php index 8622de4..edff084 100644 --- a/includes/activitypub/transformer/class-modern-events-calendar-lite.php +++ b/includes/activitypub/transformer/class-modern-events-calendar-lite.php @@ -2,17 +2,17 @@ /** * ActivityPub Tribe Transformer * - * @package ActivityPub_Event_Bridge + * @package Event_Bridge_For_ActivityPub * @license AGPL-3.0-or-later */ -namespace ActivityPub_Event_Bridge\Activitypub\Transformer; +namespace Event_Bridge_For_ActivityPub\Activitypub\Transformer; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore use Activitypub\Activity\Extended_Object\Place; -use ActivityPub_Event_Bridge\Activitypub\Transformer\Event; +use Event_Bridge_For_ActivityPub\Activitypub\Transformer\Event; use MEC; use MEC\Events\Event as MEC_Event; diff --git a/includes/activitypub/transformer/class-the-events-calendar.php b/includes/activitypub/transformer/class-the-events-calendar.php index f50fa29..880fee3 100644 --- a/includes/activitypub/transformer/class-the-events-calendar.php +++ b/includes/activitypub/transformer/class-the-events-calendar.php @@ -2,17 +2,17 @@ /** * ActivityPub Tribe Transformer * - * @package ActivityPub_Event_Bridge + * @package Event_Bridge_For_ActivityPub * @license AGPL-3.0-or-later */ -namespace ActivityPub_Event_Bridge\Activitypub\Transformer; +namespace Event_Bridge_For_ActivityPub\Activitypub\Transformer; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore use Activitypub\Activity\Extended_Object\Place; -use ActivityPub_Event_Bridge\Activitypub\Transformer\Event; +use Event_Bridge_For_ActivityPub\Activitypub\Transformer\Event; use WP_Post; use function Activitypub\esc_hashtag; @@ -72,7 +72,7 @@ final class The_Events_Calendar extends Event { /** * Get the end time from the event object. */ - protected function get_end_time(): ?string { + public function get_end_time(): ?string { if ( empty( $this->tribe_event->end_date ) ) { return null; } @@ -83,7 +83,7 @@ final class The_Events_Calendar extends Event { /** * Get the end time from the event object. */ - protected function get_start_time(): string { + public function get_start_time(): string { $date = date_create( $this->tribe_event->start_date, wp_timezone() ); return \gmdate( 'Y-m-d\TH:i:s\Z', $date->getTimestamp() ); } diff --git a/includes/activitypub/transformer/class-vs-event-list.php b/includes/activitypub/transformer/class-vs-event-list.php index c476404..42fdb14 100644 --- a/includes/activitypub/transformer/class-vs-event-list.php +++ b/includes/activitypub/transformer/class-vs-event-list.php @@ -2,17 +2,17 @@ /** * ActivityPub Transformer for the plugin Very Simple Event List. * - * @package ActivityPub_Event_Bridge + * @package Event_Bridge_For_ActivityPub * @license AGPL-3.0-or-later */ -namespace ActivityPub_Event_Bridge\Activitypub\Transformer; +namespace Event_Bridge_For_ActivityPub\Activitypub\Transformer; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore use Activitypub\Activity\Extended_Object\Place; -use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer; +use Event_Bridge_For_ActivityPub\Activitypub\Transformer\Event as Event_Transformer; /** * ActivityPub Transformer for VS Event. @@ -44,7 +44,7 @@ final class VS_Event_List extends Event_Transformer { /** * Get the end time from the events metadata. */ - protected function get_end_time(): ?string { + public function get_end_time(): ?string { if ( 'yes' === get_post_meta( $this->wp_object->ID, 'event-hide-end-time', true ) ) { return null; } @@ -58,7 +58,7 @@ final class VS_Event_List extends Event_Transformer { /** * Get the end time from the events metadata. */ - protected function get_start_time(): string { + public function get_start_time(): string { $start_time = get_post_meta( $this->wp_object->ID, 'event-start-date', true ); return \gmdate( 'Y-m-d\TH:i:s\Z', $start_time ); } diff --git a/includes/activitypub/transformer/class-wp-event-manager.php b/includes/activitypub/transformer/class-wp-event-manager.php index 6330152..7985291 100644 --- a/includes/activitypub/transformer/class-wp-event-manager.php +++ b/includes/activitypub/transformer/class-wp-event-manager.php @@ -2,17 +2,17 @@ /** * ActivityPub Transformer for the plugin Very Simple Event List. * - * @package ActivityPub_Event_Bridge + * @package Event_Bridge_For_ActivityPub * @license AGPL-3.0-or-later */ -namespace ActivityPub_Event_Bridge\Activitypub\Transformer; +namespace Event_Bridge_For_ActivityPub\Activitypub\Transformer; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore use Activitypub\Activity\Extended_Object\Place; -use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer; +use Event_Bridge_For_ActivityPub\Activitypub\Transformer\Event as Event_Transformer; use DateTime; /** @@ -101,7 +101,7 @@ final class WP_Event_Manager extends Event_Transformer { if ( str_starts_with( $event_link_url, 'http' ) ) { return array( 'type' => 'Link', - 'name' => \esc_html__( 'Video URL', 'activitypub-event-bridge' ), + 'name' => \esc_html__( 'Video URL', 'event-bridge-for-activitypub' ), 'href' => \esc_url( $event_link_url ), 'mediaType' => 'text/html', ); diff --git a/includes/admin/class-event-plugin-admin-notices.php b/includes/admin/class-event-plugin-admin-notices.php index 73ed33c..cb4af54 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_Bridge + * @package Event_Bridge_For_ActivityPub * @since 1.0.0 * @license AGPL-3.0-or-later */ -namespace ActivityPub_Event_Bridge\Admin; +namespace Event_Bridge_For_ActivityPub\Admin; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore -use ActivityPub_Event_Bridge\Plugins\Event_Plugin; +use Event_Bridge_For_ActivityPub\Integrations\Event_Plugin; /** * Class responsible for Event Plugin related admin notices. @@ -69,17 +69,25 @@ class Event_Plugin_Admin_Notices { * @return void */ private function do_admin_notice_post_type_not_activitypub_enabled(): void { - $event_plugin_data = get_plugin_data( WP_PLUGIN_DIR . '/' . $this->event_plugin::get_plugin_file() ); + $all_plugins = get_plugins(); + $event_plugin_file = $this->event_plugin::get_relative_plugin_file(); + if ( isset( $all_plugins[ $event_plugin_file ]['Name'] ) ) { + $event_plugin_name = $all_plugins[ $event_plugin_file ]['Name']; + } elseif ( isset( get_mu_plugins()[ $event_plugin_file ]['Name'] ) ) { + $event_plugin_name = get_mu_plugins()[ $event_plugin_file ]['Name']; + } else { + return; + } $activitypub_plugin_data = get_plugin_data( ACTIVITYPUB_PLUGIN_FILE ); $notice = sprintf( /* translators: 1: the name of the event plugin a admin notice is shown. 2: The name of the ActivityPub plugin. */ _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-bridge' + 'event-bridge-for-activitypub' ), esc_html( $activitypub_plugin_data['Name'] ), - esc_html( $event_plugin_data['Name'] ), + esc_html( $event_plugin_name ), admin_url( 'options-general.php?page=activitypub&tab=settings' ) ); $allowed_html = array( diff --git a/includes/admin/class-general-admin-notices.php b/includes/admin/class-general-admin-notices.php index 7ab1f2b..ee7f886 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_Bridge + * @package Event_Bridge_For_ActivityPub * @since 1.0.0 * @license AGPL-3.0-or-later */ -namespace ActivityPub_Event_Bridge\Admin; +namespace Event_Bridge_For_ActivityPub\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_BRIDGE_SUPPORTED_EVENT_PLUGINS_URL = 'https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge#events-plugin-that-will-be-supported-at-first'; + const EVENT_BRIDGE_FOR_ACTIVITYPUB_SUPPORTED_EVENT_PLUGINS_URL = 'https://code.event-federation.eu/Event-Federation/wordpress-event-bridge-for-activitypub#supported-event-plugins'; /** * Allowed HTML for admin notices. @@ -38,8 +38,9 @@ class General_Admin_Notices { */ const ALLOWED_HTML = array( 'a' => array( - 'href' => true, - 'title' => true, + 'href' => true, + 'title' => true, + 'target' => true, ), 'br', 'i', @@ -54,9 +55,9 @@ class General_Admin_Notices { return sprintf( /* translators: 1: An URL that points to the ActivityPub plugin. */ _x( - 'For the ActivityPub Event Bridge to work, you will need to install and activate the ActivityPub plugin.', + 'For the Event Bridge for ActivityPub to work, you will need to install and activate the ActivityPub plugin.', 'admin notice', - 'activitypub-event-bridge' + 'event-bridge-for-activitypub' ), esc_html( self::ACTIVITYPUB_PLUGIN_URL ) ); @@ -71,12 +72,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 Bridge to work.', + 'Please upgrade your ActivityPub plugin. At least version %2$s is required for the Event Bridge for ActivityPub to work.', 'admin notice', - 'activitypub-event-bridge' + 'event-bridge-for-activitypub' ), esc_html( self::ACTIVITYPUB_PLUGIN_URL ), - esc_html( ACTIVITYPUB_EVENT_BRIDGE_ACTIVITYPUB_PLUGIN_MIN_VERSION ) + esc_html( EVENT_BRIDGE_FOR_ACTIVITYPUB_ACTIVITYPUB_PLUGIN_MIN_VERSION ) ); } @@ -89,12 +90,12 @@ class General_Admin_Notices { return sprintf( /* translators: 1: An URL to the list of supported event plugins. */ _x( - 'The Plugin ActivityPub Event Bridge is of no use, because you do not have installed and activated a supported Event Plugin. -
For a list of supported Event Plugins see here.', + 'The Plugin Event Bridge for ActivityPub is of no use, because you do not have installed and activated a supported Event Plugin. +
For a list of supported Event Plugins see here.', 'admin notice', - 'activitypub-event-bridge' + 'event-bridge-for-activitypub' ), - esc_html( self::ACTIVITYPUB_EVENT_BRIDGE_SUPPORTED_EVENT_PLUGINS_URL ) + esc_url( self::EVENT_BRIDGE_FOR_ACTIVITYPUB_SUPPORTED_EVENT_PLUGINS_URL ) ); } @@ -107,12 +108,12 @@ class General_Admin_Notices { return sprintf( /* translators: 1: An URL to the list of supported event plugins. */ _x( - 'The Plugin ActivityPub Event Bridge is of no use, because you do not have installed and activated a supported Event Plugin. + 'The Plugin Event Bridge for ActivityPub is of no use, because you do not have installed and activated a supported Event Plugin.
For a list of supported Event Plugins see here.', 'admin notice', - 'activitypub-event-bridge' + 'event-bridge-for-activitypub' ), - esc_html( self::ACTIVITYPUB_EVENT_BRIDGE_SUPPORTED_EVENT_PLUGINS_URL ) + esc_html( self::EVENT_BRIDGE_FOR_ACTIVITYPUB_SUPPORTED_EVENT_PLUGINS_URL ) ); } diff --git a/includes/admin/class-health-check.php b/includes/admin/class-health-check.php index daaa0e0..07c0a95 100644 --- a/includes/admin/class-health-check.php +++ b/includes/admin/class-health-check.php @@ -5,11 +5,11 @@ * @package Activitypub_Event_Bridge */ -namespace ActivityPub_Event_Bridge\Admin; +namespace Event_Bridge_For_ActivityPub\Admin; use Activitypub\Transformer\Factory as Transformer_Factory; -use ActivityPub_Event_Bridge\Plugins\Event_Plugin; -use ActivityPub_Event_Bridge\Setup; +use Event_Bridge_For_ActivityPub\Integrations\Event_Plugin; +use Event_Bridge_For_ActivityPub\Setup; use WP_Query; /** @@ -32,8 +32,8 @@ class Health_Check { * @return array The filtered test array. */ public static function add_tests( $tests ) { - $tests['direct']['activitypub_event_bridge_test'] = array( - 'label' => __( 'ActivityPub Event Transformer Test', 'activitypub-event-bridge' ), + $tests['direct']['event_bridge_for_activitypub_test'] = array( + 'label' => __( 'ActivityPub Event Transformer Test', 'event-bridge-for-activitypub' ), 'test' => array( self::class, 'test_event_transformation' ), ); @@ -47,15 +47,15 @@ class Health_Check { */ public static function test_event_transformation() { $result = array( - 'label' => \__( 'Transformation of Events to a valid ActivityStreams representation.', 'activitypub-event-bridge' ), + 'label' => \__( 'Transformation of Events to a valid ActivityStreams representation.', 'event-bridge-for-activitypub' ), 'status' => 'good', 'badge' => array( - 'label' => \__( 'ActivityPub Event Bridge', 'activitypub-event-bridge' ), + 'label' => \__( 'Event Bridge for ActivityPub', 'event-bridge-for-activitypub' ), 'color' => 'green', ), 'description' => \sprintf( '

%s

', - \__( 'The transformation of your most recent events was successful.', 'activitypub-event-bridge' ) + \__( 'The transformation of your most recent events was successful.', 'event-bridge-for-activitypub' ) ), 'actions' => '', 'test' => 'test_event_transformation', @@ -68,7 +68,7 @@ class Health_Check { } $result['status'] = 'critical'; - $result['label'] = \__( 'One or more of your most recent events failed to transform to ActivityPub', 'activitypub-event-bridge' ); + $result['label'] = \__( 'One or more of your most recent events failed to transform to ActivityPub', 'event-bridge-for-activitypub' ); $result['badge']['color'] = 'red'; $result['description'] = \sprintf( '

%s

', @@ -114,7 +114,12 @@ class Health_Check { */ public static function get_most_recent_event_posts( $event_post_type = null, $number_of_posts = 5 ) { if ( ! $event_post_type ) { - $event_post_type = Setup::get_instance()->get_active_event_plugins()[0]->get_post_type(); + $active_event_plugins = Setup::get_instance()->get_active_event_plugins(); + $active_event_plugin = reset( $active_event_plugins ); + if ( ! $active_event_plugin ) { + return false; + } + $event_post_type = $active_event_plugin->get_post_type(); } $args = array( @@ -148,7 +153,7 @@ class Health_Check { $active_event_plugins = Setup::get_instance()->get_active_event_plugins(); $info = array(); foreach ( $active_event_plugins as $active_event_plugin ) { - $event_plugin_file = $active_event_plugin->get_plugin_file(); + $event_plugin_file = $active_event_plugin->get_relative_plugin_file(); $event_plugin_data = \get_plugin_data( $event_plugin_file ); $event_plugin_name = isset( $event_plugin_data['Plugin Name'] ) ? $event_plugin_data['Plugin Name'] : 'Name not found'; $event_plugin_version = isset( $event_plugin_version['Plugin Version'] ) ? $event_plugin_version['Plugin Version'] : 'Version not found'; @@ -168,12 +173,12 @@ class Health_Check { * @return array The extended information. */ public static function add_debug_information( $info ) { - $info['activitypub_event_bridge'] = array( - 'label' => __( 'ActivityPub Event Bridge', 'activitypub-event-bridge' ), + $info['event_bridge_for_activitypub'] = array( + 'label' => __( 'Event Bridge for ActivityPub', 'event-bridge-for-activitypub' ), 'fields' => array( 'plugin_version' => array( - 'label' => __( 'Plugin Version', 'activitypub-event-bridge' ), - 'value' => ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_VERSION, + 'label' => __( 'Plugin Version', 'event-bridge-for-activitypub' ), + 'value' => EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_VERSION, 'private' => true, ), 'active_event_plugins' => self::get_info_about_active_event_plugins(), diff --git a/includes/admin/class-settings-page.php b/includes/admin/class-settings-page.php index b2dbb3e..e901064 100644 --- a/includes/admin/class-settings-page.php +++ b/includes/admin/class-settings-page.php @@ -3,32 +3,32 @@ * General settings class. * * This file contains the General class definition, which handles the "General" settings - * page for the Activitypub Event Bridge Plugin, providing options for configuring various general settings. + * page for the Event Bridge for ActivityPub Plugin, providing options for configuring various general settings. * - * @package ActivityPub_Event_Bridge + * @package Event_Bridge_For_ActivityPub * @since 1.0.0 */ -namespace ActivityPub_Event_Bridge\Admin; +namespace Event_Bridge_For_ActivityPub\Admin; // Exit if accessed directly. defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore -use ActivityPub_Event_Bridge\Plugins\Event_Plugin; -use ActivityPub_Event_Bridge\Setup; +use Event_Bridge_For_ActivityPub\Integrations\Event_Plugin; +use Event_Bridge_For_ActivityPub\Setup; /** - * Class responsible for the Activitypub Event Bridge related Settings. + * Class responsible for the Event Bridge for ActivityPub related Settings. * - * Class which handles the "General" settings page for the Activitypub Event Bridge Plugin, + * Class which handles the "General" settings page for the Event Bridge for ActivityPub Plugin, * providing options for configuring various general settings. * * @since 1.0.0 */ class Settings_Page { - const STATIC = 'ActivityPub_Event_Bridge\Admin\Settings_Page'; + const STATIC = 'Event_Bridge_For_ActivityPub\Admin\Settings_Page'; - const SETTINGS_SLUG = 'activitypub-event-bridge'; + const SETTINGS_SLUG = 'event-bridge-for-activitypub'; /** * Warning if the plugin is Active and the ActivityPub plugin is not. * @@ -36,8 +36,8 @@ class Settings_Page { */ public static function admin_menu(): void { \add_options_page( - 'Activitypub Event Bridge', - __( 'ActivityPub Event Bridge', 'activitypub-event-bridge' ), + 'Event Bridge for ActivityPub', + __( 'Event Bridge for ActivityPub', 'event-bridge-for-activitypub' ), 'manage_options', self::SETTINGS_SLUG, array( self::STATIC, 'settings_page' ), @@ -97,6 +97,9 @@ class Settings_Page { $tab = sanitize_key( $_GET['tab'] ); } + // Fallback to always re-scan active event plugins, when user visits admin area of this plugin. + Setup::get_instance()->redetect_active_event_plugins(); + switch ( $tab ) { case 'settings': $plugin_setup = Setup::get_instance(); @@ -114,7 +117,7 @@ class Settings_Page { 'event_terms' => $event_terms, ); - \load_template( ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_DIR . 'templates/settings.php', true, $args ); + \load_template( EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_DIR . 'templates/settings.php', true, $args ); break; case 'welcome': default: @@ -122,7 +125,7 @@ class Settings_Page { add_thickbox(); wp_enqueue_script( 'updates' ); - \load_template( ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_DIR . 'templates/welcome.php', true ); + \load_template( EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_DIR . 'templates/welcome.php', true ); break; } } diff --git a/includes/class-autoloader.php b/includes/class-autoloader.php index e0315d8..40f99cd 100644 --- a/includes/class-autoloader.php +++ b/includes/class-autoloader.php @@ -1,17 +1,17 @@ 'string', - 'description' => \__( 'Define your own custom post template', 'activitypub-event-bridge' ), + 'description' => \__( 'Define your own custom post template', 'event-bridge-for-activitypub' ), 'show_in_rest' => true, 'default' => self::DEFAULT_EVENT_CATEGORY, 'sanitize_callback' => array( self::class, 'sanitize_mapped_event_category' ), @@ -52,25 +50,47 @@ class Settings { ); \register_setting( - 'activitypub-event-bridge', - 'activitypub_event_bridge_event_category_mappings', + 'event-bridge-for-activitypub', + 'event_bridge_for_activitypub_event_category_mappings', array( 'type' => 'array', - 'description' => \__( 'Define your own custom post template', 'activitypub-event-bridge' ), + 'description' => \__( 'Define your own custom post template', 'event-bridge-for-activitypub' ), 'default' => array(), 'sanitize_callback' => array( self::class, 'sanitize_event_category_mappings' ), ) ); \register_setting( - 'activitypub-event-bridge', - 'activitypub_event_bridge_initially_activated', + 'event-bridge-for-activitypub', + 'event_bridge_for_activitypub_initially_activated', array( 'type' => 'boolean', - 'description' => \__( 'Whether the plugin just got activated for the first time.', 'activitypub-event-bridge' ), + 'description' => \__( 'Whether the plugin just got activated for the first time.', 'event-bridge-for-activitypub' ), 'default' => 1, ) ); + + \register_setting( + 'event-bridge-for-activitypub', + 'event_bridge_for_activitypub_summary_type', + array( + 'type' => 'string', + 'description' => \__( 'Summary type to use for ActivityStreams', 'event-bridge-for-activitypub' ), + 'show_in_rest' => true, + 'default' => 'preset', + ) + ); + + \register_setting( + 'event-bridge-for-activitypub', + 'event_bridge_for_activitypub_custom_summary', + array( + 'type' => 'string', + 'description' => \__( 'Define your own custom summary template for events', 'event-bridge-for-activitypub' ), + 'show_in_rest' => true, + 'default' => EVENT_BRIDGE_FOR_ACTIVITYPUB_CUSTOM_SUMMARY, + ) + ); } /** @@ -111,7 +131,8 @@ class Settings { * @return bool True if allowed, false otherwise. */ private static function is_allowed_event_category( $event_category ): bool { - $allowed_event_categories = Event::DEFAULT_EVENT_CATEGORIES; + require_once EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_DIR . '/includes/event-categories.php'; + $allowed_event_categories = array_keys( EVENT_BRIDGE_FOR_ACTIVITYPUB_EVENT_CATEGORIES ); return in_array( $event_category, $allowed_event_categories, true ); } } diff --git a/includes/class-setup.php b/includes/class-setup.php index 91140a1..b4adc28 100644 --- a/includes/class-setup.php +++ b/includes/class-setup.php @@ -1,33 +1,32 @@ activitypub_plugin_is_active ) { - // deactivate_plugins( ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE ); + // deactivate_plugins( EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_FILE ); // return; // }. - $this->active_event_plugins = self::detect_active_event_plugins(); $this->activitypub_plugin_version = self::get_activitypub_plugin_version(); - $this->setup_hooks(); + add_action( 'plugins_loaded', array( $this, 'setup_hooks' ) ); } /** @@ -107,8 +105,7 @@ class Setup { if ( defined( 'ACTIVITYPUB_PLUGIN_VERSION' ) ) { return constant( 'ACTIVITYPUB_PLUGIN_VERSION' ); } - $version = get_file_data( WP_PLUGIN_DIR . '/activitypub/activitypub.php', array( 'Version' ) )[0]; - return $version ?? '0.0.0'; + return '0.0.0'; } /** @@ -126,32 +123,57 @@ class Setup { * @var array */ private const EVENT_PLUGIN_CLASSES = array( - '\ActivityPub_Event_Bridge\Plugins\Events_Manager', - '\ActivityPub_Event_Bridge\Plugins\GatherPress', - '\ActivityPub_Event_Bridge\Plugins\The_Events_Calendar', - '\ActivityPub_Event_Bridge\Plugins\VS_Event_List', - '\ActivityPub_Event_Bridge\Plugins\WP_Event_Manager', - '\ActivityPub_Event_Bridge\Plugins\Eventin', - '\ActivityPub_Event_Bridge\Plugins\Modern_Events_Calendar_Lite', + '\Event_Bridge_For_ActivityPub\Integrations\Events_Manager', + '\Event_Bridge_For_ActivityPub\Integrations\GatherPress', + '\Event_Bridge_For_ActivityPub\Integrations\The_Events_Calendar', + '\Event_Bridge_For_ActivityPub\Integrations\VS_Event_List', + '\Event_Bridge_For_ActivityPub\Integrations\WP_Event_Manager', + '\Event_Bridge_For_ActivityPub\Integrations\Eventin', + '\Event_Bridge_For_ActivityPub\Integrations\Modern_Events_Calendar_Lite', + '\Event_Bridge_For_ActivityPub\Integrations\Event_Organiser', ); + /** + * 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 static function detect_active_event_plugins(): array { - $active_event_plugins = array(); + 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_CLASSES as $event_plugin_class ) { - if ( ! class_exists( $event_plugin_class ) || ! method_exists( $event_plugin_class, 'get_plugin_file' ) ) { + $event_plugin_file = call_user_func( array( $event_plugin_class, 'get_relative_plugin_file' ) ); + if ( ! $event_plugin_file ) { continue; } - $event_plugin_file = call_user_func( array( $event_plugin_class, 'get_plugin_file' ) ); - if ( \is_plugin_active( $event_plugin_file ) ) { - $active_event_plugins[] = new $event_plugin_class(); + if ( array_key_exists( $event_plugin_file, $all_plugins ) && \is_plugin_active( $event_plugin_file ) ) { + $active_event_plugins[ $event_plugin_file ] = new $event_plugin_class(); } } + set_transient( 'event_bridge_for_activitypub_active_event_plugins', $active_event_plugins ); + $this->active_event_plugins = $active_event_plugins; return $active_event_plugins; } @@ -164,15 +186,20 @@ class Setup { * * @return void */ - protected function setup_hooks(): void { - register_activation_hook( ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE, array( $this, 'activate' ) ); + public function setup_hooks(): void { + $this->detect_active_event_plugins(); + + register_activation_hook( EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_FILE, array( $this, 'activate' ) ); + + add_action( 'activated_plugin', array( $this, 'redetect_active_event_plugins' ) ); + add_action( 'deactivated_plugin', array( $this, 'redetect_active_event_plugins' ) ); add_action( 'admin_init', array( $this, 'do_admin_notices' ) ); add_action( 'admin_init', array( Settings::class, 'register_settings' ) ); add_action( 'admin_enqueue_scripts', array( self::class, 'enqueue_styles' ) ); add_action( 'admin_menu', array( Settings_Page::class, 'admin_menu' ) ); add_filter( - 'plugin_action_links_' . ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_BASENAME, + 'plugin_action_links_' . EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_BASENAME, array( Settings_Page::class, 'settings_link' ) ); @@ -184,12 +211,12 @@ class Setup { add_action( 'init', array( Health_Check::class, 'init' ) ); // Check if the minimum required version of the ActivityPub plugin is installed. - if ( ! version_compare( $this->activitypub_plugin_version, ACTIVITYPUB_EVENT_BRIDGE_ACTIVITYPUB_PLUGIN_MIN_VERSION ) ) { + if ( ! version_compare( $this->activitypub_plugin_version, EVENT_BRIDGE_FOR_ACTIVITYPUB_ACTIVITYPUB_PLUGIN_MIN_VERSION ) ) { return; } // Register the handler for incoming ActivityPub "Join" activities. - add_action( 'init', array( Join::class, 'init' ) ); + add_action( 'init', array( \Event_Bridge_For_ActivityPub\ActivityPub\Handler\Join::class, 'init' ) ); // Register the custom ActivityPub transformers. add_filter( 'activitypub_transformer', array( $this, 'register_activitypub_event_transformer' ), 10, 3 ); @@ -203,24 +230,24 @@ class Setup { * @return void */ public static function enqueue_styles( $hook_suffix ): void { - if ( false !== strpos( $hook_suffix, 'activitypub-event-bridge' ) ) { + if ( false !== strpos( $hook_suffix, 'event-bridge-for-activitypub' ) ) { wp_enqueue_style( - 'activitypub-event-bridge-admin-styles', + 'event-bridge-for-activitypub-admin-styles', plugins_url( - 'assets/css/activitypub-event-bridge-admin.css', - ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE + 'assets/css/event-bridge-for-activitypub-admin.css', + EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_FILE ), array(), - ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_VERSION + EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_VERSION ); wp_enqueue_script( - 'activitypub-event-bridge-admin-script', + 'event-bridge-for-activitypub-admin-script', plugins_url( - 'assets/js/activitypub-event-bridge-admin.js', - ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE + 'assets/js/event-bridge-for-activitypub-admin.js', + EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_FILE ), array( 'jquery' ), - ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_VERSION, + EVENT_BRIDGE_FOR_ACTIVITYPUB_PLUGIN_VERSION, false ); } @@ -236,15 +263,15 @@ class Setup { // 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( 'ActivityPub_Event_Bridge\Admin\General_Admin_Notices', 'activitypub_plugin_not_enabled' ), 10, 1 ); + 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, ACTIVITYPUB_EVENT_BRIDGE_ACTIVITYPUB_PLUGIN_MIN_VERSION ) ) { + 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( 'ActivityPub_Event_Bridge\Admin\General_Admin_Notices', 'activitypub_plugin_version_too_old' ), 10, 1 ); + 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( 'ActivityPub_Event_Bridge\Admin\General_Admin_Notices', 'no_supported_event_plugin_active' ), 10, 1 ); + add_action( 'admin_notices', array( 'Event_Bridge_For_ActivityPub\Admin\General_Admin_Notices', 'no_supported_event_plugin_active' ), 10, 1 ); } } @@ -257,7 +284,7 @@ class Setup { * * @return \Activitypub\Transformer\Base|null */ - public function register_activitypub_event_transformer( $transformer, $wp_object, $object_class ): \Activitypub\Transformer\Base { + 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; @@ -297,18 +324,19 @@ class Setup { } /** - * Activates the ActivityPub Event Bridge plugin. + * Activates the Event Bridge for ActivityPub plugin. * - * This method handles the activation of the ActivityPub Event Bridge 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( ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE ) ); + 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 ), @@ -318,7 +346,7 @@ class Setup { } if ( empty( $this->active_event_plugins ) ) { - deactivate_plugins( plugin_basename( ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE ) ); + 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 ), diff --git a/includes/event-categories.php b/includes/event-categories.php index 6350a52..15fbdcf 100644 --- a/includes/event-categories.php +++ b/includes/event-categories.php @@ -2,46 +2,46 @@ /** * File responsible for defining the event category strings. * - * @package ActivityPub_Event_Bridge + * @package Event_Bridge_For_ActivityPub * @since 1.0.0 * @license AGPL-3.0-or-later */ -namespace ActivityPub_Event_Bridge; +namespace Event_Bridge_For_ActivityPub; define( - 'ACTIVITYPUB_EVENT_BRIDGE_EVENT_CATEGORIES', + 'EVENT_BRIDGE_FOR_ACTIVITYPUB_EVENT_CATEGORIES', array( - 'ARTS' => __( 'Arts', 'activitypub-event-bridge' ), - 'BOOK_CLUBS' => __( 'Book clubs', 'activitypub-event-bridge' ), - 'BUSINESS' => __( 'Business', 'activitypub-event-bridge' ), - 'CAUSES' => __( 'Causes', 'activitypub-event-bridge' ), - 'COMEDY' => __( 'Comedy', 'activitypub-event-bridge' ), - 'CRAFTS' => __( 'Crafts', 'activitypub-event-bridge' ), - 'FOOD_DRINK' => __( 'Food & Drink', 'activitypub-event-bridge' ), - 'HEALTH' => __( 'Health', 'activitypub-event-bridge' ), - 'MUSIC' => __( 'Music', 'activitypub-event-bridge' ), - 'AUTO_BOAT_AIR' => __( 'Auto, boat and air', 'activitypub-event-bridge' ), - 'COMMUNITY' => __( 'Community', 'activitypub-event-bridge' ), - 'FAMILY_EDUCATION' => __( 'Family & Education', 'activitypub-event-bridge' ), - 'FASHION_BEAUTY' => __( 'Fashion & Beauty', 'activitypub-event-bridge' ), - 'FILM_MEDIA' => __( 'Film & Media', 'activitypub-event-bridge' ), - 'GAMES' => __( 'Games', 'activitypub-event-bridge' ), - 'LANGUAGE_CULTURE' => __( 'Language & Culture', 'activitypub-event-bridge' ), - 'LEARNING' => __( 'Learning', 'activitypub-event-bridge' ), - 'LGBTQ' => __( 'LGBTQ', 'activitypub-event-bridge' ), - 'MOVEMENTS_POLITICS' => __( 'Movements and politics', 'activitypub-event-bridge' ), - 'NETWORKING' => __( 'Networking', 'activitypub-event-bridge' ), - 'PARTY' => __( 'Party', 'activitypub-event-bridge' ), - 'PERFORMING_VISUAL_ARTS' => __( 'Performing & Visual Arts', 'activitypub-event-bridge' ), - 'PETS' => __( 'Pets', 'activitypub-event-bridge' ), - 'PHOTOGRAPHY' => __( 'Photography', 'activitypub-event-bridge' ), - 'OUTDOORS_ADVENTURE' => __( 'Outdoors & Adventure', 'activitypub-event-bridge' ), - 'SPIRITUALITY_RELIGION_BELIEFS' => __( 'Spirituality, Religion & Beliefs', 'activitypub-event-bridge' ), - 'SCIENCE_TECH' => __( 'Science & Tech', 'activitypub-event-bridge' ), - 'SPORTS' => __( 'Sports', 'activitypub-event-bridge' ), - 'THEATRE' => __( 'Theatre', 'activitypub-event-bridge' ), - 'MEETING' => __( 'Meeting', 'activitypub-event-bridge' ), // Default value in federation. - 'DEFAULT' => __( 'Default', 'activitypub-event-bridge' ), // Internal default for overrides. + 'ARTS' => __( 'Arts', 'event-bridge-for-activitypub' ), + 'BOOK_CLUBS' => __( 'Book clubs', 'event-bridge-for-activitypub' ), + 'BUSINESS' => __( 'Business', 'event-bridge-for-activitypub' ), + 'CAUSES' => __( 'Causes', 'event-bridge-for-activitypub' ), + 'COMEDY' => __( 'Comedy', 'event-bridge-for-activitypub' ), + 'CRAFTS' => __( 'Crafts', 'event-bridge-for-activitypub' ), + 'FOOD_DRINK' => __( 'Food & Drink', 'event-bridge-for-activitypub' ), + 'HEALTH' => __( 'Health', 'event-bridge-for-activitypub' ), + 'MUSIC' => __( 'Music', 'event-bridge-for-activitypub' ), + 'AUTO_BOAT_AIR' => __( 'Auto, boat and air', 'event-bridge-for-activitypub' ), + 'COMMUNITY' => __( 'Community', 'event-bridge-for-activitypub' ), + 'FAMILY_EDUCATION' => __( 'Family & Education', 'event-bridge-for-activitypub' ), + 'FASHION_BEAUTY' => __( 'Fashion & Beauty', 'event-bridge-for-activitypub' ), + 'FILM_MEDIA' => __( 'Film & Media', 'event-bridge-for-activitypub' ), + 'GAMES' => __( 'Games', 'event-bridge-for-activitypub' ), + 'LANGUAGE_CULTURE' => __( 'Language & Culture', 'event-bridge-for-activitypub' ), + 'LEARNING' => __( 'Learning', 'event-bridge-for-activitypub' ), + 'LGBTQ' => __( 'LGBTQ', 'event-bridge-for-activitypub' ), + 'MOVEMENTS_POLITICS' => __( 'Movements and politics', 'event-bridge-for-activitypub' ), + 'NETWORKING' => __( 'Networking', 'event-bridge-for-activitypub' ), + 'PARTY' => __( 'Party', 'event-bridge-for-activitypub' ), + 'PERFORMING_VISUAL_ARTS' => __( 'Performing & Visual Arts', 'event-bridge-for-activitypub' ), + 'PETS' => __( 'Pets', 'event-bridge-for-activitypub' ), + 'PHOTOGRAPHY' => __( 'Photography', 'event-bridge-for-activitypub' ), + 'OUTDOORS_ADVENTURE' => __( 'Outdoors & Adventure', 'event-bridge-for-activitypub' ), + 'SPIRITUALITY_RELIGION_BELIEFS' => __( 'Spirituality, Religion & Beliefs', 'event-bridge-for-activitypub' ), + 'SCIENCE_TECH' => __( 'Science & Tech', 'event-bridge-for-activitypub' ), + 'SPORTS' => __( 'Sports', 'event-bridge-for-activitypub' ), + 'THEATRE' => __( 'Theatre', 'event-bridge-for-activitypub' ), + 'MEETING' => __( 'Meeting', 'event-bridge-for-activitypub' ), // Default value in federation. + 'DEFAULT' => __( 'Default', 'event-bridge-for-activitypub' ), // Internal default for overrides. ), ); diff --git a/includes/integrations/class-event-organiser.php b/includes/integrations/class-event-organiser.php new file mode 100644 index 0000000..0fbd190 --- /dev/null +++ b/includes/integrations/class-event-organiser.php @@ -0,0 +1,69 @@ + - - + @@ -117,7 +116,7 @@ - + diff --git a/readme.txt b/readme.txt index 66ef1b9..fb2603c 100644 --- a/readme.txt +++ b/readme.txt @@ -1,9 +1,9 @@ -=== ActivityPub Event Bridge === +=== Event Bridge for ActivityPub === Contributors: andremenrath Tags: events, fediverse, activitypub, calendar Requires at least: 6.5 Tested up to: 6.7 -Stable tag: 0.2.1 +Stable tag: 0.3.4 Requires PHP: 7.4 License: AGPL-3.0-or-later License URI: https://www.gnu.org/licenses/agpl-3.0.html @@ -11,34 +11,38 @@ Integrating popular event plugins with the ActivityPub plugin. == Description == -Make your events more discoverable, expand your reach effortlessly while being independent of other (commercial) platforms, and be a part of the growing decentralized web (the Fediverse). -With the ActivityPub Event Bridge Plugin for WordPress, your events can be automatically followed, aggregated and displayed across decentralized platforms like [Mastodon](https://joinmastodon.org) or [Gancio](https://gancio.org), without any extra work. -Forget the hassle of managing multiple social media accounts just to keep your audience informed. +Make your events more discoverable, expand your reach effortlessly while being independent of other (commercial) platforms, and be a part of the growing decentralized web (the Fediverse). With the Event Bridge for ActivityPub Plugin for WordPress, your events can be automatically followed, aggregated and displayed across decentralized platforms like [Mastodon](https://joinmastodon.org) or [Gancio](https://gancio.org), without any extra work. Forget the hassle of managing multiple social media accounts just to keep your audience informed. -This plugin is not an event managing plugin but an add-on to popular event plugins. It extends their functionality to fully support the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). -With the ActivityPub plugin people can follow your website directly and engage with your events just as they would on social media: liking, boosting and even commenting if you enable it. -You retain full ownership of your content. By integrating into your existing setup, it ensures no extra work is needed while enhancing your events' visibility across the web. +This plugin is not an event managing plugin but an add-on to popular event plugins. It extends their functionality to fully support the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). With the ActivityPub plugin people can follow your website directly and engage with your events just as they would on social media: liking, boosting and even commenting if you enable it. You retain full ownership of your content. By integrating into your existing setup, it ensures no extra work is needed while enhancing your events' visibility across the web. + += 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/) +* [Events Manager](https://de.wordpress.org/plugins/events-manager/) +* [WP Event Manager](https://de.wordpress.org/plugins/wp-event-manager/) +* [Eventin](https://de.wordpress.org/plugins/wp-event-solution/) +* [Modern Events Calendar Lite](https://webnus.net/modern-events-calendar/) +* [GatherPress](https://gatherpress.org/) +* [Event Organiser](https://wordpress.org/plugins/event-organiser/) = How It Works = -With the ActivityPub Event Bridge WordPress plugin, sharing your events is effortless and automatic! -Once you create an event on your WordPress site, it is seamlessly shared across the decentralized web using the ActivityPub protocol. +With the Event Bridge for ActivityPub WordPress plugin, sharing your events is effortless and automatic! Once you create an event on your WordPress site, it is seamlessly shared across the decentralized web using the ActivityPub protocol. -![](./.wordpress-org/event-activitypub-publishing.gif) +[vimeo https://vimeo.com/1043105544 ] -Your events can be automatically delivered to platforms that fully support events, such as [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). -These platforms create public event calendars by pulling in events from various sources, including your website. Any updates you make to your events are synced across these platforms—so you only need to manage your events on your own site, with no extra work required. +Your events can be automatically delivered to platforms that fully support events, such as [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). These platforms create public event calendars by pulling in events from various sources, including your website. Any updates you make to your events are synced across these platforms—so you only need to manage your events on your own site, with no extra work required. -![](./.wordpress-org/decentralized-event-calenders.gif) +[vimeo https://vimeo.com/1043104445 ] -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. +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. = Features for Your WordPress Events and the Fediverse = **ActivityPub-Enabled Event Sharing:** Your WordPress events are now compatible with the Fediverse, using the ActivityStreams format. This means your events can be easily discovered and followed by users on platforms like Mastodon and other ActivityPub-compatible services. -**Automatic Event Summaries:** When your event is shared on the Fediverse, platforms like Mastodon that don't fully support events will display a brief HTML summary of key details — such as the event's title, start time, and location. This ensures that even if someone can't view the full event on their platform, they still get the important info at a glance, with a link to your WordPress event page. +**Automatic Event Summaries:** When your event is shared on the Fediverse, platforms like Mastodon that don't fully support events will display a brief HTML summary of key details — such as the event's title, start time, and location. This ensures that even if someone can't view the full event on their platform, they still get the important info at a glance, with a link to your WordPress event page. Advanced users can create custom summaries via a set of shortcodes. **Improved Event Discoverability:** Your custom event categories are mapped to a set of default categories used in the Fediverse, helping your events reach a wider audience. This improves the chances that users searching for similar events on other platforms will find yours. @@ -57,8 +61,9 @@ This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/ac * [Eventin](https://de.wordpress.org/plugins/wp-event-solution/) * [Modern Events Calendar Lite](https://webnus.net/modern-events-calendar/) * [GatherPress](https://gatherpress.org/) +* [Event Organiser](https://wordpress.org/plugins/event-organiser/) -== Configuration == += Configuration = If you're new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), it’s recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality. @@ -86,18 +91,18 @@ No, the Event Federation Plugin depends on the [ActivityPub plugin](https://word = 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-bridge/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-event-bridge-for-activitypub/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-bridge/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-event-bridge-for-activitypub/issues). + +== Acknowledgement == + +The development of this WordPress plugin was funded through the [NGI0 Entrust](https://NLnet.nl/entrust) Fund, a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) programme, under the aegis of [Communications Networks, Content and Technology](https://commission.europa.eu/about-european-commission/departments-and-executive-agencies/communications-networks-content-and-technology_en) under grant agreement number 101069594. == Changelog == -= [0.2.1] 2024-11-16 = += [0.3.4] 2024-12-21 = * Initial release on https://wordpress.org/ - -= [0.2.0] 2024-10-29 = - -* Initial submission to https://wordpress.org/ diff --git a/templates/admin-header.php b/templates/admin-header.php index 4ee283b..4c84ff2 100644 --- a/templates/admin-header.php +++ b/templates/admin-header.php @@ -2,7 +2,7 @@ /** * Template for the header and navigation of the admin pages. * - * @package ActivityPub_Event_Bridge + * @package Event_Bridge_For_ActivityPub */ // Exit if accessed directly. @@ -18,18 +18,18 @@ $args = wp_parse_args( ); ?> -
-
-

+
+
+

-
diff --git a/templates/settings.php b/templates/settings.php index 309590f..9623eca 100644 --- a/templates/settings.php +++ b/templates/settings.php @@ -1,10 +1,10 @@ -
+
- + +
+

+

+

+ +

+

+ +

+
+ +
+ +
+
+
[ap_start_time]
+
+
[ap_end_time]
+
+
[ap_location]
+
+
[ap_hashtags]
+
+
[ap_excerpt]
+
+
[ap_content]
+
+
+
+
+
+
-

-

+

+

- +
- '; $label ) { + foreach ( EVENT_BRIDGE_FOR_ACTIVITYPUB_EVENT_CATEGORIES as $value => $label ) { echo ''; } ?> @@ -62,14 +108,14 @@ $current_category_mapping = \get_option( 'activitypub_event_bridge_event_
-

-

+

+

name ); ?> - -- ' . esc_html( ACTIVITYPUB_EVENT_BRIDGE_EVENT_CATEGORIES[ $mapping ] ) . ' -- '; + echo ''; } else { - echo ''; + echo ''; } - echo ''; + echo ''; foreach ( Event::DEFAULT_EVENT_CATEGORIES as $event_category ) { - echo ''; + echo ''; } ?> @@ -99,7 +145,7 @@ $current_category_mapping = \get_option( 'activitypub_event_bridge_event_ diff --git a/templates/welcome.php b/templates/welcome.php index cb63f5c..7134c7e 100644 --- a/templates/welcome.php +++ b/templates/welcome.php @@ -1,16 +1,17 @@ get_active_event_plugins(); -$activitypub_event_bridge_status_ok = true; -$example_event_post = Health_Check::get_most_recent_event_posts(); +$active_event_plugins = Setup::get_instance()->get_active_event_plugins(); +$event_bridge_for_activitypub_status_ok = true; +$example_event_post = Health_Check::get_most_recent_event_posts(); if ( empty( $example_event_post ) ) { $example_event_post = 'https://yoursite.com/events/event-name'; @@ -37,13 +38,19 @@ WP_Filesystem(); ?> -
+
-

-

+

+

+ ⚠' . \wp_kses( $notice, General_Admin_Notices::ALLOWED_HTML ) . '

'; + } + ?>

get_plugin_name() ); ?>:

-
    +
    • %2$s is enabled in the %1$s settings.', 'admin notice', - 'activitypub-event-bridge' + 'event-bridge-for-activitypub' ), esc_html( get_plugin_data( ACTIVITYPUB_PLUGIN_FILE )['Name'] ), esc_html( $active_event_plugin->get_plugin_name() ), admin_url( 'options-general.php?page=activitypub&tab=settings' ) ); } else { - $activitypub_event_bridge_status_ok = false; + $event_bridge_for_activitypub_status_ok = false; echo '❌ '; $status_message_post_type_enabled = sprintf( /* translators: 1: the name of the event plugin a admin notice is shown. 2: The name of the ActivityPub plugin. */ _x( 'The post type for events of the plugin %2$s is not enabled in the %1$s settings.', 'admin notice', - 'activitypub-event-bridge' + 'event-bridge-for-activitypub' ), esc_html( get_plugin_data( ACTIVITYPUB_PLUGIN_FILE )['Name'] ), esc_html( $active_event_plugin->get_plugin_name() ), @@ -89,11 +96,11 @@ WP_Filesystem();
      • @@ -101,95 +108,95 @@ WP_Filesystem();
- +
-

+

' . \esc_html__( 'Please fix the status issues above first.', 'activitypub-event-bridge' ) . '

'; + if ( ! $event_bridge_for_activitypub_status_ok ) { + echo '

' . \esc_html__( 'Please fix the status issues above first.', 'event-bridge-for-activitypub' ) . '

'; } ?> -

-
-

-

-