class-gravityview-change-entry-creator.php

Go to the documentation of this file.

<?php

/**
 * @since 1.2
 */
class GravityView_Change_Entry_Creator {

    /*
     * @var int Number of users to show in the select element
     */
    const DEFAULT_NUMBER_OF_USERS = 100;

    function __construct() {

        /**
         * @since  1.5.1
         */
        add_action( 'gform_user_registered', array( $this, 'assign_new_user_to_lead' ), 10, 4 );

        // ONLY ADMIN FROM HERE ON.
        if ( ! is_admin() ) {
            return;
        }

        /**
         * @filter `gravityview_disable_change_entry_creator` Disable the Change Entry Creator functionality
         * @since  1.7.4
         * @param boolean $disable Disable the Change Entry Creator functionality. Default: false.
         */
        if ( apply_filters( 'gravityview_disable_change_entry_creator', false ) ) {
            return;
        }

        /**
         * Use `init` to fix bbPress warning
         *
         * @see https://bbpress.trac.wordpress.org/ticket/2309
         */
        add_action( 'init', array( $this, 'load' ), 100 );

        add_action( 'plugins_loaded', array( $this, 'prevent_conflicts' ) );

        // Enqueue and allow selectWoo UI assets
        add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_selectwoo_assets' ) );
        add_filter( 'gform_noconflict_scripts', array( $this, 'register_gform_noconflict' ) );
        add_filter( 'gform_noconflict_styles', array( $this, 'register_gform_noconflict' ) );

        // Ajax callback to get users to change entry creator.
        add_action( 'wp_ajax_entry_creator_get_users', array( $this, 'entry_creator_get_users' ) );
    }

    /**
     * Enqueue selectWoo script and style.
     *
     * @since  2.9.1
     */
    function enqueue_selectwoo_assets() {

        if ( ! class_exists( 'GFForms' ) ) {
            return;
        }

        if ( ! in_array( GFForms::get_page(), array( 'entry_detail_edit' ) ) ) {
            return;
        }

        $version      = \GV\Plugin::$version;
        $script_debug = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';

        if ( gravityview()->plugin->is_GF_25() ) {
            wp_deregister_script( 'gform_selectwoo' );
            wp_dequeue_script( 'gform_selectwoo' );
        }

        wp_enqueue_script( 'gravityview_selectwoo', plugins_url( 'assets/lib/selectWoo/selectWoo.full.min.js', GRAVITYVIEW_FILE ), array(), $version );
        wp_enqueue_style( 'gravityview_selectwoo', plugins_url( 'assets/lib/selectWoo/selectWoo.min.css', GRAVITYVIEW_FILE ), array(), $version );

        wp_enqueue_script( 'gravityview_entry_creator', plugins_url( 'assets/js/admin-entry-creator' . $script_debug . '.js', GRAVITYVIEW_FILE ), array( 'jquery', 'gravityview_selectwoo' ), $version );

        wp_localize_script(
            'gravityview_entry_creator',
            'GVEntryCreator',
            array(
                'ajaxurl'  => admin_url( 'admin-ajax.php' ),
                'action'   => 'entry_creator_get_users',
                'gf25'    => (bool) gravityview()->plugin->is_GF_25(),
                'language' => array(
                    'search_placeholder' => esc_html__( 'Search by ID, login, email, or name.', 'gk-gravityview' ),
                ),
            )
        );
    }

    /**
     * Get users list for entry creator.
     *
     * @since  2.9.1
     *
     */
    function entry_creator_get_users() {

        $post_var = wp_parse_args(
            wp_unslash( $_POST ),
            array(
                'q'        => '',
                'gv_nonce' => '',
            )
        );

        if ( ! wp_verify_nonce( $post_var['gv_nonce'], 'gv_entry_creator' ) ) {
            die();
        }

        $search_string = $post_var['q'];

        if ( is_numeric( $search_string ) ) {
            $user_args = array(
                'search'         => $search_string . '*',
                'search_columns' => array( 'ID' ),
            );
        } else {
            $user_args = array(
                'search'         => '*' . $search_string . '*',
                'search_columns' => array( 'user_login', 'user_email', 'user_nicename', 'display_name' ),
            );
        }

        $users = GVCommon::get_users( 'change_entry_creator', $user_args );

        wp_send_json( $users, 200 );
    }

