Skip to content

Adds escaping of some uncommon but valid email characters #3

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

Merged
a6software merged 1 commit into from
Feb 8, 2019
Merged

Adds escaping of some uncommon but valid email characters #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 43 additions & 7 deletions public/class-gdpr-requests-public.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public function delete_user( $user, $index ) {

if ( parent::remove_from_requests( $index ) ) {
$token = GDPR::generate_pin();
GDPR_Email::send( $user->user_email, 'delete-resolved', array( 'token' => $token ) );
GDPR_Email::send( $this->get_escaped_user_email_address( $user ), 'delete-resolved', array( 'token' => $token ) );
Copy link

@jmorgan74 jmorgan74 Feb 8, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
GDPR_Email::send( $this->get_escaped_user_email_address( $user ), 'delete-resolved', array( 'token' => $token ) );
$email_address = $this->get_escaped_user_email_address( $user )
GDPR_Email::send( $email_address , 'delete-resolved', array( 'token' => $token ) );

Copy link

@jmorgan74 jmorgan74 Feb 8, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just prefer to avoid "train coach" code, feels more readable. Not really an issue though, just readability.

Copy link
Author

@a6software a6software Feb 8, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aye, it's a good shout. TBH Jon I'm just trying to do the bare minimum with it to get it to a place where we can replace the existing GDPR plugin with this fork. I don't want to change anything too much, at this stage, just so if anything goes wrong there's less to rule out.

I will get onto tidying this entire thing up as part of a further PR I have in progress currently.

GDPR_Audit_Log::log( $user->ID, esc_html__( 'User was removed from the site.', 'gdpr' ) );
GDPR_Audit_Log::export_log( $user->ID, $token );
wp_delete_user( $user->ID );
Expand Down Expand Up @@ -196,14 +196,15 @@ public function send_request_email() {
break;
}

$key = parent::add_to_requests( $user->user_email, $type, $data );
$escaped_user_email = $this->get_escaped_user_email_address( $user );
$key = parent::add_to_requests( $escaped_user_email, $type, $data );

if ( 'export-data' !== $type ) {
$email_args['confirm_url'] = add_query_arg(
array(
'type' => $type,
'key' => $key,
'email' => $user->user_email,
'email' => $escaped_user_email,
),
home_url()
);
Expand All @@ -212,7 +213,7 @@ public function send_request_email() {
array(
'type' => $type,
'key' => $key,
'email' => $user->user_email,
'email' => $escaped_user_email,
'format' => 'xml',
),
home_url()
Expand All @@ -221,15 +222,15 @@ public function send_request_email() {
array(
'type' => $type,
'key' => $key,
'email' => $user->user_email,
'email' => $escaped_user_email,
'format' => 'json',
),
home_url()
);
}

if ( GDPR_Email::send(
$user->user_email,
$escaped_user_email,
"{$type}-request",
$email_args
) ) {
Expand Down Expand Up @@ -378,7 +379,7 @@ public function request_confirmed() {
$format = isset( $_GET['format'] ) ? sanitize_text_field( wp_unslash( $_GET['format'] ) ) : 'xml'; // WPCS: Input var ok, CSRF ok.
/* translators: File format. Can be XML or JSON */
GDPR_Audit_Log::log( $user->ID, sprintf( esc_html__( 'User downloaded all their data in %s format.', 'gdpr' ), $format ) );
$this->file_export_data( $user->user_email, $format, $key );
$this->file_export_data( $this->get_escaped_user_email_address( $user ), $format, $key );
break;
}
}
Expand Down Expand Up @@ -406,4 +407,39 @@ private function file_export_data( $email, $format, $key ) {
}
die();
}

/**
* Provides escaping for uncommon, yet valid email address characters.
*
* @param string $email_in The starting email address.
*
* @return mixed|string
*/
private function escape_email_address( $email_in = '' ) {
$email_out = '';
$email_string_length = \strlen( $email_in );

for ( $i = 0; $i < $email_string_length; $i++ ) {
$hex = dechex( ord( $email_in[ $i ] ) );
if ('' === $hex) {
$email_out .= rawurlencode( $email_in[ $i ] );
} else {
$email_out = $email_out . '%' . ( ( 1 === strlen( $hex ) ) ? ( '0' . strtoupper( $hex ) ) : strtoupper( $hex ) );
}
}
$email_out = str_replace( array( '+', '_', '.', '-' ), array( '%20', '%5F', '%2E', '%2D' ), $email_out );

return $email_out;
}

/**
* Get the escpaed user email address.
*
* @param WP_User $user the User object.
*
* @return mixed|string
*/
private function get_escaped_user_email_address( WP_User $user ) {
return $this->escape_email_address( $user->user_email );
}
}