<!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>[47146] trunk: Privacy: Introduce a JSON file into the personal data export.</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/47146">47146</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/47146","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-01-31 01:34:17 +0000 (Fri, 31 Jan 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: Introduce a JSON file into the personal data export.
The produced ZIP archive will now include an `export.json` file along with the current `index.html`.
Props xkon.
Fixes <a href="https://core.trac.wordpress.org/ticket/49029">#49029</a>. See <a href="https://core.trac.wordpress.org/ticket/46424">#46424</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesprivacytoolsphp">trunk/src/wp-admin/includes/privacy-tools.php</a></li>
<li><a href="#trunktestsphpunittestsprivacywpPrivacyGeneratePersonalDataExportFilephp">trunk/tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportFile.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-01-31 01:15:32 UTC (rev 47145)
+++ trunk/src/wp-admin/includes/privacy-tools.php 2020-01-31 01:34:17 UTC (rev 47146)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -324,11 +324,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $file_basename = 'wp-personal-data-file-' . $obscura;
</span><span class="cx" style="display: block; padding: 0 10px"> $html_report_filename = wp_unique_filename( $exports_dir, $file_basename . '.html' );
</span><span class="cx" style="display: block; padding: 0 10px"> $html_report_pathname = wp_normalize_path( $exports_dir . $html_report_filename );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $file = fopen( $html_report_pathname, 'w' );
- if ( false === $file ) {
- wp_send_json_error( __( 'Unable to open export file (HTML report) for writing.' ) );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $json_report_filename = $file_basename . '.json';
+ $json_report_pathname = wp_normalize_path( $exports_dir . $json_report_filename );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Gather general data needed.
+ */
+
+ // Title.
</ins><span class="cx" style="display: block; padding: 0 10px"> $title = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: User's email address. */
</span><span class="cx" style="display: block; padding: 0 10px"> __( 'Personal Data Export for %s' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -335,31 +338,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $email_address
</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">- // Open HTML.
- fwrite( $file, "<!DOCTYPE html>\n" );
- fwrite( $file, "<html>\n" );
-
- // Head.
- fwrite( $file, "<head>\n" );
- fwrite( $file, "<meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />\n" );
- fwrite( $file, "<style type='text/css'>" );
- fwrite( $file, 'body { color: black; font-family: Arial, sans-serif; font-size: 11pt; margin: 15px auto; width: 860px; }' );
- fwrite( $file, 'table { background: #f0f0f0; border: 1px solid #ddd; margin-bottom: 20px; width: 100%; }' );
- fwrite( $file, 'th { padding: 5px; text-align: left; width: 20%; }' );
- fwrite( $file, 'td { padding: 5px; }' );
- fwrite( $file, 'tr:nth-child(odd) { background-color: #fafafa; }' );
- fwrite( $file, '</style>' );
- fwrite( $file, '<title>' );
- fwrite( $file, esc_html( $title ) );
- fwrite( $file, '</title>' );
- fwrite( $file, "</head>\n" );
-
- // Body.
- fwrite( $file, "<body>\n" );
-
- // Heading.
- fwrite( $file, '<h1>' . esc_html__( 'Personal Data Export' ) . '</h1>' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // And now, all the Groups.
</span><span class="cx" style="display: block; padding: 0 10px"> $groups = get_post_meta( $request_id, '_export_data_grouped', true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -394,6 +372,51 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Merge in the special about group.
</span><span class="cx" style="display: block; padding: 0 10px"> $groups = array_merge( array( 'about' => $about_group ), $groups );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Convert the groups to JSON format.
+ $groups_json = wp_json_encode( $groups );
+
+ /*
+ * Handle the JSON export.
+ */
+ $file = fopen( $json_report_pathname, 'w' );
+
+ if ( false === $file ) {
+ wp_send_json_error( __( 'Unable to open export file (JSON report) for writing.' ) );
+ }
+
+ fwrite( $file, '{' );
+ fwrite( $file, '"' . $title . '":' );
+ fwrite( $file, $groups_json );
+ fwrite( $file, '}' );
+ fclose( $file );
+
+ /*
+ * Handle the HTML export.
+ */
+ $file = fopen( $html_report_pathname, 'w' );
+
+ if ( false === $file ) {
+ wp_send_json_error( __( 'Unable to open export file (HTML report) for writing.' ) );
+ }
+
+ fwrite( $file, "<!DOCTYPE html>\n" );
+ fwrite( $file, "<html>\n" );
+ fwrite( $file, "<head>\n" );
+ fwrite( $file, "<meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />\n" );
+ fwrite( $file, "<style type='text/css'>" );
+ fwrite( $file, 'body { color: black; font-family: Arial, sans-serif; font-size: 11pt; margin: 15px auto; width: 860px; }' );
+ fwrite( $file, 'table { background: #f0f0f0; border: 1px solid #ddd; margin-bottom: 20px; width: 100%; }' );
+ fwrite( $file, 'th { padding: 5px; text-align: left; width: 20%; }' );
+ fwrite( $file, 'td { padding: 5px; }' );
+ fwrite( $file, 'tr:nth-child(odd) { background-color: #fafafa; }' );
+ fwrite( $file, '</style>' );
+ fwrite( $file, '<title>' );
+ fwrite( $file, esc_html( $title ) );
+ fwrite( $file, '</title>' );
+ fwrite( $file, "</head>\n" );
+ fwrite( $file, "<body>\n" );
+ fwrite( $file, '<h1>' . esc_html__( 'Personal Data Export' ) . '</h1>' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Now, iterate over every group in $groups and have the formatter render it in HTML.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $groups as $group_id => $group_data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> fwrite( $file, wp_privacy_generate_personal_data_export_group_html( $group_data ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -400,8 +423,6 @@
</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"> fwrite( $file, "</body>\n" );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- // Close HTML.
</del><span class="cx" style="display: block; padding: 0 10px"> fwrite( $file, "</html>\n" );
</span><span class="cx" style="display: block; padding: 0 10px"> fclose( $file );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -431,8 +452,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $zip = new ZipArchive;
</span><span class="cx" style="display: block; padding: 0 10px"> if ( true === $zip->open( $archive_pathname, ZipArchive::CREATE ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $zip->addFile( $json_report_pathname, 'export.json' ) ) {
+ $error = __( 'Unable to add data to JSON file.' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $zip->addFile( $html_report_pathname, 'index.html' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $error = __( 'Unable to add data to export file.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error = __( 'Unable to add data to HTML file.' );
</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"> $zip->close();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -448,13 +473,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $html_report_pathname The full path to the personal data report on the filesystem.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $request_id The export request ID.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- do_action( 'wp_privacy_personal_data_export_file_created', $archive_pathname, $archive_url, $html_report_pathname, $request_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ do_action( 'wp_privacy_personal_data_export_file_created', $archive_pathname, $archive_url, $html_report_pathname, $request_id, $json_report_pathname );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $error = __( 'Unable to open export file (archive) for writing.' );
</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">- // And remove the HTML file.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Remove the JSON file.
+ unlink( $json_report_pathname );
+
+ // Remove the HTML file.
</ins><span class="cx" style="display: block; padding: 0 10px"> unlink( $html_report_pathname );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $error ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsprivacywpPrivacyGeneratePersonalDataExportFilephp"></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/wpPrivacyGeneratePersonalDataExportFile.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportFile.php 2020-01-31 01:15:32 UTC (rev 47145)
+++ trunk/tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportFile.php 2020-01-31 01:34:17 UTC (rev 47146)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -237,11 +237,11 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Test the export file has all the expected parts.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test the export HTML file has all the expected parts.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 44233
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_contents() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_html_contents() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->expectOutputString( '' );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_privacy_generate_personal_data_export_file( self::$export_request_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( file_exists( $this->export_file_name ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -264,4 +264,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( '<h2>About</h2>', $report_contents );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( $request->email, $report_contents );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Test the export JSON file has all the expected parts.
+ *
+ * @ticket 49029
+ */
+ public function test_json_contents() {
+ $this->expectOutputString( '' );
+ wp_privacy_generate_personal_data_export_file( self::$export_request_id );
+ $this->assertTrue( file_exists( $this->export_file_name ) );
+
+ $report_dir = trailingslashit( self::$exports_dir . 'test_contents' );
+ mkdir( $report_dir );
+
+ $zip = new ZipArchive();
+ $opened_zip = $zip->open( $this->export_file_name );
+ $this->assertTrue( $opened_zip );
+
+ $zip->extractTo( $report_dir );
+ $zip->close();
+
+ $request = wp_get_user_request_data( self::$export_request_id );
+
+ $this->assertTrue( file_exists( $report_dir . 'export.json' ) );
+
+ $report_contents_json = file_get_contents( $report_dir . 'export.json' );
+
+ $this->assertContains( '"Personal Data Export for ' . $request->email . '"', $report_contents_json );
+ $this->assertContains( '"about"', $report_contents_json );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>