From c520d26527a6dd81951c6aa6e37ea24a5589fd22 Mon Sep 17 00:00:00 2001 From: Corey McKrill <916023+coreymckrill@users.noreply.github.com> Date: Thu, 17 Oct 2019 16:12:53 -0700 Subject: [PATCH] Pledge Form: Abstract the procedure for getting filtered post input --- plugins/wporg-5ftf/includes/pledge-form.php | 119 +++++++++++++++++- plugins/wporg-5ftf/includes/pledge-meta.php | 27 +--- .../views/inputs-pledge-contributors.php | 2 +- .../views/inputs-pledge-new-misc.php | 7 +- 4 files changed, 124 insertions(+), 31 deletions(-) diff --git a/plugins/wporg-5ftf/includes/pledge-form.php b/plugins/wporg-5ftf/includes/pledge-form.php index 32381a3..1dc9f58 100755 --- a/plugins/wporg-5ftf/includes/pledge-form.php +++ b/plugins/wporg-5ftf/includes/pledge-form.php @@ -8,7 +8,7 @@ namespace WordPressDotOrg\FiveForTheFuture\PledgeForm; use WordPressDotOrg\FiveForTheFuture; use WordPressDotOrg\FiveForTheFuture\Pledge; use WordPressDotOrg\FiveForTheFuture\PledgeMeta; -use WP_Error; +use WP_Error, WP_Post, WP_User; defined( 'WPINC' ) || die(); @@ -23,9 +23,9 @@ add_shortcode( '5ftf_pledge_form_manage', __NAMESPACE__ . '\render_form_manage' */ function render_form_new() { $action = filter_input( INPUT_POST, 'action' ); + $data = get_form_submission(); $messages = []; $complete = false; - $data = PledgeMeta\get_pledge_meta(); if ( 'Submit Pledge' === $action ) { $processed = process_form_new(); @@ -50,7 +50,7 @@ function render_form_new() { * @return string|WP_Error String "success" if the form processed correctly. Otherwise WP_Error. */ function process_form_new() { - $submission = filter_input_array( INPUT_POST, PledgeMeta\get_input_filters() ); + $submission = get_form_submission(); $has_required = PledgeMeta\has_required_pledge_meta( $submission ); @@ -81,6 +81,13 @@ function process_form_new() { ); } + $contributors = parse_contributors( $submission['pledge-contributors'] ); + + if ( is_wp_error( $contributors ) ) { + return $contributors; + } + + /* $name = sanitize_meta( PledgeMeta\META_PREFIX . 'org-name', $submission['org-name'], @@ -95,6 +102,7 @@ function process_form_new() { } PledgeMeta\save_pledge_meta( $created, $submission ); + */ return 'success'; } @@ -135,7 +143,7 @@ function render_form_manage() { * @return string|WP_Error String "success" if the form processed correctly. Otherwise WP_Error. */ function process_form_manage() { - $submission = filter_input_array( INPUT_POST, PledgeMeta\get_input_filters() ); + $submission = get_form_submission(); $has_required = PledgeMeta\has_required_pledge_meta( $submission ); @@ -167,6 +175,25 @@ function process_form_manage() { } } +/** + * Get and sanitize $_POST values from a form submission. + * + * @return array|bool + */ +function get_form_submission() { + $input_filters = array_merge( + // Inputs that correspond to meta values. + wp_list_pluck( PledgeMeta\get_pledge_meta_config( 'user_input' ), 'php_filter' ), + // Inputs with no corresponding meta value. + array( + 'pledge-contributors' => FILTER_SANITIZE_STRING, + 'pledge-agreement' => FILTER_VALIDATE_BOOLEAN, + ) + ); + + return filter_input_array( INPUT_POST, $input_filters ); +} + /** * Check a key value against existing pledges to see if one already exists. * @@ -210,6 +237,90 @@ function has_existing_pledge( $key, $key_type, int $current_pledge_id = 0 ) { return ! empty( $matching_pledge ); } +/** + * TODO Move this to the contributor cpt include file. + * + * @param int $pledge_id + * + * @return array + */ +function get_pledge_contributors( $pledge_id = 0 ) { + $contributors = array(); + + // Get POST'd submission, if it exists. + $submission = filter_input( INPUT_POST, 'pledge-contributors', FILTER_SANITIZE_STRING ); + + // Get existing pledge, if it exists. + $pledge = get_post( $pledge_id ); + + if ( ! empty( $submission ) ) { + $contributors = array_map( 'sanitize_user', explode( ',', $submission ) ); + } elseif ( $pledge instanceof WP_Post ) { + // TODO the Contributor post type is being introduced in a separate PR. These details may change. + + $contributor_posts = get_posts( array( + 'post_type' => '', + 'post_status' => array( 'pending', 'publish' ), + 'post_parent' => $pledge_id, + 'numberposts' => -1, + ) ); + + $contributors = wp_list_pluck( $contributor_posts, 'post_title' ); + } + + return $contributors; +} + +/** + * Ensure each item in a list of usernames is valid and corresponds to a user. + * + * @param string $contributors A comma-separated list of username strings. + * + * @return array|WP_Error An array of sanitized wporg usernames on success. Otherwise WP_Error. + */ +function parse_contributors( $contributors ) { + $invalid_contributors = array(); + $sanitized_contributors = array(); + + $contributors = explode( ',', $contributors ); + + foreach ( $contributors as $wporg_username ) { + $sanitized_username = sanitize_user( $wporg_username ); + $user = get_user_by( 'login', $sanitized_username ); + + if ( $user instanceof WP_User ) { + $sanitized_contributors[] = $sanitized_username; + } else { + $invalid_contributors[] = $wporg_username; + } + } + + if ( ! empty( $invalid_contributors ) ) { + /* translators: Used between sponsor names in a list, there is a space after the comma. */ + $item_separator = _x( ', ', 'list item separator', 'wporg' ); + + return new WP_Error( + 'invalid_contributor', + sprintf( + /* translators: %s is a list of usernames. */ + __( 'The following contributor usernames are not valid: %s', 'wporg' ), + implode( $item_separator, $invalid_contributors ) + ) + ); + } + + if ( empty( $sanitized_contributors ) ) { + return new WP_Error( + 'contributor_required', + __( 'The pledge must have at least one contributor username.', 'wporg' ) + ); + } + + $sanitized_contributors = array_unique( $sanitized_contributors ); + + return $sanitized_contributors; +} + /** * * diff --git a/plugins/wporg-5ftf/includes/pledge-meta.php b/plugins/wporg-5ftf/includes/pledge-meta.php index 1c29d22..8bdce61 100755 --- a/plugins/wporg-5ftf/includes/pledge-meta.php +++ b/plugins/wporg-5ftf/includes/pledge-meta.php @@ -7,6 +7,7 @@ namespace WordPressDotOrg\FiveForTheFuture\PledgeMeta; use WordPressDotOrg\FiveForTheFuture; use WordPressDotOrg\FiveForTheFuture\Pledge; +use WordPressDotOrg\FiveForTheFuture\PledgeForm; use WP_Post, WP_Error; defined( 'WPINC' ) || die(); @@ -291,26 +292,6 @@ function has_required_pledge_meta( array $submission ) { return true; } -/** - * Get the input filters for submitted content. - * - * @return array - */ -function get_input_filters() { - return array_merge( - // Inputs that correspond to meta values. - wp_list_pluck( get_pledge_meta_config( 'user_input' ), 'php_filter' ), - // Inputs with no corresponding meta value. - array( - 'contributor-wporg-usernames' => [ - 'filter' => FILTER_SANITIZE_STRING, - 'flags' => FILTER_REQUIRE_ARRAY, - ], - 'pledge-agreement' => FILTER_VALIDATE_BOOLEAN, - ) - ); -} - /** * Get the metadata for a given pledge, or a default set if no pledge is provided. * @@ -326,13 +307,13 @@ function get_pledge_meta( $pledge_id = 0, $context = '' ) { $meta = array(); // Get POST'd submission, if it exists. - $submission = filter_input_array( INPUT_POST, get_input_filters() ); + $submission = PledgeForm\get_form_submission(); foreach ( $keys as $key => $config ) { if ( isset( $submission[ $key ] ) ) { $meta[ $key ] = $submission[ $key ]; - } else if ( $pledge instanceof WP_Post ) { - $meta_key = META_PREFIX . $key; + } elseif ( $pledge instanceof WP_Post ) { + $meta_key = META_PREFIX . $key; $meta[ $key ] = get_post_meta( $pledge->ID, $meta_key, true ); } else { $meta[ $key ] = $config['default'] ?: ''; diff --git a/plugins/wporg-5ftf/views/inputs-pledge-contributors.php b/plugins/wporg-5ftf/views/inputs-pledge-contributors.php index bc3fee3..96a13e2 100644 --- a/plugins/wporg-5ftf/views/inputs-pledge-contributors.php +++ b/plugins/wporg-5ftf/views/inputs-pledge-contributors.php @@ -16,7 +16,7 @@ namespace WordPressDotOrg\FiveForTheFuture\View; type="text" id="5ftf-pledge-contributors" name="pledge-contributors" - value="" + value="" required aria-describedby="5ftf-pledge-contributors-help" /> diff --git a/plugins/wporg-5ftf/views/inputs-pledge-new-misc.php b/plugins/wporg-5ftf/views/inputs-pledge-new-misc.php index 2954f53..3b74b78 100644 --- a/plugins/wporg-5ftf/views/inputs-pledge-new-misc.php +++ b/plugins/wporg-5ftf/views/inputs-pledge-new-misc.php @@ -12,11 +12,12 @@ namespace WordPressDotOrg\FiveForTheFuture\View; /> -