<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[48127] trunk: Privacy: Use relative paths for exported personal data.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/48127">48127</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/48127","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>whyisjake</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-22 22:38:11 +0000 (Mon, 22 Jun 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Privacy: Use relative paths for exported personal data.
Ensures back-compat while moving to paths off of the /exports directory.
Fixes: <a href="https://core.trac.wordpress.org/ticket/44038">#44038</a>.
Props: allendav, mrTall, desrosj, garrett-eclipse, cameronamcintyre, nmenescardi, xkon, whyisjake, davidbaumwald.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesprivacytoolsphp">trunk/src/wp-admin/includes/privacy-tools.php</a></li>
<li><a href="#trunktestsphpunittestsprivacywpPrivacyProcessPersonalDataExportPagephp">trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php</a></li>
<li><a href="#trunktestsphpunittestsprivacywpPrivacySendPersonalDataExportEmailphp">trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesprivacytoolsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/privacy-tools.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/privacy-tools.php 2020-06-22 21:24:44 UTC (rev 48126)
+++ trunk/src/wp-admin/includes/privacy-tools.php 2020-06-22 22:38:11 UTC (rev 48127)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -468,17 +468,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * filename, to avoid breaking any URLs that may have been previously sent
</span><span class="cx" style="display: block; padding: 0 10px"> * via email.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $error = false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error = false;
+
+ // This postmeta is used from version 5.4.
+ $archive_filename = get_post_meta( $request_id, '_export_file_name', true );
+
+ // These are used for backwards compatibility.
</ins><span class="cx" style="display: block; padding: 0 10px"> $archive_url = get_post_meta( $request_id, '_export_file_url', true );
</span><span class="cx" style="display: block; padding: 0 10px"> $archive_pathname = get_post_meta( $request_id, '_export_file_path', true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $archive_pathname ) || empty( $archive_url ) ) {
- $archive_filename = $file_basename . '.zip';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If archive_filename exists, make sure to remove deprecated postmeta.
+ if ( ! empty( $archive_filename ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $archive_pathname = $exports_dir . $archive_filename;
</span><span class="cx" style="display: block; padding: 0 10px"> $archive_url = $exports_url . $archive_filename;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_post_meta( $request_id, '_export_file_url', $archive_url );
- update_post_meta( $request_id, '_export_file_path', wp_normalize_path( $archive_pathname ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Remove the deprecated postmeta.
+ delete_post_meta( $request_id, '_export_file_url' );
+ delete_post_meta( $request_id, '_export_file_path' );
+ } elseif ( ! empty( $archive_pathname ) ) {
+ // Check if archive_pathname exists. If not, create the new postmeta and remove the deprecated.
+ $archive_filename = basename( $archive_pathname );
+ $archive_url = $exports_url . $archive_filename;
+
+ // Add the new postmeta that is used since version 5.4.
+ update_post_meta( $request_id, '_export_file_name', wp_normalize_path( $archive_filename ) );
+
+ // Remove the deprecated postmeta.
+ delete_post_meta( $request_id, '_export_file_url' );
+ delete_post_meta( $request_id, '_export_file_path' );
+ } else {
+ // If there's no archive_filename or archive_pathname create a new one.
+ $archive_filename = $file_basename . '.zip';
+ $archive_url = $exports_url . $archive_filename;
+ $archive_pathname = $exports_dir . $archive_filename;
+
+ // Add the new postmeta that is used since version 5.4.
+ update_post_meta( $request_id, '_export_file_name', wp_normalize_path( $archive_filename ) );
+
+ // Remove the deprecated postmeta.
+ delete_post_meta( $request_id, '_export_file_url' );
+ delete_post_meta( $request_id, '_export_file_path' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $archive_pathname ) && file_exists( $archive_pathname ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -539,6 +568,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Get the request.
</span><span class="cx" style="display: block; padding: 0 10px"> $request = wp_get_user_request( $request_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Get the export file URL.
+ $exports_url = wp_privacy_exports_url();
+ $export_file_name = get_post_meta( $request_id, '_export_file_name', true );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $request || 'export_personal_data' !== $request->action_name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'invalid_request', __( 'Invalid request ID when sending personal data export email.' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -556,7 +589,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $expiration = apply_filters( 'wp_privacy_export_expiration', 3 * DAY_IN_SECONDS );
</span><span class="cx" style="display: block; padding: 0 10px"> $expiration_date = date_i18n( get_option( 'date_format' ), time() + $expiration );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $export_file_url = get_post_meta( $request_id, '_export_file_url', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $export_file_url = $exports_url . $export_file_name;
</ins><span class="cx" style="display: block; padding: 0 10px"> $site_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
</span><span class="cx" style="display: block; padding: 0 10px"> $site_url = home_url();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -820,7 +853,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> _wp_privacy_completed_request( $request_id );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> // Modify the response to include the URL of the export file so the browser can fetch it.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $export_file_url = get_post_meta( $request_id, '_export_file_url', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $exports_url = wp_privacy_exports_url();
+ $export_file_name = get_post_meta( $request_id, '_export_file_name', true );
+ $export_file_url = $exports_url . $export_file_name;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $export_file_url ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $response['url'] = $export_file_url;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsprivacywpPrivacyProcessPersonalDataExportPagephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php 2020-06-22 21:24:44 UTC (rev 48126)
+++ trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php 2020-06-22 22:38:11 UTC (rev 48127)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -44,10 +44,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $response_last_page;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Export File Url.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Export Url.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 5.2.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.5.0
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @var string $export_url
+ */
+ protected static $export_url;
+
+ /**
+ * Export File Name.
+ *
+ * @since 5.5.0
+ *
+ * @var string $export_file_name
+ */
+ protected static $export_file_name;
+
+ /**
+ * Export File URL.
+ *
+ * @since 5.5.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @var string $export_file_url
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $export_file_url;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -131,7 +149,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function wpSetUpBeforeClass( $factory ) {
</span><span class="cx" style="display: block; padding: 0 10px"> self::$requester_email = 'requester@example.com';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self::$export_file_url = wp_privacy_exports_url() . 'wp-personal-data-file-Wv0RfMnGIkl4CFEDEEkSeIdfLmaUrLsl.zip';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$export_url = wp_privacy_exports_url();
+ self::$export_file_name = 'wp-personal-data-file-Wv0RfMnGIkl4CFEDEEkSeIdfLmaUrLsl.zip';
+ self::$export_file_url = self::$export_url . self::$export_file_name;
</ins><span class="cx" style="display: block; padding: 0 10px"> self::$request_id = wp_create_user_request( self::$requester_email, 'export_personal_data' );
</span><span class="cx" style="display: block; padding: 0 10px"> self::$page_index_first = 1;
</span><span class="cx" style="display: block; padding: 0 10px"> self::$page_index_last = 2;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -502,7 +522,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 44233
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_return_response_with_export_file_url_when_not_sent_as_email_for_last_exporter_on_last_page() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_post_meta( self::$request_id, '_export_file_url', self::$export_file_url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ update_post_meta( self::$request_id, '_export_file_name', self::$export_file_name );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Process data, given the last exporter, on the last page and not send as email.
</span><span class="cx" style="display: block; padding: 0 10px"> $actual_response = wp_privacy_process_personal_data_export_page(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -528,7 +548,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 44233
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_return_response_without_export_file_url_when_sent_as_email_for_last_exporter_on_last_page() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_post_meta( self::$request_id, '_export_file_url', self::$export_file_url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ update_post_meta( self::$request_id, '_export_file_name', self::$export_file_name );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Process data, given the last exporter, on the last page and send as email.
</span><span class="cx" style="display: block; padding: 0 10px"> $actual_response = wp_privacy_process_personal_data_export_page(
</span></span></pre></div>
<a id="trunktestsphpunittestsprivacywpPrivacySendPersonalDataExportEmailphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php 2020-06-22 21:24:44 UTC (rev 48126)
+++ trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php 2020-06-22 22:38:11 UTC (rev 48127)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -104,8 +104,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The function should send an export link to the requester when the user request is confirmed.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_function_should_send_export_link_to_requester() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $archive_url = wp_privacy_exports_url() . 'wp-personal-data-file-Wv0RfMnGIkl4CFEDEEkSeIdfLmaUrLsl.zip';
- update_post_meta( self::$request_id, '_export_file_url', $archive_url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $archive_url = wp_privacy_exports_url();
+ $archive_file_name = 'wp-personal-data-file-Wv0RfMnGIkl4CFEDEEkSeIdfLmaUrLsl.zip';
+ $archive_file_url = $archive_url . $archive_file_name;
+ update_post_meta( self::$request_id, '_export_file_name', $archive_file_name );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $email_sent = wp_privacy_send_personal_data_export_email( self::$request_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $mailer = tests_retrieve_phpmailer_instance();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -113,7 +115,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'request-confirmed', get_post_status( self::$request_id ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( self::$requester_email, $mailer->get_recipient( 'to' )->address );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( 'Personal Data Export', $mailer->get_sent()->subject );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertContains( $archive_url, $mailer->get_sent()->body );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertContains( $archive_file_url, $mailer->get_sent()->body );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( 'please download it', $mailer->get_sent()->body );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( $email_sent );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>