salmon.php

<?php
/**
 * Plugin Name: Salmon
 * Plugin URI: https://github.com/pfefferle/wordpress-salmon
 * Description: Salmon plugin for WordPress.
 * Version: 0.9.2
 * Author: Matthias Pfefferle
 * Author URI: https://notiz.blog/
 * License: MIT
 * License URI: http://opensource.org/licenses/MIT
 * Text Domain: salmon
 * Domain Path: /languages
 */

/*
 * Thanks to Arne Roomann-Kurrik for his inspiration with salmonpress
 *
 * salmonpress: http://code.google.com/p/salmonpress/
 * Arne Roomann-Kurrik: http://roomanna.com
 */

add_action( 'plugins_loaded', array( 'Salmon_Plugin', 'init' ) );

/**
 * Static class to register callback handlers and otherwise configure
 * WordPress for accepting Salmon posts.
 *
 * @author Matthias Pfefferle
 */
class Salmon_Plugin {

	public static function init() {
		require_once 'includes/functions.php';

		require_once 'includes/class-salmon-entry.php';

		// add salmon discovery
		require_once 'includes/class-salmon-discovery.php';
		Salmon_Discovery::init();

		require_once 'includes/class-magic-sig.php';

		// Query handler
		add_action( 'parse_query', array( 'Salmon_Plugin', 'parse_query' ) );
		add_filter( 'query_vars', array( 'Salmon_Plugin', 'query_vars' ) );

		add_action( 'init', array( 'Salmon_Plugin', 'flush_rewrite_rules' ) );
		add_action( 'generate_rewrite_rules', array( 'Salmon_Plugin', 'add_rewrite_rules' ) );

		// add avatar filter
		add_filter( 'pre_get_avatar_data', array( 'Salmon_Plugin', 'pre_get_avatar_data' ), 10, 2 );

		add_action( 'comment_atom_entry', array( 'Salmon_Plugin', 'add_crossposting_extension' ) );

		add_action( 'admin_init', array( 'Salmon_Plugin', 'text_domain' ) );
		add_action( 'admin_menu', array( 'Salmon_Plugin', 'admin_menu' ) );
	}

	/**
	 * Generates the enpoint url
	 *
	 * @param Object $user |null
	 *
	 * @return string
	 */
	public static function generate_api_url( $user = null ) {
		if ( $user ) {
			$url = add_query_arg( 'salmon', 'endpoint', get_author_posts_url( $user->ID, $user->user_nicename ) );
		} else {
			$url = site_url( '/?salmon=endpoint' );
		}

		return $url;
	}

	/**
	 * Checks a query for the 'Salmon_Plugin' parameter and attempts to parse a
	 * Salmon post if the parameter exists.
	 */
	public static function parse_query( $wp_query ) {
		if (
			isset( $wp_query->query_vars['salmon'] ) ||
			isset( $wp_query->query_vars['salmonpress'] )
		) {
			Salmon_Plugin::parse_salmon_post();
		}
	}

	/**
	 * Replaces the default avatar with the Salmon photo
	 *
	 * @param array             $args Arguments passed to get_avatar_data(), after processing.
	 * @param int|string|object $id_or_email A user ID, email address, or comment object
	 *
	 * @return array $args
	 */
	public static function pre_get_avatar_data( $args, $id_or_email ) {
		if ( ! $id_or_email instanceof WP_Comment ||
			! isset( $id_or_email->comment_type ) ||
			$id_or_email->user_id ) {
			return $args;
		}

		$avatars = get_comment_meta( $id_or_email->comment_ID, '_salmon_avatars', true );

		if ( ! $avatars ) {
			return $args;
		}

		$size = $args['size'];

		if ( array_key_exists( $size, $avatars ) ) {
			$args['url'] = $avatars[ $size ];
		} else {
			$args['url'] = $avatars[ min( array_diff( array_keys( $avatars ), range( 0, $size ) ) ) ];
		}

		$args['class'][] = 'avatar-salmon';
		$args['class'][] = "avatar-$size";

		return $args;
	}

	/**
	 * Adds the crossposting extension to the feeds
	 *
	 * @param int $comment_id
	 */
	public static function add_crossposting_extension( $comment_id ) {
		// get comment
		$comment = get_comment( $comment_id );
		// check if comment-type is 'salmon'
		if ( get_comment_meta( $comment->comment_ID, '_comment_type', true ) == true ) {
			$id   = get_comment_meta( $comment->comment_ID, '_crossposting_id', true );
			$link = get_comment_meta( $comment->comment_ID, '_crossposting_link', true );

			// add extension if id is set
			if ( $id ) {
	?>
	<crosspost:source xmlns:crosspost="http://purl.org/syndication/cross-posting">
		<id><?php echo $id; ?></id>
		<?php if ( $link ) { ?>
		<link rel="alternate" type="text/html" href="<?php echo $link; ?>" />
		<?php } ?>
	</crosspost:source>
	<?php
			}
		}
	}


