<!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>[47246] trunk: Privacy: Give progress indication for export and erasure.</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/47246">47246</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/47246","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-02-10 20:17:58 +0000 (Mon, 10 Feb 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: Give progress indication for export and erasure.
This adds a progress indicator for "Download Personal Data" and "Erase Personal Data" row actions, which can take a while with a lot of data.
Props garrett-eclipse, allendav, dominic_ks, xkon, karmatosed, birgire.
Fixes <a href="https://core.trac.wordpress.org/ticket/44264">#44264</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjs_enqueuesadminprivacytoolsjs">trunk/src/js/_enqueues/admin/privacy-tools.js</a></li>
<li><a href="#trunksrcwpadminincludesclasswpprivacydataexportrequestslisttablephp">trunk/src/wp-admin/includes/class-wp-privacy-data-export-requests-list-table.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswpprivacydataremovalrequestslisttablephp">trunk/src/wp-admin/includes/class-wp-privacy-data-removal-requests-list-table.php</a></li>
<li><a href="#trunktestsphpunittestsprivacywpPrivacySendRequestConfirmationNotificationphp">trunk/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjs_enqueuesadminprivacytoolsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/_enqueues/admin/privacy-tools.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/_enqueues/admin/privacy-tools.js 2020-02-10 19:55:51 UTC (rev 47245)
+++ trunk/src/js/_enqueues/admin/privacy-tools.js 2020-02-10 20:17:58 UTC (rev 47246)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -59,6 +59,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> var $this = $( this ),
</span><span class="cx" style="display: block; padding: 0 10px"> $action = $this.parents( '.export-personal-data' ),
</span><span class="cx" style="display: block; padding: 0 10px"> $requestRow = $this.parents( 'tr' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $progress = $requestRow.find( '.export-progress' );
</ins><span class="cx" style="display: block; padding: 0 10px"> requestID = $action.data( 'request-id' ),
</span><span class="cx" style="display: block; padding: 0 10px"> nonce = $action.data( 'nonce' ),
</span><span class="cx" style="display: block; padding: 0 10px"> exportersCount = $action.data( 'exporters-count' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -69,6 +70,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $action.blur();
</span><span class="cx" style="display: block; padding: 0 10px"> clearResultsAfterRow( $requestRow );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ setExportProgress( 0 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function onExportDoneSuccess( zipUrl ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var summaryMessage = strings.emailSent;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -77,7 +79,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> appendResultsAfterRow( $requestRow, 'notice-success', summaryMessage, [] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this.hide();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'undefined' !== typeof zipUrl ) {
</span><span class="cx" style="display: block; padding: 0 10px"> window.location = zipUrl;
</span><span class="cx" style="display: block; padding: 0 10px"> } else if ( ! sendAsEmail ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,6 +94,12 @@
</span><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">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function setExportProgress( exporterIndex ) {
+ var progress = ( exportersCount > 0 ? exporterIndex / exportersCount : 0 );
+ var progressString = Math.round( progress * 100 ).toString() + '%';
+ $progress.html( progressString );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function doNextExport( exporterIndex, pageIndex ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $.ajax(
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -120,6 +128,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> setTimeout( doNextExport( exporterIndex, pageIndex + 1 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( exporterIndex < exportersCount ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ setExportProgress( exporterIndex );
</ins><span class="cx" style="display: block; padding: 0 10px"> setTimeout( doNextExport( exporterIndex + 1, 1 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> onExportDoneSuccess( responseData.url );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,6 +150,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> var $this = $( this ),
</span><span class="cx" style="display: block; padding: 0 10px"> $action = $this.parents( '.remove-personal-data' ),
</span><span class="cx" style="display: block; padding: 0 10px"> $requestRow = $this.parents( 'tr' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $progress = $requestRow.find( '.erasure-progress' );
</ins><span class="cx" style="display: block; padding: 0 10px"> requestID = $action.data( 'request-id' ),
</span><span class="cx" style="display: block; padding: 0 10px"> nonce = $action.data( 'nonce' ),
</span><span class="cx" style="display: block; padding: 0 10px"> erasersCount = $action.data( 'erasers-count' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -152,6 +162,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $action.blur();
</span><span class="cx" style="display: block; padding: 0 10px"> clearResultsAfterRow( $requestRow );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ setErasureProgress( 0 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function onErasureDoneSuccess() {
</span><span class="cx" style="display: block; padding: 0 10px"> var summaryMessage = strings.noDataFound;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -183,6 +194,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> appendResultsAfterRow( $requestRow, 'notice-error', strings.removalError, [] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function setErasureProgress( eraserIndex ) {
+ var progress = ( erasersCount > 0 ? eraserIndex / erasersCount : 0 );
+ var progressString = Math.round( progress * 100 ).toString() + '%';
+ $progress.html( progressString );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function doNextErasure( eraserIndex, pageIndex ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $.ajax({
</span><span class="cx" style="display: block; padding: 0 10px"> url: window.ajaxurl,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -214,6 +231,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> setTimeout( doNextErasure( eraserIndex, pageIndex + 1 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( eraserIndex < erasersCount ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ setErasureProgress( eraserIndex );
</ins><span class="cx" style="display: block; padding: 0 10px"> setTimeout( doNextErasure( eraserIndex + 1, 1 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> onErasureDoneSuccess();
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswpprivacydataexportrequestslisttablephp"></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/class-wp-privacy-data-export-requests-list-table.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-privacy-data-export-requests-list-table.php 2020-02-10 19:55:51 UTC (rev 47245)
+++ trunk/src/wp-admin/includes/class-wp-privacy-data-export-requests-list-table.php 2020-02-10 20:17:58 UTC (rev 47246)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -57,7 +57,7 @@
</span><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"> $download_data_markup .= '<span class="export-personal-data-idle"><button type="button" class="button-link export-personal-data-handle">' . __( 'Download Personal Data' ) . '</button></span>' .
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<span class="export-personal-data-processing hidden">' . __( 'Downloading Data...' ) . '</span>' .
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<span class="export-personal-data-processing hidden">' . __( 'Downloading Data...' ) . ' <span class="export-progress"></span></span>' .
</ins><span class="cx" style="display: block; padding: 0 10px"> '<span class="export-personal-data-success hidden"><button type="button" class="button-link export-personal-data-handle">' . __( 'Download Personal Data Again' ) . '</button></span>' .
</span><span class="cx" style="display: block; padding: 0 10px"> '<span class="export-personal-data-failed hidden">' . __( 'Download failed.' ) . ' <button type="button" class="button-link">' . __( 'Retry' ) . '</button></span>';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,7 +100,7 @@
</span><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"> <span class="export-personal-data-idle"><button type="button" class="button export-personal-data-handle"><?php _e( 'Send Export Link' ); ?></button></span>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <span class="export-personal-data-processing button updating-message hidden"><?php _e( 'Sending Email...' ); ?></span>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <span class="export-personal-data-processing button updating-message hidden"><?php _e( 'Sending Email...' ); ?> <span class="export-progress"></span></span>
</ins><span class="cx" style="display: block; padding: 0 10px"> <span class="export-personal-data-success success-message hidden"><?php _e( 'Email sent.' ); ?></span>
</span><span class="cx" style="display: block; padding: 0 10px"> <span class="export-personal-data-failed hidden"><?php _e( 'Email could not be sent.' ); ?> <button type="button" class="button export-personal-data-handle"><?php _e( 'Retry' ); ?></button></span>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswpprivacydataremovalrequestslisttablephp"></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/class-wp-privacy-data-removal-requests-list-table.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-privacy-data-removal-requests-list-table.php 2020-02-10 19:55:51 UTC (rev 47245)
+++ trunk/src/wp-admin/includes/class-wp-privacy-data-removal-requests-list-table.php 2020-02-10 20:17:58 UTC (rev 47246)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -62,7 +62,7 @@
</span><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"> $remove_data_markup .= '<span class="remove-personal-data-idle"><button type="button" class="button-link remove-personal-data-handle">' . __( 'Force Erase Personal Data' ) . '</button></span>' .
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<span class="remove-personal-data-processing hidden">' . __( 'Erasing Data...' ) . '</span>' .
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<span class="remove-personal-data-processing hidden">' . __( 'Erasing Data...' ) . ' <span class="erasure-progress"></span></span>' .
</ins><span class="cx" style="display: block; padding: 0 10px"> '<span class="remove-personal-data-success hidden">' . __( 'Erasure completed.' ) . '</span>' .
</span><span class="cx" style="display: block; padding: 0 10px"> '<span class="remove-personal-data-failed hidden">' . __( 'Force Erasure has failed.' ) . ' <button type="button" class="button-link remove-personal-data-handle">' . __( 'Retry' ) . '</button></span>';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -106,7 +106,7 @@
</span><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"> <span class="remove-personal-data-idle"><button type="button" class="button remove-personal-data-handle"><?php _e( 'Erase Personal Data' ); ?></button></span>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <span class="remove-personal-data-processing button updating-message hidden"><?php _e( 'Erasing Data...' ); ?></span>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <span class="remove-personal-data-processing button updating-message hidden"><?php _e( 'Erasing Data...' ); ?> <span class="erasure-progress"></span></span>
</ins><span class="cx" style="display: block; padding: 0 10px"> <span class="remove-personal-data-success success-message hidden" ><?php _e( 'Erasure completed.' ); ?></span>
</span><span class="cx" style="display: block; padding: 0 10px"> <span class="remove-personal-data-failed hidden"><?php _e( 'Data Erasure has failed.' ); ?> <button type="button" class="button remove-personal-data-handle"><?php _e( 'Retry' ); ?></button></span>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span></span></pre></div>
<a id="trunktestsphpunittestsprivacywpPrivacySendRequestConfirmationNotificationphp"></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/wpPrivacySendRequestConfirmationNotification.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php 2020-02-10 19:55:51 UTC (rev 47245)
+++ trunk/tests/phpunit/tests/privacy/wpPrivacySendRequestConfirmationNotification.php 2020-02-10 20:17:58 UTC (rev 47246)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -156,8 +156,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.8
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $admin_email The email address of the notification recipient.
- * @param WP_User_Request $request The request that is initiating the notification.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $admin_email The email address of the notification recipient.
+ * @param WP_User_Request $request The request that is initiating the notification.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Admin email address.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function modify_email_address( $admin_email, $request ) {
</span></span></pre>
</div>
</div>
</body>
</html>