diff --git a/.distignore b/.distignore new file mode 100644 index 0000000..471f8fb --- /dev/null +++ b/.distignore @@ -0,0 +1,24 @@ +.distignore +.git +.gitignore +.wordpress-org +.wp-env.json +bin +CHANGELOG.md +CODE_OF_CONDUCT.md +composer.json +composer.lock +docker-compose.yml +Dockerfile +docs +FEDERATION.md +Gruntfile.js +node_modules +package.json +package-lock.json +phpcs.xml +phpunit.xml +README.md +src +tests +vendor diff --git a/.forgejo/workflows/phpunit.yml b/.forgejo/workflows/phpunit.yml index 10d25e1..f8e08ac 100644 --- a/.forgejo/workflows/phpunit.yml +++ b/.forgejo/workflows/phpunit.yml @@ -21,7 +21,8 @@ jobs: MYSQL_ROOT_PASSWORD: root strategy: matrix: - php-version: ['8.1', '8.2', '8.3'] + php-version: ['7.4', '8.0', '8.1', '8.2', '8.3'] + wordpress-version: ['6.7'] name: PHPUnit – PHP ${{ matrix.php-version }} env: extensions: mysql @@ -37,7 +38,7 @@ jobs: path: | ${{ env.WP_CORE_DIR }} ${{ env.WP_TESTS_DIR }} - key: cache-wordpress-10 + key: cache-wordpress-67-2 - name: Cache Composer id: cache-composer-phpunit @@ -45,7 +46,7 @@ jobs: with: path: | ./vendor/ - key: cache-composer-phpunit-1 + key: cache-composer-phpunit-2 - name: Setup PHP uses: https://github.com/shivammathur/setup-php@v2 @@ -68,11 +69,11 @@ jobs: - name: Setup Test Environment if: steps.cache-wordpress.outputs.cache-hit != 'true' - run: bash bin/install-wp-tests.sh wordpress_test root root 127.0.0.1 6.6 false false false false + run: bash bin/install-wp-tests.sh wordpress_test root root 127.0.0.1 ${{ matrix.wordpress-version }} false false false false - name: Initialize WordPress test database if: steps.cache-wordpress.outputs.cache-hit != 'false' - run: bash bin/install-wp-tests.sh wordpress_test root root 127.0.0.1 6.6 false true true true + run: bash bin/install-wp-tests.sh wordpress_test root root 127.0.0.1 ${{ matrix.wordpress-version }} false true true true - name: Run Integration tests for The Events Calendar run: cd /workspace/Event-Federation/wordpress-activitypub-event-bridge/ && ./vendor/bin/phpunit --filter=the_events_calendar diff --git a/.forgejo/workflows/release.yml b/.forgejo/workflows/release.yml new file mode 100644 index 0000000..6aaf1ad --- /dev/null +++ b/.forgejo/workflows/release.yml @@ -0,0 +1,16 @@ +on: + push: + tags: 'v*' + +jobs: + upload-release: + runs-on: ubuntu-latest + steps: + - uses: https://code.forgejo.org/actions/checkout@v4 + + - uses: https://code.forgejo.org/actions/forgejo-release@v2 + with: + direction: upload + url: https://code.event-federation.eu + release-notes: ${{ TAG }} + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..ae639c6 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,23 @@ +.distignore export-ignore +.forgejo export-ignore +.gitattributes export-ignore +.gitignore export-ignore +.wp-env.json export-ignore +bin export-ignore +CODE_OF_CONDUCT.md export-ignore +composer.json export-ignore +composer.lock export-ignore +docker-compose.yml export-ignore +Dockerfile export-ignore +docs export-ignore +FEDERATION.md export-ignore +Gruntfile.js export-ignore +node_modules export-ignore +package.json export-ignore +package-lock.json export-ignore +phpcs.xml export-ignore +phpunit.xml export-ignore +README.md export-ignore +src export-ignore +tests export-ignore +vendor export-ignore diff --git a/.gitignore b/.gitignore index c9c0c3f..e9adf39 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ vendor/ composer.lock .phpunit.result.cache node_modules/ +package-lock.json diff --git a/.wordpress-org/banner-1544x500.jpg b/.wordpress-org/banner-1544x500.jpg index 0f1839b..ca4af3e 100644 Binary files a/.wordpress-org/banner-1544x500.jpg and b/.wordpress-org/banner-1544x500.jpg differ diff --git a/.wordpress-org/banner-772x250.jpg b/.wordpress-org/banner-772x250.jpg index 9f5a437..ca59aa2 100644 Binary files a/.wordpress-org/banner-772x250.jpg and b/.wordpress-org/banner-772x250.jpg differ diff --git a/.wordpress-org/event-activitypub-publishing.gif b/.wordpress-org/event-activitypub-publishing.gif index 8d57db0..e2ca178 100644 Binary files a/.wordpress-org/event-activitypub-publishing.gif and b/.wordpress-org/event-activitypub-publishing.gif differ diff --git a/.wordpress-org/icon-128x128.gif b/.wordpress-org/icon-128x128.gif index 25ebcc0..d9d905f 100644 Binary files a/.wordpress-org/icon-128x128.gif and b/.wordpress-org/icon-128x128.gif differ diff --git a/.wordpress-org/icon-256x256.gif b/.wordpress-org/icon-256x256.gif index 9385c37..68b90db 100644 Binary files a/.wordpress-org/icon-256x256.gif and b/.wordpress-org/icon-256x256.gif differ diff --git a/CHANGELOG.md b/CHANGELOG.md index 9a605a7..b1f6405 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,8 +5,18 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [0.1.0] - 2024-10-20 +## [0.2.1] - 2024-11-16 ### Added -* Initial version tag. +* Initial release on WordPress.org + +### Fixed + +* Applied some WordPress best practices + +## [0.2.0] - 2024-10-20 + +### Added + +* Initial submission to WordPress.org diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9d367c6 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,126 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement via email to +simon@fdpl.io. All complaints will be reviewed and investigated fairly +and as soon as personal time and energy of community leaders permits. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html). + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at +[https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). diff --git a/Gruntfile.js b/Gruntfile.js new file mode 100644 index 0000000..df4eb26 --- /dev/null +++ b/Gruntfile.js @@ -0,0 +1,59 @@ +module.exports = function (grunt) { + // Project configuration. + grunt.initConfig( + { + checktextdomain: { + options:{ + text_domain: 'activitypub-event-bridge', + keywords: [ + '__:1,2d', + '_e:1,2d', + '_x:1,2c,3d', + 'esc_html__:1,2d', + 'esc_html_e:1,2d', + 'esc_html_x:1,2c,3d', + 'esc_attr__:1,2d', + 'esc_attr_e:1,2d', + 'esc_attr_x:1,2c,3d', + '_ex:1,2c,3d', + '_n:1,2,4d', + '_nx:1,2,4c,5d', + '_n_noop:1,2,3d', + '_nx_noop:1,2,3c,4d' + ] + }, + files: { + src: [ + '**/*.php', // Include all files + '!sass/**', // Exclude sass/ + '!node_modules/**', // Exclude node_modules/ + '!tests/**', // Exclude tests/ + '!vendor/**', // Exclude vendor/ + '!build/**', // Exclude build/ + '!static/**', // Exclude static resources + ], + expand: true + } + }, + + wp_readme_to_markdown: { + target: { + files: { + 'README.md': 'readme.txt' + }, + }, + options: { + pre_convert: function ( readme ) { + return readme.replace( /\*\*Note\*\*:/g, "> [!NOTE]\n>" ); + } + } + } + } + ); + + grunt.loadNpmTasks( 'grunt-wp-readme-to-markdown' ); + grunt.loadNpmTasks( 'grunt-checktextdomain' ); + + // Default task(s). + grunt.registerTask( 'default', ['wp_readme_to_markdown', 'checktextdomain'] ); +}; \ No newline at end of file diff --git a/README.md b/README.md index 07aceea..023e5c2 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,48 @@ -# 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 - +# ActivityPub Event Bridge # +**Contributors:** [andremenrath](https://profiles.wordpress.org/andremenrath/) +**Tags:** events, fediverse, activitypub, calendar +**Requires at least:** 6.5 +**Tested up to:** 6.7 +**Stable tag:** 0.2.1 +**Requires PHP:** 7.4 +**License:** AGPL-3.0-or-later +**License URI:** https://www.gnu.org/licenses/agpl-3.0.html Integrating popular event plugins with the ActivityPub plugin. -![](.wordpress-org/banner-1544x500.jpg) +![Federate your Events, Expand your Reach!](.wordpress-org/banner-1544x500.jpg) -## Description +## Description ## Make your events more discoverable, expand your reach effortlessly while being independent of other (commercial) platforms, and be a part of the growing decentralized web (the Fediverse). -With the ActivityPub Event Bridge plugin for WordPress, your events can be automatically followed, aggregated and displayed across decentralized platforms like [Mastodon](https://joinmastodon.org) or [Gancio](https://gancio.org), without any extra work. +With the 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 +### 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.

