enmi-conf.org: comparison wp/wp-admin/includes/privacy-tools.php

equal deleted inserted replaced

-:34716fd837a4
+:be944660c56a
 *
 * @since 4.9.6
 * @access private
 *
 * @param int $request_id Request ID.
-* @return bool|WP_Error Returns true/false based on the success of sending the email, or a WP_Error object.
+* @return true|WP_Error Returns true if sending the email was successful, or a WP_Error object.
 */
 function _wp_privacy_resend_request( $request_id ) {
 	$request_id = absint( $request_id );
 	$request    = get_post( $request_id );
 	if ( ! $request || 'user_request' !== $request->post_type ) {
-		return new WP_Error( 'privacy_request_error', __( 'Invalid request.' ) );
+		return new WP_Error( 'privacy_request_error', __( 'Invalid personal data request.' ) );
 	}
 	$result = wp_send_user_request( $request_id );
 	if ( is_wp_error( $result ) ) {
 		return $result;
 	} elseif ( ! $result ) {
-		return new WP_Error( 'privacy_request_error', __( 'Unable to initiate confirmation request.' ) );
+		return new WP_Error( 'privacy_request_error', __( 'Unable to initiate confirmation for personal data request.' ) );
 	}
 	return true;
 }
 	// Get the request.
 	$request_id = absint( $request_id );
 	$request    = wp_get_user_request( $request_id );
 	if ( ! $request ) {
-		return new WP_Error( 'privacy_request_error', __( 'Invalid request.' ) );
+		return new WP_Error( 'privacy_request_error', __( 'Invalid personal data request.' ) );
 	}
 	update_post_meta( $request_id, '_wp_user_request_completed_timestamp', time() );
 	$result = wp_update_post(
 				if ( ! isset( $_POST['type_of_action'], $_POST['username_or_email_for_privacy_request'] ) ) {
 					add_settings_error(
 						'action_type',
 						'action_type',
-						__( 'Invalid action.' ),
+						__( 'Invalid personal data action.' ),
 						'error'
 					);
 				}
 				$action_type               = sanitize_text_field( wp_unslash( $_POST['type_of_action'] ) );
 				$username_or_email_address = sanitize_text_field( wp_unslash( $_POST['username_or_email_for_privacy_request'] ) );
 				$email_address             = '';
+				$status                    = 'pending';
+				if ( ! isset( $_POST['send_confirmation_email'] ) ) {
+					$status = 'confirmed';
+				}
 				if ( ! in_array( $action_type, _wp_privacy_action_request_types(), true ) ) {
 					add_settings_error(
 						'action_type',
 						'action_type',
-						__( 'Invalid action.' ),
+						__( 'Invalid personal data action.' ),
 						'error'
 					);
 				}
 				if ( ! is_email( $username_or_email_address ) ) {
 				if ( empty( $email_address ) ) {
 					break;
 				}
-				$request_id = wp_create_user_request( $email_address, $action_type );
+				$request_id = wp_create_user_request( $email_address, $action_type, array(), $status );
+				$message    = '';
 				if ( is_wp_error( $request_id ) ) {
+					$message = $request_id->get_error_message();
+				} elseif ( ! $request_id ) {
+					$message = __( 'Unable to initiate confirmation request.' );
+				}
+				if ( $message ) {
 					add_settings_error(
 						'username_or_email_for_privacy_request',
 						'username_or_email_for_privacy_request',
-						$request_id->get_error_message(),
+						$message,
-						'error'
-					);
-					break;
-				} elseif ( ! $request_id ) {
-					add_settings_error(
-						'username_or_email_for_privacy_request',
-						'username_or_email_for_privacy_request',
-						__( 'Unable to initiate confirmation request.' ),
 						'error'
 					);
 					break;
 				}
-				wp_send_user_request( $request_id );
+				if ( 'pending' === $status ) {
+					wp_send_user_request( $request_id );
-				add_settings_error(
-					'username_or_email_for_privacy_request',
+					$message = __( 'Confirmation request initiated successfully.' );
-					'username_or_email_for_privacy_request',
+				} elseif ( 'confirmed' === $status ) {
-					__( 'Confirmation request initiated successfully.' ),
+					$message = __( 'Request added successfully.' );
-					'success'
+				}
-				);
-				break;
+				if ( $message ) {
+					add_settings_error(
+						'username_or_email_for_privacy_request',
+						'username_or_email_for_privacy_request',
+						$message,
+						'success'
+					);
+					break;
+				}
 		}
 	}
 }
 /**
 		$group_html .= '</table>';
 	}
 	if ( $groups_count > 1 ) {
 		$group_html .= '<div class="return-to-top">';
-		$group_html .= '<a href="#top"><span aria-hidden="true">&uarr; </span> ' . esc_html__( 'Return to top' ) . '</a>';
+		$group_html .= '<a href="#top"><span aria-hidden="true">&uarr; </span> ' . esc_html__( 'Go to top' ) . '</a>';
 		$group_html .= '</div>';
 	}
 	$group_html .= '</div>';
 *
 * @param int $request_id The export request ID.
 */
 function wp_privacy_generate_personal_data_export_file( $request_id ) {
 	if ( ! class_exists( 'ZipArchive' ) ) {
-		wp_send_json_error( __( 'Unable to generate export file. ZipArchive not available.' ) );
+		wp_send_json_error( __( 'Unable to generate personal data export file. ZipArchive not available.' ) );
 	}
 	// Get the request.
 	$request = wp_get_user_request( $request_id );
 	if ( ! $request || 'export_personal_data' !== $request->action_name ) {
-		wp_send_json_error( __( 'Invalid request ID when generating export file.' ) );
+		wp_send_json_error( __( 'Invalid request ID when generating personal data export file.' ) );
 	}
 	$email_address = $request->email;
 	if ( ! is_email( $email_address ) ) {
-		wp_send_json_error( __( 'Invalid email address when generating export file.' ) );
+		wp_send_json_error( __( 'Invalid email address when generating personal data export file.' ) );
 	}
 	// Create the exports folder if needed.
 	$exports_dir = wp_privacy_exports_dir();
 	$exports_url = wp_privacy_exports_url();
 	if ( ! wp_mkdir_p( $exports_dir ) ) {
-		wp_send_json_error( __( 'Unable to create export folder.' ) );
+		wp_send_json_error( __( 'Unable to create personal data export folder.' ) );
 	}
 	// Protect export folder from browsing.
-	$index_pathname = $exports_dir . 'index.html';
+	$index_pathname = $exports_dir . 'index.php';
 	if ( ! file_exists( $index_pathname ) ) {
 		$file = fopen( $index_pathname, 'w' );
 		if ( false === $file ) {
-			wp_send_json_error( __( 'Unable to protect export folder from browsing.' ) );
+			wp_send_json_error( __( 'Unable to protect personal data export folder from browsing.' ) );
 		}
-		fwrite( $file, '<!-- Silence is golden. -->' );
+		fwrite( $file, "<?php\n// Silence is golden.\n" );
 		fclose( $file );
 	}
 	$obscura              = wp_generate_password( 32, false, false );
 	$file_basename        = 'wp-personal-data-file-' . $obscura;
 	$title = sprintf(
 		/* translators: %s: User's email address. */
 		__( 'Personal Data Export for %s' ),
 		$email_address
 	);
-	// And now, all the Groups.
-	$groups = get_post_meta( $request_id, '_export_data_grouped', true );
 	// First, build an "About" group on the fly for this report.
 	$about_group = array(
 		/* translators: Header for the About section in a personal data export. */
 		'group_label'       => _x( 'About', 'personal data group label' ),
 				),
 			),
 		),
 	);
