<!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>[42889] trunk/src/wp-admin: Privacy: add support for exporting multiple pages of 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 { 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/42889">42889</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/42889","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>azaozz</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-03-28 19:27:59 +0000 (Wed, 28 Mar 2018)</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: add support for exporting multiple pages of personal data.
Props allendav.
See <a href="https://core.trac.wordpress.org/ticket/43438">#43438</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminadminajaxphp">trunk/src/wp-admin/admin-ajax.php</a></li>
<li><a href="#trunksrcwpadminincludesajaxactionsphp">trunk/src/wp-admin/includes/ajax-actions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminadminajaxphp"></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/admin-ajax.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/admin-ajax.php 2018-03-28 17:24:06 UTC (rev 42888)
+++ trunk/src/wp-admin/admin-ajax.php 2018-03-28 19:27:59 UTC (rev 42889)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -129,6 +129,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'get-post-thumbnail-html',
</span><span class="cx" style="display: block; padding: 0 10px"> 'get-community-events',
</span><span class="cx" style="display: block; padding: 0 10px"> 'edit-theme-plugin-file',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wp-privacy-export-personal-data',
</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"> // Deprecated
</span></span></pre></div>
<a id="trunksrcwpadminincludesajaxactionsphp"></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/ajax-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/ajax-actions.php 2018-03-28 17:24:06 UTC (rev 42888)
+++ trunk/src/wp-admin/includes/ajax-actions.php 2018-03-28 19:27:59 UTC (rev 42889)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4326,3 +4326,120 @@
</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 wp_ajax_wp_privacy_export_personal_data() {
+// check_ajax_referer( 'wp-privacy-export-personal-data', 'security' );
+
+ if ( ! current_user_can( 'manage_options' ) ) {
+ wp_send_json_error( 'access denied' );
+ }
+
+ $email_address = sanitize_text_field( $_POST['email'] );
+ $exporter_index = (int) $_POST['exporter'];
+ $page = (int) $_POST['page'];
+
+ /**
+ * Filters the array of exporter callbacks.
+ *
+ * @since 4.9.5.
+ *
+ * @param array $args {
+ * An array of callable exporters of personal data. Default empty array.
+ * [
+ * callback string Callable exporter that accepts an email address and
+ * a page and returns an array of name => value
+ * pairs of personal data
+ * exporter_friendly_name string Translated user facing friendly name for the exporter
+ * ]
+ * }
+ */
+ $exporters = apply_filters( 'wp_privacy_personal_data_exporters', array() );
+
+ if ( ! is_array( $exporters ) ) {
+ wp_send_json_error( 'An exporter has improperly used the registration filter.' );
+ }
+
+ // Do we have any registered exporters?
+ if ( 0 < count( $exporters ) ) {
+ if ( $exporter_index < 1 ) {
+ wp_send_json_error( 'Exporter index cannot be negative.' );
+ }
+
+ if ( $exporter_index > count( $exporters ) ) {
+ wp_send_json_error( 'Exporter index out of range.' );
+ }
+
+ $index = $exporter_index - 1;
+
+ if ( $page < 1 ) {
+ wp_send_json_error( 'Page index cannot be less than one.' );
+ }
+
+ // Surprisingly, email addresses can contain mutli-byte characters now
+ $email_address = trim( mb_strtolower( $email_address ) );
+
+ if ( ! is_email( $email_address ) ) {
+ wp_send_json_error( 'A valid email address must be given.' );
+ }
+
+ $exporter = $exporters[ $index ];
+ if ( ! is_array( $exporter ) ) {
+ wp_send_json_error( "Expected an array describing the exporter at index {$exporter_index}." );
+ }
+ if ( ! array_key_exists( 'callback', $exporter ) ) {
+ wp_send_json_error( "Exporter array at index {$exporter_index} does not include a callback." );
+ }
+ if ( ! is_callable( $exporter['callback'] ) ) {
+ wp_send_json_error( "Exporter callback at index {$exporter_index} is not a valid callback." );
+ }
+ if ( ! array_key_exists( 'exporter_friendly_name', $exporter ) ) {
+ wp_send_json_error( "Exporter array at index {$exporter_index} does not include a friendly name." );
+ }
+
+ $callback = $exporters[ $index ]['callback'];
+ $exporter_friendly_name = $exporters[ $index ]['exporter_friendly_name'];
+
+ $response = call_user_func( $callback, $email_address, $page );
+ if ( is_wp_error( $response ) ) {
+ wp_send_json_error( $response );
+ }
+
+ if ( ! is_array( $response ) ) {
+ wp_send_json_error( "Expected response as an array from exporter: {$exporter_friendly_name}." );
+ }
+ if ( ! array_key_exists( 'data', $response ) ) {
+ wp_send_json_error( "Expected data in response array from exporter: {$exporter_friendly_name}." );
+ }
+ if ( ! is_array( $response['data'] ) ) {
+ wp_send_json_error( "Expected data array in response array from exporter: {$exporter_friendly_name}." );
+ }
+ if ( ! array_key_exists( 'done', $response ) ) {
+ wp_send_json_error( "Expected done (boolean) in response array from exporter: {$exporter_friendly_name}." );
+ }
+ } else {
+ // No exporters, so we're done
+ $response = array(
+ 'data' => array(),
+ 'done' => true,
+ );
+ }
+
+ /**
+ * Filters a page of personal data exporter data. Used to build the export report.
+ *
+ * Allows the export response to be consumed by destinations in addition to Ajax.
+ *
+ * @since 4.9.5
+ *
+ * @param array $response The personal data for the given exporter and page.
+ * @param int $exporter_index The index of the exporter that provided this data.
+ * @param string $email_address The email address associated with this personal data.
+ * @param int $page The zero-based page for this response.
+ */
+ $response = apply_filters( 'wp_privacy_personal_data_export_page', $response, $exporter_index, $email_address, $page );
+ if ( is_wp_error( $response ) ) {
+ wp_send_json_error( $response );
+ }
+
+ wp_send_json_success( $response );
+}
</ins></span></pre>
</div>
</div>
</body>
</html>