    /**
     * When an user is created using the User Registration add-on, assign the entry to them
     *
     * @since  1.5.1
     * @param int    $user_id  WordPress User ID
     * @param array  $config   User registration feed configuration
     * @param array  $entry    GF Entry array
     * @param string $password User password
     * @return void
     * @uses   RGFormsModel::update_lead_property() Modify the entry `created_by` field
     */
    function assign_new_user_to_lead( $user_id, $config, $entry = array(), $password = '' ) {

        /**
         * Disable assigning the new user to the entry by returning false.
         *
         * @param int   $user_id WordPress User ID
         * @param array $config  User registration feed configuration
         * @param array $entry   GF Entry array
         */
        $assign_to_lead = apply_filters( 'gravityview_assign_new_user_to_entry', true, $user_id, $config, $entry );

        // If filter returns false, do not process
        if ( empty( $assign_to_lead ) ) {
            return;
        }

        // Update the entry. The `false` prevents checking Akismet; `true` disables the user updated hook from firing
        $result = RGFormsModel::update_entry_property( (int) $entry['id'], 'created_by', (int) $user_id, false, true );

        if ( false === $result ) {
            $status = __( 'Error', 'gk-gravityview' );
            global $wpdb;
            $note = sprintf( '%s: Failed to assign User ID #%d as the entry creator (Last database error: "%s")', $status, $user_id, $wpdb->last_error );
        } else {
            $status = __( 'Success', 'gk-gravityview' );
            $note   = sprintf( _x( '%s: Assigned User ID #%d as the entry creator.', 'First parameter: Success or error of the action. Second: User ID number', 'gk-gravityview' ), $status, $user_id );
        }

        gravityview()->log->debug( 'GravityView_Change_Entry_Creator[assign_new_user_to_lead] - {note}', array( 'note' => $note ) );

        /**
         * @filter `gravityview_disable_change_entry_creator_note` Disable adding a note when changing the entry creator
         * @since  1.21.5
         * @param boolean $disable Disable the Change Entry Creator note. Default: false.
         */
        if ( apply_filters( 'gravityview_disable_change_entry_creator_note', false ) ) {
            return;
        }

        GravityView_Entry_Notes::add_note( $entry['id'], - 1, 'GravityView', $note, 'gravityview' );

    }

    /**
     * Disable previous functionality; use this one as the canonical.
     *
     * @return void
     */
    function prevent_conflicts() {

        // Plugin that was provided here:
        // @link https://gravityview.co/support/documentation/201991205/
        remove_action( "gform_entry_info", 'gravityview_change_entry_creator_form', 10 );
        remove_action( "gform_after_update_entry", 'gravityview_update_entry_creator', 10 );

    }

    /**
     * @since  3.6.3
     * @return void
     */
    function load() {

        // Does GF exist?
        if ( ! class_exists( 'GFCommon' ) ) {
            return;
        }

        // Can the user edit entries?
        if ( ! GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_entries' ) ) ) {
            return;
        }

        // If screen mode isn't set, then we're in the wrong place.
        if ( empty( $_REQUEST['screen_mode'] ) ) {
            return;
        }

        // Now, no validation is required in the methods; let's hook in.
        add_action( 'admin_init', array( &$this, 'set_screen_mode' ) );

        add_action( 'gform_entry_info', array( &$this, 'add_select' ), 10, 2 );

        add_action( "gform_after_update_entry", array( &$this, 'update_entry_creator' ), 10, 2 );

    }

    /**
     * Allows for edit links to work with a link instead of a form (GET instead of POST)
     *
     * @return void
     */
    function set_screen_mode() {

        if ( 'view' === \GV\Utils::_POST( 'screen_mode' ) ) {
            return;
        }

        // If $_GET['screen_mode'] is set to edit, set $_POST value
        if ( \GV\Utils::_GET( 'screen_mode' ) === 'edit' ) {
            $_POST["screen_mode"] = 'edit';
        }

    }

