<?php
/**
* Module Name: Subscriptions
* Module Description: Allow users to subscribe to your posts and comments to receive a notification via email.
* Sort Order: 1
* First Introduced: 1.2
*/
class Jetpack_Subscriptions {
var $jetpack = false;
/**
* Singleton
* @static
*/
function &init() {
static $instance = array();
if ( !$instance ) {
$instance[0] =& new Jetpack_Subscriptions;
}
return $instance[0];
}
function Jetpack_Subscriptions() {
$this->jetpack = Jetpack::init();
add_filter( 'jetpack_xmlrpc_methods', array( &$this, 'xmlrpc_methods' ) );
// Handle Posts
add_action( 'transition_post_status', array( &$this, 'transition_post_status' ), 10, 3 );
add_action( 'trashed_post', array( &$this, 'delete_post' ) );
add_action( 'delete_post', array( &$this, 'delete_post' ) );
// Handle Comments
add_action( 'wp_insert_comment', array( &$this, 'save_comment' ), 10, 2 );
add_action( 'transition_comment_status', array( &$this, 'transition_comment_status' ), 10, 3 );
add_action( 'trashed_comment', array( &$this, 'delete_comment' ) );
add_action( 'delete_comment', array( &$this, 'delete_comment' ) );
// Set up the subscription widget.
add_action( 'widgets_init', array( &$this, 'widget_init' ) );
// Catch subscription widget submits
if ( isset( $_REQUEST['jetpack_subscriptions_widget'] ) )
add_action( 'template_redirect', array( &$this, 'widget_submit' ) );
// Set up the comment subscription checkboxes
add_action( 'comment_form', array( &$this, 'comment_subscribe_init' ) );
// Catch comment posts and check for subscriptions.
add_action( 'comment_post', array( &$this, 'comment_subscribe_submit' ), 50, 2 );
}
function post_is_public( $the_post ) {
if ( !$post = get_post( $the_post ) ) {
return false;
}
return 'publish' === $post->post_status && strlen( (string) $post->post_password ) < 1;
}
function transition_post_status( $new, $old, $the_post ) {
if ( 'publish' == $old && 'publish' != $new ) {
// A published post was trashed or something else
$this->delete_post( $the_post->ID );
return;
}
clean_post_cache( $the_post->ID );
// Publish a new post
if (
'publish' != $old
&&
$this->post_is_public( $the_post->ID )
&&
( 'post' == $the_post->post_type || 'page' == $the_post->post_type )
) {
$this->jetpack->sync->post( $the_post->ID );
}
}
function delete_post( $id ) {
$the_post = get_post( $id );
if ( 'post' == $the_post->post_type || 'page' == $the_post->post_type )
$this->jetpack->sync->delete_post( $id );
}
function save_comment( $id, $comment ) {
if ( !$this->post_is_public( $comment->comment_post_ID ) ) {
return;
}
if ( 1 == $comment->comment_approved ) {
$this->jetpack->sync->comment( $id );
}
}
function transition_comment_status( $new, $old, $the_comment ) {
if ( !$this->post_is_public( $the_comment->comment_post_ID ) ) {
return;
}
if ( 'approved' == $new ) {
$this->jetpack->sync->comment( $the_comment->comment_ID );
} else if ( 'approved' == $old && 'approved' != $new ) {
// Delete comments that are changing to anything but approved
$this->jetpack->sync->delete_comment( $the_comment->comment_ID );
}
}
function delete_comment( $id ) {
$this->jetpack->sync->delete_comment( $id );
}
/**
* Jetpack_Subscriptions::xmlrpc_methods()
*
* Register subscriptions methods with the Jetpack XML-RPC server.
* @param array $methods
*/
function xmlrpc_methods( $methods ) {
return array_merge( $methods, array(
'jetpack.subscriptions.subscribe' => array( &$this, 'subscribe' ),
) );
}
/**
* Jetpack_Subscriptions::configure()
*
* Jetpack Subscriptions configuration screen.
*/
function configure() {
echo '<p>This is the configuration page for the Subscriptions Module.</p>';
}
/**
* Jetpack_Subscriptions::subscribe()
*
* Send a synchronous XML-RPC subscribe to blog posts or subscribe to post comments request.
*
* @param string $email
* @param array $post_ids (optional) defaults to 0 for blog posts only: array of post IDs to subscribe to blog's posts
* @param bool $async (optional) Should the subscription be performed asynchronously? Defaults to true.
*
* @return true|Jetpack_Error true on success
* invalid_email : not a valid email address
* invalid_post_id : not a valid post ID
* unknown_post_id : unknown post
* not_subscribed : strange error. Jetpack servers at WordPress.com could subscribe the email.
* disabled : Site owner has disabled subscriptions.
* active : Already subscribed.
* unknown : strange error. Jetpack servers at WordPress.com returned something malformed.
* unknown_status : strange error. Jetpack servers at WordPress.com returned something I didn't understand.
*/
function subscribe( $email, $post_ids = 0, $async = true ) {
if ( !is_email( $email ) ) {
return new Jetpack_Error( 'invalid_email' );
}
if ( !$async ) {
Jetpack::load_xml_rpc_client();
$xml =& new Jetpack_IXR_ClientMulticall();
}
foreach( (array) $post_ids as $post_id ) {
$post_id = (int) $post_id;
if ( $post_id < 0 ) {
return new Jetpack_Error( 'invalid_post_id' );
} else if ( $post_id && !$post = get_post( $post_id ) ) {
return new Jetpack_Error( 'unknown_post_id' );
}
if ( $async ) {
Jetpack::xmlrpc_async_call( 'jetpack.subscribeToSite', $email, $post_id );
} else {
$xml->addCall( 'jetpack.subscribeToSite', $email, $post_id );
}
}
if ( $async ) {
return;
}
// Call
$xml->query();
if ( $xml->isError() ) {
return $xml->get_jetpack_error();
}
$responses = $xml->getResponse();
$r = array();
foreach( (array) $responses as $response ) {
if ( isset( $response['faultCode'] ) || isset( $response['faultString'] ) ) {
$r[] = $xml->get_jetpack_error( $response['faultCode'], $response['faultString'] );
continue;
}
if ( !is_array( $response[0] ) || empty( $response[0]['status'] ) ) {
$r[] =& new Jetpack_Error( 'unknown' );
continue;
}
switch ( $response[0]['status'] ) {
case 'error' :
$r[] =& new Jetpack_Error( 'not_subscribed' );
continue 2;
case 'disabled' :
$r[] =& new Jetpack_Error( 'disabled' );
continue 2;
case 'active' :
$r[] =& new Jetpack_Error( 'active' );
continue 2;
case 'pending' :
$r[] = true;
continue 2;
default :
$r[] =& new Jetpack_Error( 'unknown_status', (string) $response[0]['status'] );
continue 2;
}
}
return $r;
}
/**
* Jetpack_Subscriptions::widget_init()
*
* Initialize and register the Jetpack Subscriptions widget.
*/
function widget_init() {
register_widget( 'Jetpack_Subscriptions_Widget' );
}
/**
* Jetpack_Subscriptions::widget_submit()
*
* When a user submits their email via the blog subscription widget, check the details and call the subsribe() method.
*/
function widget_submit() {
// Check the nonce.
check_admin_referer( 'blogsub_subscribe_' . get_current_blog_id() );
if ( empty( $_REQUEST['email'] ) )
return false;
$redirect_fragment = false;
if ( isset( $_REQUEST['redirect_fragment'] ) ) {
$redirect_fragment = preg_replace( '/[^a-z0-9_-]/i', '', $_REQUEST['redirect_fragment'] );
}
if ( !$redirect_fragment ) {
$redirect_fragment = 'subscribe-blog';
}
$subscribe = Jetpack_Subscriptions::subscribe( $_REQUEST['email'], 0, false );
if ( is_wp_error( $subscribe ) ) {
$error = $subscribe->get_error_code();
} else {
$error = false;
foreach ( $subscribe as $response ) {
if ( is_wp_error( $response ) ) {
$error = $response->get_error_code();
break;
}
}
}
if ( $error ) {
switch( $error ) {
case 'invalid_email':
$redirect = add_query_arg( 'subscribe', 'invalid_email' );
break;
case 'active': case 'pending':
$redirect = add_query_arg( 'subscribe', 'already' );
break;
default:
$redirect = add_query_arg( 'subscribe', 'error' );
break;
}
} else {
$redirect = add_query_arg( 'subscribe', 'success' );
}
wp_safe_redirect( "$redirect#$redirect_fragment" );
exit;
}
/**
* Jetpack_Subscriptions::comment_subscribe_init()
*
* Set up and add the comment subscription checkbox to the comment form.
*/
function comment_subscribe_init() {
global $post;
$comments_checked = '';
$blog_checked = '';
// Check for a comment / blog submission and set a cookie to retain the setting and check the boxes.
if ( isset( $_COOKIE[ 'jetpack_comments_subscribe_' . COOKIEHASH ] ) && $_COOKIE[ 'jetpack_comments_subscribe_' . COOKIEHASH ] == $post->ID )
$comments_checked = ' checked="checked"';
if ( isset( $_COOKIE[ 'jetpack_blog_subscribe_' . COOKIEHASH ] ) )
$blog_checked = ' checked="checked"';
// Some themes call this function, don't show the checkbox again
remove_action( 'comment_form', 'subscription_comment_form' );
// Check if Mark Jaquith's Subscribe to Comments plugin is active - if so, suppress Jetpack checkbox
$str = '';
if ( FALSE === has_filter( 'comment_form', 'show_subscription_checkbox' ) ) {
// Subscribe to comments checkbox
$str .= '<p class="comment-subscription-form"><input type="checkbox" name="subscribe_comments" id="subscribe_comments" value="subscribe" style="width: auto; -moz-appearance: checkbox; -webkit-appearance: checkbox;"' . $comments_checked . ' /> ';
$str .= '<label class="subscribe-label" id="subscribe-label" for="subscribe_comments">' . __( 'Notify me of follow-up comments by email.', 'jetpack' ) . '</label>';
$str .= '</p>';
}
// Subscribe to blog checkbox
$str .= '<p class="comment-subscription-form"><input type="checkbox" name="subscribe_blog" id="subscribe_blog" value="subscribe" style="width: auto; -moz-appearance: checkbox; -webkit-appearance: checkbox;"' . $blog_checked . ' /> ';
$str .= '<label class="subscribe-label" id="subscribe-blog-label" for="subscribe_blog">' . __( 'Notify me of new posts by email.', 'jetpack' ) . '</label>';
$str .= '</p>';
echo apply_filters( 'jetpack_comment_subscription_form', $str );
}
/**
* Jetpack_Subscriptions::comment_subscribe_init()
*
* When a user checks the comment subscribe box and submits a comment, subscribe them to the comment thread.
*/
function comment_subscribe_submit( $comment_id, $approved ) {
if ( 'spam' === $approved ) {
return;
}
// Set cookies for this post/comment
$this->set_cookies( isset( $_REQUEST['subscribe_comments'] ), isset( $_REQUEST['subscribe_blog'] ) );
if ( !isset( $_REQUEST['subscribe_comments'] ) && !isset( $_REQUEST['subscribe_blog'] ) )
return;
$comment = get_comment( $comment_id );
$post_ids = array();
if ( isset( $_REQUEST['subscribe_comments'] ) )
$post_ids[] = $comment->comment_post_ID;
if ( isset( $_REQUEST['subscribe_blog'] ) )
$post_ids[] = 0;
Jetpack_Subscriptions::subscribe( $comment->comment_author_email, $post_ids );
}
/**
* Jetpack_Subscriptions::set_cookies()
*
* Set a cookie to save state on the comment and post subscription checkboxes.
*/
function set_cookies( $comments = true, $posts = true ) {
global $post;
$cookie_lifetime = apply_filters( 'comment_cookie_lifetime', 30000000 );
if ( $comments )
setcookie( 'jetpack_comments_subscribe_' . COOKIEHASH, $post->ID, time() + $cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN );
else
setcookie( 'jetpack_comments_subscribe_' . COOKIEHASH, '', time() - 3600, COOKIEPATH, COOKIE_DOMAIN );
if ( $posts )
setcookie( 'jetpack_blog_subscribe_' . COOKIEHASH, 1, time() + $cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN );
else
setcookie( 'jetpack_blog_subscribe_' . COOKIEHASH, '', time() - 3600, COOKIEPATH, COOKIE_DOMAIN );
}
}
Jetpack_Subscriptions::init();
/***
* Blog Subscription Widget
*/
class Jetpack_Subscriptions_Widget extends WP_Widget {
function Jetpack_Subscriptions_Widget() {
$widget_ops = array( 'classname' => 'jetpack_subscription_widget', 'description' => __( 'Add an email signup form to allow people to subscribe to your blog.', 'jetpack' ) );
$control_ops = array( 'width' => 300 );
$this->WP_Widget( 'blog_subscription', __( 'Blog Subscriptions (Jetpack)', 'jetpack' ), $widget_ops, $control_ops );
}
function widget( $args, $instance ) {
global $current_user;
$source = 'widget';
extract( $args );
$instance = wp_parse_args( (array) $instance, $this->defaults() );
$title = stripslashes( $instance['title'] );
$subscribe_text = stripslashes( $instance['subscribe_text'] );
$subscribe_button = stripslashes( $instance['subscribe_button'] );
$subscribe_logged_in = stripslashes( $instance['subscribe_logged_in'] );
$show_subscribers_total = (bool) $instance['show_subscribers_total'];
$subscribers_total = $this->fetch_subscriber_count();
if ( ! is_array( $subscribers_total ) )
$show_subscribers_total = FALSE;
echo $before_widget;
echo $before_title . '<label for="subscribe-field">' . esc_attr( $instance['title'] ) . '</label>' . $after_title . "\n";
$referer = ( is_ssl() ? 'https' : 'http' ) . '://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
// Check for subscription confirmation.
if ( isset( $_GET['subscribe'] ) && 'success' == $_GET['subscribe'] ) {
?>
<div style="background-color: #FFFFE0; border: 1px solid #E6DB55; padding-left: 5px; padding-right: 5px; margin-bottom: 10px;">
<?php _e( 'An email was just sent to confirm your subscription. Please find the email now and click activate to start subscribing.', 'jetpack' ); ?>
</div>
<?php
}
// Display any errors
if ( isset( $_GET['subscribe'] ) ) :
switch ( $_GET['subscribe'] ) :
case 'invalid_email' : ?>
<p class="error"><?php _e( 'The email you entered was invalid, please check and try again.', 'jetpack' ); ?></p>
<?php break;
case 'already' : ?>
<p class="error"><?php _e( 'You have already subscribed to this site, please check your inbox.', 'jetpack' ); ?></p>
<?php break;
case 'success' :
echo wpautop( $subscribe_text );
break;
default : ?>
<p class="error"><?php _e( 'There was an error when subscribing, please try again.', 'jetpack' ) ?></p>
<?php break;
endswitch;
endif;
$email_address = '';
if ( ! empty( $current_user->user_email ) )
$email_address = $current_user->user_email;
// Display a subscribe form ?>
<a name="subscribe-blog"></a>
<form action="" method="post" accept-charset="utf-8" id="subscribe-blog">
<?php
if ( ! isset ( $_GET['subscribe'] ) ) {
?><p><?php echo $subscribe_text ?></p><?php
}
if ( $show_subscribers_total && $subscribers_total['value'] > 0 ) {
echo wpautop( sprintf( _n( 'Join %s other subscriber', 'Join %s other subscribers', $subscribers_total['value'], 'jetpack' ), number_format_i18n( $subscribers_total['value'] ) ) );
}
?>
<p><input type="text" name="email" style="width: 95%; padding: 1px 2px" value="<?php if ( !empty( $email_address ) ) { echo $email_address; } else { _e( 'Email Address', 'jetpack' ); } ?>" id="subscribe-field" onclick="if ( this.value == '<?php _e( 'Email Address', 'jetpack' ) ?>' ) { this.value = ''; }" onblur="if ( this.value == '' ) { this.value = '<?php _e( 'Email Address', 'jetpack' ) ?>'; }" /></p>
<p>
<input type="hidden" name="action" value="subscribe" />
<input type="hidden" name="source" value="<?php echo esc_url( $referer ); ?>" />
<input type="hidden" name="sub-type" value="<?php echo esc_attr( $source ); ?>" />
<input type="hidden" name="redirect_fragment" value="<?php echo esc_attr( $widget_id ); ?>" />
<?php wp_nonce_field( 'blogsub_subscribe_'. get_current_blog_id(), '_wpnonce', false ); ?>
<input type="submit" value="<?php echo esc_attr( $subscribe_button ); ?>" name="jetpack_subscriptions_widget" />
</p>
</form>
<?php
echo "\n" . $after_widget;
}
function increment_subscriber_count( $current_subs_array = array() ) {
$current_subs_array['value']++;
set_transient( 'wpcom_subscribers_total', $current_subs_array, 3600 ); // try to cache the result for at least 1 hour
return $current_subs_array;
}
function fetch_subscriber_count() {
$subs_count = get_transient( 'wpcom_subscribers_total' );
if ( FALSE === $subs_count || 'failed' == $subs_count['status'] ) {
Jetpack:: load_xml_rpc_client();
$xml =& new Jetpack_IXR_Client( array(
'user_id' => $GLOBALS['current_user']->ID
) );
$xml->query( 'jetpack.fetchSubscriberCount' );
if ( $xml->isError() ) { // if we get an error from .com, set the status to failed so that we will try again next time the data is requested
$subs_count = array(
'status' => 'failed',
'code' => $xml->getErrorCode(),
'message' => $xml->getErrorMessage(),
'value' => ( isset( $subs_count['value'] ) ) ? $subs_count['value'] : 0,
);
} else {
$subs_count = array(
'status' => 'success',
'value' => $xml->getResponse(),
);
}
set_transient( 'wpcom_subscribers_total', $subs_count, 3600 ); // try to cache the result for at least 1 hour
}
return $subs_count;
}
function update( $new_instance, $old_instance ) {
$instance = $old_instance;
$instance['title'] = strip_tags( stripslashes( $new_instance['title'] ) );
$instance['subscribe_text'] = wp_filter_post_kses( stripslashes( $new_instance['subscribe_text'] ) );
$instance['subscribe_logged_in'] = wp_filter_post_kses( stripslashes( $new_instance['subscribe_logged_in'] ) );
$instance['subscribe_button'] = strip_tags( stripslashes( $new_instance['subscribe_button'] ) );
$instance['show_subscribers_total'] = isset( $new_instance['show_subscribers_total'] ) && $new_instance['show_subscribers_total'];
return $instance;
}
function defaults() {
return array(
'title' => __( 'Subscribe to Blog via Email', 'jetpack' ),
'subscribe_text' => __( 'Enter your email address to subscribe to this blog and receive notifications of new posts by email.', 'jetpack' ),
'subscribe_button' => __( 'Subscribe', 'jetpack' ),
'subscribe_logged_in' => __( 'Click to subscribe to this blog and receive notifications of new posts by email.', 'jetpack' ),
'show_subscribers_total' => true,
);
}
function form( $instance ) {
$instance = wp_parse_args( (array) $instance, $this->defaults() );
$title = esc_attr( stripslashes( $instance['title'] ) );
$subscribe_text = esc_attr( stripslashes( $instance['subscribe_text'] ) );
$subscribe_button = esc_attr( stripslashes( $instance['subscribe_button'] ) );
$show_subscribers_total = checked( $instance['show_subscribers_total'], true, false );
$subs_fetch = $this->fetch_subscriber_count();
if ( 'failed' == $subs_fetch['status'] ) {
printf( '<div class="error inline"><p>' . __( '%s: %s', 'jetpack' ) . '</p></div>', esc_html( $subs_fetch['code'] ), esc_html( $subs_fetch['message'] ) );
}
$subscribers_total = number_format_i18n( $subs_fetch['value'] );
?>
<p>
<label for="<?php echo $this->get_field_id( 'title' ); ?>">
<?php _e( 'Widget title:', 'jetpack' ); ?>
<input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" />
</label>
</p>
<p>
<label for="<?php echo $this->get_field_id( 'subscribe_text' ); ?>">
<?php _e( 'Optional text to display to your readers:', 'jetpack' ); ?>
<textarea style="width: 95%" id="<?php echo $this->get_field_id( 'subscribe_text' ); ?>" name="<?php echo $this->get_field_name( 'subscribe_text' ); ?>" type="text"><?php echo esc_html( $subscribe_text ); ?></textarea>
</label>
</p>
<p>
<label for="<?php echo $this->get_field_id( 'subscribe_button' ); ?>">
<?php _e( 'Subscribe Button:', 'jetpack' ); ?>
<input class="widefat" id="<?php echo $this->get_field_id( 'subscribe_button' ); ?>" name="<?php echo $this->get_field_name( 'subscribe_button' ); ?>" type="text" value="<?php echo esc_attr( $subscribe_button ); ?>" />
</label>
</p>
<p>
<label for="<?php echo $this->get_field_id( 'show_subscribers_total' ); ?>">
<input type="checkbox" id="<?php echo $this->get_field_id( 'show_subscribers_total' ); ?>" name="<?php echo $this->get_field_name( 'show_subscribers_total' ); ?>" value="1"<?php echo $show_subscribers_total; ?> />
<?php echo esc_html( sprintf( _n( 'Show total number of subscribers? (%s subscriber)', 'Show total number of subscribers? (%s subscribers)', $subscribers_total, 'jetpack' ), number_format_i18n( $subscribers_total ) ) ); ?>
</label>
</p>
<?php
}
}