Privacy: update and enhance the method to confirm user requests by email. Introduce WP_User_Request to hold all request vars similarly to WP_Post.

Props mikejolley.
See #43443.

Built from https://develop.svn.wordpress.org/trunk@43011


git-svn-id: http://core.svn.wordpress.org/trunk@42840 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Andrew Ozz 2018-04-27 17:31:22 +00:00
parent af6704edad
commit e9eb7518c0
5 changed files with 230 additions and 122 deletions

View File

@ -4463,12 +4463,13 @@ function wp_ajax_wp_privacy_erase_personal_data() {
check_ajax_referer( 'wp-privacy-erase-personal-data-' . $request_id, 'security' ); check_ajax_referer( 'wp-privacy-erase-personal-data-' . $request_id, 'security' );
// Find the request CPT // Find the request CPT
$request = get_post( $request_id ); $request = wp_get_user_request_data( $request_id );
if ( 'remove_personal_data' !== $request->post_title ) {
if ( ! $request || 'remove_personal_data' !== $request->action_name ) {
wp_send_json_error( __( 'Error: Invalid request ID.' ) ); wp_send_json_error( __( 'Error: Invalid request ID.' ) );
} }
$email_address = get_post_meta( $request_id, '_wp_user_request_user_email', true ); $email_address = $request->email;
if ( ! is_email( $email_address ) ) { if ( ! is_email( $email_address ) ) {
wp_send_json_error( __( 'Error: Invalid email address in request.' ) ); wp_send_json_error( __( 'Error: Invalid email address in request.' ) );

View File

@ -626,10 +626,12 @@ function _wp_privacy_completed_request( $request_id ) {
} }
update_post_meta( $request_id, '_wp_user_request_confirmed_timestamp', time() ); update_post_meta( $request_id, '_wp_user_request_confirmed_timestamp', time() );
$request = wp_update_post( array( $request = wp_update_post( array(
'ID' => $request_data['request_id'], 'ID' => $request_id,
'post_status' => 'request-confirmed', 'post_status' => 'request-confirmed',
) ); ) );
return $request; return $request;
} }
@ -771,6 +773,38 @@ function _wp_personal_data_handle_actions() {
} }
} }
/**
* Cleans up failed and expired requests before displaying the list table.
*
* @since 4.9.6
* @access private
*/
function _wp_personal_data_cleanup_requests() {
$expires = (int) apply_filters( 'user_request_key_expiration', DAY_IN_SECONDS );
$requests_query = new WP_Query( array(
'post_type' => 'user_request',
'posts_per_page' => -1,
'post_status' => 'request-pending',
'fields' => 'ids',
'date_query' => array(
array(
'column' => 'post_modified_gmt',
'before' => $expires . ' seconds ago',
),
),
) );
$request_ids = $requests_query->posts;
foreach ( $request_ids as $request_id ) {
wp_update_post( array(
'ID' => $request_id,
'post_status' => 'request-failed',
'post_password' => '',
) );
}
}
/** /**
* Personal data export. * Personal data export.
* *
@ -783,6 +817,7 @@ function _wp_personal_data_export_page() {
} }
_wp_personal_data_handle_actions(); _wp_personal_data_handle_actions();
_wp_personal_data_cleanup_requests();
$requests_table = new WP_Privacy_Data_Export_Requests_Table( array( $requests_table = new WP_Privacy_Data_Export_Requests_Table( array(
'plural' => 'privacy_requests', 'plural' => 'privacy_requests',
@ -844,6 +879,7 @@ function _wp_personal_data_removal_page() {
} }
_wp_personal_data_handle_actions(); _wp_personal_data_handle_actions();
_wp_personal_data_cleanup_requests();
// "Borrow" xfn.js for now so we don't have to create new files. // "Borrow" xfn.js for now so we don't have to create new files.
wp_enqueue_script( 'xfn' ); wp_enqueue_script( 'xfn' );
@ -882,7 +918,7 @@ function _wp_personal_data_removal_page() {
<form class="search-form wp-clearfix"> <form class="search-form wp-clearfix">
<?php $requests_table->search_box( __( 'Search Requests' ), 'requests' ); ?> <?php $requests_table->search_box( __( 'Search Requests' ), 'requests' ); ?>
<input type="hidden" name="page" value="export_personal_data" /> <input type="hidden" name="page" value="remove_personal_data" />
<input type="hidden" name="filter-status" value="<?php echo isset( $_REQUEST['filter-status'] ) ? esc_attr( sanitize_text_field( $_REQUEST['filter-status'] ) ) : ''; ?>" /> <input type="hidden" name="filter-status" value="<?php echo isset( $_REQUEST['filter-status'] ) ? esc_attr( sanitize_text_field( $_REQUEST['filter-status'] ) ) : ''; ?>" />
<input type="hidden" name="orderby" value="<?php echo isset( $_REQUEST['orderby'] ) ? esc_attr( sanitize_text_field( $_REQUEST['orderby'] ) ) : ''; ?>" /> <input type="hidden" name="orderby" value="<?php echo isset( $_REQUEST['orderby'] ) ? esc_attr( sanitize_text_field( $_REQUEST['orderby'] ) ) : ''; ?>" />
<input type="hidden" name="order" value="<?php echo isset( $_REQUEST['order'] ) ? esc_attr( sanitize_text_field( $_REQUEST['order'] ) ) : ''; ?>" /> <input type="hidden" name="order" value="<?php echo isset( $_REQUEST['order'] ) ? esc_attr( sanitize_text_field( $_REQUEST['order'] ) ) : ''; ?>" />
@ -948,11 +984,11 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
*/ */
public function get_columns() { public function get_columns() {
$columns = array( $columns = array(
'cb' => '<input type="checkbox" />', 'cb' => '<input type="checkbox" />',
'email' => __( 'Requester' ), 'email' => __( 'Requester' ),
'status' => __( 'Status' ), 'status' => __( 'Status' ),
'requested_timestamp' => __( 'Requested' ), 'created_timestamp' => __( 'Requested' ),
'next_steps' => __( 'Next Steps' ), 'next_steps' => __( 'Next Steps' ),
); );
return $columns; return $columns;
} }
@ -1000,7 +1036,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
SELECT post_status, COUNT( * ) AS num_posts SELECT post_status, COUNT( * ) AS num_posts
FROM {$wpdb->posts} FROM {$wpdb->posts}
WHERE post_type = %s WHERE post_type = %s
AND post_title = %s AND post_name = %s
GROUP BY post_status"; GROUP BY post_status";
$results = (array) $wpdb->get_results( $wpdb->prepare( $query, $this->post_type, $this->request_type ), ARRAY_A ); $results = (array) $wpdb->get_results( $wpdb->prepare( $query, $this->post_type, $this->request_type ), ARRAY_A );
@ -1088,7 +1124,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
case 'resend': case 'resend':
foreach ( $request_ids as $request_id ) { foreach ( $request_ids as $request_id ) {
$resend = _wp_privacy_resend_request( $request_id ); $resend = _wp_privacy_resend_request( $request_id );
if ( $resend && ! is_wp_error( $resend ) ) { if ( $resend && ! is_wp_error( $resend ) ) {
$count++; $count++;
} }
@ -1124,10 +1160,11 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
$posts_per_page = 20; $posts_per_page = 20;
$args = array( $args = array(
'post_type' => $this->post_type, 'post_type' => $this->post_type,
'title' => $this->request_type, 'post_name__in' => array( $this->request_type ),
'posts_per_page' => $posts_per_page, 'posts_per_page' => $posts_per_page,
'offset' => isset( $_REQUEST['paged'] ) ? max( 0, absint( $_REQUEST['paged'] ) - 1 ) * $posts_per_page: 0, 'offset' => isset( $_REQUEST['paged'] ) ? max( 0, absint( $_REQUEST['paged'] ) - 1 ) * $posts_per_page: 0,
'post_status' => 'any', 'post_status' => 'any',
's' => isset( $_REQUEST['s'] ) ? sanitize_text_field( $_REQUEST['s'] ) : '',
); );
if ( ! empty( $_REQUEST['filter-status'] ) ) { if ( ! empty( $_REQUEST['filter-status'] ) ) {
@ -1135,18 +1172,6 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
$args['post_status'] = $filter_status; $args['post_status'] = $filter_status;
} }
if ( ! empty( $_REQUEST['s'] ) ) {
$args['meta_query'] = array(
$name_query,
'relation' => 'AND',
array(
'key' => '_wp_user_request_user_email',
'value' => isset( $_REQUEST['s'] ) ? sanitize_text_field( $_REQUEST['s'] ): '',
'compare' => 'LIKE',
),
);
}
$requests_query = new WP_Query( $args ); $requests_query = new WP_Query( $args );
$requests = $requests_query->posts; $requests = $requests_query->posts;
@ -1154,6 +1179,8 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
$this->items[] = wp_get_user_request_data( $request->ID ); $this->items[] = wp_get_user_request_data( $request->ID );
} }
$this->items = array_filter( $this->items );
$this->set_pagination_args( $this->set_pagination_args(
array( array(
'total_items' => $requests_query->found_posts, 'total_items' => $requests_query->found_posts,
@ -1167,11 +1194,11 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param array $item Item being shown. * @param WP_User_Request $item Item being shown.
* @return string * @return string
*/ */
public function column_cb( $item ) { public function column_cb( $item ) {
return sprintf( '<input type="checkbox" name="request_id[]" value="%1$s" /><span class="spinner"></span>', esc_attr( $item['request_id'] ) ); return sprintf( '<input type="checkbox" name="request_id[]" value="%1$s" /><span class="spinner"></span>', esc_attr( $item->ID ) );
} }
/** /**
@ -1179,11 +1206,11 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param array $item Item being shown. * @param WP_User_Request $item Item being shown.
* @return string * @return string
*/ */
public function column_status( $item ) { public function column_status( $item ) {
$status = get_post_status( $item['request_id'] ); $status = get_post_status( $item->ID );
$status_object = get_post_status_object( $status ); $status_object = get_post_status_object( $status );
if ( ! $status_object || empty( $status_object->label ) ) { if ( ! $status_object || empty( $status_object->label ) ) {
@ -1194,10 +1221,10 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
switch ( $status ) { switch ( $status ) {
case 'request-confirmed': case 'request-confirmed':
$timestamp = $item['confirmed_timestamp']; $timestamp = $item->confirmed_timestamp;
break; break;
case 'request-completed': case 'request-completed':
$timestamp = $item['completed_timestamp']; $timestamp = $item->completed_timestamp;
break; break;
} }
@ -1238,14 +1265,14 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param array $item Item being shown. * @param WP_User_Request $item Item being shown.
* @param string $column_name Name of column being shown. * @param string $column_name Name of column being shown.
* @return string * @return string
*/ */
public function column_default( $item, $column_name ) { public function column_default( $item, $column_name ) {
$cell_value = $item[ $column_name ]; $cell_value = $item->$column_name;
if ( in_array( $column_name, array( 'requested_timestamp' ), true ) ) { if ( in_array( $column_name, array( 'created_timestamp' ), true ) ) {
return $this->get_timestamp_as_date( $cell_value ); return $this->get_timestamp_as_date( $cell_value );
} }
@ -1257,11 +1284,11 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param array $item Item being shown. * @param WP_User_Request $item Item being shown.
* @return string * @return string
*/ */
public function column_email( $item ) { public function column_email( $item ) {
return sprintf( '%1$s %2$s', $item['email'], $this->row_actions( array() ) ); return sprintf( '%1$s %2$s', $item->email, $this->row_actions( array() ) );
} }
/** /**
@ -1269,7 +1296,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param array $item Item being shown. * @param WP_User_Request $item Item being shown.
*/ */
public function column_next_steps( $item ) {} public function column_next_steps( $item ) {}
@ -1278,10 +1305,10 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param object $item The current item * @param WP_User_Request $item The current item
*/ */
public function single_row( $item ) { public function single_row( $item ) {
$status = get_post_status( $item['request_id'] ); $status = $item->status;
echo '<tr class="status-' . esc_attr( $status ) . '">'; echo '<tr class="status-' . esc_attr( $status ) . '">';
$this->single_row_columns( $item ); $this->single_row_columns( $item );
@ -1325,13 +1352,13 @@ class WP_Privacy_Data_Export_Requests_Table extends WP_Privacy_Requests_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param array $item Item being shown. * @param WP_User_Request $item Item being shown.
* @return string * @return string
*/ */
public function column_email( $item ) { public function column_email( $item ) {
$exporters = apply_filters( 'wp_privacy_personal_data_exporters', array() ); $exporters = apply_filters( 'wp_privacy_personal_data_exporters', array() );
$exporters_count = count( $exporters ); $exporters_count = count( $exporters );
$request_id = $item['request_id']; $request_id = $item->ID;
$nonce = wp_create_nonce( 'wp-privacy-export-personal-data-' . $request_id ); $nonce = wp_create_nonce( 'wp-privacy-export-personal-data-' . $request_id );
$download_data_markup = '<div class="download_personal_data" ' . $download_data_markup = '<div class="download_personal_data" ' .
@ -1348,7 +1375,7 @@ class WP_Privacy_Data_Export_Requests_Table extends WP_Privacy_Requests_Table {
'download_data' => $download_data_markup, 'download_data' => $download_data_markup,
); );
return sprintf( '%1$s %2$s', $item['email'], $this->row_actions( $row_actions ) ); return sprintf( '%1$s %2$s', $item->email, $this->row_actions( $row_actions ) );
} }
/** /**
@ -1356,10 +1383,10 @@ class WP_Privacy_Data_Export_Requests_Table extends WP_Privacy_Requests_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param array $item Item being shown. * @param WP_User_Request $item Item being shown.
*/ */
public function column_next_steps( $item ) { public function column_next_steps( $item ) {
$status = get_post_status( $item['request_id'] ); $status = $item->status;
switch ( $status ) { switch ( $status ) {
case 'request-pending': case 'request-pending':
@ -1369,12 +1396,12 @@ class WP_Privacy_Data_Export_Requests_Table extends WP_Privacy_Requests_Table {
// TODO Complete in follow on patch. // TODO Complete in follow on patch.
break; break;
case 'request-failed': case 'request-failed':
submit_button( __( 'Retry' ), 'secondary', 'privacy_action_email_retry[' . $item['request_id'] . ']', false ); submit_button( __( 'Retry' ), 'secondary', 'privacy_action_email_retry[' . $item->ID . ']', false );
break; break;
case 'request-completed': case 'request-completed':
echo '<a href="' . esc_url( wp_nonce_url( add_query_arg( array( echo '<a href="' . esc_url( wp_nonce_url( add_query_arg( array(
'action' => 'delete', 'action' => 'delete',
'request_id' => array( $item['request_id'] ) 'request_id' => array( $item->ID )
), admin_url( 'tools.php?page=export_personal_data' ) ), 'bulk-privacy_requests' ) ) . '">' . esc_html__( 'Remove request' ) . '</a>'; ), admin_url( 'tools.php?page=export_personal_data' ) ), 'bulk-privacy_requests' ) ) . '">' . esc_html__( 'Remove request' ) . '</a>';
break; break;
} }
@ -1410,18 +1437,18 @@ class WP_Privacy_Data_Removal_Requests_Table extends WP_Privacy_Requests_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param array $item Item being shown. * @param WP_User_Request $item Item being shown.
* @return string * @return string
*/ */
public function column_email( $item ) { public function column_email( $item ) {
$row_actions = array(); $row_actions = array();
// Allow the administrator to "force remove" the personal data even if confirmation has not yet been received // Allow the administrator to "force remove" the personal data even if confirmation has not yet been received.
$status = get_post_status( $item['request_id'] ); $status = $item->status;
if ( 'request-confirmed' !== $status ) { if ( 'request-confirmed' !== $status ) {
$erasers = apply_filters( 'wp_privacy_personal_data_erasers', array() ); $erasers = apply_filters( 'wp_privacy_personal_data_erasers', array() );
$erasers_count = count( $erasers ); $erasers_count = count( $erasers );
$request_id = $item['request_id']; $request_id = $item->ID;
$nonce = wp_create_nonce( 'wp-privacy-erase-personal-data-' . $request_id ); $nonce = wp_create_nonce( 'wp-privacy-erase-personal-data-' . $request_id );
$remove_data_markup = '<div class="remove_personal_data force_remove_personal_data" ' . $remove_data_markup = '<div class="remove_personal_data force_remove_personal_data" ' .
@ -1439,7 +1466,7 @@ class WP_Privacy_Data_Removal_Requests_Table extends WP_Privacy_Requests_Table {
); );
} }
return sprintf( '%1$s %2$s', $item['email'], $this->row_actions( $row_actions ) ); return sprintf( '%1$s %2$s', $item->email, $this->row_actions( $row_actions ) );
} }
/** /**
@ -1447,10 +1474,10 @@ class WP_Privacy_Data_Removal_Requests_Table extends WP_Privacy_Requests_Table {
* *
* @since 4.9.6 * @since 4.9.6
* *
* @param array $item Item being shown. * @param WP_User_Request $item Item being shown.
*/ */
public function column_next_steps( $item ) { public function column_next_steps( $item ) {
$status = get_post_status( $item['request_id'] ); $status = $item->status;
switch ( $status ) { switch ( $status ) {
case 'request-pending': case 'request-pending':
@ -1459,7 +1486,7 @@ class WP_Privacy_Data_Removal_Requests_Table extends WP_Privacy_Requests_Table {
case 'request-confirmed': case 'request-confirmed':
$erasers = apply_filters( 'wp_privacy_personal_data_erasers', array() ); $erasers = apply_filters( 'wp_privacy_personal_data_erasers', array() );
$erasers_count = count( $erasers ); $erasers_count = count( $erasers );
$request_id = $item['request_id']; $request_id = $item->ID;
$nonce = wp_create_nonce( 'wp-privacy-erase-personal-data-' . $request_id ); $nonce = wp_create_nonce( 'wp-privacy-erase-personal-data-' . $request_id );
echo '<div class="remove_personal_data" ' . echo '<div class="remove_personal_data" ' .
@ -1477,12 +1504,12 @@ class WP_Privacy_Data_Removal_Requests_Table extends WP_Privacy_Requests_Table {
break; break;
case 'request-failed': case 'request-failed':
submit_button( __( 'Retry' ), 'secondary', 'privacy_action_email_retry[' . $item['request_id'] . ']', false ); submit_button( __( 'Retry' ), 'secondary', 'privacy_action_email_retry[' . $item->ID . ']', false );
break; break;
case 'request-completed': case 'request-completed':
echo '<a href="' . esc_url( wp_nonce_url( add_query_arg( array( echo '<a href="' . esc_url( wp_nonce_url( add_query_arg( array(
'action' => 'delete', 'action' => 'delete',
'request_id' => array( $item['request_id'] ), 'request_id' => array( $item->ID ),
), admin_url( 'tools.php?page=remove_personal_data' ) ), 'bulk-privacy_requests' ) ) . '">' . esc_html__( 'Remove request' ) . '</a>'; ), admin_url( 'tools.php?page=remove_personal_data' ) ), 'bulk-privacy_requests' ) ) . '">' . esc_html__( 'Remove request' ) . '</a>';
break; break;
} }

View File

@ -3980,7 +3980,7 @@ function check_and_publish_future_post( $post_id ) {
* @return string Unique slug for the post, based on $post_name (with a -1, -2, etc. suffix) * @return string Unique slug for the post, based on $post_name (with a -1, -2, etc. suffix)
*/ */
function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_parent ) { function wp_unique_post_slug( $slug, $post_ID, $post_status, $post_type, $post_parent ) {
if ( in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) || ( 'inherit' == $post_status && 'revision' == $post_type ) ) { if ( in_array( $post_status, array( 'draft', 'pending', 'auto-draft' ) ) || ( 'inherit' == $post_status && 'revision' == $post_type ) || 'user_request' === $post_type ) {
return $slug; return $slug;
} }

View File

@ -2840,13 +2840,13 @@ function _wp_privacy_account_request_confirmed( $request_id ) {
return; return;
} }
if ( ! in_array( $request_data['status'], array( 'request-pending', 'request-failed' ), true ) ) { if ( ! in_array( $request_data->status, array( 'request-pending', 'request-failed' ), true ) ) {
return; return;
} }
update_post_meta( $request_id, '_wp_user_request_confirmed_timestamp', time() ); update_post_meta( $request_id, '_wp_user_request_confirmed_timestamp', time() );
wp_update_post( array( wp_update_post( array(
'ID' => $request_data['request_id'], 'ID' => $request_id,
'post_status' => 'request-confirmed', 'post_status' => 'request-confirmed',
) ); ) );
} }
@ -2862,7 +2862,7 @@ function _wp_privacy_account_request_confirmed( $request_id ) {
function _wp_privacy_account_request_confirmed_message( $message, $request_id ) { function _wp_privacy_account_request_confirmed_message( $message, $request_id ) {
$request = wp_get_user_request_data( $request_id ); $request = wp_get_user_request_data( $request_id );
if ( $request && in_array( $request['action'], _wp_privacy_action_request_types(), true ) ) { if ( $request && in_array( $request->action_name, _wp_privacy_action_request_types(), true ) ) {
$message = '<p class="message">' . __( 'Action has been confirmed.' ) . '</p>'; $message = '<p class="message">' . __( 'Action has been confirmed.' ) . '</p>';
$message .= __( 'The site administrator has been notified and will fulfill your request as soon as possible.' ); $message .= __( 'The site administrator has been notified and will fulfill your request as soon as possible.' );
} }
@ -2900,16 +2900,11 @@ function wp_create_user_request( $email_address = '', $action_name = '', $reques
// Check for duplicates. // Check for duplicates.
$requests_query = new WP_Query( array( $requests_query = new WP_Query( array(
'post_type' => 'user_request', 'post_type' => 'user_request',
'title' => $action_name, 'post_name__in' => array( $action_name ), // Action name stored in post_name column.
'post_status' => 'any', 'title' => $email_address, // Email address stored in post_title column.
'fields' => 'ids', 'post_status' => 'any',
'meta_query' => array( 'fields' => 'ids',
array(
'key' => '_wp_user_request_user_email',
'value' => $email_address,
),
),
) ); ) );
if ( $requests_query->found_posts ) { if ( $requests_query->found_posts ) {
@ -2918,7 +2913,8 @@ function wp_create_user_request( $email_address = '', $action_name = '', $reques
$request_id = wp_insert_post( array( $request_id = wp_insert_post( array(
'post_author' => $user_id, 'post_author' => $user_id,
'post_title' => $action_name, 'post_name' => $action_name,
'post_title' => $email_address,
'post_content' => wp_json_encode( $request_data ), 'post_content' => wp_json_encode( $request_data ),
'post_status' => 'request-pending', 'post_status' => 'request-pending',
'post_type' => 'user_request', 'post_type' => 'user_request',
@ -2926,13 +2922,6 @@ function wp_create_user_request( $email_address = '', $action_name = '', $reques
'post_date_gmt' => current_time( 'mysql', true ), 'post_date_gmt' => current_time( 'mysql', true ),
), true ); ), true );
if ( is_wp_error( $request_id ) ) {
return $request_id;
}
update_post_meta( $request_id, '_wp_user_request_user_email', $email_address );
update_post_meta( $request_id, '_wp_user_request_confirmed_timestamp', false );
return $request_id; return $request_id;
} }
@ -2963,7 +2952,7 @@ function wp_user_request_action_description( $action_name ) {
* *
* @param string $description The default description. * @param string $description The default description.
* @param string $action_name The name of the request. * @param string $action_name The name of the request.
*/ */
return apply_filters( 'user_request_action_description', $description, $action_name ); return apply_filters( 'user_request_action_description', $description, $action_name );
} }
@ -2979,25 +2968,15 @@ function wp_user_request_action_description( $action_name ) {
*/ */
function wp_send_user_request( $request_id ) { function wp_send_user_request( $request_id ) {
$request_id = absint( $request_id ); $request_id = absint( $request_id );
$request = get_post( $request_id ); $request = wp_get_user_request_data( $request_id );
if ( ! $request || 'user_request' !== $request->post_type ) { if ( ! $request ) {
return new WP_Error( 'user_request_error', __( 'Invalid request.' ) ); return new WP_Error( 'user_request_error', __( 'Invalid request.' ) );
} }
if ( 'request-pending' !== $request->post_status ) {
wp_update_post( array(
'ID' => $request_id,
'post_status' => 'request-pending',
'post_date' => current_time( 'mysql', false ),
'post_date_gmt' => current_time( 'mysql', true ),
) );
}
$email_data = array( $email_data = array(
'action_name' => $request->post_title, 'email' => $request->email,
'email' => get_post_meta( $request->ID, '_wp_user_request_user_email', true ), 'description' => wp_user_request_action_description( $request->action_name ),
'description' => wp_user_request_action_description( $request->post_title ),
'confirm_url' => add_query_arg( array( 'confirm_url' => add_query_arg( array(
'action' => 'confirmaction', 'action' => 'confirmaction',
'request_id' => $request_id, 'request_id' => $request_id,
@ -3045,12 +3024,12 @@ All at ###SITENAME###
* @param array $email_data { * @param array $email_data {
* Data relating to the account action email. * Data relating to the account action email.
* *
* @type string $action_name Name of the action being performed. * @type WP_User_Request $request User request object.
* @type string $email The email address this is being sent to. * @type string $email The email address this is being sent to.
* @type string $description Description of the action being performed so the user knows what the email is for. * @type string $description Description of the action being performed so the user knows what the email is for.
* @type string $confirm_url The link to click on to confirm the account action. * @type string $confirm_url The link to click on to confirm the account action.
* @type string $sitename The site name sending the mail. * @type string $sitename The site name sending the mail.
* @type string $siteurl The site URL sending the mail. * @type string $siteurl The site URL sending the mail.
* } * }
*/ */
$content = apply_filters( 'user_request_action_email_content', $email_text, $email_data ); $content = apply_filters( 'user_request_action_email_content', $email_text, $email_data );
@ -3066,7 +3045,7 @@ All at ###SITENAME###
} }
/** /**
* Returns a confirmation key for a user action and stores the hashed version. * Returns a confirmation key for a user action and stores the hashed version for future comparison.
* *
* @since 4.9.6 * @since 4.9.6
* *
@ -3085,8 +3064,13 @@ function wp_generate_user_request_key( $request_id ) {
$wp_hasher = new PasswordHash( 8, true ); $wp_hasher = new PasswordHash( 8, true );
} }
update_post_meta( $request_id, '_wp_user_request_confirm_key', $wp_hasher->HashPassword( $key ) ); wp_update_post( array(
update_post_meta( $request_id, '_wp_user_request_confirm_key_timestamp', time() ); 'ID' => $request_id,
'post_status' => 'request-pending',
'post_password' => $wp_hasher->HashPassword( $key ),
'post_modified' => current_time( 'mysql', false ),
'post_modified_gmt' => current_time( 'mysql', true ),
) );
return $key; return $key;
} }
@ -3110,7 +3094,7 @@ function wp_validate_user_request_key( $request_id, $key ) {
return new WP_Error( 'user_request_error', __( 'Invalid request.' ) ); return new WP_Error( 'user_request_error', __( 'Invalid request.' ) );
} }
if ( ! in_array( $request['status'], array( 'request-pending', 'request-failed' ), true ) ) { if ( ! in_array( $request->status, array( 'request-pending', 'request-failed' ), true ) ) {
return __( 'This link has expired.' ); return __( 'This link has expired.' );
} }
@ -3123,8 +3107,8 @@ function wp_validate_user_request_key( $request_id, $key ) {
$wp_hasher = new PasswordHash( 8, true ); $wp_hasher = new PasswordHash( 8, true );
} }
$key_request_time = $request['confirm_key_timestamp']; $key_request_time = $request->modified_timestamp;
$saved_key = $request['confirm_key']; $saved_key = $request->confirm_key;
if ( ! $saved_key ) { if ( ! $saved_key ) {
return new WP_Error( 'invalid_key', __( 'Invalid key' ) ); return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
@ -3165,23 +3149,119 @@ function wp_validate_user_request_key( $request_id, $key ) {
*/ */
function wp_get_user_request_data( $request_id ) { function wp_get_user_request_data( $request_id ) {
$request_id = absint( $request_id ); $request_id = absint( $request_id );
$request = get_post( $request_id ); $post = get_post( $request_id );
if ( ! $request || 'user_request' !== $request->post_type ) { if ( ! $post || 'user_request' !== $post->post_type ) {
return false; return false;
} }
return array( return new WP_User_Request( $post );
'request_id' => $request->ID, }
'user_id' => $request->post_author,
'email' => get_post_meta( $request->ID, '_wp_user_request_user_email', true ), /**
'action' => $request->post_title, * WP_User_Request class.
'requested_timestamp' => strtotime( $request->post_date_gmt ), *
'confirmed_timestamp' => get_post_meta( $request->ID, '_wp_user_request_confirmed_timestamp', true ), * Represents user request data loaded from a WP_Post object.
'completed_timestamp' => get_post_meta( $request->ID, '_wp_user_request_completed_timestamp', true ), *
'request_data' => json_decode( $request->post_content, true ), * @since 4.9.6
'status' => $request->post_status, */
'confirm_key' => get_post_meta( $request_id, '_wp_user_request_confirm_key', true ), final class WP_User_Request {
'confirm_key_timestamp' => get_post_meta( $request_id, '_wp_user_request_confirm_key_timestamp', true ), /**
); * Request ID.
*
* @var int
*/
public $ID = 0;
/**
* User ID.
*
* @var int
*/
public $user_id = 0;
/**
* User email.
*
* @var int
*/
public $email = '';
/**
* Action name.
*
* @var string
*/
public $action_name = '';
/**
* Current status.
*
* @var string
*/
public $status = '';
/**
* Timestamp this request was created.
*
* @var int|null
*/
public $created_timestamp = null;
/**
* Timestamp this request was last modified.
*
* @var int|null
*/
public $modified_timestamp = null;
/**
* Timestamp this request was confirmed.
*
* @var int
*/
public $confirmed_timestamp = null;
/**
* Timestamp this request was completed.
*
* @var int
*/
public $completed_timestamp = null;
/**
* Misc data assigned to this request.
*
* @var array
*/
public $request_data = array();
/**
* Key used to confirm this request.
*
* @var string
*/
public $confirm_key = '';
/**
* Constructor.
*
* @since 4.9.6
*
* @param WP_Post|object $post Post object.
*/
public function __construct( $post ) {
$this->ID = $post->ID;
$this->user_id = $post->post_author;
$this->email = $post->post_title;
$this->action_name = $post->post_name;
$this->status = $post->post_status;
$this->created_timestamp = strtotime( $post->post_date_gmt );
$this->modified_timestamp = strtotime( $post->post_modified_gmt );
$this->confirmed_timestamp = (int) get_post_meta( $post->ID, '_wp_user_request_confirmed_timestamp', true );
$this->completed_timestamp = (int) get_post_meta( $post->ID, '_wp_user_request_completed_timestamp', true );
$this->request_data = json_decode( $post->post_content, true );
$this->confirm_key = $post->post_password;
}
} }

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.0-alpha-43010'; $wp_version = '5.0-alpha-43011';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.