<?php
/**
 * Custom hook notifications (developer option).
 *
 * @package PingPush
 */

defined( 'ABSPATH' ) || exit;

/**
 * Lets an administrator send a notification whenever a named WordPress action fires.
 */
class PingPush_Event_Custom_Hook extends PingPush_Integration {

	const MAX_HOOKS = 20;

	/**
	 * Name.
	 *
	 * @return string
	 */
	public static function name() {
		return __( 'Custom hooks', 'pingpush' );
	}

	/**
	 * Event id for a hook name.
	 *
	 * @param string $hook Hook.
	 * @return string
	 */
	public static function event_id( $hook ) {
		return 'custom_' . substr( md5( (string) $hook ), 0, 12 );
	}

	/**
	 * Validate a hook name. Rejects malformed names, very frequent hooks and hooks that
	 * PingPush itself triggers while sending (which would loop).
	 *
	 * @param string $hook Hook.
	 * @return true|string True or an error message.
	 */
	public static function validate( $hook ) {
		$hook = (string) $hook;
		if ( ! preg_match( '/^[A-Za-z0-9_\-\/\.:]{2,190}$/', $hook ) ) {
			return __( 'Hook names may only contain letters, numbers and _ - / . :', 'pingpush' );
		}

		$blocked          = array(
			'all',
			'init',
			'wp_loaded',
			'wp',
			'shutdown',
			'muplugins_loaded',
			'plugins_loaded',
			'setup_theme',
			'after_setup_theme',
			'set_current_user',
			'parse_request',
			'send_headers',
			'template_redirect',
			'pre_get_posts',
			'the_post',
			'loop_start',
			'loop_end',
			'wp_head',
			'wp_footer',
			'wp_enqueue_scripts',
			'wp_print_scripts',
			'wp_print_styles',
			'admin_init',
			'admin_menu',
			'admin_head',
			'admin_footer',
			'admin_enqueue_scripts',
			'admin_bar_menu',
			'admin_notices',
			'widgets_init',
			'rest_api_init',
			'heartbeat_received',
			'gettext',
			'query',
			'added_option',
			'updated_option',
			'deleted_option',
			'setted_transient',
			'deleted_transient',
		);
		$blocked_prefixes = array( 'pingpush', 'http_', 'pre_http', 'requests-', 'requests_', 'wp_remote', 'cron', 'action_scheduler', 'update_option', 'add_option', 'delete_option', 'set_transient', 'set_site_transient', 'pre_option', 'option_', 'site_transient_', 'transient_', 'pre_transient', 'pre_site_transient', 'gettext', 'sanitize_', 'esc_' );

		$lower = strtolower( $hook );
		if ( in_array( $lower, $blocked, true ) ) {
			return __( 'This hook runs on every page load and would flood your phone.', 'pingpush' );
		}
		foreach ( $blocked_prefixes as $prefix ) {
			if ( 0 === strpos( $lower, $prefix ) ) {
				return __( 'This hook is used internally while sending notifications or runs very often, so it cannot be used.', 'pingpush' );
			}
		}
		return true;
	}

	/**
	 * Saved, valid rows.
	 *
	 * @return array<int,array>
	 */
	private function rows() {
		$settings = PingPush_Settings::get();
		$rows     = isset( $settings['custom_hooks'] ) && is_array( $settings['custom_hooks'] ) ? $settings['custom_hooks'] : array();
		return array_slice(
			array_values(
				array_filter(
					$rows,
					static function ( $row ) {
						return is_array( $row ) && ! empty( $row['hook'] ) && true === self::validate( $row['hook'] );
					}
				)
			),
			0,
			self::MAX_HOOKS
		);
	}

	/**
	 * Register one event per row.
	 */
	public function register_events() {
		foreach ( $this->rows() as $row ) {
			PingPush_Events::register(
				self::event_id( $row['hook'] ),
				array(
					/* translators: %s: hook name. */
					'label'        => sprintf( __( 'Custom hook: %s', 'pingpush' ), $row['hook'] ),
					'group'        => 'other',
					'source'       => 'custom',
					'title'        => '' !== (string) ( $row['title'] ?? '' ) ? $row['title'] : '{hook}',
					'message'      => '' !== (string) ( $row['message'] ?? '' ) ? $row['message'] : __( 'The {hook} action ran.', 'pingpush' ),
					'priority'     => (int) ( $row['priority'] ?? 0 ),
					'sound'        => (string) ( $row['sound'] ?? '' ),
					'enabled'      => ! empty( $row['enabled'] ),
					'placeholders' => array( 'hook', 'arg1', 'arg2', 'arg3', 'arg4', 'arg5' ),
				)
			);
		}
	}

	/**
	 * Attach a listener to each hook.
	 */
	public function hooks() {
		foreach ( $this->rows() as $row ) {
			if ( empty( $row['enabled'] ) ) {
				continue;
			}
			$hook = (string) $row['hook'];
			$id   = self::event_id( $hook );

			// Works for actions and filters: always hands back the first argument unchanged.
			add_action(
				$hook,
				static function ( ...$args ) use ( $hook, $id ) {
					if ( ! PingPush_Queue::is_sending() ) {
						$data = array( 'hook' => $hook );
						for ( $i = 0; $i < 5; $i++ ) {
							$data[ 'arg' . ( $i + 1 ) ] = array_key_exists( $i, $args ) ? self::describe( $args[ $i ] ) : '';
						}
						PingPush_Events::trigger(
							$id,
							$data,
							array(
								'url'        => admin_url(),
								'url_title'  => __( 'Open dashboard', 'pingpush' ),
								'dedupe'     => 'request',
								'dedupe_ttl' => 0,
							)
						);
					}
					return $args[0] ?? null;
				},
				999,
				5
			);
		}
	}

	/**
	 * Readable text for a hook argument.
	 *
	 * @param mixed $value Value.
	 * @return string
	 */
	public static function describe( $value ) {
		if ( $value instanceof WP_Post ) {
			return get_the_title( $value );
		}
		if ( $value instanceof WP_User ) {
			return $value->user_login;
		}
		if ( $value instanceof WP_Comment ) {
			return $value->comment_author;
		}
		if ( $value instanceof WP_Error ) {
			return $value->get_error_message();
		}
		if ( is_object( $value ) ) {
			return get_class( $value );
		}
		$text = PingPush_Templates::stringify( $value );
		return PingPush_Templates::truncate( $text, 200 );
	}
}