    /**
     * When the entry creator is changed, add a note to the entry
     *
     * @param array $form     GF entry array
     * @param int   $entry_id Entry ID
     * @return void
     */
    function update_entry_creator( $form, $entry_id ) {

        global $current_user;

        // Update the entry
        $created_by = absint( \GV\Utils::_POST( 'created_by' ) );

        RGFormsModel::update_lead_property( $entry_id, 'created_by', $created_by );

        // If the creator has changed, let's add a note about who it used to be.
        $originally_created_by = \GV\Utils::_POST( 'originally_created_by' );

        // If there's no owner and there didn't used to be, keep going
        if ( empty( $originally_created_by ) && empty( $created_by ) ) {
            return;
        }

        // If the values have changed
        if ( absint( $originally_created_by ) !== absint( $created_by ) ) {

            $user_data = get_userdata( $current_user->ID );

            $user_format = _x( '%s (ID #%d)', 'The name and the ID of users who initiated changes to entry ownership', 'gk-gravityview' );

            $original_name = $created_by_name = esc_attr_x( 'No User', 'To show that the entry was unassigned from an actual user to no user.', 'gk-gravityview' );

            if ( ! empty( $originally_created_by ) ) {
                $originally_created_by_user_data = get_userdata( $originally_created_by );

                $original_name = ! empty( $originally_created_by_user_data ) ?
                    sprintf( $user_format, $originally_created_by_user_data->display_name, $originally_created_by_user_data->ID ) :
                    esc_attr_x( 'Deleted User', 'To show that the entry was created by a no longer existing user.', 'gk-gravityview' );
            }

            if ( ! empty( $created_by ) ) {
                $created_by_user_data = get_userdata( $created_by );

                $created_by_name = ! empty( $created_by_user_data ) ?
                    sprintf( $user_format, $created_by_user_data->display_name, $created_by_user_data->ID ) :
                    esc_attr_x( 'Deleted User', 'To show that the entry was created by a no longer existing user.', 'gk-gravityview' );
            }

            GravityView_Entry_Notes::add_note( $entry_id, $current_user->ID, $user_data->display_name, sprintf( __( 'Changed entry creator from %s to %s', 'gk-gravityview' ), $original_name, $created_by_name ), 'note' );
        }

    }

    /**
     * Output select element used to change the entry creator
     *
     * @param int   $form_id GF Form ID
     * @param array $entry   GF entry array
     *
     * @return void
     */
    function add_select( $form_id, $entry ) {

        if ( 'edit' !== \GV\Utils::_POST( 'screen_mode' ) ) {
            return;
        }

        $output = '<label for="change_created_by">';
        $output .= esc_html__( 'Change Entry Creator:', 'gk-gravityview' );
        $output .= '</label>';
        $output .= '<select name="created_by" id="change_created_by" class="widefat">';

        $entry_creator_user_id = \GV\Utils::get( $entry, 'created_by' );

        $entry_creator_user = GVCommon::get_users( 'change_entry_creator', array( 'include' => $entry_creator_user_id ) );
        $entry_creator_user = isset( $entry_creator_user[0] ) ? $entry_creator_user[0] : array();

        $output .= '<option value="0" ' . selected( true, empty( $entry_creator_user_id ), false ) . '> &mdash; ' . esc_attr_x( 'No User', 'No user assigned to the entry', 'gk-gravityview' ) . ' &mdash; </option>';

        // Always show the entry creator, even when the user isn't included within the pagination limits
        if ( ! empty( $entry_creator_user_id ) && ! empty( $entry_creator_user ) ) {
            $output .= '<option value="' . $entry_creator_user->ID . '" selected="selected">' . esc_attr( $entry_creator_user->display_name . ' (' . $entry_creator_user->user_nicename . ')' ) . '</option>';
        }

        $all_users = GVCommon::get_users( 'change_entry_creator', array( 'number' => self::DEFAULT_NUMBER_OF_USERS ) );
        foreach ( $all_users as $user ) {
            if ( $entry_creator_user_id === $user->ID ) {
                continue;
            }

            $output .= '<option value="' . esc_attr( $user->ID ) . '">' . esc_attr( $user->display_name . ' (' . $user->user_nicename . ')' ) . '</option>';
        }

        $user_count      = count_users();
        $user_count      = $user_count['total_users'];
        $users_displayed = self::DEFAULT_NUMBER_OF_USERS + ( ! empty( $entry_creator_user ) ? 1 : 0 );
        if ( $user_count > $users_displayed ) {
            $remaining_users = $user_count - $users_displayed;
            $user_users = _n( esc_html__('user', 'gk-gravityview' ), esc_html__('users', 'gk-gravityview' ), $remaining_users );
            $message = esc_html_x( 'Use the input above to search the remaining %d %s.', '%d is replaced with user count %s is replaced with "user" or "users"', 'gk-gravityview' );
            $message = sprintf( $message, $remaining_users, $user_users );
            $output  .= '<option value="_user_count" disabled="disabled">' . esc_html( $message ) . '</option>';
        }

        $output .= '</select>';
        $output .= '<input name="originally_created_by" value="' . esc_attr( $entry['created_by'] ) . '" type="hidden" />';
        $output .= wp_nonce_field( 'gv_entry_creator', 'gv_entry_creator_nonce', false, false );

        echo $output;
    }

    /**
     * Allow UI assets
     *
     * @param array $assets
     *
     * @return array
     */
    function register_gform_noconflict( $assets ) {
        $assets[] = 'gravityview_selectwoo';
        $assets[] = 'gravityview_entry_creator';

        return $assets;
    }
}

new GravityView_Change_Entry_Creator;