wordpress-activitypub-event.../includes/class-reminder.php

195 lines
6.4 KiB
PHP
Raw Permalink Normal View History

2024-10-11 10:53:12 +02:00
<?php
/**
* General settings class.
*
* 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_Bridge
* @since 1.0.0
*/
namespace ActivityPub_Event_Bridge;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore
use Activitypub\Activity_Dispatcher;
use Activitypub\Transformer\Factory as Transformer_Factory;
use ActivityPub_Event_Bridge\Setup;
use ActivityPub_Event_Bridge\Activitypub\Transformer\Event as Event_Transformer;
use DateTime;
use function Activitypub\is_user_disabled;
/**
* Adds automatic announcing or sending of reminders before the events start time.
*/
class Reminder {
/**
* Initialize the class, registering WordPress hooks.
*/
public static function init() {
// Post transitions.
2024-10-11 19:05:20 +02:00
\add_action( 'transition_post_status', array( self::class, 'maybe_schedule_event_reminder' ), 33, 3 );
\add_action( 'delete_post', array( self::class, 'unschedule_event_reminder' ), 33, 1 );
2024-10-11 10:53:12 +02:00
// Send an event reminder.
\add_action( 'activitypub_event_bridge_send_event_reminder', array( self::class, 'send_event_reminder' ), 10, 1 );
2024-10-13 15:39:23 +02:00
// Load the block which allows overriding the reminder time for an individual event in the post settings.
2024-10-11 10:53:12 +02:00
\add_action( 'enqueue_block_editor_assets', array( self::class, 'enqueue_editor_assets' ) );
2024-10-13 15:39:23 +02:00
// Register the post-meta which stores per-event overrides of the side-wide default of the reminder time gap.
2024-10-11 10:53:12 +02:00
\add_action( 'init', array( self::class, 'register_postmeta' ), 11 );
}
/**
* Register post meta for controlling whether and when a reminder is scheduled for an individual event.
*/
public static function register_postmeta() {
$ap_post_types = \get_post_types_by_support( 'activitypub' );
foreach ( $ap_post_types as $post_type ) {
\register_post_meta(
$post_type,
'activitypub_event_bridge_reminder_time_gap',
array(
'show_in_rest' => true,
'single' => true,
'type' => 'integer',
'sanitize_callback' => 'absint',
)
);
}
}
/**
* Enqueue the block editor assets.
*/
public static function enqueue_editor_assets() {
// Check for our supported post types.
$current_screen = \get_current_screen();
$event_post_types = Setup::get_instance()->get_active_event_plugins_post_types();
if ( ! $current_screen || ! in_array( $current_screen->post_type, $event_post_types, true ) ) {
return;
}
$asset_data = include ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_DIR . 'build/reminder/plugin.asset.php';
$plugin_url = plugins_url( 'build/reminder/plugin.js', ACTIVITYPUB_EVENT_BRIDGE_PLUGIN_FILE );
wp_enqueue_script( 'activitypub-event-bridge-reminder', $plugin_url, $asset_data['dependencies'], $asset_data['version'], true );
// Pass the the default site wide time gap option to the settings block on the events edit page.
wp_localize_script(
'activitypub-event-bridge-reminder',
'activityPubEventBridge',
array(
'reminderTypeGap' => \get_option( 'activitypub_event_bridge_reminder_time_gap', 0 ),
)
);
}
/**
* Schedule Activities.
*
* @param string $new_status New post status.
* @param string $old_status Old post status.
* @param WP_Post $post Post object.
*/
2024-10-11 19:05:20 +02:00
public static function maybe_schedule_event_reminder( $new_status, $old_status, $post ): void {
2024-10-13 15:39:23 +02:00
// Re-Check that we got a valid post.
2024-10-11 10:53:12 +02:00
$post = get_post( $post );
if ( ! $post ) {
return;
}
2024-10-13 15:39:23 +02:00
// At first always unschedule the reminder for this event, it will be added again, in case.
self::unschedule_event_reminder( $post->ID );
// Do not set reminders if post is password protected.
2024-10-11 10:53:12 +02:00
if ( \post_password_required( $post ) ) {
return;
}
// Only schedule an reminder for event post types.
if ( ! Setup::get_instance()->is_post_type_event_of_active_event_plugin( $post->post_type ) ) {
return;
}
// Do not schedule a reminder if the event is not published.
if ( 'publish' !== $new_status ) {
return;
}
2024-10-13 15:39:23 +02:00
// See if a reminder time gap is set for the event individually in the events post-meta.
$reminder_time_gap = (int) get_post_meta( $post->ID, 'activitypub_event_bridge_reminder_time_gap', true );
// If not fallback to the global reminder time gap.
if ( ! $reminder_time_gap ) {
$reminder_time_gap = \get_option( 'activitypub_event_bridge_reminder_time_gap', 0 );
}
// Any non positive integer means that this feature is not active for this event post.
if ( 0 === $reminder_time_gap || ! is_int( $reminder_time_gap ) ) {
return;
}
2024-10-11 10:53:12 +02:00
// Get start time of the event.
$event_transformer = Transformer_Factory::get_transformer( $post );
if ( \is_wp_error( $event_transformer ) || ! $event_transformer instanceof Event_Transformer ) {
return;
}
$start_time = $event_transformer->get_start_time();
$start_datetime = new DateTime( $start_time );
$start_timestamp = $start_datetime->getTimestamp();
// Get the time when the reminder of the event's start should be sent.
$schedule_time = $start_timestamp - $reminder_time_gap;
2024-10-13 15:39:23 +02:00
// If the reminder time has already passed "now" skip it.
2024-10-11 10:53:12 +02:00
if ( $schedule_time < \time() ) {
return;
}
2024-10-13 15:39:23 +02:00
// All checks passed: schedule a single event which will trigger the sending of the reminder for this event post.
\wp_schedule_single_event( $schedule_time, 'activitypub_event_bridge_send_event_reminder', array( $post->ID ) );
2024-10-11 10:53:12 +02:00
}
2024-10-11 19:05:20 +02:00
/**
* Unschedule the event reminder.
*
* @param int $post_id The WordPress post ID of the event post.
*/
public static function unschedule_event_reminder( $post_id ): void {
2024-10-13 15:39:23 +02:00
\wp_clear_scheduled_hook( 'activitypub_event_bridge_send_event_reminder', array( $post_id ) );
2024-10-11 19:05:20 +02:00
}
2024-10-11 10:53:12 +02:00
/**
* Send a reminder for an event post.
*
* This currently sends an Announce activity.
*
* @param int $post_id The WordPress post ID of the event post.
*/
public static function send_event_reminder( $post_id ): void {
$post = \get_post( $post_id );
$transformer = Transformer_Factory::get_transformer( $post );
if ( \is_wp_error( $transformer ) || ! $transformer instanceof Event_Transformer ) {
return;
}
$user_id = $transformer->get_wp_user_id();
2024-10-11 19:05:20 +02:00
if ( $user_id > 0 && is_user_disabled( $user_id ) ) {
2024-10-11 10:53:12 +02:00
return;
}
$activity = $transformer->to_announce_self_activity( 'Announce' );
Activity_Dispatcher::send_activity_to_followers( $activity, $user_id, $post );
}
}