Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Post by Email: Refactoring and Unit Tests #15139

Merged
merged 7 commits into from
Apr 2, 2020
Merged

Post by Email: Refactoring and Unit Tests #15139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1537bb4
Refactor the Post by Email module
sergeymitr Mar 5, 2020
949cb01
Integration tests for Post by Email REST API.
sergeymitr Mar 9, 2020
ddc47ea
Post by Email: Unit tests for “regenerate” and “delete” API endpoints
sergeymitr Mar 26, 2020
84a2f3b
Post by Email: Switching to XMLHttpRequest.
sergeymitr Mar 27, 2020
3de453c
Post by Email: Modifying assertions for compatibility with PHPUnit 5.7
sergeymitr Mar 27, 2020
acb25a9
Bring PBE into full PHPCS compliance
kraftbj Apr 1, 2020
867af1b
Post by Email: corrected paths to JS and CSS files, adjusted style at…
sergeymitr Apr 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions _inc/lib/class.core-rest-api-endpoints.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2960,8 +2960,7 @@ public static function get_remote_value( $module, $option ) {
if ( ! class_exists( 'Jetpack_Post_By_Email' ) && ! include_once( Jetpack::get_module_path( $module ) ) ) {
return false;
}
$post_by_email = new Jetpack_Post_By_Email();
$value = $post_by_email->get_post_by_email_address();
$value = Jetpack_Post_By_Email::init()->get_post_by_email_address();
if ( $value === null ) {
$value = 'NULL'; // sentinel value so it actually gets set
}
Expand Down
52 changes: 1 addition & 51 deletions _inc/lib/core-api/class.jetpack-core-api-module-endpoints.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -681,24 +681,7 @@ public function update_data( $request ) {
break;

case 'post_by_email_address':
if ( 'create' == $value ) {
$result = $this->_process_post_by_email(
'jetpack.createPostByEmailAddress',
esc_html__( 'Unable to create the Post by Email address. Please try again later.', 'jetpack' )
);
} elseif ( 'regenerate' == $value ) {
$result = $this->_process_post_by_email(
'jetpack.regeneratePostByEmailAddress',
esc_html__( 'Unable to regenerate the Post by Email address. Please try again later.', 'jetpack' )
);
} elseif ( 'delete' == $value ) {
$result = $this->_process_post_by_email(
'jetpack.deletePostByEmailAddress',
esc_html__( 'Unable to delete the Post by Email address. Please try again later.', 'jetpack' )
);
} else {
$result = false;
}
$result = Jetpack_Post_By_Email::init()->process_api_request( $value );

// If we got an email address (create or regenerate) or 1 (delete), consider it done.
if ( is_string( $result ) && preg_match( '/[a-z0-9]+@post.wordpress.com/', $result ) ) {
Expand Down Expand Up @@ -1206,39 +1189,6 @@ static function has_business_address_widget( $sidebar ) {
return false;
}

/**
* Calls WPCOM through authenticated request to create, regenerate or delete the Post by Email address.
* @todo: When all settings are updated to use endpoints, move this to the Post by Email module and replace __process_ajax_proxy_request.
*
* @since 4.3.0
*
* @param string $endpoint Process to call on WPCOM to create, regenerate or delete the Post by Email address.
* @param string $error Error message to return.
*
* @return array
*/
private function _process_post_by_email( $endpoint, $error ) {
if ( ! current_user_can( 'edit_posts' ) ) {
return array( 'message' => $error );
}

$this->xmlrpc->query( $endpoint );

if ( $this->xmlrpc->isError() ) {
return array( 'message' => $error );
}

$response = $this->xmlrpc->getResponse();
if ( empty( $response ) ) {
return array( 'message' => $error );
}

// Used only in Jetpack_Core_Json_Api_Endpoints::get_remote_value.
update_option( 'post_by_email_address' . get_current_user_id(), $response );

return $response;
}

/**
* Check if user is allowed to perform the update.
*
Expand Down
2 changes: 2 additions & 0 deletions bin/phpcs-whitelist.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ module.exports = [
'modules/memberships/',
'modules/module-extras.php',
'modules/module-info.php',
'modules/post-by-email.php',
'modules/post-by-email/',
'modules/search/class-jetpack-instant-search.php',
'modules/search/class-jetpack-search-customize.php',
'modules/search/class.jetpack-search-options.php',
Expand Down
192 changes: 7 additions & 185 deletions modules/post-by-email.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<?php

/**
* Module Name: Post by email
* Module Description: Publish posts by sending an email
Expand All @@ -10,192 +9,15 @@
* Module Tags: Writing
* Feature: Writing
* Additional Search Queries: post by email, email
*
* @package Jetpack
*/

/**
* Require the PBE Class.
*/
require_once dirname( __FILE__ ) . '/post-by-email/class-jetpack-post-by-email.php';

add_action( 'jetpack_modules_loaded', array( 'Jetpack_Post_By_Email', 'init' ) );

Jetpack::enable_module_configurable( __FILE__ );

class Jetpack_Post_By_Email {
public static function init() {
static $instance = NULL;

if ( !$instance ) {
$instance = new Jetpack_Post_By_Email;
}

return $instance;
}

function __construct() {
add_action( 'init', array( &$this, 'action_init' ) );
}

function action_init() {
if ( ! current_user_can( 'edit_posts' ) )
return;

add_action( 'profile_personal_options', array( &$this, 'user_profile' ) );
add_action( 'admin_print_scripts-profile.php', array( &$this, 'profile_scripts' ) );

add_action( 'wp_ajax_jetpack_post_by_email_enable', array( &$this, 'create_post_by_email_address' ) );
add_action( 'wp_ajax_jetpack_post_by_email_regenerate', array( &$this, 'regenerate_post_by_email_address' ) );
add_action( 'wp_ajax_jetpack_post_by_email_disable', array( &$this, 'delete_post_by_email_address' ) );
}

function profile_scripts() {
wp_enqueue_script( 'post-by-email', plugins_url( 'post-by-email/post-by-email.js', __FILE__ ), array( 'jquery' ) );
wp_localize_script( 'post-by-email', 'pbeVars', array(
'nonces' => array(
'enable' => wp_create_nonce( 'jetpack.createPostByEmailAddress' ),
'regenerate' => wp_create_nonce( 'jetpack.regeneratePostByEmailAddress' ),
'disable' => wp_create_nonce( 'jetpack.deletePostByEmailAddress' ),
),
));
wp_enqueue_style( 'post-by-email', plugins_url( 'post-by-email/post-by-email.css', __FILE__ ) );
wp_style_add_data( 'post-by-email', 'jetpack-inline', true );
// Do we really need `admin_styles`? With the new admin UI, it's breaking some bits.
// Jetpack::init()->admin_styles();
}

function check_user_connection() {
$user_token = Jetpack_Data::get_access_token( get_current_user_id() );
$is_user_connected = $user_token && !is_wp_error( $user_token );

// If the user is already connected via Jetpack, then we're good
if ( $is_user_connected )
return true;

return false;
}

function user_profile() {
$blog_name = get_bloginfo( 'blogname' );
if ( empty( $blog_name ) ) {
$blog_name = home_url( '/' );
}

?>
<div id="post-by-email" class="jetpack-targetable">
<h3><?php esc_html_e( 'Post by Email', 'jetpack' ); ?></h3>
<table class="form-table">
<tr>
<th scope="row"><?php esc_html_e( 'Email Address', 'jetpack' ); ?><span id="jp-pbe-spinner" class="spinner"></span></th>
<td>
<div id="jp-pbe-error" class="jetpack-inline-error"></div> <?php

if ( $this->check_user_connection() ) {
$email = $this->get_post_by_email_address();

if ( empty( $email ) ) {
$enable_hidden = '';
$info_hidden = ' style="display: none;"';
} else {
$enable_hidden = ' style="display: none;"';
$info_hidden = '';
} ?>

<input type="button" name="jp-pbe-enable" id="jp-pbe-enable" class="button" value="<?php esc_attr_e( 'Enable Post By Email', 'jetpack' ); ?> "<?php echo $enable_hidden; ?> />
<div id="jp-pbe-info"<?php echo $info_hidden; ?>>
<p id="jp-pbe-email-wrapper">
<input type="text" id="jp-pbe-email" value="<?php echo esc_attr( $email ); ?>" readonly="readonly" class="regular-text" />
<span class="description"><a target="_blank" href="https://jetpack.com/support/post-by-email/"><?php esc_html_e( 'More information', 'jetpack' ); ?></a></span>
</p>
<p>
<input type="button" name="jp-pbe-regenerate" id="jp-pbe-regenerate" class="button" value="<?php esc_attr_e( 'Regenerate Address', 'jetpack' ); ?> " />
<input type="button" name="jp-pbe-disable" id="jp-pbe-disable" class="button" value="<?php esc_attr_e( 'Disable Post By Email', 'jetpack' ); ?> " />
</p>
</div> <?php
} else {
$jetpack = Jetpack::init(); ?>

<p class="jetpack-inline-message">
<?php printf(
esc_html( wptexturize( __( 'To use Post By Email, you need to link your %s account to your WordPress.com account.', 'jetpack' ) ) ),
'<strong>' . esc_html( $blog_name ) . '</strong>'
); ?><br />
<?php echo esc_html( wptexturize( __( "If you don't have a WordPress.com account yet, you can sign up for free in just a few seconds.", 'jetpack' ) ) ); ?>
</p>
<p>
<a href="<?php echo $jetpack->build_connect_url( false, get_edit_profile_url( get_current_user_id() ) . '#post-by-email', 'unlinked-user-pbe' ); ?>" class="button button-connector" id="wpcom-connect"><?php esc_html_e( 'Link account with WordPress.com', 'jetpack' ); ?></a>
</p>
<?php
} ?>
</td>
</tr>
</table>
</div>
<?php
}

function get_post_by_email_address() {
$xml = new Jetpack_IXR_Client( array(
'user_id' => get_current_user_id(),
) );
$xml->query( 'jetpack.getPostByEmailAddress' );

if ( $xml->isError() )
return NULL;

$response = $xml->getResponse();
if ( empty( $response ) )
return NULL;

return $response;
}

function create_post_by_email_address() {
self::__process_ajax_proxy_request(
'jetpack.createPostByEmailAddress',
__( 'Unable to create your Post By Email address. Please try again later.', 'jetpack' )
);
}

function regenerate_post_by_email_address() {
self::__process_ajax_proxy_request(
'jetpack.regeneratePostByEmailAddress',
__( 'Unable to regenerate your Post By Email address. Please try again later.', 'jetpack' )
);
}

function delete_post_by_email_address() {
self::__process_ajax_proxy_request(
'jetpack.deletePostByEmailAddress',
__( 'Unable to disable your Post By Email address. Please try again later.', 'jetpack' )
);
}

/**
* Back end function to abstract the xmlrpc function calls to wpcom.
*
* @param $endpoint
* @param $error_message
*/
function __process_ajax_proxy_request( $endpoint, $error_message ) { // phpcs:ignore
if ( ! current_user_can( 'edit_posts' ) ) {
wp_send_json_error( $error_message );
}
if ( empty( $_REQUEST['pbe_nonce'] ) || ! wp_verify_nonce( $_REQUEST['pbe_nonce'], $endpoint ) ) {
wp_send_json_error( $error_message );
}

$xml = new Jetpack_IXR_Client( array(
'user_id' => get_current_user_id(),
) );
$xml->query( $endpoint );

if ( $xml->isError() ) {
wp_send_json_error( $error_message );
}

$response = $xml->getResponse();
if ( empty( $response ) ) {
wp_send_json_error( $error_message );
}

// Will be used only in Jetpack_Core_Json_Api_Endpoints::get_remote_value.
update_option( 'post_by_email_address' . get_current_user_id(), $response );

wp_send_json_success( $response );
}
}
Loading