-	// Merge in the special about group.
+	// And now, all the Groups.
-	$groups = array_merge( array( 'about' => $about_group ), $groups );
+	$groups = get_post_meta( $request_id, '_export_data_grouped', true );
+	if ( is_array( $groups ) ) {
-	$groups_count = count( $groups );
+		// Merge in the special "About" group.
+		$groups       = array_merge( array( 'about' => $about_group ), $groups );
+		$groups_count = count( $groups );
+	} else {
+		if ( false !== $groups ) {
+			_doing_it_wrong(
+				__FUNCTION__,
+				/* translators: %s: Post meta key. */
+				sprintf( __( 'The %s post meta must be an array.' ), '<code>_export_data_grouped</code>' ),
+				'5.8.0'
+			);
+		}
+		$groups       = null;
+		$groups_count = 0;
+	}
 	// Convert the groups to JSON format.
 	$groups_json = wp_json_encode( $groups );
+	if ( false === $groups_json ) {
+		$error_message = sprintf(
+			/* translators: %s: Error message. */
+			__( 'Unable to encode the personal data for export. Error: %s' ),
+			json_last_error_msg()
+		);
+		wp_send_json_error( $error_message );
+	}
 	/*
 	 * 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.' ) );
+		wp_send_json_error( __( 'Unable to open personal data export file (JSON report) for writing.' ) );
 	}
 	fwrite( $file, '{' );
 	fwrite( $file, '"' . $title . '":' );
 	fwrite( $file, $groups_json );
 	 * 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.' ) );
+		wp_send_json_error( __( 'Unable to open personal data export (HTML report) for writing.' ) );
 	}
 	fwrite( $file, "<!DOCTYPE html>\n" );
 	fwrite( $file, "<html>\n" );
 	fwrite( $file, "<head>\n" );
 	}
 	$zip = new ZipArchive;
 	if ( true === $zip->open( $archive_pathname, ZipArchive::CREATE ) ) {
 		if ( ! $zip->addFile( $json_report_pathname, 'export.json' ) ) {
-			$error = __( 'Unable to add data to JSON file.' );
+			$error = __( 'Unable to archive the personal data export file (JSON format).' );
 		}
 		if ( ! $zip->addFile( $html_report_pathname, 'index.html' ) ) {
-			$error = __( 'Unable to add data to HTML file.' );
+			$error = __( 'Unable to archive the personal data export file (HTML format).' );
 		}
 		$zip->close();
 		if ( ! $error ) {
 			 * @param string $json_report_pathname The full path to the JSON personal data report on the filesystem.
 			 */
 			do_action( 'wp_privacy_personal_data_export_file_created', $archive_pathname, $archive_url, $html_report_pathname, $request_id, $json_report_pathname );
 		}
 	} else {
-		$error = __( 'Unable to open export file (archive) for writing.' );
+		$error = __( 'Unable to open personal data export file (archive) for writing.' );
 	}
 	// Remove the JSON file.
 	unlink( $json_report_pathname );
 	 */
 	$subject = apply_filters( 'wp_privacy_personal_data_email_subject', $subject, $site_name, $email_data );
 	/* translators: Do not translate EXPIRATION, LINK, SITENAME, SITEURL: those are placeholders. */
 	$email_text = __(
-		'Howdy,
+// phpcs:ignore Generic.WhiteSpace.ScopeIndent.Incorrect, PEAR.Functions.FunctionCallSignature.Indent
+'Howdy,
 Your request for an export of personal data has been completed. You may
 download your personal data by clicking on the link below. For privacy
 and security, we will automatically delete the file on ###EXPIRATION###,
 so please download it before then.
 	// Get the request.
 	$request = wp_get_user_request( $request_id );
 	if ( ! $request || 'export_personal_data' !== $request->action_name ) {
-		wp_send_json_error( __( 'Invalid request ID when merging exporter data.' ) );
+		wp_send_json_error( __( 'Invalid request ID when merging personal data to export.' ) );
 	}
 	$export_data = array();
 	// First exporter, first page? Reset the report data accumulation array.
 	if ( 1 === $exporter_index && 1 === $page ) {
 		update_post_meta( $request_id, '_export_data_raw', $export_data );
 	} else {
-		$export_data = get_post_meta( $request_id, '_export_data_raw', true );
+		$accumulated_data = get_post_meta( $request_id, '_export_data_raw', true );
+		if ( $accumulated_data ) {
+			$export_data = $accumulated_data;
+		}
 	}
 	// Now, merge the data from the exporter response into the data we have accumulated already.
 	$export_data = array_merge( $export_data, $response['data'] );
 	update_post_meta( $request_id, '_export_data_raw', $export_data );
 	// Get the request.
 	$request = wp_get_user_request( $request_id );
 	if ( ! $request || 'remove_personal_data' !== $request->action_name ) {
-		wp_send_json_error( __( 'Invalid request ID when processing eraser data.' ) );
+		wp_send_json_error( __( 'Invalid request ID when processing personal data to erase.' ) );
 	}
 	/** This filter is documented in wp-admin/includes/ajax-actions.php */
 	$erasers        = apply_filters( 'wp_privacy_personal_data_erasers', array() );
 	$is_last_eraser = count( $erasers ) === $eraser_index;

changeset 18	be944660c56a
parent 16	a86126ab1dd4
child 19	3d72ae0968f4