- Logo + Logo

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

- Logo + Logo

Even platforms that don't yet fully support events, like [Mastodon](https://joinmastodon.org), will still receive a detailed, well-composed summary of your event. The Event Federation plugin ensures that users from those platforms are provided with all important information about an event. -### Features for Your WordPress Events and the Fediverse +### Features for Your WordPress Events and the Fediverse ### -**ActivityPub-Enabled Event Sharing:** Your WordPress events are not part of the Fediverse and +**ActivityPub-Enabled Event Sharing:** Your WordPress events are now compatible with the Fediverse, using the ActivityStreams format. This means your events can be easily discovered and followed by users on platforms like Mastodon and other ActivityPub-compatible services. **Automatic Event Summaries:** When your event is shared on the Fediverse, platforms like Mastodon that don't fully support events will display a brief HTML summary of key details — such as the event's title, start time, and location. This ensures that even if someone can't view the full event on their platform, they still get the important info at a glance, with a link to your WordPress event page. @@ -52,11 +50,11 @@ The Event Federation plugin ensures that users from those platforms are provided **Event Reminders for Your Followers:** Often, events are planned well in advance. To keep your followers informed right in time, you can set up reminders that are supposed to trigger the events showing up in their timelines right before the event starts. At the moment this reminder is implemented as a self-boost of your original event post. While this feature may behave differently across various platforms, we are working on a more robust solution that will let you schedule dedicated reminder notes that appear in all followers' timelines. -## Installation +## Installation ## -This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). Additionally, you need to use one of the supported event plugins. See below. +This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/). Additionally, you need to use one of the supported event Plugins. -### 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/) @@ -66,41 +64,46 @@ This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/ac * [Modern Events Calendar Lite](https://webnus.net/modern-events-calendar/) * [GatherPress](https://gatherpress.org/) -## Configuration +## Configuration ## -If you’re new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), it’s recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality. +If you're new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), it’s recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality. -## Frequently Asked Questions +## Frequently Asked Questions ## -### Do I need to install another event plugin to use the Event Federation plugin? +### Do I need to install another event plugin to use the Event Federation Plugin? ### Yes, this plugin works 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 don’t fully support events yet, will display all important information about the events. +### What platforms can follow my events? ### -### How much extra work is required to maintain my events across the decentralized Web? +Your events can be followed on platforms that support ActivityPub like [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). Even other applications like [Mastodon](https://joinmastodon.org), which don't fully support events yet, will display all important information about the events. + +### How much extra work is required to maintain my events across the decentralized Web? ### 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? +### 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? +### Will this plugin work if I don't use the ActivityPub plugin? ### -No, the Event Federation plugin depends on the ActivityPub plugin to deliver your events across decentralized platforms, so it's essential to have it installed and configured. +No, the Event Federation Plugin depends on the [ActivityPub plugin](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? +### 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? +### 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 +## Changelog ## -### [0.1.0] 2024-10-01 +### [0.2.1] 2024-11-16 ### -* Initial alpha release on WordPress.org +* Initial release on https://wordpress.org/ + +### [0.2.0] 2024-10-29 ### + +* Initial submission to https://wordpress.org/ diff --git a/activitypub-event-bridge.php b/activitypub-event-bridge.php index b1cb2ea..961af39 100644 --- a/activitypub-event-bridge.php +++ b/activitypub-event-bridge.php @@ -3,15 +3,15 @@ * Plugin Name: ActivityPub Event Bridge * Description: Integrating popular event plugins with the ActivityPub plugin. * Plugin URI: https://event-federation.eu/ - * Version: 0.1.1 + * Version: 0.2.1 * 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 + * License URI: https://www.gnu.org/licenses/agpl-3.0.html + * Requires PHP: 7.4 * - * Requires at least ActivityPub plugin with version >= 3.2.2. ActivityPub plugin tested up to: 3.3.3. + * Requires at least ActivityPub plugin with version >= 3.2.2. ActivityPub plugin tested up to: 4.2.0. * * @package ActivityPub_Event_Bridge * @license AGPL-3.0-or-later diff --git a/bin/install-wp-tests.sh b/bin/install-wp-tests.sh index 728aa58..26eb82a 100755 --- a/bin/install-wp-tests.sh +++ b/bin/install-wp-tests.sh @@ -208,9 +208,15 @@ install_wp_plugin() { fi # Get the latest tag. - LATEST_TAG=$(svn log https://plugins.svn.wordpress.org/$PLUGIN_NAME/tags --limit 1 | awk 'NR == 4 { print $4 }' | sed 's/,$//') - if [ -n "$LATEST_TAG" ]; then - PLUGIN_FILE="$PLUGIN_NAME.$LATEST_TAG.zip" + if [ -z "$2" ]; then + LATEST_TAG=$(svn log https://plugins.svn.wordpress.org/$PLUGIN_NAME/tags --limit 1 | awk 'NR == 4 { print $4 }' | sed 's/,$//') + PLUGIN_VERSION=$LATEST_TAG + else + PLUGIN_VERSION=$2 + fi + + if [ -n "$PLUGIN_VERSION" ]; then + PLUGIN_FILE="$PLUGIN_NAME.$PLUGIN_VERSION.zip" else PLUGIN_FILE="$PLUGIN_NAME.zip" fi @@ -248,13 +254,14 @@ install_wp_plugins() { # Install the one and only ActivityPub plugin (greetings @pfefferle). install_wp_plugin activitypub # Install (not-activate) all supported event plugins. - install_wp_plugin the-events-calendar + install_wp_plugin the-events-calendar "6.8.1" install_wp_plugin very-simple-event-list install_wp_plugin gatherpress install_wp_plugin events-manager - install_wp_plugin wp-event-manager - install_wp_plugin wp-event-solution install_wp_plugin my-calendar + install_wp_plugin events-manager "6.6.3" + install_wp_plugin wp-event-manager "3.1.45.1" + install_wp_plugin wp-event-solution "4.0.14" # Mec is not installable via wordpress.org, we use our own mirror. install_wp_plugin_mec } diff --git a/composer.json b/composer.json index 5e21aaa..1f836c3 100644 --- a/composer.json +++ b/composer.json @@ -4,7 +4,7 @@ "description": "The ActivityPub Event Bridge help for event custom post types to federate properly.", "type": "wordpress-plugin", "require": { - "php": ">=8.1.0", + "php": ">=7.4.0", "composer/installers": "^2.0" }, "require-dev": { diff --git a/docs/add_your_event_plugin.md b/docs/add_your_event_plugin.md index 44ec1f4..165f285 100644 --- a/docs/add_your_event_plugin.md +++ b/docs/add_your_event_plugin.md @@ -180,7 +180,7 @@ In the pipeline we want to run each event plugins integration tests in a single To activate/load your plugin add it to the switch statement within the function `_manually_load_plugin()` within `tests/bootstrap.php`. ```php - switch ( $activitypub_event_extension_integration_filter ) { + switch ( $activitypub_event_bridge_integration_filter ) { ... case 'my_event_plugin': $plugin_file = 'my-event-plugin/my-event-plugin.php'; diff --git a/improvements.md b/improvements.md deleted file mode 100644 index c095490..0000000 --- a/improvements.md +++ /dev/null @@ -1,16 +0,0 @@ -Make use of: - -https://docs.theeventscalendar.com/reference/classes/tribe__events__api/get_event_terms/ - -for getting all tags/terms for an event! - -``` -public static function get_event_terms( $event_id, array $args = array() ) { - $terms = array(); - foreach ( get_post_taxonomies( $event_id ) as $taxonomy ) { - $tax_terms = wp_get_object_terms( $event_id, $taxonomy, $args ); - $terms[ $taxonomy ] = $tax_terms; - } - return $terms; -} -``` diff --git a/includes/activitypub/transformer/class-the-events-calendar.php b/includes/activitypub/transformer/class-the-events-calendar.php index 2fe7274..f50fa29 100644 --- a/includes/activitypub/transformer/class-the-events-calendar.php +++ b/includes/activitypub/transformer/class-the-events-calendar.php @@ -121,9 +121,9 @@ final class The_Events_Calendar extends Event { /** * Get the event location. * - * @return Place|array The place/venue if one is set. + * @return ?Place The place/venue if one is set. */ - public function get_location(): Place|null { + public function get_location(): ?Place { // Get short handle for the venues. $venues = $this->tribe_event->venues; diff --git a/includes/admin/class-health-check.php b/includes/admin/class-health-check.php index 5fa3f9a..daaa0e0 100644 --- a/includes/admin/class-health-check.php +++ b/includes/admin/class-health-check.php @@ -47,7 +47,7 @@ class Health_Check { */ public static function test_event_transformation() { $result = array( - 'label' => \__( 'Transformation of Events to a valid ActivityStreams representation.', 'activitypub' ), + 'label' => \__( 'Transformation of Events to a valid ActivityStreams representation.', 'activitypub-event-bridge' ), 'status' => 'good', 'badge' => array( 'label' => \__( 'ActivityPub Event Bridge', 'activitypub-event-bridge' ), @@ -172,7 +172,7 @@ class Health_Check { 'label' => __( 'ActivityPub Event Bridge', 'activitypub-event-bridge' ), 'fields' => array( 'plugin_version' => array( - 'label' => __( 'Plugin Version', 'activitypub' ), + 'label' => __( 'Plugin Version', 'activitypub-event-bridge' ), 'value' => ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_VERSION, 'private' => true, ), diff --git a/includes/class-settings.php b/includes/class-settings.php index 3367dd1..6cd7d2e 100644 --- a/includes/class-settings.php +++ b/includes/class-settings.php @@ -44,7 +44,7 @@ class Settings { 'activitypub_event_bridge_default_event_category', array( 'type' => 'string', - 'description' => \__( 'Define your own custom post template', 'activitypub' ), + 'description' => \__( 'Define your own custom post template', 'activitypub-event-bridge' ), 'show_in_rest' => true, 'default' => self::DEFAULT_EVENT_CATEGORY, 'sanitize_callback' => array( self::class, 'sanitize_mapped_event_category' ), @@ -56,7 +56,7 @@ class Settings { 'activitypub_event_bridge_event_category_mappings', array( 'type' => 'array', - 'description' => \__( 'Define your own custom post template', 'activitypub' ), + 'description' => \__( 'Define your own custom post template', 'activitypub-event-bridge' ), 'default' => array(), 'sanitize_callback' => array( self::class, 'sanitize_event_category_mappings' ), ) @@ -67,7 +67,7 @@ class Settings { 'activitypub_event_bridge_initially_activated', array( 'type' => 'boolean', - 'description' => \__( 'Whether the plugin just got activated for the first time.', 'activitypub' ), + 'description' => \__( 'Whether the plugin just got activated for the first time.', 'activitypub-event-bridge' ), 'default' => 1, ) ); diff --git a/includes/class-setup.php b/includes/class-setup.php index c717619..1e0c801 100644 --- a/includes/class-setup.php +++ b/includes/class-setup.php @@ -253,7 +253,7 @@ class Setup { * * @return \Activitypub\Transformer\Base|null */ - public function register_activitypub_event_transformer( $transformer, $wp_object, $object_class ): \Activitypub\Transformer\Base|null { + public function register_activitypub_event_transformer( $transformer, $wp_object, $object_class ): \Activitypub\Transformer\Base { // If the current WordPress object is not a post (e.g., a WP_Comment), don't change the transformer. if ( 'WP_Post' !== $object_class ) { return $transformer; diff --git a/includes/plugins/class-modern-events-calendar-lite.php b/includes/plugins/class-modern-events-calendar-lite.php index 796634d..45f060f 100644 --- a/includes/plugins/class-modern-events-calendar-lite.php +++ b/includes/plugins/class-modern-events-calendar-lite.php @@ -38,7 +38,7 @@ final class Modern_Events_Calendar_Lite extends Event_plugin { */ public static function get_post_type(): string { // See MEC_feature_events->get_main_post_type(). - return apply_filters( 'mec_post_type_name', 'mec-events' ); // phpcs:ignore + return 'mec-events'; } /** diff --git a/package.json b/package.json new file mode 100644 index 0000000..4db7d96 --- /dev/null +++ b/package.json @@ -0,0 +1,29 @@ + +{ + "name": "activitypub-event-bridge", + "version": "0.1.0", + "author": { + "name": "André Menrath", + "web": "https://graz.social/@linos" + }, + "scripts": { + "dev": "wp-scripts start", + "build": "wp-scripts build", + "readme": "grunt wp_readme_to_markdown", + "env-start": "wp-env start && wp-env run cli wp rewrite structure '/%year%/%monthnum%/%postname%/'", + "env-stop": "wp-env stop" + }, + "license": "AGPL-3.0", + "bugs": { + "url": "https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge/issues" + }, + "devDependencies": { + "@wordpress/env": "^10.10.0", + "@wordpress/scripts": "^30.0.2", + "classnames": "^2.3.2", + "grunt": "^1.1.0", + "grunt-checktextdomain": "^1.0.1", + "grunt-wp-i18n": "^1.0.3", + "grunt-wp-readme-to-markdown": "^2.0.1" + } +} \ No newline at end of file diff --git a/phpcs.xml b/phpcs.xml index cf1bc1b..e1ef42c 100644 --- a/phpcs.xml +++ b/phpcs.xml @@ -29,6 +29,9 @@ *.min.js + + Gruntfile.js + diff --git a/readme.txt b/readme.txt index d0b9c7e..66ef1b9 100644 --- a/readme.txt +++ b/readme.txt @@ -2,9 +2,9 @@ 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 +Tested up to: 6.7 +Stable tag: 0.2.1 +Requires PHP: 7.4 License: AGPL-3.0-or-later License URI: https://www.gnu.org/licenses/agpl-3.0.html Integrating popular event plugins with the ActivityPub plugin. @@ -31,6 +31,8 @@ These platforms create public event calendars by pulling in events from various ![](./.wordpress-org/decentralized-event-calenders.gif) +Even platforms that don't yet fully support events, like [Mastodon](https://joinmastodon.org), will still receive a detailed, well-composed summary of your event. +The Event Federation plugin ensures that users from those platforms are provided with all important information about an event. = Features for Your WordPress Events and the Fediverse = @@ -58,17 +60,17 @@ This plugin depends on the [ActivityPub plugin](https://wordpress.org/plugins/ac == Configuration == -If you’re new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), it’s recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality. +If you're new to the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/), it’s recommended to spend a few minutes reading through its documentation to familiarize yourself with its setup and functionality. == 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. +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 don’t fully support events yet, will display all important information about the events. +Your events can be followed on platforms that support ActivityPub like [Mobilizon](https://joinmobilizon.org/), [Gancio](https://gancio.org), [Friendica](https://friendi.ca), [Hubzilla](https://hubzilla.org), and [Pleroma](https://pleroma.social/). Even other applications like [Mastodon](https://joinmastodon.org), which don't fully support events yet, will display all important information about the events. = How much extra work is required to maintain my events across the decentralized Web? = @@ -92,6 +94,10 @@ We're always interested in your feedback. Feel free to reach out to us via [E-Ma == Changelog == -= [0.1.0] 2024-09-01 = += [0.2.1] 2024-11-16 = -* Initial alpha release on WordPress.org +* Initial release on https://wordpress.org/ + += [0.2.0] 2024-10-29 = + +* Initial submission to https://wordpress.org/ diff --git a/templates/admin-header.php b/templates/admin-header.php index efc02bc..4ee283b 100644 --- a/templates/admin-header.php +++ b/templates/admin-header.php @@ -5,6 +5,9 @@ * @package ActivityPub_Event_Bridge */ +// Exit if accessed directly. +defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore + /* @var array $args Template arguments. */ $args = wp_parse_args( $args, diff --git a/tests/bootstrap.php b/tests/bootstrap.php index a3afd79..6d34003 100755 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -35,10 +35,10 @@ function _manually_load_plugin() { require_once $plugin_dir . 'activitypub/activitypub.php'; // Capture the --filter argument. - $activitypub_event_extension_integration_filter = null; + $activitypub_event_bridge_integration_filter = null; foreach ( $_SERVER['argv'] as $arg ) { if ( strpos( $arg, '--filter=' ) === 0 ) { - $activitypub_event_extension_integration_filter = substr( $arg, strlen( '--filter=' ) ); + $activitypub_event_bridge_integration_filter = substr( $arg, strlen( '--filter=' ) ); break; } } @@ -49,7 +49,7 @@ function _manually_load_plugin() { $plugin_file = null; // See if we want to run integration tests for a specific event-plugin. - switch ( $activitypub_event_extension_integration_filter ) { + switch ( $activitypub_event_bridge_integration_filter ) { case 'the_events_calendar': $plugin_file = 'the-events-calendar/the-events-calendar.php'; break; @@ -87,14 +87,14 @@ function _manually_load_plugin() { } // Hot fix that allows using Events Manager within unit tests, because the em_init() is later not run as admin. - if ( 'events_manager' === $activitypub_event_extension_integration_filter ) { + if ( 'events_manager' === $activitypub_event_bridge_integration_filter ) { require_once $plugin_dir . 'events-manager/em-install.php'; em_create_events_table(); em_create_events_meta_table(); em_create_locations_table(); } - if ( 'modern_events_calendar_lite' === $activitypub_event_extension_integration_filter ) { + if ( 'modern_events_calendar_lite' === $activitypub_event_bridge_integration_filter ) { require_once $plugin_dir . 'modern-events-calendar-lite/app/libraries/factory.php'; $mec_factory = new MEC_factory(); $mec_factory->install();