	/**
	 * Adds the 'Salmon_Plugin' query variable to WordPress.
	 */
	public static function query_vars( $queryvars ) {
		$queryvars[] = 'salmon';
		$queryvars[] = 'salmonpress';

		return $queryvars;
	}

	/**
	 * Clears the cached rewrite rules so that we may add our own.
	 */
	public static function flush_rewrite_rules() {
		global $wp_rewrite;
		$wp_rewrite->flush_rules();
	}

	/**
	 * Adds a rewrite rule so that http://mysite.com/index.php?Salmon_Plugin=true
	 * can be rewritten as http://mysite.com/Salmon_Plugin
	 */
	public static function add_rewrite_rules( $wp_rewrite ) {
		global $wp_rewrite;
		$new_rules         = array(
			'salmon/?(.+)' => 'index.php?salmon=' . $wp_rewrite->preg_index( 1 ),
			'salmon'       => 'index.php?salmon=endpoint',
		);
		$wp_rewrite->rules = $new_rules + $wp_rewrite->rules;
	}

	/**
	 * Attempts to parse data sent to the Salmon endpoint and post it as a
	 * comment for the current blog.
	 */
	public static function parse_salmon_post() {
		$user = null;
		// get user by url
		if ( get_query_var( 'author_name' ) ) :
			$user = get_user_by( 'slug', get_query_var( 'author_name' ) );
		else :
			$user = get_userdata( get_query_var( 'author' ) );
		endif;

		// Allow cross domain JavaScript requests, from salmon-playground.
		if (
			'OPTIONS' === strtoupper( $_SERVER['REQUEST_METHOD'] ) &&
			'POST' === strtoupper( $_SERVER['HTTP_ACCESS_CONTROL_REQUEST_METHOD'] )
		) {
			// See https://developer.mozilla.org/En/HTTP_access_control
			header( 'HTTP/1.1 200 OK' );
			header( 'Access-Control-Allow-Origin: * ' );
			die();
		}

		if ( strtoupper( $_SERVER['REQUEST_METHOD'] ) !== 'POST' ) {
			header( 'HTTP/1.1 400 Bad Request' );
			echo Salmon_Plugin::endpoint( 'Error: The posted Salmon entry was malformed.' );
		}

		$request_body = @file_get_contents( 'php://input' );

		$env  = Magic_Sig::parse( $request_body );
		$data = base64_url_decode( $env['data'] );

		do_action( 'salmon_atom_data', $data, $user );

		$entry = Salmon_Entry::from_atom( $data );
		// Validate the request if the option is set.
		if ( get_option( 'salmon_validate' ) ) {
			if ( $entry->validate() === false ) {
				header( 'HTTP/1.1 403 Forbidden' );
				Salmon_Plugin::endpoint( 'Error: The posted Salmon entry was malformed.' );
			}
		}

		$commentdata = $entry->to_commentdata();
		do_action( 'salmon_comment_data', $commentdata, $user );

		if ( $user ) {
			wp_mail( $user->user_email, 'you\'ve fished a salmon', strip_tags( $commentdata['comment_content'] ) );
		}

		if ( $commentdata['comment_post_ID'] ) {
			// save comment
			$comment_id = wp_insert_comment( $commentdata );
			// add comment meta
			update_comment_meta( $comment_id, '_salmon_avatars', $entry->avatars );
			update_comment_meta( $comment_id, '_comment_type', 'salmon' );
			update_comment_meta( $comment_id, '_crossposting_id', $entry->id );
			update_comment_meta( $comment_id, '_crossposting_link', $entry->link );
			header( 'HTTP/1.1 201 Created' );
			Salmon_Plugin::endpoint( 'The Salmon entry was posted.' );
		}
		die();
	}

	/**
	 *
	 */
	public static function endpoint( $text ) {
		?>
				<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
								"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
				<html xmlns="http://www.w3.org/1999/xhtml" <?php language_attributes(); ?>>
				<head>
						<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
						<title>Salmon Endpoint</title>
			<?php
			wp_admin_css( 'install', true );
			do_action( 'admin_head' );
			?>
				</head>
				<body>
				<h1>Salmon Endpoint</h1>

				<p><?php echo $text; ?></p>
				</body>
				</html>
		<?php
		exit;
	}

	/**
	 * Load plugin text domain
	 */
	public static function text_domain() {
		load_plugin_textdomain( 'salmon' );
	}
	/**
	 * Add admin menu entry
	 */
	public static function admin_menu() {
		add_options_page(
			'Salmon',
			'Salmon',
			'manage_options',
			'salmon',
			array( 'Salmon_Plugin', 'settings_page' )
		);
	}
	/**
	 * Load settings page
	 */
	public static function settings_page() {
		load_template( dirname( __FILE__ ) . '/templates/settings-page.php' );
	}
}