Compare commits

...

23 commits

Author SHA1 Message Date
0fba291706 fix readme
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 37s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 1m6s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 1m8s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 1m1s
2024-10-03 20:38:28 +02:00
8168df2965 remove duplicated definition of event category strings (#51)
Some checks failed
PHPUnit / PHPUnit – PHP 8.3 (push) Waiting to run
PHP Code Checker / PHP Code Checker (push) Successful in 39s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 1m2s
PHPUnit / PHPUnit – PHP 8.2 (push) Has been cancelled
Reviewed-on: #51
2024-10-03 20:35:46 +02:00
8e56eb66c0 remove duplicated definition of event category strings
All checks were successful
PHP Code Checker / PHP Code Checker (pull_request) Successful in 55s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Successful in 1m10s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Successful in 1m9s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Successful in 1m4s
2024-10-03 19:59:31 +02:00
4cc992d79b Remove actions needed for local https development
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 47s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 1m12s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 1m3s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 1m0s
moved to external plugin: https://code.event-federation.eu/Event-Federation/wordpress-localhost-https-development
2024-10-03 15:30:00 +02:00
17648dc664 improve documentation how to add new event plugin and write a new transformer
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 38s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 1m6s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 1m2s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 1m0s
2024-10-02 22:40:41 +02:00
a8627cdb02 set default status in the transformer 2024-10-02 22:40:12 +02:00
4aad867d1f Rename plugin to ActivityPub Event Bridge (#47)
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 40s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 1m6s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 1m12s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 1m0s
See the results of the poll: https://graz.social/@linos/113214893071983918

Reviewed-on: #47
Co-authored-by: André Menrath <andre.menrath@posteo.de>
Co-committed-by: André Menrath <andre.menrath@posteo.de>
2024-10-02 21:54:03 +02:00
2124b1f612 Set timezone and status for The Events Calendar (#46)
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 42s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 1m8s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 1m7s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 1m2s
Reviewed-on: Event-Federation/wordpress-activitypub-event-extensions#46
2024-10-02 19:53:13 +02:00
ced5ee90b1 set timezone and status for tribe
All checks were successful
PHP Code Checker / PHP Code Checker (pull_request) Successful in 43s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Successful in 1m8s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Successful in 1m7s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Successful in 1m5s
2024-10-02 19:50:41 +02:00
972fcbb2db Improve the design of the Base Event Transformer (#44)
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 44s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 1m7s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 1m6s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 1m2s
Co-authored-by: André Menrath <andre.menrath@posteo.de>
Reviewed-on: Event-Federation/wordpress-activitypub-event-extensions#44
Reviewed-by: André Menrath <andre.menrath@event-federation.eu>
Co-authored-by: ruru4143 <ruru@event-federation.eu>
Co-committed-by: ruru4143 <ruru@event-federation.eu>
2024-10-02 19:15:28 +02:00
2257e86f0f Merge branch 'format_summary'
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 35s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 59s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 1m3s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 56s
2024-09-28 16:38:29 +02:00
11bf3a2048 add node_modules to gitignore
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 36s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 1m5s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 59s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 1m0s
2024-09-28 16:18:00 +02:00
6f744b9e14 Cleanup top of PHP files (#40)
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 32s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 57s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 58s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 1m5s
- sorting use statements
- always check for `ABSPATH` after namespace

Reviewed-on: Event-Federation/wordpress-activitypub-event-extensions#40
Co-authored-by: André Menrath <andre.menrath@posteo.de>
Co-committed-by: André Menrath <andre.menrath@posteo.de>
2024-09-28 13:14:10 +02:00
c599384006 improve readme text
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 33s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 58s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 54s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 57s
2024-09-28 11:51:43 +02:00
f92c5853ad First draft of a proper Readme (targeting WordPress.org) (#39)
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 33s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 56s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 1m0s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 56s
Reviewed-on: Event-Federation/wordpress-activitypub-event-extensions#39
Co-authored-by: André Menrath <andre.menrath@posteo.de>
Co-committed-by: André Menrath <andre.menrath@posteo.de>
2024-09-28 11:45:47 +02:00
19457a9f19 The Events Calendar: add categories to ActivityStreams tag (#37)
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 36s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 56s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 55s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 54s
Reviewed-on: Event-Federation/wordpress-activitypub-event-extensions#37
Co-authored-by: André Menrath <andre.menrath@posteo.de>
Co-committed-by: André Menrath <andre.menrath@posteo.de>
2024-09-27 23:20:30 +02:00
7ab51b104e Fix location for tribe (#36)
All checks were successful
PHP Code Checker / PHP Code Checker (push) Successful in 35s
PHPUnit / PHPUnit – PHP 8.1 (push) Successful in 59s
PHPUnit / PHPUnit – PHP 8.2 (push) Successful in 1m0s
PHPUnit / PHPUnit – PHP 8.3 (push) Successful in 57s
Updates did not work. Always use the tribe_event instead of the wp_object where ever possible!

Reviewed-on: Event-Federation/wordpress-activitypub-event-extensions#36
Co-authored-by: André Menrath <andre.menrath@posteo.de>
Co-committed-by: André Menrath <andre.menrath@posteo.de>
2024-09-27 18:04:29 +02:00
3dbd3e21ee phpdocs, phpcs
All checks were successful
PHP Code Checker / PHP Code Checker (pull_request) Successful in 39s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Successful in 1m10s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Successful in 1m9s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Successful in 1m4s
2024-09-26 15:51:23 +02:00
20f0ea2823 add filter to never include permalink in summary
Some checks failed
PHP Code Checker / PHP Code Checker (pull_request) Failing after 48s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Successful in 1m10s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Successful in 1m17s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Successful in 1m4s
2024-09-26 15:44:22 +02:00
c13230ac6f fix more function return types in transformers
All checks were successful
PHP Code Checker / PHP Code Checker (pull_request) Successful in 33s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Successful in 1m3s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Successful in 57s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Successful in 52s
2024-09-25 14:30:37 +02:00
4d4328f3fd add missing phpdoc
Some checks failed
PHP Code Checker / PHP Code Checker (pull_request) Successful in 34s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Failing after 57s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Failing after 58s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Failing after 50s
2024-09-25 14:25:27 +02:00
35bd198f47 fix return types of transformer functions
Some checks failed
PHP Code Checker / PHP Code Checker (pull_request) Failing after 36s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Has been cancelled
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Has been cancelled
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Has been cancelled
2024-09-25 14:24:30 +02:00
ac99300949 wip draft of composed human readable summary using vs events list
Some checks failed
PHP Code Checker / PHP Code Checker (pull_request) Failing after 36s
PHPUnit / PHPUnit – PHP 8.1 (pull_request) Failing after 55s
PHPUnit / PHPUnit – PHP 8.2 (pull_request) Failing after 53s
PHPUnit / PHPUnit – PHP 8.3 (pull_request) Failing after 50s
2024-09-25 13:59:31 +02:00
36 changed files with 774 additions and 594 deletions

View file

@ -75,21 +75,21 @@ jobs:
run: bash bin/install-wp-tests.sh wordpress_test root root 127.0.0.1 6.6 false true true true
- name: Run Integration tests for The Events Calendar
run: cd /workspace/Event-Federation/wordpress-activitypub-event-extensions/ && ./vendor/bin/phpunit --filter=the_events_calendar
run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./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-extensions/ && ./vendor/bin/phpunit --filter=vs_event_list
run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./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-extensions/ && ./vendor/bin/phpunit --filter=gatherpress
run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./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-extensions/ && ./vendor/bin/phpunit --filter=events_manager
run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./vendor/bin/phpunit --filter=events_manager
env:
PHP_VERSION: ${{ matrix.php-version }}

3
.gitignore vendored
View file

@ -1,3 +1,4 @@
vendor
vendor/
composer.lock
.phpunit.result.cache
node_modules/

Binary file not shown.

After

Width:  |  Height:  |  Size: 389 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

View file

@ -1,26 +1,92 @@
This is a WordPress plugin improves the Fediverse integration of Events via the [WordPress ActivityPub plugin](https://wordpress.org/plugins/activitypub/).
# ActivityPub Event Bridge
> **_NOTE:_** This is still pre-alpha. It is not more than a skeleton/playground. Things change rapidly. Please contact us, instead of trying it out yourself at this time.
Contributors: andremenrath
Tags: events, fediverse, activitypub, calendar
Requires at least: 6.5
Tested up to: 6.6
Stable tag: 0.1.0
Requires PHP: 8.1
License: AGPL-3.0-or-later
License URI: https://www.gnu.org/licenses/agpl-3.0.html
For more information checkout our website https://event-federation.eu/. You can follow updates via [RSS](https://event-federation.eu/feed/) or ActivityPub: [@blog@event-federation.eu](https://event-federation.eu/blog/).
Integrating popular event plugins with the ActivityPub plugin.
## Goals
* Proper ActivityPub (JSON-LD) representation of events within WordPress
* Improving the setup and configuration workflow of ActivityPub
* Researching/Implementing federated RSVP/attendee management
![](.wordpress-org/banner-1544x500.jpg)
## Supported Event Plugins
## Description
### Events plugin that will be supported at first:
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.
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.
### 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.
<p align="center">
<img src="./.wordpress-org/event-activitypub-publishing.gif" alt="Logo" width="250" />
</p>
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.
<p align="center">
<img src="./.wordpress-org/decentralized-event-calenders.gif" alt="Logo" width="250" />
</p>
Even platforms that dont 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.
## Installation
This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). Additionally, you need to use one of the supported event plugins. See below.
### 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/)
* [GatherPress](https://github.com/GatherPress/gatherpress)
### Later:
- [All in One Events Calendar](https://de.wordpress.org/plugins/all-in-one-event-calendar/)
- TBA
## Configuration
### Your event plugin:
- [**Contact us**](https://event-federation.eu/contact/), if you want to see your event plugin on the list.
If youre new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), its recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality.
## Frequently Asked Questions
### Do I need to install another event plugin to use the Event Federation plugin?
Yes, this plugin works as an add-on and requires both the ActivityPub plugin and a supported event plugin such as The Events Calendar, VS Event List, or Events Manager to manage your events. It just fills the missing gap between event plugins and the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/).
### What platforms can follow my events?
Your events can be followed on platforms that support ActivityPub like [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). Even other applications like [Mastodon](https://joinmastodon.org), which dont fully support events yet, will display all important information about the events.
### How much extra work is required to maintain my events across the decentralized Web?
None! Once the plugin is set up, your events are automatically sent to all connected platforms or account that follow you (your Website). Any updates you make to your events are synced without additional effort.
### Can I still use social media to promote my events?
Yes, you can still use traditional social media if you wish. However, this plugin helps reduce reliance on commercial platforms by connecting your events to the decentralized Fediverse.
### Will this plugin work if I don't use the ActivityPub plugin?
No, the Event Federation plugin depends on the ActivityPub plugin to deliver your events across decentralized platforms, so it's essential to have it installed and configured.
### 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.
### 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).
## Changelog
### [0.1.0] 2024-10-01
* Initial alpha release on WordPress.org

View file

@ -0,0 +1,36 @@
<?php
/**
* Plugin Name: ActivityPub Event Bridge
* Description: Integrating popular event plugins with the ActivityPub plugin.
* Plugin URI: https://event-federation.eu/
* Version: 0.1.0
* Author: André Menrath
* Author URI: https://graz.social/@linos
* Text Domain: activitypub-event-bridge
* License: AGPL-3.0-or-later
* License URI: https://www.gnu.org/licenses/agpl-3.0.de.html
* Requires PHP: 8.1
*
* Requires at least ActivityPub plugin with version >= 3.2.2. ActivityPub plugin tested up to: 3.2.2.
*
* @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();

View file

@ -1,72 +0,0 @@
<?php
/**
* Plugin Name: ActivityPub Event Extensions
* Description: Custom ActivityPub Transformers and Integrations for common Event Plugins.
* Plugin URI: https://event-federation.eu/
* Version: 0.1.0
* Author: André Menrath
* Author URI: https://graz.social/@linos
* Text Domain: activitypub-event-extensions
* License: AGPL-3.0-or-later
* License URI: https://www.gnu.org/licenses/agpl-3.0.de.html
* Requires PHP: 8.1
*
* Requires at least ActivityPub plugin with version >= 3.2.2. ActivityPub plugin tested up to: 3.2.2.
*
* @package activitypub-event-extensions
* @license AGPL-3.0-or-later
*/
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
define( 'ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
define( 'ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_BASENAME', plugin_basename( __FILE__ ) );
define( 'ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_FILE', plugin_dir_path( __FILE__ ) . '/' . basename( __FILE__ ) );
define( 'ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
define( 'ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_VERSION', current( get_file_data( __FILE__, array( 'Version' ), 'plugin' ) ) );
define( 'ACTIVITYPUB_EVENT_EXTENSIONS_DOMAIN', 'activitypub-event-extensions' );
define( 'ACTIVITYPUB_EVENT_EXTENSIONS_ACTIVITYPUB_PLUGIN_MIN_VERSION', '3.2.2' );
// Include and register the autoloader class for automatic loading of plugin classes.
require_once ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_DIR . '/includes/class-autoloader.php';
Activitypub_Event_Extensions\Autoloader::register();
// Initialize the plugin.
Activitypub_Event_Extensions\Setup::get_instance();
// BeforeFirstRelease: Remove everything after this after here.
/**
* Add a filter for http_request_host_is_external
*
* BeforeFirstRelease: Remove this for release.
*/
add_filter( 'http_request_host_is_external', 'activitypub_event_extensions_custom_http_request_host_is_external', 10, 3 );
/**
* Add a filter for http_request_host_is_external
*
* BeforeFirstRelease: Remove this for release.
*
* @param bool $is_external Whether the request is external.
*/
function activitypub_event_extensions_custom_http_request_host_is_external( $is_external ) {
$is_external = true;
return $is_external;
}
/**
* Don't verify ssl certs for testing.
*
* BeforeFirstRelease: Remove this for release.
*/
add_filter( 'https_ssl_verify', 'activitypub_event_extensions_dont_verify_local_dev_https', 10, 3 );
/**
* BeforeFirstRelease: remove it.
*/
function activitypub_event_extensions_dont_verify_local_dev_https() {
return false;
}

View file

@ -1,4 +1,4 @@
.activitypub-event-extensions-settings-page .box {
.activitypub-event-bridge-settings-page .box {
border: 1px solid #c3c4c7;
background-color: #fff;
padding: 1em 1.5em;

View file

@ -1,6 +1,6 @@
{
"name": "menrath/wordpress-activitypub-event-extensions",
"description": "The ActivityPub Event Extensions help for event custom post types to federate properly.",
"name": "menrath/wordpress-activitypub-event-bridge",
"description": "The ActivityPub Event Bridge help for event custom post types to federate properly.",
"type": "wordpress-plugin",
"require": {
"php": ">=8.1.0",
@ -32,7 +32,7 @@
}
],
"extra": {
"installer-name": "activitypub-event-extensions"
"installer-name": "activitypub-event-bridge"
},
"scripts": {
"lint": [
@ -54,7 +54,7 @@
],
"test-debug": [
"@prepare-test",
"@test-vs-event-list"
"@test-gatherpress"
],
"test-vs-event-list": "phpunit --filter=vs_event_list",
"test-the-events-calendar": "phpunit --filter=the_events_calendar",

View file

@ -13,7 +13,7 @@ version: '3'
# "request": "launch",
# "port": 9003,
# "pathMappings": {
# "/app/": "${workspaceRoot}/wp-content/plugins/activitypub-event-extensions/",
# "/app/": "${workspaceRoot}/wp-content/plugins/activitypub-event-bridge/",
# "/tmp/wordpress/": "${workspaceRoot}/"
# },
# },

View file

@ -10,34 +10,48 @@ To make the WordPress ActivityPub plugin use a custom transformer simply add a f
## Add your event plugin
First you need to add some basic information about your event plugin in the constant `SUPPORTED_EVENT_PLUGIN` in the file `includes/class-setup.php`:
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
// Example from the Events Manager plugin.
'events_manager' => array( // Choose any key you like.
'plugin_file' => 'events-manager/events-manager.php',
'post_type' => 'event',
'settings_page' => 'options-general.php?page=vsel',
'transformer_class' => 'Events_Manager', // Points to the class in the file `includes/activitypub/transformer/class-events-manager.php`.
),
namespace ActivityPub_Event_Bridge\Plugins;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
/**
* Integration information for My Event Plugin
*
* This class defines necessary meta information is for the integration of My Event Plugin with the ActivityPub plugin.
*
* @since 1.0.0
*/
final class My_Event_Plugin extends Event_Plugin {
```
The Plugin takes care of applying the transformer, so you can jump right into implementing it.
The ActivityPub Event Bridge then takes care of applying the transformer, so you can jump right into implementing it.
## Writing an event transformer class
If you are writing a transformer for a custom post type it is recommended to start by extending the provided [event transformer](./includes/activitypub/transformer/class-event.php). It is an extension of the default generic post transformer and inherits useful default implementations for generating the [attachments](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attachment), rendering a proper [content](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-content) in HTML from either blocks or the classic editor, extracting [tags](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-tag) and more.
Within WordPress most content types are stored as a custom post type in the posts table. The ActivityPub plugin offers a basic support for all post types out of the box. So-called transformers take care of converting WordPress WP_Post objects to ActivityStreams JSON. The ActivityPub plugin offers a generic transformer for all post types. Additionally, custom transformers can be implemented to better fit a custom post type, and they can be easily registered with the ActivityPub plugin.
If you are writing a transformer for your event post type we recommend to start by extending the provided [event transformer](./includes/activitypub/transformer/class-event.php). It is an extension of the default generic post transformer and inherits useful default implementations for generating the [attachments](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attachment), rendering a proper [content](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-content) in HTML from either blocks or the classic editor, extracting [tags](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-tag) and more. Furthermore, it offers functions which are likely to be shared by multiple event plugins, so you do not need to reimplement those, or you can fork and extend them to your needs.
So create a new file at `./includes/activitypub/transformer/my-event-plugin.php`.
```php
namespace Activitypub_Event_Extensions\Activitypub\Transformer;
namespace ActivityPub_Event_Bridge\Activitypub\Transformer;
use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer;
/**
* ActivityPub Transformer for my_event_post_type.
* ActivityPub Transformer for My Event Plugin' event post type.
*/
class My_Event_Post_Type_Transformer extends Event; {
class My_Event_Plugin extends Event_Transformer; {
```
The main function which controls the transformation is `to_object`. This one is called by the ActivityPub plugin to get the resulting ActivityPub representation as an PHP-array. The conversion to JSON-LD takes place later, and you don't need to cover that. You might just want to start by applying the parent function, but the chances are high, you don't even need to extend this functions functionality.
The main function which controls the transformation is `to_object`. This one is called by the ActivityPub plugin to get the resulting ActivityStreams represented by a PHP-object (`\Activitypub\Activity\Object\Extended_Object\Event`). The conversion to the actual JSON-LD takes place later, and you don't need to cover that (> `to_array` > associative array > `to_json` > JSON).
The chances are good that you will not need to override that function.
```php
/**
@ -52,7 +66,16 @@ public function to_object() {
}
```
The ActivityPub object classes contain dynamic getter and setter functions: `set_<property-name>` and `get_<property-name>`. Of course, the property with `property-name` must exist for these to work. The function `transform_object_properties` tries to set all properties known to the ActivityPub object where a function called `get_<property-name>` exists in the current transformer class.
We also recommend extending the constructor of the transformer class and set a specialized API object of the event, if it is available. For instance:
```php
public function __construct( $wp_object, $wp_taxonomy ) {
parent::__construct( $wp_object, $wp_taxonomy );
$this->event_api = new My_Event_Object_API( $wp_object );
}
```
The ActivityPub object classes contain dynamic getter and setter functions: `set_<property>()` and `get_<property>()`. The function `transform_object_properties()` usually called by `to_object()` tries to set all properties known to the target ActivityPub object where a function called `get_<property>` exists in the current transformer class.
### How to add new properties
@ -65,7 +88,7 @@ Adding new properties is not encouraged to do at the transformer level. It's rec
You can find all available event related properties in the [event class](https://github.com/Automattic/wordpress-activitypub/blob/master/includes/activity/extended-object/class-event.php) along documentation and with links to the specifications.
#### Mandatory Properties for an Event
#### Mandatory fields
In order to ensure your events are compatible with other ActivityPub Event implementations there are several required properties that must be set by your transformer.
@ -75,8 +98,12 @@ In order to ensure your events are compatible with other ActivityPub Event imple
* **[`name`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-name)**: the title of the event
#### Recommended properties for an Event in order to achieve good interoperability with other ActivityPub platforms
#### Checklist for properties you SHOULD at least consider writing a getter functions for
* **[summary](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-summary)**: Other ActivityPub platforms that don't natively support event should use the summary (and the `name`) to display it as a converted object type. For example Mastodon converts an `Event` object to a `Note`. It is recommended to write the summary as text-centered with minimal HTML markup and that it contains the most important event details like place, time, etc.
* **`isOnline`**:
* **`endTime`**
* **`location`** Note: the `address` within can be both a `string` or a `PostalAddress`.
* **`isOnline`**
* **`status`**
* **`get_tag`**
* **`timezone`**
* **`commentsEnabled`**

View file

@ -2,24 +2,32 @@
/**
* Replace the default ActivityPub Transformer
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @license AGPL-3.0-or-later
*/
namespace Activitypub_Event_Extensions\Activitypub\Transformer;
namespace ActivityPub_Event_Bridge\Activitypub\Transformer;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
use Activitypub\Activity\Extended_Object\Event as Event_Object;
use Activitypub\Activity\Extended_Object\Place;
use Activitypub\Transformer\Post;
use function Activitypub\get_rest_url_by_path;
use DateTime;
/**
* Base transformer for WordPress event post types to ActivityPub events.
*
* Everything that transforming several WordPress post types that represent events
* have in common, as well as sane defaults for events should be defined here.
*
* BeforeFirstRelease:
* [ ] remove link at the end of the content.
* [ ] add organizer.
* [ ] do add Cancelled reason in the content.
*/
class Event extends Post {
abstract class Event extends Post {
/**
* The WordPress event taxonomy.
@ -28,17 +36,6 @@ class Event extends Post {
*/
protected $wp_taxonomy;
/**
* Returns the User-URL of the Author of the Post.
*
* If `single_user` mode is enabled, the URL of the Blog-User is returned.
*
* @return string The User-URL.
*/
protected function get_actor(): ?string {
return $this->get_attributed_to();
}
/**
* Returns the ActivityStreams 2.0 Object-Type for an Event.
*
@ -57,6 +54,16 @@ class Event extends Post {
return comments_open( $this->wp_object );
}
/**
* Set a hardcoded template for the content.
*
* This actually disabled templates for the content.
* Maybe this independent templates for events will be added later.
*/
protected function get_post_content_template(): string {
return '[ap_content]';
}
/**
* Returns the title of the event.
*
@ -74,7 +81,7 @@ class Event extends Post {
* @param WP_Post $wp_object The WordPress post object (event).
* @param string $wp_taxonomy The taxonomy slug of the event post type.
*/
public function __construct( $wp_object, $wp_taxonomy ) {
public function __construct( $wp_object, $wp_taxonomy = 'category' ) {
parent::__construct( $wp_object );
$this->wp_taxonomy = $wp_taxonomy;
}
@ -104,9 +111,14 @@ class Event extends Post {
/**
* Set the event category, via the mapping setting.
*
* @return ?string
*/
public function get_category(): ?string {
$current_category_mapping = \get_option( 'activitypub_event_extensions_event_category_mappings', array() );
if ( is_null( $this->wp_taxonomy ) ) {
return null;
}
$current_category_mapping = \get_option( 'activitypub_event_bridge_event_category_mappings', array() );
$terms = \get_the_terms( $this->wp_object, $this->wp_taxonomy );
// Check if the event has a category set and if that category has a specific mapping return that one.
@ -114,10 +126,220 @@ class Event extends Post {
return sanitize_text_field( $current_category_mapping[ $terms[0]->slug ] );
} else {
// Return the default event category.
return sanitize_text_field( \get_option( 'activitypub_event_extensions_default_event_category', 'MEETING' ) );
return sanitize_text_field( \get_option( 'activitypub_event_bridge_default_event_category', 'MEETING' ) );
}
}
/**
* Retrieves the excerpt text (may be HTML). Used for constructing the summary.
*
* @return ?string
*/
protected function retrieve_excerpt(): ?string {
if ( $this->wp_object->post_excerpt ) {
return $this->wp_object->post_excerpt;
} else {
return null;
}
}
/**
* Get the start time.
*
* This is mandatory and must be implemented in the final event transformer class.
*/
abstract protected 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 {
return null;
}
/**
* Get a default for the location.
*
* This should be overridden in the actual event transformer.
*/
protected function get_location(): ?Place {
return null;
}
/**
* Default value for the event status.
*/
protected function get_status(): ?string {
return 'CONFIRMED';
}
/**
* Compose a human readable formatted start time.
*/
protected function format_start_time(): string {
return $this->format_time( $this->get_start_time() );
}
/**
* Compose a human readable formatted end time.
*/
protected function format_end_time(): string {
return $this->format_time( $this->get_end_time() );
}
/**
* Compose a human readable formatted time.
*
* @param ?string $time The time which needs to be formatted.
*/
private static function format_time( $time ) {
if ( is_null( $time ) ) {
return '';
}
$start_datetime = new DateTime( $time );
$start_timestamp = $start_datetime->getTimestamp();
$datetime_format = get_option( 'date_format' ) . ' ' . get_option( 'time_format' );
return wp_date( $datetime_format, $start_timestamp );
}
/**
* Format a human readable address.
*/
protected function format_address(): string {
$location = $this->get_location();
if ( is_null( $location ) ) {
return '';
}
$address = $location->get_address();
if ( ! $address ) {
return $location->get_name();
}
if ( is_string( $address ) ) {
return $address;
}
if ( ! is_array( $address ) ) {
return '';
}
return isset( $address['locality'] ) ? $address['locality'] : '';
}
/**
* Format the category using the translation.
*/
protected function format_categories(): string {
if ( is_null( $this->wp_taxonomy ) ) {
return '';
}
$categories = array();
// Add the federated category string.
require_once ACTIVITYPUB_EVENT_BRIDGE_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 ];
}
// Add all category terms.
$terms = \get_the_terms( $this->wp_object, $this->wp_taxonomy );
if ( $terms && ! is_wp_error( $terms ) ) {
foreach ( $terms as $term ) {
$categories[] = $term->name;
}
}
if ( ! empty( $categories ) ) {
return implode( ' · ', array_unique( $categories ) );
}
return '';
}
/**
* Create a custom summary.
*
* It contains also the most important meta-information. The summary is often used when the
* ActivityPub object type 'Event' is not supported, e.g. in Mastodon.
*
* @return string $summary The custom event summary.
*/
public function get_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.
$fallback_to_content = true;
if ( is_null( $excerpt ) && $fallback_to_content ) {
$excerpt = parent::get_content();
}
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();
$formatted_items = array();
if ( ! empty( $category ) ) {
$formatted_items[] = '🏷️ ' . __( 'Category', 'activitypub-event-bridge' ) . ': ' . $category;
}
if ( ! empty( $start_time ) ) {
$formatted_items[] = '🗓️ ' . __( 'Start', 'activitypub-event-bridge' ) . ': ' . $start_time;
}
if ( ! empty( $end_time ) ) {
$formatted_items[] = '⏳ ' . __( 'End', 'activitypub-event-bridge' ) . ': ' . $end_time;
}
if ( ! empty( $address ) ) {
$formatted_items[] = '📍 ' . __( 'Address', 'activitypub-event-bridge' ) . ': ' . $address;
}
// Compose the summary based on the number of meta items.
if ( count( $formatted_items ) > 1 ) {
$summary = '<ul><li>' . implode( '</li><li>', $formatted_items ) . '</li></ul>';
} elseif ( 1 === count( $formatted_items ) ) {
$summary = $formatted_items[0]; // Just the one item without <ul><li>.
} else {
$summary = ''; // No items, so no output.
}
$summary .= $excerpt;
return $summary;
}
/**
* By default set the timezone of the WordPress site.
*
* This is likely to be overwritten by the actual transformer.
*
* @return string The timezone string of the site.
*/
public function get_timezone(): string {
return wp_timezone_string();
}
/**
* Remove the permalink shortcode from a WordPress template.
*
* This used for the summary template, because the summary usually gets,
* used when converting a object, where the URL is usually appended anyway.
*
* @param string $template The template string.
* @param WP_Post|WP_Comment $wp_object The wp_object which was used to select the template.
*/
public static function remove_ap_permalink_from_template( $template, $wp_object ) {
// we could override the template here, to get out custom template from an option.
if ( 'event' === $wp_object->post_type ) {
$template = str_replace( '[ap_permalink]', '', $template );
$template = str_replace( '[ap_permalink type="html"]', '', $template );
}
return $template;
}
/**
* Generic function that converts an WP-Event object to an ActivityPub-Event object.
*
@ -127,6 +349,8 @@ class Event extends Post {
$activitypub_object = new Event_Object();
$activitypub_object = $this->transform_object_properties( $activitypub_object );
// maybe move the following logic (till end of the function) into getter functions.
$published = \strtotime( $this->wp_object->post_date_gmt );
$activitypub_object->set_published( \gmdate( 'Y-m-d\TH:i:s\Z', $published ) );
@ -146,7 +370,7 @@ class Event extends Post {
$activitypub_object->set_to(
array(
'https://www.w3.org/ns/activitystreams#Public',
$this->get_actor_object()->get_followers(),
$this->get_actor_object()->get_followers(), // this fails on my machine.
)
);

View file

@ -2,23 +2,23 @@
/**
* ActivityPub Transformer for the plugin Very Simple Event List.
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @license AGPL-3.0-or-later
*/
namespace Activitypub_Event_Extensions\Activitypub\Transformer;
namespace ActivityPub_Event_Bridge\Activitypub\Transformer;
use Activitypub_Event_Extensions\Activitypub\Transformer\Event as Event_Transformer;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
use Activitypub\Activity\Extended_Object\Event;
use Activitypub\Activity\Extended_Object\Place;
use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer;
use DateTime;
use DateTimeZone;
use EM_Event;
use Activitypub\Activity\Extended_Object\Event;
use Activitypub\Activity\Extended_Object\Place;
use function Activitypub\esc_hashtag;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
use function Activitypub\esc_hashtag;
/**
* ActivityPub Transformer for events from the WordPress plugin 'Events Manager'
@ -37,42 +37,17 @@ final class Events_Manager extends Event_Transformer {
protected $em_event;
/**
* Get transformer name.
* Extend the constructor, to also set the Eventsmanager objects.
*
* Retrieve the transformers name.
* This is a special class object form The Events Calendar which
* has a lot of useful functions, we make use of our getter functions.
*
* @since 1.0.0
* @access public
* @return string Widget name.
* @param WP_Post $wp_object The WordPress object.
* @param string $wp_taxonomy The taxonomy slug of the event post type.
*/
public function get_transformer_name() {
return 'activitypub-event-transformers/events-manager';
}
/**
* Get transformer title.
*
* Retrieve the transformers label.
*
* @since 1.0.0
* @access public
* @return string Widget title.
*/
public function get_transformer_label() {
return 'Events Manager';
}
/**
* Get supported post types.
*
* Retrieve the list of supported WordPress post types this transformer widget can handle.
*
* @since 1.0.0
* @access public
* @return array Widget categories.
*/
public static function get_supported_post_types() {
return array();
public function __construct( $wp_object, $wp_taxonomy ) {
parent::__construct( $wp_object, $wp_taxonomy );
$this->em_event = new EM_Event( $this->wp_object->ID, 'post_id' );
}
/**
@ -89,7 +64,7 @@ final class Events_Manager extends Event_Transformer {
*
* @return array The Place.
*/
public function get_location() {
public function get_location(): ?Place {
if ( 'url' === $this->em_event->event_location_type ) {
return null;
}
@ -114,9 +89,6 @@ final class Events_Manager extends Event_Transformer {
if ( $em_location->location_state ) {
$address['addressRegion'] = $em_location->location_state;
}
if ( $em_location->location_postcode ) {
$address['postalCode'] = $em_location->location_postcode;
}
$location->set_address( $address );
return $location;
@ -125,14 +97,14 @@ final class Events_Manager extends Event_Transformer {
/**
* Get the end time from the events metadata.
*/
public function get_end_time() {
public function get_end_time(): ?string {
return null;
}
/**
* Get the end time from the events metadata.
*/
public function get_start_time() {
public function get_start_time(): string {
$date_string = $this->em_event->event_start_date;
$time_string = $this->em_event->event_start_time;
$timezone_string = $this->em_event->event_timezone;
@ -163,8 +135,8 @@ final class Events_Manager extends Event_Transformer {
* @return int
*/
public function get_remaining_attendee_capacity() {
$em_bookings = $this->em_event->get_bookings()->get_bookings();
$remaining_attendee_capacity = $this->em_event->event_spaces - count( $em_bookings->bookings );
$em_bookings_count = $this->get_participant_count();
$remaining_attendee_capacity = $this->em_event->event_spaces - $em_bookings_count;
return $remaining_attendee_capacity;
}
@ -178,23 +150,6 @@ final class Events_Manager extends Event_Transformer {
return count( $em_bookings->bookings );
}
/**
* Hardcoded function for generating a summary.
*/
public function get_summary() {
if ( $this->em_event->post_excerpt ) {
$excerpt = $this->em_event->post_excerpt;
} else {
$excerpt = $this->get_content();
}
$address = $this->em_event->get_location()->location_name;
$start_time = strtotime( $this->get_start_time() );
$datetime_format = get_option( 'date_format' ) . ' ' . get_option( 'time_format' );
$start_time_string = wp_date( $datetime_format, $start_time );
$summary = "📍 {$address}\n📅 {$start_time_string}\n\n{$excerpt}";
return $summary;
}
/**
* Get the event link as an ActivityPub Link object, but as an associative array.
*
@ -260,20 +215,4 @@ final class Events_Manager extends Event_Transformer {
protected function get_name(): string {
return $this->em_event->event_name;
}
/**
* Transform the WordPress Object into an ActivityPub Object.
*
* @return Activitypub\Activity\Event
*/
public function to_object(): Event {
$this->em_event = new EM_Event( $this->wp_object->ID, 'post_id' );
$activitypub_object = new Event();
$activitypub_object = $this->transform_object_properties( $activitypub_object );
$activitypub_object->set_external_participation_url( $this->get_url() );
return $activitypub_object;
}
}

View file

@ -2,24 +2,21 @@
/**
* ActivityPub Transformer for the plugin Very Simple Event List.
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @license AGPL-3.0-or-later
*/
namespace Activitypub_Event_Extensions\Activitypub\Transformer;
namespace ActivityPub_Event_Bridge\Activitypub\Transformer;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
use Activitypub_Event_Extensions\Activitypub\Transformer\Event;
use Activitypub\Model\Blog;
use Activitypub\Activity\Extended_Object\Event as Event_Object;
use Activitypub\Activity\Extended_Object\Place;
use Activitypub\Model\Blog;
use ActivityPub_Event_Bridge\Activitypub\Transformer\Event;
use GatherPress\Core\Event as GatherPress_Event;
use function Activitypub\get_rest_url_by_path;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
/**
* ActivityPub Transformer for VS Event
*
@ -27,13 +24,6 @@ if ( ! defined( 'ABSPATH' ) ) {
*/
final class GatherPress extends Event {
/**
* The target ActivityPub Event object of the transformer.
*
* @var Event
*/
protected $ap_object;
/**
* The current GatherPress Event object.
*
@ -63,25 +53,12 @@ final class GatherPress extends Event {
$this->gp_venue = $this->gp_event->get_venue_information();
}
/**
* Get supported post types.
*
* Retrieve the list of supported WordPress post types this transformer widget can handle.
*
* @since 1.0.0
* @access public
* @return array Widget categories.
*/
public static function get_supported_post_types() {
return array( GatherPress_Event::POST_TYPE );
}
/**
* Get the event location.
*
* @return Place|null The place objector null if not place set.
*/
public function get_location(): Place|null {
public function get_location(): ?Place {
$address = $this->gp_venue['full_address'];
if ( $address ) {
$place = new Place();
@ -97,14 +74,14 @@ final class GatherPress extends Event {
/**
* Get the end time from the event object.
*/
protected function get_end_time() {
protected function get_end_time(): ?string {
return $this->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() {
protected function get_start_time(): string {
return $this->gp_event->get_datetime_start( 'Y-m-d\TH:i:s\Z' );
}
@ -141,47 +118,30 @@ final class GatherPress extends Event {
}
/**
* Returns the User-URL of the Author of the Post.
* Prevents gatherpress blocks from being rendered for the content.
*
* If `single_user` mode is enabled, the URL of the Blog-User is returned.
*
* @return string The User-URL.
* @param mixed $block_content The blocks content.
* @param mixed $block The block.
*/
protected function get_attributed_to(): string {
$user = new Blog();
return $user->get_url();
}
/**
* Create a custom summary.
*
* It contains also the most important meta-information. The summary is often used when the
* ActivityPub object type 'Event' is not supported, e.g. in Mastodon.
*
* @return string $summary The custom event summary.
*/
public function get_summary(): string {
if ( $this->wp_object->excerpt ) {
$excerpt = $this->wp_object->post_excerpt;
} elseif ( get_post_meta( $this->wp_object->ID, 'event-summary', true ) ) {
$excerpt = get_post_meta( $this->wp_object->ID, 'event-summary', true );
} else {
$excerpt = $this->get_content();
public static function filter_gatherpress_blocks( $block_content, $block ) {
// Check if the block name starts with 'gatherpress'.
if ( strpos( $block['blockName'], 'gatherpress/' ) === 0 ) {
return ''; // Skip rendering this block.
}
$address = get_post_meta( $this->wp_object->ID, 'event-location', true );
$start_time = get_post_meta( $this->wp_object->ID, 'event-start-date', true );
$datetime_format = get_option( 'date_format' ) . ' ' . get_option( 'time_format' );
$start_time_string = wp_date( $datetime_format, $start_time );
$summary = "📍 {$address}\n📅 {$start_time_string}\n\n{$excerpt}";
return $summary;
return $block_content; // Return the content for other blocks.
}
/**
* Get the content.
* Apply the filter for preventing the rendering off gatherpress blocks just in time.
*
* @return Event_Object
*/
public function get_content(): string {
return $this->wp_object->post_content;
public function to_object(): Event_Object {
add_filter( 'render_block', array( self::class, 'filter_gatherpress_blocks' ), 10, 2 );
$activitypub_object = parent::to_object();
remove_filter( 'render_block', array( self::class, 'filter_gatherpress_blocks' ) );
return $activitypub_object;
}
/**
@ -192,16 +152,4 @@ final class GatherPress extends Event {
public function get_is_online(): bool {
return $this->gp_event->maybe_get_online_event_link() ? true : false;
}
/**
* Transform the WordPress Object into an ActivityPub Object.
*
* @return Activitypub\Activity\Event
*/
public function to_object(): Event_Object {
$activitypub_object = parent::to_object();
return $activitypub_object;
}
}

View file

@ -2,22 +2,22 @@
/**
* ActivityPub Tribe Transformer
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @license AGPL-3.0-or-later
*/
namespace Activitypub_Event_Extensions\Activitypub\Transformer;
namespace ActivityPub_Event_Bridge\Activitypub\Transformer;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
use Activitypub_Event_Extensions\Activitypub\Transformer\Event;
use Activitypub\Activity\Extended_Object\Place;
use Activitypub\Activity\Extended_Object\Event as Event_Object;
use WP_Error;
use Activitypub\Activity\Extended_Object\Place;
use ActivityPub_Event_Bridge\Activitypub\Transformer\Event;
use WP_Post;
use function Activitypub\esc_hashtag;
/**
* ActivityPub Tribe Transformer
*
@ -47,24 +47,36 @@ final class The_Events_Calendar extends Event {
}
/**
* Get tribe category of wp_post
* Get the tags, including also the set categories from The Events Calendar.
*
* @return string|null tribe category if it exists
* @return ?array The array if tags,
*/
public function get_tribe_category() {
$categories = tribe_get_event_cat_slugs( $this->wp_object->ID );
if ( count( $categories ) === 0 ) {
return null;
public function get_tag(): ?array {
$tags = array();
$category_ids = tribe_get_event_cat_ids();
if ( $category_ids ) {
foreach ( $category_ids as $category_id ) {
$term = \get_term( $category_id );
$tag = array(
'type' => 'Hashtag',
'href' => \esc_url( \get_term_link( $term ) ),
'name' => esc_hashtag( $term->name ),
);
$tags[] = $tag;
}
}
$tags = array_merge( $tags, parent::get_tag() );
return $categories[0];
return $tags;
}
/**
* Get the end time from the event object.
*/
protected function get_end_time() {
protected function get_end_time(): ?string {
if ( empty( $this->tribe_event->end_date ) ) {
return null;
}
$date = date_create( $this->tribe_event->end_date, wp_timezone() );
return \gmdate( 'Y-m-d\TH:i:s\Z', $date->getTimestamp() );
}
@ -72,7 +84,7 @@ final class The_Events_Calendar extends Event {
/**
* Get the end time from the event object.
*/
protected function get_start_time() {
protected 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() );
}
@ -82,21 +94,17 @@ final class The_Events_Calendar extends Event {
*
* @return string status of the event
*/
public function get_tribe_status() {
public function get_status(): ?string {
if ( 'canceled' === $this->tribe_event->event_status ) {
return 'CANCELLED';
}
if ( 'postponed' === $this->tribe_event->event_status ) {
return 'CANCELLED'; // This will be reflected in the cancelled reason.
}
if ( '' === $this->tribe_event->event_status ) {
return 'CONFIRMED';
}
return new WP_Error( 'invalid event_status value', __( 'invalid event_status', 'activitypub' ), array( 'status' => 404 ) );
return 'CONFIRMED';
}
/**
* Check if the comments are enabled for the current event.
*/
@ -111,24 +119,6 @@ final class The_Events_Calendar extends Event {
return false;
}
/**
* Returns the content for the ActivityPub Item with
*
* The content will be generated based on the user settings.
*
* @return string The content.
*/
protected function get_content() {
$content = parent::get_content();
// /BeforeFirstRelease:
// * remove link at the end of the content.
// * add organizer.
// * do add Cancelled reason in the content.s
return $content;
}
/**
* Get the event location.
*
@ -136,7 +126,7 @@ final class The_Events_Calendar extends Event {
*/
public function get_location(): Place|null {
// Get short handle for the venues.
$venues = $this->wp_object->venues;
$venues = $this->tribe_event->venues;
// Get first venue. We currently only support a single venue.
if ( $venues instanceof \Tribe\Events\Collections\Lazy_Post_Collection ) {
@ -181,6 +171,8 @@ final class The_Events_Calendar extends Event {
$location = new Place();
if ( count( $address ) > 1 ) {
$location->set_address( $address );
} else {
$location->set_address( $venue->post_title );
}
$location->set_id( $venue->permalink );
$location->set_name( $venue->post_title );
@ -189,15 +181,11 @@ final class The_Events_Calendar extends Event {
}
/**
* Extend the default event transformers to_object function.
* Get the timezone of the event.
*
* This is the heart of the ActivityPub transformer.
*
* @return Event_Object
* @return string The timezone string of the site.
*/
public function to_object(): Event_Object {
$activitypub_object = parent::to_object();
return $activitypub_object;
public function get_timezone(): string {
return $this->tribe_event->timezone;
}
}

View file

@ -2,22 +2,18 @@
/**
* ActivityPub Transformer for the plugin Very Simple Event List.
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @license AGPL-3.0-or-later
*/
namespace Activitypub_Event_Extensions\Activitypub\Transformer;
namespace ActivityPub_Event_Bridge\Activitypub\Transformer;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
use Activitypub_Event_Extensions\Activitypub\Transformer\Event as Event_Transformer;
use Activitypub\Activity\Extended_Object\Event;
use Activitypub\Activity\Extended_Object\Place;
use WP_Error;
use function Activitypub\get_rest_url_by_path;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer;
/**
* ActivityPub Transformer for VS Event.
@ -27,23 +23,6 @@ if ( ! defined( 'ABSPATH' ) ) {
* @since 1.0.0
*/
final class VS_Event_List extends Event_Transformer {
/**
* The target transformer ActivityPub Event object.
*
* @var Event
*/
protected $ap_object;
/**
* Returns the ActivityStreams 2.0 Object-Type for an Event.
*
* @see https://www.w3.org/TR/activitystreams-vocabulary/#dfn-event
* @since 1.0.0
* @return string The Event Object-Type.
*/
protected function get_type(): string {
return 'Event';
}
/**
* Get the event location.
@ -71,6 +50,9 @@ final class VS_Event_List extends Event_Transformer {
return null;
}
$end_time = get_post_meta( $this->wp_object->ID, 'event-date', true );
if ( is_null( $end_time ) || empty( $end_time ) || 'no' === $end_time ) {
return null;
}
return $end_time ? \gmdate( 'Y-m-d\TH:i:s\Z', $end_time ) : null;
}
@ -79,7 +61,7 @@ final class VS_Event_List extends Event_Transformer {
*/
protected function get_start_time(): string {
$start_time = get_post_meta( $this->wp_object->ID, 'event-start-date', true );
return $start_time ? \gmdate( 'Y-m-d\TH:i:s\Z', $start_time ) : null;
return \gmdate( 'Y-m-d\TH:i:s\Z', $start_time );
}
/**
@ -118,27 +100,15 @@ final class VS_Event_List extends Event_Transformer {
}
/**
* Create a custom summary.
* Retrieves the excerpt text (may be HTML). Used for constructing the summary.
*
* It contains also the most important meta-information. The summary is often used when the
* ActivityPub object type 'Event' is not supported, e.g. in Mastodon.
*
* @return string $summary The custom event summary.
* @return ?string
*/
public function get_summary(): ?string {
if ( $this->wp_object->excerpt ) {
$excerpt = $this->wp_object->post_excerpt;
} elseif ( get_post_meta( $this->wp_object->ID, 'event-summary', true ) ) {
$excerpt = get_post_meta( $this->wp_object->ID, 'event-summary', true );
protected function retrieve_excerpt(): ?string {
if ( get_post_meta( $this->wp_object->ID, 'event-summary', true ) ) {
return get_post_meta( $this->wp_object->ID, 'event-summary', true );
} else {
$excerpt = $this->get_content();
return parent::retrieve_excerpt();
}
$address = get_post_meta( $this->wp_object->ID, 'event-location', true );
$start_time = get_post_meta( $this->wp_object->ID, 'event-start-date', true );
$datetime_format = get_option( 'date_format' ) . ' ' . get_option( 'time_format' );
$start_time_string = wp_date( $datetime_format, $start_time );
$summary = "📍 {$address}\n📅 {$start_time_string}\n\n{$excerpt}";
return $summary;
}
}

View file

@ -4,14 +4,17 @@
*
* Notices for guiding to proper configuration of ActivityPub with event plugins.
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
* @license AGPL-3.0-or-later
*/
namespace Activitypub_Event_Extensions\Admin;
namespace ActivityPub_Event_Bridge\Admin;
use Activitypub_Event_Extensions\Plugins\Event_Plugin;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
use ActivityPub_Event_Bridge\Plugins\Event_Plugin;
/**
* Class responsible for Event Plugin related admin notices.
@ -73,7 +76,7 @@ class Event_Plugin_Admin_Notices {
_x(
'You have installed the <i>%1$s</i> plugin, but the event post type of the plugin <i>%2$s</i> is <b>not enabled</b> in the <a href="%3$s">%1$s settings</a>.',
'admin notice',
'activitypub-event-extensions'
'activitypub-event-bridge'
),
esc_html( $activitypub_plugin_data['Name'] ),
esc_html( $event_plugin_data['Name'] ),

View file

@ -4,12 +4,15 @@
*
* Notices for guiding to proper configuration of this plugin.
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
* @license AGPL-3.0-or-later
*/
namespace Activitypub_Event_Extensions\Admin;
namespace ActivityPub_Event_Bridge\Admin;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
/**
* Class responsible for general admin notices.
@ -26,7 +29,7 @@ class General_Admin_Notices {
*/
const ACTIVITYPUB_PLUGIN_URL = 'https://wordpress.org/plugins/activitypub';
const ACTIVITYPUB_EVENT_EXTENSIONS_SUPPORTED_EVENT_PLUGINS_URL = 'https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-extensions#events-plugin-that-will-be-supported-at-first';
const ACTIVITYPUB_EVENT_BRIDGE_SUPPORTED_EVENT_PLUGINS_URL = 'https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge#events-plugin-that-will-be-supported-at-first';
/**
* Allowed HTML for admin notices.
@ -51,9 +54,9 @@ class General_Admin_Notices {
return sprintf(
/* translators: 1: An URL that points to the ActivityPub plugin. */
_x(
'For the ActivityPub Event Extensions to work, you will need to install and activate the <a href="%1$s">ActivityPub</a> plugin.',
'For the ActivityPub Event Bridge to work, you will need to install and activate the <a href="%1$s">ActivityPub</a> plugin.',
'admin notice',
'activitypub-event-extensions'
'activitypub-event-bridge'
),
esc_html( self::ACTIVITYPUB_PLUGIN_URL )
);
@ -68,12 +71,12 @@ class General_Admin_Notices {
return sprintf(
/* translators: 1: The name of the ActivityPub plugin. 2: The minimum required version number of the ActivityPub plugin. */
_x(
'Please upgrade your <a href="%1$s">ActivityPub</a> plugin. At least version %2$s is required for the ActivityPub event extensions to work.',
'Please upgrade your <a href="%1$s">ActivityPub</a> plugin. At least version %2$s is required for the ActivityPub Event Bridge to work.',
'admin notice',
'activitypub-event-extensions'
'activitypub-event-bridge'
),
esc_html( self::ACTIVITYPUB_PLUGIN_URL ),
esc_html( ACTIVITYPUB_EVENT_EXTENSIONS_ACTIVITYPUB_PLUGIN_MIN_VERSION )
esc_html( ACTIVITYPUB_EVENT_BRIDGE_ACTIVITYPUB_PLUGIN_MIN_VERSION )
);
}
@ -86,12 +89,12 @@ class General_Admin_Notices {
return sprintf(
/* translators: 1: An URL to the list of supported event plugins. */
_x(
'The Plugin <i>ActivityPub Event Extensions</i> is of no use, because you do not have installed and activated a supported Event Plugin.
'The Plugin <i>ActivityPub Event Bridge</i> is of no use, because you do not have installed and activated a supported Event Plugin.
<br> For a list of supported Event Plugins see <a href="%1$s">here</a>.',
'admin notice',
'activitypub-event-extensions'
'activitypub-event-bridge'
),
esc_html( self::ACTIVITYPUB_EVENT_EXTENSIONS_SUPPORTED_EVENT_PLUGINS_URL )
esc_html( self::ACTIVITYPUB_EVENT_BRIDGE_SUPPORTED_EVENT_PLUGINS_URL )
);
}

View file

@ -5,18 +5,18 @@
* This file contains the General class definition, which handles the "General" settings
* page for the ActivityPub Event Extension Plugin, providing options for configuring various general settings.
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
*/
namespace Activitypub_Event_Extensions\Admin;
use Activitypub_Event_Extensions\Setup;
use Activitypub_Event_Extensions\Plugins\Event_Plugin;
namespace ActivityPub_Event_Bridge\Admin;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
use ActivityPub_Event_Bridge\Plugins\Event_Plugin;
use ActivityPub_Event_Bridge\Setup;
/**
* Class responsible for the ActivityPub Event Extension related Settings.
*
@ -26,9 +26,9 @@ defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
* @since 1.0.0
*/
class Settings_Page {
const STATIC = 'Activitypub_Event_Extensions\Admin\Settings_Page';
const STATIC = 'ActivityPub_Event_Bridge\Admin\Settings_Page';
const SETTINGS_SLUG = 'activitypub-event-extensions';
const SETTINGS_SLUG = 'activitypub-event-bridge';
/**
* Warning if the plugin is Active and the ActivityPub plugin is not.
*
@ -37,7 +37,7 @@ class Settings_Page {
public static function admin_menu(): void {
\add_options_page(
'Activitypub Event Extension',
__( 'ActivityPub Events', 'activitypub-event-extensions' ),
__( 'ActivityPub Events', 'activitypub-event-bridge' ),
'manage_options',
self::SETTINGS_SLUG,
array( self::STATIC, 'settings_page' )
@ -104,6 +104,6 @@ class Settings_Page {
'event_terms' => $event_terms,
);
\load_template( ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_DIR . 'templates/settings.php', true, $args );
\load_template( ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_DIR . 'templates/settings.php', true, $args );
}
}

View file

@ -1,17 +1,17 @@
<?php
/**
* Class responsible for autoloading ActivityPub Event Extensions class files.
* Class responsible for autoloading ActivityPub Event Bridge class files.
*
* The Autoloader class is responsible for automatically loading class files as needed
* to ensure a clean and organized codebase. It maps class names to their corresponding
* file locations within the GatherPress plugin.
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
* @license AGPL-3.0-or-later
*/
namespace Activitypub_Event_Extensions;
namespace ActivityPub_Event_Bridge;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
@ -34,8 +34,8 @@ class Autoloader {
public static function register(): void {
spl_autoload_register(
function ( $full_class ) {
$base_dir = ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_DIR . '/includes/';
$base = 'Activitypub_Event_Extensions\\';
$base_dir = ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_DIR . '/includes/';
$base = 'ActivityPub_Event_Bridge\\';
if ( strncmp( $full_class, $base, strlen( $base ) ) === 0 ) {
$maybe_uppercase = str_replace( $base, '', $full_class );

View file

@ -5,17 +5,17 @@
* This file contains the General class definition, which handles the "General" settings
* page for the ActivityPub Event Extension Plugin, providing options for configuring various general settings.
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
*/
namespace Activitypub_Event_Extensions;
use Activitypub\Activity\Extended_Object\Event;
namespace ActivityPub_Event_Bridge;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
use Activitypub\Activity\Extended_Object\Event;
/**
* Class responsible for the ActivityPui Event Extension related Settings.
*
@ -24,7 +24,7 @@ defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
* @since 1.0.0
*/
class Settings {
const SETTINGS_SLUG = 'activitypub-event-extensions';
const SETTINGS_SLUG = 'activitypub-event-bridge';
/**
* The default ActivityPub event category.
@ -34,14 +34,14 @@ class Settings {
const DEFAULT_EVENT_CATEGORY = 'MEETING';
/**
* Register the settings for the ActivityPub Event Extensions plugin.
* Register the settings for the ActivityPub Event Bridge plugin.
*
* @return void
*/
public static function register_settings(): void {
\register_setting(
'activitypub-event-extensions',
'activitypub_event_extensions_default_event_category',
'activitypub-event-bridge',
'activitypub_event_bridge_default_event_category',
array(
'type' => 'string',
'description' => \__( 'Define your own custom post template', 'activitypub' ),
@ -52,8 +52,8 @@ class Settings {
);
\register_setting(
'activitypub-event-extensions',
'activitypub_event_extensions_event_category_mappings',
'activitypub-event-bridge',
'activitypub_event_bridge_event_category_mappings',
array(
'type' => 'array',
'description' => \__( 'Define your own custom post template', 'activitypub' ),

View file

@ -1,31 +1,31 @@
<?php
/**
* Class responsible for initializing ActivityPub Event Extensions.
* Class responsible for initializing ActivityPub Event Bridge.
*
* The setup class provides function for checking if this plugin should be activated.
* It detects supported event plugins and provides all setup hooks and filters.
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
* @license AGPL-3.0-or-later
*/
namespace Activitypub_Event_Extensions;
use Activitypub_Event_Extensions\Admin\Event_Plugin_Admin_Notices;
use Activitypub_Event_Extensions\Admin\General_Admin_Notices;
use Activitypub_Event_Extensions\Admin\Settings_Page;
use Activitypub_Event_Extensions\Plugins\Event_Plugin;
namespace ActivityPub_Event_Bridge;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
use ActivityPub_Event_Bridge\Admin\Event_Plugin_Admin_Notices;
use ActivityPub_Event_Bridge\Admin\General_Admin_Notices;
use ActivityPub_Event_Bridge\Admin\Settings_Page;
use ActivityPub_Event_Bridge\Plugins\Event_Plugin;
require_once ABSPATH . 'wp-admin/includes/plugin.php';
/**
* Class Setup.
*
* This class is responsible for initializing ActivityPub Event Extensions.
* This class is responsible for initializing ActivityPub Event Bridge.
*
* @since 1.0.0
*/
@ -63,7 +63,7 @@ class Setup {
is_plugin_active( 'activitypub/activitypub.php' );
// BeforeFirstRelease: decide whether we want to do anything at all when ActivityPub plugin is note active.
// if ( ! $this->activitypub_plugin_is_active ) {
// deactivate_plugins( ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_FILE );
// deactivate_plugins( ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE );
// return;
// }.
$this->active_event_plugins = self::detect_active_event_plugins();
@ -124,10 +124,10 @@ class Setup {
* @var array
*/
private const EVENT_PLUGIN_CLASSES = array(
'\Activitypub_Event_Extensions\Plugins\Events_Manager',
'\Activitypub_Event_Extensions\Plugins\GatherPress',
'\Activitypub_Event_Extensions\Plugins\The_Events_Calendar',
'\Activitypub_Event_Extensions\Plugins\VS_Event_List',
'\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',
);
/**
@ -160,7 +160,7 @@ class Setup {
* @return void
*/
protected function setup_hooks(): void {
register_activation_hook( ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_FILE, array( $this, 'activate' ) );
register_activation_hook( ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE, array( $this, 'activate' ) );
add_action( 'admin_init', array( $this, 'do_admin_notices' ) );
add_action( 'admin_init', array( Settings::class, 'register_settings' ) );
@ -175,12 +175,12 @@ class Setup {
add_action( 'admin_menu', array( Settings_Page::class, 'admin_menu' ) );
add_filter(
'plugin_action_links_' . ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_BASENAME,
'plugin_action_links_' . ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_BASENAME,
array( Settings_Page::class, 'settings_link' )
);
// Check if the minimum required version of the ActivityPub plugin is installed.
if ( ! version_compare( $this->activitypub_plugin_version, ACTIVITYPUB_EVENT_EXTENSIONS_ACTIVITYPUB_PLUGIN_MIN_VERSION ) ) {
if ( ! version_compare( $this->activitypub_plugin_version, ACTIVITYPUB_EVENT_BRIDGE_ACTIVITYPUB_PLUGIN_MIN_VERSION ) ) {
return;
}
@ -195,15 +195,15 @@ class Setup {
* @return void
*/
public static function enqueue_styles( $hook_suffix ): void {
if ( false !== strpos( $hook_suffix, 'activitypub-event-extensions' ) ) {
if ( false !== strpos( $hook_suffix, 'activitypub-event-bridge' ) ) {
wp_enqueue_style(
'activitypub-event-extensions-admin-styles',
'activitypub-event-bridge-admin-styles',
plugins_url(
'assets/css/activitypub-event-extensions-admin.css',
ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_FILE
'assets/css/activitypub-event-bridge-admin.css',
ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE
),
array(),
ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_VERSION
ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_VERSION
);
}
}
@ -218,15 +218,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_Extensions\Admin\General_Admin_Notices', 'activitypub_plugin_not_enabled' ), 10, 1 );
add_action( 'admin_notices', array( 'ActivityPub_Event_Bridge\Admin\General_Admin_Notices', 'activitypub_plugin_not_enabled' ), 10, 1 );
}
if ( ! version_compare( $this->activitypub_plugin_version, ACTIVITYPUB_EVENT_EXTENSIONS_ACTIVITYPUB_PLUGIN_MIN_VERSION ) ) {
if ( ! version_compare( $this->activitypub_plugin_version, ACTIVITYPUB_EVENT_BRIDGE_ACTIVITYPUB_PLUGIN_MIN_VERSION ) ) {
// The ActivityPub plugin is too old.
add_action( 'admin_notices', array( 'Activitypub_Event_Extensions\Admin\General_Admin_Notices', 'activitypub_plugin_version_too_old' ), 10, 1 );
add_action( 'admin_notices', array( 'ActivityPub_Event_Bridge\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_Extensions\Admin\General_Admin_Notices', 'no_supported_event_plugin_active' ), 10, 1 );
add_action( 'admin_notices', array( 'ActivityPub_Event_Bridge\Admin\General_Admin_Notices', 'no_supported_event_plugin_active' ), 10, 1 );
}
}
@ -272,15 +272,16 @@ class Setup {
foreach ( $this->active_event_plugins as $event_plugin ) {
if ( ! in_array( $event_plugin->get_post_type(), $activitypub_supported_post_types, true ) ) {
$activitypub_supported_post_types[] = $event_plugin->get_post_type();
add_post_type_support( $event_plugin->get_post_type(), 'activitypub' );
}
}
update_option( 'activitypub_support_post_types', $activitypub_supported_post_types );
}
/**
* Activates the ActivityPub Event Extensions plugin.
* Activates the ActivityPub Event Bridge plugin.
*
* This method handles the activation of the ActivityPub Event Extensions plugin.
* This method handles the activation of the ActivityPub Event Bridge plugin.
*
* @since 1.0.0
*
@ -289,7 +290,7 @@ class Setup {
public function activate(): void {
// 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_EXTENSIONS_PLUGIN_FILE ) );
deactivate_plugins( plugin_basename( ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE ) );
$notice = General_Admin_Notices::get_admin_notice_activitypub_plugin_not_enabled();
wp_die(
wp_kses( $notice, General_Admin_Notices::ALLOWED_HTML ),
@ -299,7 +300,7 @@ class Setup {
}
if ( empty( $this->active_event_plugins ) ) {
deactivate_plugins( plugin_basename( ACTIVITYPUB_EVENT_EXTENSIONS_PLUGIN_FILE ) );
deactivate_plugins( plugin_basename( ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE ) );
$notice = General_Admin_Notices::get_admin_notice_no_supported_event_plugin_active();
wp_die(
wp_kses( $notice, General_Admin_Notices::ALLOWED_HTML ),

View file

@ -0,0 +1,47 @@
<?php
/**
* File responsible for defining the event category strings.
*
* @package ActivityPub_Event_Bridge
* @since 1.0.0
* @license AGPL-3.0-or-later
*/
namespace ActivityPub_Event_Bridge;
define(
'ACTIVITYPUB_EVENT_BRIDGE_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.
),
);

View file

@ -4,13 +4,13 @@
*
* Basic information that each supported event needs for this plugin to work.
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
*/
namespace Activitypub_Event_Extensions\Plugins;
namespace ActivityPub_Event_Bridge\Plugins;
use Activitypub_Event_Extensions\Activitypub\Transformer\Event as Event_Transformer;
use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore

View file

@ -5,11 +5,11 @@
* Defines all the necessary meta information for the Events Manager WordPress Plugin.
*
* @link https://wordpress.org/plugins/events-manager/
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
*/
namespace Activitypub_Event_Extensions\Plugins;
namespace ActivityPub_Event_Bridge\Plugins;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore

View file

@ -5,11 +5,11 @@
* Defines all the necessary meta information for the GatherPress plugin.
*
* @link https://wordpress.org/plugins/gatherpress/
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
*/
namespace Activitypub_Event_Extensions\Plugins;
namespace ActivityPub_Event_Bridge\Plugins;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore

View file

@ -5,11 +5,11 @@
* Defines all the necessary meta information for the events calendar.
*
* @link https://wordpress.org/plugins/the-events-calendar/
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
*/
namespace Activitypub_Event_Extensions\Plugins;
namespace ActivityPub_Event_Bridge\Plugins;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore

View file

@ -6,13 +6,13 @@
* "Very Simple Events List".
*
* @link https://de.wordpress.org/plugins/very-simple-event-list/
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
*/
namespace Activitypub_Event_Extensions\Plugins;
namespace ActivityPub_Event_Bridge\Plugins;
use Activitypub_Event_Extensions\Event_Plugins;
use ActivityPub_Event_Bridge\Event_Plugins;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore

View file

@ -105,7 +105,7 @@
<rule ref="WordPress.WP.I18n">
<properties>
<property name="text_domain" type="array">
<element value="activitypub-event-extensions"/>
<element value="activitypub-event-bridge"/>
<element value="activitypub"/>
</property>
</properties>
@ -114,7 +114,7 @@
<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
<properties>
<property name="prefixes" type="array">
<element value="ACTIVITYPUB_EVENT_EXTENSIONS"/>
<element value="ACTIVITYPUB_EVENT_BRIDGE"/>
</property>
</properties>
</rule>

View file

@ -1,53 +1,83 @@
=== ActivityPub Event Extensions ===
Contributors: menrath
Tags: events, fediverse, activitypub, activitystreams
Requires at least: 5.5
Tested up to: 6.4
Stable tag: 1.0.0
Requires PHP: 7.4
=== ActivityPub Event Bridge ===
Contributors: andremenrath
Tags: events, fediverse, activitypub, calendar
Requires at least: 6.5
Tested up to: 6.6
Stable tag: 0.1.0
Requires PHP: 8.1
License: AGPL-3.0-or-later
License URI: https://www.gnu.org/licenses/agpl-3.0.html
The ActivityPub Event Extensions
Integrating popular event plugins with the ActivityPub plugin.
== Description ==
With this event others can automatically aggregate and display events published on your website!
Additionally, people who do not want to miss on of your events will not have to follow a social-media account of yours that you maintain on the website of another party (and thereby you push the people to use these platforms), but could just follow your website directly.
Following like in social media, including all features you know like boosting, liking or commenting.
And the best: as you already publish events on your website, this means no extra work for you.
In the long term it actually might lead to less work and you help to provide a momentum to become independent of commercial platforms like Facebook and co.
For more details read our detailed project 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.
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.
= 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.
![](./.wordpress-org/event-activitypub-publishing.gif)
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)
== Installation ==
This plugin depends on the ActivityPub plugin. Furthermore you need to use one of the supported Event Plugins. See below.
This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). Additionally, you need to use one of the supported event Plugins.
== 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/)
* [GatherPress](https://github.com/GatherPress/gatherpress)
== Configuration ==
At first be sure to spend some minutes reading the Documentation of the ActivityPub plugin](https://wordpress.org/plugins/activitypub/), in case you have not used it before.
TODO
If youre new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), its recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality.
== Frequently Asked Questions ==
= Do I need to install another event plugin to use the Event Federation Plugin? =
Yes, this plugin works as an add-on and requires both the ActivityPub plugin and a supported event plugin such as The Events Calendar, VS Event List, or Events Manager to manage your events.
= What platforms can follow my events? =
Your events can be followed on platforms that support ActivityPub like [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). Even other applications like [Mastodon](https://joinmastodon.org), which dont fully support events yet, will display all important information about the events.
= How much extra work is required to maintain my events across the decentralized Web? =
None! Once the plugin is set up, your events are automatically sent to all connected platforms or account that follow you (your Website). Any updates you make to your events are synced without additional effort.
= Can I still use social media to promote my events? =
Yes, you can still use traditional social media if you wish. However, this plugin helps reduce reliance on commercial platforms by connecting your events to the decentralized Fediverse.
= Will this plugin work if I don't use the ActivityPub plugin? =
No, the Event Federation Plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/) to deliver your events across decentralized platforms, so it's essential to have it installed and configured.
= My event plugin is not supported, what can I do? =
If you know about coding have a look at the documentation of how to add your plugin or open an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-extensions/issues), if we can spare some free hours we might add it.
If you know about coding have a look at the documentation of how to add your plugin or open an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge/issues), if we can spare some free hours we might add it.
= What if I experience problems? =
We're always interested in your feedback. Feel free to reach out to us via E-Mail or create an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-extensions/issues).
We're always interested in your feedback. Feel free to reach out to us via [E-Mail](https://event-federation.eu/contact/) or create an [issue](https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge/issues).
== Changelog ==
= [1.0.0] 2024-09-01 =
= [0.1.0] 2024-09-01 =
* Initial release
* Initial alpha release on WordPress.org

View file

@ -1,10 +1,10 @@
<?php
/**
* Template for ActivityPub Event Extensions settings page.
* Template for ActivityPub Event Bridge settings page.
*
* This template is used to display and manage settings for the ActivityPub Event Extensions plugin.
* This template is used to display and manage settings for the ActivityPub Event Bridge plugin.
*
* @package ActivityPub_Event_Extensions
* @package ActivityPub_Event_Bridge
* @since 1.0.0
*
* @param array $args An array of arguments for the settings page.
@ -25,65 +25,33 @@ if ( ! current_user_can( 'manage_options' ) ) {
$event_terms = $args['event_terms'];
$default_event_category_strings = array(
'ARTS' => __( 'Arts', 'activitypub-event-extensions' ),
'BOOK_CLUBS' => __( 'Book clubs', 'activitypub-event-extensions' ),
'BUSINESS' => __( 'Business', 'activitypub-event-extensions' ),
'CAUSES' => __( 'Causes', 'activitypub-event-extensions' ),
'COMEDY' => __( 'Comedy', 'activitypub-event-extensions' ),
'CRAFTS' => __( 'Crafts', 'activitypub-event-extensions' ),
'FOOD_DRINK' => __( 'Food & Drink', 'activitypub-event-extensions' ),
'HEALTH' => __( 'Health', 'activitypub-event-extensions' ),
'MUSIC' => __( 'Music', 'activitypub-event-extensions' ),
'AUTO_BOAT_AIR' => __( 'Auto, boat and air', 'activitypub-event-extensions' ),
'COMMUNITY' => __( 'Community', 'activitypub-event-extensions' ),
'FAMILY_EDUCATION' => __( 'Family & Education', 'activitypub-event-extensions' ),
'FASHION_BEAUTY' => __( 'Fashion & Beauty', 'activitypub-event-extensions' ),
'FILM_MEDIA' => __( 'Film & Media', 'activitypub-event-extensions' ),
'GAMES' => __( 'Games', 'activitypub-event-extensions' ),
'LANGUAGE_CULTURE' => __( 'Language & Culture', 'activitypub-event-extensions' ),
'LEARNING' => __( 'Learning', 'activitypub-event-extensions' ),
'LGBTQ' => __( 'LGBTQ', 'activitypub-event-extensions' ),
'MOVEMENTS_POLITICS' => __( 'Movements and politics', 'activitypub-event-extensions' ),
'NETWORKING' => __( 'Networking', 'activitypub-event-extensions' ),
'PARTY' => __( 'Party', 'activitypub-event-extensions' ),
'PERFORMING_VISUAL_ARTS' => __( 'Performing & Visual Arts', 'activitypub-event-extensions' ),
'PETS' => __( 'Pets', 'activitypub-event-extensions' ),
'PHOTOGRAPHY' => __( 'Photography', 'activitypub-event-extensions' ),
'OUTDOORS_ADVENTURE' => __( 'Outdoors & Adventure', 'activitypub-event-extensions' ),
'SPIRITUALITY_RELIGION_BELIEFS' => __( 'Spirituality, Religion & Beliefs', 'activitypub-event-extensions' ),
'SCIENCE_TECH' => __( 'Science & Tech', 'activitypub-event-extensions' ),
'SPORTS' => __( 'Sports', 'activitypub-event-extensions' ),
'THEATRE' => __( 'Theatre', 'activitypub-event-extensions' ),
'MEETING' => __( 'Meeting', 'activitypub-event-extensions' ), // Default value in federation.
'DEFAULT' => __( 'Default', 'activitypub-event-extensions' ), // Internal default for overrides.
);
require_once ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_DIR . '/includes/event-categories.php';
$selected_default_event_category = \get_option( 'activitypub_event_extensions_default_event_category', 'MEETING' );
$current_category_mapping = \get_option( 'activitypub_event_extensions_event_category_mappings', array() );
$selected_default_event_category = \get_option( 'activitypub_event_bridge_default_event_category', 'MEETING' );
$current_category_mapping = \get_option( 'activitypub_event_bridge_event_category_mappings', array() );
?>
<div class="activitypub-settings-header">
<div class="activitypub-settings-title-section">
<h1><?php \esc_html_e( 'ActivityPub Event Extensions', 'activitypub-event-extensions' ); ?></h1>
<h1><?php \esc_html_e( 'ActivityPub Event Bridge', 'activitypub-event-bridge' ); ?></h1>
</div>
</div>
<hr class="wp-header-end">
<div class="activitypub-settings activitypub-settings-page activitypub-event-extensions-settings-page hide-if-no-js">
<div class="activitypub-settings activitypub-settings-page activitypub-event-bridge-settings-page hide-if-no-js">
<form method="post" action="options.php">
<?php \settings_fields( 'activitypub-event-extensions' ); ?>
<?php \settings_fields( 'activitypub-event-bridge' ); ?>
<div class="box">
<h2> <?php esc_html_e( 'Default ActivityPub Event Category', 'activitypub-event-extensions' ); ?> </h2>
<p> <?php esc_html_e( 'To help visitors find events more easily, the community created a set of basic event categories. Please select the category that best matches the majority of the events you organize.', 'activitypub-event-extensions' ); ?> </p>
<h2> <?php esc_html_e( 'Default ActivityPub Event Category', 'activitypub-event-bridge' ); ?> </h2>
<p> <?php esc_html_e( 'To help visitors find events more easily, the community created a set of basic event categories. Please select the category that best matches the majority of the events you organize.', 'activitypub-event-bridge' ); ?> </p>
<table class="form-table">
<tr>
<th scope="row"> <?php esc_html_e( 'Default Category', 'activitypub-event-extensions' ); ?> </th>
<th scope="row"> <?php esc_html_e( 'Default Category', 'activitypub-event-bridge' ); ?> </th>
<td>
<select id="activitypub_event_extensions_default_event_category" name="activitypub_event_extensions_default_event_category">';
<select id="activitypub_event_bridge_default_event_category" name="activitypub_event_bridge_default_event_category">';
<?php
foreach ( $default_event_category_strings as $value => $label ) {
foreach ( ACTIVITYPUB_EVENT_BRIDGE_EVENT_CATEGORIES as $value => $label ) {
echo '<option value="' . esc_attr( $value ) . '" ' . selected( $selected_default_event_category, $value, false ) . '>' . esc_html( $label ) . '</option>';
}
?>
@ -95,14 +63,14 @@ $current_category_mapping = \get_option( 'activitypub_event_extensions_ev
<?php if ( ! empty( $event_terms ) ) : ?>
<div class="box">
<h2> <?php esc_html_e( 'Advanced Event Category Settings', 'activitypub-event-extensions' ); ?> </h2>
<p> <?php esc_html_e( 'Take more control by adjusting how your event categories are mapped to the basic category set used in ActivityPub. This option lets you override the default selection above, ensuring more accurate categorization and better visibility for your events.', 'activitypub-event-extensions' ); ?> </p>
<h2> <?php esc_html_e( 'Advanced Event Category Settings', 'activitypub-event-bridge' ); ?> </h2>
<p> <?php esc_html_e( 'Take more control by adjusting how your event categories are mapped to the basic category set used in ActivityPub. This option lets you override the default selection above, ensuring more accurate categorization and better visibility for your events.', 'activitypub-event-bridge' ); ?> </p>
<table class="form-table">
<?php foreach ( $event_terms as $event_term ) { ?>
<tr>
<th scope="row"> <?php echo esc_html( $event_term->name ); ?> </th>
<td>
<select name="activitypub_event_extensions_event_category_mappings[<?php echo esc_attr( $event_term->slug ); ?>]">
<select name="activitypub_event_bridge_event_category_mappings[<?php echo esc_attr( $event_term->slug ); ?>]">
<?php
$current_mapping_is_set = false;
if ( ! empty( $current_category_mapping ) ) {
@ -114,13 +82,13 @@ $current_category_mapping = \get_option( 'activitypub_event_extensions_ev
$mapping = 'DEFAULT';
}
if ( 'DEFAULT' === $mapping ) {
echo '<option value="' . esc_attr( $mapping ) . '"> -- ' . esc_html( $default_event_category_strings[ $mapping ] ) . ' -- </option>';
echo '<option value="' . esc_attr( $mapping ) . '"> -- ' . esc_html( ACTIVITYPUB_EVENT_BRIDGE_EVENT_CATEGORIES[ $mapping ] ) . ' -- </option>';
} else {
echo '<option value="' . esc_attr( $mapping ) . '">' . esc_html( $default_event_category_strings[ $mapping ] ) . '</option>';
echo '<option value="' . esc_attr( $mapping ) . '">' . esc_html( ACTIVITYPUB_EVENT_BRIDGE_EVENT_CATEGORIES[ $mapping ] ) . '</option>';
}
echo '<option value="DEFAULT" ' . selected( $selected_default_event_category, 'DEFAULT', false ) . '> -- ' . esc_html__( 'Default', 'activitypub-event-extensions' ) . ' -- </option>';
echo '<option value="DEFAULT" ' . selected( $selected_default_event_category, 'DEFAULT', false ) . '> -- ' . esc_html__( 'Default', 'activitypub-event-bridge' ) . ' -- </option>';
foreach ( Event::DEFAULT_EVENT_CATEGORIES as $event_category ) {
echo '<option value="' . esc_attr( $event_category ) . '" ' . selected( $mappings[ $event_term->slug ] ?? '', $event_category, false ) . '>' . esc_html( $default_event_category_strings[ $event_category ] ) . '</option>';
echo '<option value="' . esc_attr( $event_category ) . '" ' . selected( $mappings[ $event_term->slug ] ?? '', $event_category, false ) . '>' . esc_html( ACTIVITYPUB_EVENT_BRIDGE_EVENT_CATEGORIES[ $event_category ] ) . '</option>';
}
?>
</select>

View file

@ -2,7 +2,7 @@
/**
* PHPUnit bootstrap file.
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
*/
$_tests_dir = getenv( 'WP_TESTS_DIR' );
@ -78,7 +78,7 @@ function _manually_load_plugin() {
}
// At last manually load our WordPress plugin.
require dirname( __DIR__ ) . '/activitypub-event-extensions.php';
require dirname( __DIR__ ) . '/activitypub-event-bridge.php';
}
tests_add_filter( 'muplugins_loaded', '_manually_load_plugin' );

View file

@ -2,7 +2,7 @@
/**
* Class SampleTest
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
*/
/**
@ -23,7 +23,7 @@ class Test_Events_Manager extends WP_UnitTestCase {
update_option( 'dbem_events_anonymous_submissions', true );
// Make sure that ActivityPub support is enabled for Events Manager.
$aec = \Activitypub_Event_Extensions\Setup::get_instance();
$aec = \ActivityPub_Event_Bridge\Setup::get_instance();
$aec->activate_activitypub_support_for_active_event_plugins();
// Delete all posts afterwards.
@ -37,7 +37,7 @@ class Test_Events_Manager extends WP_UnitTestCase {
// We only test for one event plugin being active at the same time,
// even though we support multiple onces in theory.
// But testing all combinations is beyond scope.
$active_event_plugins = \Activitypub_Event_Extensions\Setup::get_instance()->get_active_event_plugins();
$active_event_plugins = \ActivityPub_Event_Bridge\Setup::get_instance()->get_active_event_plugins();
$this->assertEquals( 1, count( $active_event_plugins ) );
// Enable ActivityPub support for the event plugin.
@ -47,7 +47,7 @@ class Test_Events_Manager extends WP_UnitTestCase {
$wp_post_id = wp_insert_post(
array(
'post_title' => 'Events Manager Test event',
'post_status' => 'published',
'post_status' => 'publish',
'post_type' => EM_POST_TYPE_EVENT,
'meta_input' => array(
'event_start_time' => strtotime( '+10 days 15:00:00' ),
@ -61,7 +61,7 @@ class Test_Events_Manager extends WP_UnitTestCase {
$transformer = \Activitypub\Transformer\Factory::get_transformer( $wp_object );
// Check that we got the right transformer.
$this->assertInstanceOf( \Activitypub_Event_Extensions\Activitypub\Transformer\Events_Manager::class, $transformer );
$this->assertInstanceOf( \ActivityPub_Event_Bridge\Activitypub\Transformer\Events_Manager::class, $transformer );
}
/**
@ -75,7 +75,7 @@ class Test_Events_Manager extends WP_UnitTestCase {
$event->event_start_date = gmdate( 'Y-m-d', strtotime( '+10 days 15:00:00' ) );
$event->event_start_time = '15:00:00';
$event->start = strtotime( $event->event_start_date . ' ' . $event->event_start_time );
$event->force_status = 'published';
$event->force_status = 'publish';
$event->event_rsvp = false;
$this->assertTrue( $event->save() );
@ -85,7 +85,7 @@ class Test_Events_Manager extends WP_UnitTestCase {
// Check that we got the right transformer.
$this->assertEquals( 'Event', $event_array['type'] );
$this->assertEquals( 'Events Manager Test event', $event_array['name'] );
$this->assertEquals( '', $event_array['content'] );
$this->assertEquals( 'Event description', wp_strip_all_tags( $event_array['content'] ) );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 15:00:00' ) ) . 'T15:00:00Z', $event_array['startTime'] );
$this->assertEquals( comments_open( $event->post_id ), $event_array['commentsEnabled'] );
$this->assertEquals( comments_open( $event->post_id ) ? 'allow_all' : 'closed', $event_array['repliesModerationOption'] );
@ -121,7 +121,7 @@ class Test_Events_Manager extends WP_UnitTestCase {
$event->event_end_time = '16:00:00';
$event->start = strtotime( $event->event_start_date . ' ' . $event->event_start_time );
$event->end = strtotime( $event->event_end_date . ' ' . $event->event_end_time );
$event->force_status = 'published';
$event->force_status = 'publish';
$event->event_rsvp = false;
$this->assertTrue( $event->save() );
@ -131,7 +131,7 @@ class Test_Events_Manager extends WP_UnitTestCase {
// Check that we got the right transformer.
$this->assertEquals( 'Event', $event_array['type'] );
$this->assertEquals( 'Events Manager Test event', $event_array['name'] );
$this->assertEquals( '', $event_array['content'] );
$this->assertEquals( 'Event description', wp_strip_all_tags( $event_array['content'] ) );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 15:00:00' ) ) . 'T15:00:00Z', $event_array['startTime'] );
$this->assertEquals( 'external', $event_array['joinMode'] );
$this->assertEquals( 'MEETING', $event_array['category'] );
@ -164,7 +164,7 @@ class Test_Events_Manager extends WP_UnitTestCase {
$event->event_end_time = '16:00:00';
$event->start = strtotime( $event->event_start_date . ' ' . $event->event_start_time );
$event->end = strtotime( $event->event_end_date . ' ' . $event->event_end_time );
$event->force_status = 'published';
$event->force_status = 'publish';
$event->event_rsvp = false;
$this->assertTrue( $event->save() );
@ -174,7 +174,7 @@ class Test_Events_Manager extends WP_UnitTestCase {
// Check that we got the right transformer.
$this->assertEquals( 'Event', $event_array['type'] );
$this->assertEquals( 'Events Manager Test event', $event_array['name'] );
$this->assertEquals( '', $event_array['content'] );
$this->assertEquals( 'Event description', wp_strip_all_tags( $event_array['content'] ) );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 15:00:00' ) ) . 'T15:00:00Z', $event_array['startTime'] );
$this->assertEquals( 'external', $event_array['joinMode'] );
$this->assertEquals( 'MEETING', $event_array['category'] );

View file

@ -2,7 +2,7 @@
/**
* Class SampleTest
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
*/
/**
@ -23,7 +23,7 @@ class Test_GatherPress extends WP_UnitTestCase {
GatherPress\Core\Setup::get_instance()->activate_gatherpress_plugin( false );
// Make sure that ActivityPub support is enabled for The Events Calendar.
$aec = \Activitypub_Event_Extensions\Setup::get_instance();
$aec = \ActivityPub_Event_Bridge\Setup::get_instance();
$aec->activate_activitypub_support_for_active_event_plugins();
// Delete all posts afterwards.
@ -37,7 +37,7 @@ class Test_GatherPress extends WP_UnitTestCase {
// We only test for one event plugin being active at the same time,
// even though we support multiple onces in theory.
// But testing all combinations is beyond scope.
$active_event_plugins = \Activitypub_Event_Extensions\Setup::get_instance()->get_active_event_plugins();
$active_event_plugins = \ActivityPub_Event_Bridge\Setup::get_instance()->get_active_event_plugins();
$this->assertEquals( 1, count( $active_event_plugins ) );
// Enable ActivityPub support for the event plugin.
@ -49,6 +49,7 @@ class Test_GatherPress extends WP_UnitTestCase {
'post_title' => 'Unit Test Event',
'post_type' => 'gatherpress_event',
'post_content' => 'Unit Test description.',
'post_status' => 'publish',
)
);
$event = new \GatherPress\Core\Event( $post_id );
@ -64,7 +65,7 @@ class Test_GatherPress extends WP_UnitTestCase {
$transformer = \Activitypub\Transformer\Factory::get_transformer( $event->event );
// Check that we got the right transformer.
$this->assertInstanceOf( \Activitypub_Event_Extensions\Activitypub\Transformer\GatherPress::class, $transformer );
$this->assertInstanceOf( \ActivityPub_Event_Bridge\Activitypub\Transformer\GatherPress::class, $transformer );
}
/**
@ -77,7 +78,7 @@ class Test_GatherPress extends WP_UnitTestCase {
'post_title' => 'Unit Test Event',
'post_type' => 'gatherpress_event',
'post_content' => 'Unit Test description.',
'post_status' => 'published',
'post_status' => 'publish',
)
);
$event = new \GatherPress\Core\Event( $post_id );
@ -94,7 +95,7 @@ class Test_GatherPress extends WP_UnitTestCase {
// Check that the event ActivityStreams representation contains everything as expected.
$this->assertEquals( 'Event', $event_array['type'] );
$this->assertEquals( 'Unit Test Event', $event_array['name'] );
$this->assertEquals( 'Unit Test description.', $event_array['content'] );
$this->assertEquals( 'Unit Test description.', wp_strip_all_tags( $event_array['content'] ) );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 15:00:00' ) ) . 'T15:00:00Z', $event_array['startTime'] );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 16:00:00' ) ) . 'T16:00:00Z', $event_array['endTime'] );
$this->assertEquals( 'external', $event_array['joinMode'] );

View file

@ -2,7 +2,7 @@
/**
* Class SampleTest
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
*/
/**
@ -37,14 +37,14 @@ class Test_The_Events_Calendar extends WP_UnitTestCase {
public const MOCKUP_EVENTS = array(
'minimal_event' => array(
'title' => 'My Event',
'content' => 'Come to my event. Let\'s connect!',
'content' => 'Come to my event!',
'start_date' => '+10 days 15:00:00',
'duration' => HOUR_IN_SECONDS,
'status' => 'publish',
),
'complex_event' => array(
'title' => 'My Event',
'content' => 'Come to my event. Let\'s connect!',
'content' => 'Come to my event!',
'start_date' => '+10 days 15:00:00',
'duration' => HOUR_IN_SECONDS,
'status' => 'publish',
@ -62,7 +62,7 @@ class Test_The_Events_Calendar extends WP_UnitTestCase {
}
// Make sure that ActivityPub support is enabled for The Events Calendar.
$aec = \Activitypub_Event_Extensions\Setup::get_instance();
$aec = \ActivityPub_Event_Bridge\Setup::get_instance();
$aec->activate_activitypub_support_for_active_event_plugins();
// Delete all posts afterwards.
@ -76,7 +76,7 @@ class Test_The_Events_Calendar extends WP_UnitTestCase {
// We only test for one event plugin being active at the same time,
// even though we support multiple onces in theory.
// But testing all combinations is beyond scope.
$active_event_plugins = \Activitypub_Event_Extensions\Setup::get_instance()->get_active_event_plugins();
$active_event_plugins = \ActivityPub_Event_Bridge\Setup::get_instance()->get_active_event_plugins();
$this->assertEquals( 1, count( $active_event_plugins ) );
// Enable ActivityPub support for the event plugin.
@ -91,7 +91,7 @@ class Test_The_Events_Calendar extends WP_UnitTestCase {
$transformer = \Activitypub\Transformer\Factory::get_transformer( $wp_object );
// Check that we got the right transformer.
$this->assertInstanceOf( \Activitypub_Event_Extensions\Activitypub\Transformer\The_Events_Calendar::class, $transformer );
$this->assertInstanceOf( \ActivityPub_Event_Bridge\Activitypub\Transformer\The_Events_Calendar::class, $transformer );
}
/**
@ -109,7 +109,7 @@ class Test_The_Events_Calendar extends WP_UnitTestCase {
// Check that the event ActivityStreams representation contains everything as expected.
$this->assertEquals( 'Event', $event_array['type'] );
$this->assertEquals( 'My Event', $event_array['name'] );
$this->assertEquals( '', $event_array['content'] );
$this->assertEquals( 'Come to my event!', wp_strip_all_tags( $event_array['content'] ) );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 15:00:00' ) ) . 'T15:00:00Z', $event_array['startTime'] );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 16:00:00' ) ) . 'T16:00:00Z', $event_array['endTime'] );
$this->assertTrue( $event_array['commentsEnabled'] );
@ -128,10 +128,10 @@ class Test_The_Events_Calendar extends WP_UnitTestCase {
$category_id_theatre = wp_insert_term( 'Theatre', Tribe__Events__Main::TAXONOMY, array( 'slug' => 'theatre' ) );
// Set default mapping for event categories.
update_option( 'activitypub_event_extensions_default_event_category', 'MUSIC' );
update_option( 'activitypub_event_bridge_default_event_category', 'MUSIC' );
// Set an override for the category with the slug theatre.
update_option( 'activitypub_event_extensions_event_category_mappings', array( 'theatre' => 'THEATRE' ) );
update_option( 'activitypub_event_bridge_event_category_mappings', array( 'theatre' => 'THEATRE' ) );
// Create a The Events Calendar event with the music category.
$wp_object = tribe_events()
@ -170,7 +170,7 @@ class Test_The_Events_Calendar extends WP_UnitTestCase {
// Check that the event ActivityStreams representation contains everything as expected.
$this->assertEquals( 'Event', $event_array['type'] );
$this->assertEquals( 'My Event', $event_array['name'] );
$this->assertEquals( '', $event_array['content'] );
$this->assertEquals( 'Come to my event!', wp_strip_all_tags( $event_array['content'] ) );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 15:00:00' ) ) . 'T15:00:00Z', $event_array['startTime'] );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 16:00:00' ) ) . 'T16:00:00Z', $event_array['endTime'] );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 16:00:00' ) ) . 'T16:00:00Z', $event_array['commentsEnabled'] );
@ -197,7 +197,7 @@ class Test_The_Events_Calendar extends WP_UnitTestCase {
// Check that the event ActivityStreams representation contains everything as expected.
$this->assertEquals( 'Event', $event_array['type'] );
$this->assertEquals( 'My Event', $event_array['name'] );
$this->assertEquals( '', $event_array['content'] );
$this->assertEquals( 'Come to my event!', wp_strip_all_tags( $event_array['content'] ) );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 15:00:00' ) ) . 'T15:00:00Z', $event_array['startTime'] );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 16:00:00' ) ) . 'T16:00:00Z', $event_array['endTime'] );
$this->assertEquals( gmdate( 'Y-m-d', strtotime( '+10 days 16:00:00' ) ) . 'T16:00:00Z', $event_array['commentsEnabled'] );

View file

@ -2,7 +2,7 @@
/**
* Class SampleTest
*
* @package Activitypub_Event_Extensions
* @package ActivityPub_Event_Bridge
*/
/**
@ -20,7 +20,7 @@ class Test_VS_Event_List extends WP_UnitTestCase {
}
// Make sure that ActivityPub support is enabled for The Events Calendar.
$aec = \Activitypub_Event_Extensions\Setup::get_instance();
$aec = \ActivityPub_Event_Bridge\Setup::get_instance();
$aec->activate_activitypub_support_for_active_event_plugins();
// Delete all posts afterwards.
@ -34,7 +34,7 @@ class Test_VS_Event_List extends WP_UnitTestCase {
// We only test for one event plugin being active at the same time,
// even though we support multiple onces in theory.
// But testing all combinations is beyond scope.
$active_event_plugins = \Activitypub_Event_Extensions\Setup::get_instance()->get_active_event_plugins();
$active_event_plugins = \ActivityPub_Event_Bridge\Setup::get_instance()->get_active_event_plugins();
$this->assertEquals( 1, count( $active_event_plugins ) );
// Enable ActivityPub support for the event plugin.
@ -58,7 +58,7 @@ class Test_VS_Event_List extends WP_UnitTestCase {
$transformer = \Activitypub\Transformer\Factory::get_transformer( $wp_object );
// Check that we got the right transformer.
$this->assertInstanceOf( \Activitypub_Event_Extensions\Activitypub\Transformer\VS_Event_List::class, $transformer );
$this->assertInstanceOf( \ActivityPub_Event_Bridge\Activitypub\Transformer\VS_Event_List::class, $transformer );
}
/**
@ -173,10 +173,10 @@ class Test_VS_Event_List extends WP_UnitTestCase {
$category_id_theatre = wp_insert_term( 'Theatre', 'event_cat', array( 'slug' => 'theatre' ) );
// Set default mapping for event categories.
update_option( 'activitypub_event_extensions_default_event_category', 'MUSIC' );
update_option( 'activitypub_event_bridge_default_event_category', 'MUSIC' );
// Set an override for the category with the slug theatre.
update_option( 'activitypub_event_extensions_event_category_mappings', array( 'theatre' => 'THEATRE' ) );
update_option( 'activitypub_event_bridge_event_category_mappings', array( 'theatre' => 'THEATRE' ) );
// Create a VS Event List event with the music category.
$wp_post_id = wp_insert_post(