Completed
Push — master ( ebef7a...94d09a )
by Zack
20:55 queued 16:56
created

GravityView_Edit_Entry_Render::load()   B

Complexity

Conditions 1
Paths 1

Size

Total Lines 26
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 10
nc 1
nop 0
dl 0
loc 26
rs 8.8571
c 0
b 0
f 0
1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 17 and the first side effect is on line 13.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
2
/**
3
 * GravityView Edit Entry - render frontend
4
 *
5
 * @package   GravityView
6
 * @license   GPL2+
7
 * @author    Katz Web Services, Inc.
8
 * @link      http://gravityview.co
9
 * @copyright Copyright 2014, Katz Web Services, Inc.
10
 */
11
12
if ( ! defined( 'WPINC' ) ) {
13
    die;
14
}
15
16
17
class GravityView_Edit_Entry_Render {
18
19
    /**
20
     * @var GravityView_Edit_Entry
21
     */
22
    protected $loader;
23
24
	/**
25
	 * @var string String used to generate unique nonce for the entry/form/view combination. Allows access to edit page.
26
	 */
27
    static $nonce_key;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $nonce_key.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
28
29
	/**
30
	 * @since 1.9
31
	 * @var string String used for check valid edit entry form submission. Allows saving edit form values.
32
	 */
33
	private static $nonce_field = 'is_gv_edit_entry';
34
35
	/**
36
	 * @since 1.9
37
	 * @var bool Whether to allow save and continue functionality
38
	 */
39
	private static $supports_save_and_continue = false;
40
41
	/**
42
	 * @since 1.9
43
	 * @var bool Whether to allow editing product fields
44
	 */
45
	private static $supports_product_fields = false;
46
47
    /**
48
     * Gravity Forms entry array
49
     *
50
     * @var array
51
     */
52
    var $entry;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $entry.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
53
54
    /**
55
     * Gravity Forms form array (GravityView modifies the content through this class lifecycle)
56
     *
57
     * @var array
58
     */
59
    var $form;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $form.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
60
61
    /**
62
     * Gravity Forms form array (it won't get changed during this class lifecycle)
63
     * @since 1.16.2.1
64
     * @var array
65
     */
66
    var $original_form;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $original_form.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
67
68
    /**
69
     * Gravity Forms form array after the form validation process
70
     * @since 1.13
71
     * @var array
72
     */
73
    var $form_after_validation = null;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $form_after_validation.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
74
75
    /**
76
     * Hold an array of GF field objects that have calculation rules
77
     * @var array
78
     */
79
    var $fields_with_calculation = array();
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $fields_with_calculation.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
80
81
    /**
82
     * Hold an array of GF field objects with type 'total'
83
     * @var array
84
     */
85
    var $total_fields = array();
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $total_fields.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
86
87
    /**
88
     * Gravity Forms form id
89
     *
90
     * @var int
91
     */
92
    var $form_id;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $form_id.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
93
94
    /**
95
     * ID of the current view
96
     *
97
     * @var int
98
     */
99
    var $view_id;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $view_id.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
100
101
    /**
102
     * Updated entry is valid (GF Validation object)
103
     *
104
     * @var array
105
     */
106
    var $is_valid = NULL;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $is_valid.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
107
108
    function __construct( GravityView_Edit_Entry $loader ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
109
        $this->loader = $loader;
110
    }
111
112
    function load() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
113
114
        /** @define "GRAVITYVIEW_DIR" "../../../" */
115
        include_once( GRAVITYVIEW_DIR .'includes/class-admin-approve-entries.php' );
116
117
        // Don't display an embedded form when editing an entry
118
        add_action( 'wp_head', array( $this, 'prevent_render_form' ) );
119
        add_action( 'wp_footer', array( $this, 'prevent_render_form' ) );
120
121
        // Stop Gravity Forms processing what is ours!
122
        add_filter( 'wp', array( $this, 'prevent_maybe_process_form'), 8 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
123
124
        add_filter( 'gravityview_is_edit_entry', array( $this, 'is_edit_entry') );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
125
126
        add_action( 'gravityview_edit_entry', array( $this, 'init' ) );
127
128
        // Disable conditional logic if needed (since 1.9)
129
        add_filter( 'gform_has_conditional_logic', array( $this, 'manage_conditional_logic' ), 10, 2 );
130
131
        // Make sure GF doesn't validate max files (since 1.9)
132
        add_filter( 'gform_plupload_settings', array( $this, 'modify_fileupload_settings' ), 10, 3 );
133
134
        // Add fields expected by GFFormDisplay::validate()
135
        add_filter( 'gform_pre_validation', array( $this, 'gform_pre_validation') );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
136
137
    }
138
139
    /**
140
     * Don't show any forms embedded on a page when GravityView is in Edit Entry mode
141
     *
142
     * Adds a `__return_empty_string` filter on the Gravity Forms shortcode on the `wp_head` action
143
     * And then removes it on the `wp_footer` action
144
     *
145
     * @since 1.16.1
146
     *
147
     * @return void
148
     */
149
    function prevent_render_form() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
150
        if( $this->is_edit_entry() ) {
151
            if( 'wp_head' === current_filter() ) {
152
                add_filter( 'gform_shortcode_form', '__return_empty_string' );
153
            } else {
154
                remove_filter( 'gform_shortcode_form', '__return_empty_string' );
155
            }
156
        }
157
    }
158
159
    /**
160
     * Because we're mimicking being a front-end Gravity Forms form while using a Gravity Forms
161
     * backend form, we need to prevent them from saving twice.
162
     * @return void
163
     */
164
    function prevent_maybe_process_form() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
165
166
        do_action('gravityview_log_debug', 'GravityView_Edit_Entry[prevent_maybe_process_form] $_POSTed data (sanitized): ', esc_html( print_r( $_POST, true ) ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
introduced by
The use of function print_r() is discouraged
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
167
168
        if( $this->is_edit_entry_submission() && $this->verify_nonce() ) {
169
            remove_action( 'wp',  array( 'RGForms', 'maybe_process_form'), 9 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
170
        }
171
    }
172
173
    /**
174
     * Is the current page an Edit Entry page?
175
     * @return boolean
176
     */
177
    public function is_edit_entry() {
178
179
        $gf_page = function_exists('rgpost') && ( 'entry' === rgget( 'view' ) && isset( $_GET['edit'] ) || rgpost( 'action' ) === 'update' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
180
181
        return $gf_page;
182
    }
183
184
	/**
185
	 * Is the current page an Edit Entry page?
186
	 * @since 1.9
187
	 * @return boolean
188
	 */
189
	public function is_edit_entry_submission() {
190
		return !empty( $_POST[ self::$nonce_field ] );
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
191
	}
192
193
    /**
194
     * When Edit entry view is requested setup the vars
195
     */
196
    function setup_vars() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
197
        $gravityview_view = GravityView_View::getInstance();
198
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
199
200
        $entries = $gravityview_view->getEntries();
201
        $this->entry = $entries[0];
202
203
        $this->original_form = $this->form = $gravityview_view->getForm();
204
        $this->form_id = $gravityview_view->getFormId();
205
        $this->view_id = $gravityview_view->getViewId();
206
207
        self::$nonce_key = GravityView_Edit_Entry::get_nonce_key( $this->view_id, $this->form_id, $this->entry['id'] );
208
    }
209
210
211
    /**
212
     * Load required files and trigger edit flow
213
     *
214
     * Run when the is_edit_entry returns true.
215
     *
216
     * @param GravityView_View_Data $gv_data GravityView Data object
217
     * @return void
218
     */
219
    function init( $gv_data ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
220
221
        require_once( GFCommon::get_base_path() . '/form_display.php' );
222
        require_once( GFCommon::get_base_path() . '/entry_detail.php' );
223
224
        $this->setup_vars();
225
226
        // Multiple Views embedded, don't proceed if nonce fails
227
        if( $gv_data->has_multiple_views() && ! wp_verify_nonce( $_GET['edit'], self::$nonce_key ) ) {
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-validated input variable: $_GET
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_GET
Loading history...
228
            return;
229
        }
230
231
        // Sorry, you're not allowed here.
232
        if( false === $this->user_can_edit_entry( true ) ) {
233
            return;
234
        }
235
236
        $this->print_scripts();
237
238
        $this->process_save();
239
240
        $this->edit_entry_form();
241
242
    }
243
244
245
    /**
246
     * Force Gravity Forms to output scripts as if it were in the admin
247
     * @return void
248
     */
249
    function print_scripts() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
250
        $gravityview_view = GravityView_View::getInstance();
251
252
        wp_register_script( 'gform_gravityforms', GFCommon::get_base_url().'/js/gravityforms.js', array( 'jquery', 'gform_json', 'gform_placeholder', 'sack', 'plupload-all', 'gravityview-fe-view' ) );
253
254
        GFFormDisplay::enqueue_form_scripts($gravityview_view->getForm(), false);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
255
256
        // Sack is required for images
257
        wp_print_scripts( array( 'sack', 'gform_gravityforms' ) );
258
    }
259
260
261
    /**
262
     * Process edit entry form save
263
     */
264
    function process_save() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
265
266
        if( empty( $_POST ) ) {
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
267
            return;
268
        }
269
270
        // Make sure the entry, view, and form IDs are all correct
271
        $valid = $this->verify_nonce();
272
273
        if( !$valid ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
274
            do_action('gravityview_log_error', __METHOD__ . ' Nonce validation failed.' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
275
            return;
276
        }
277
278
        if( $this->entry['id'] !== $_POST['lid'] ) {
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-validated input variable: $_POST
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_POST
Loading history...
279
            do_action('gravityview_log_error', __METHOD__ . ' Entry ID did not match posted entry ID.' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
280
            return;
281
        }
282
283
        do_action('gravityview_log_debug', 'GravityView_Edit_Entry[process_save] $_POSTed data (sanitized): ', esc_html( print_r( $_POST, true ) ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
introduced by
The use of function print_r() is discouraged
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
284
285
        $this->process_save_process_files( $this->form_id );
286
287
        $this->validate();
288
289
        if( $this->is_valid ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->is_valid of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
290
291
            do_action('gravityview_log_debug', 'GravityView_Edit_Entry[process_save] Submission is valid.' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
292
293
            /**
294
             * @hack This step is needed to unset the adminOnly from form fields, to add the calculation fields
295
             */
296
            $form = $this->form_prepare_for_save();
297
298
            /**
299
             * @hack to avoid the capability validation of the method save_lead for GF 1.9+
300
             */
301
            unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
302
303
            GFFormsModel::save_lead( $form, $this->entry );
304
305
            // If there's a post associated with the entry, process post fields
306
            if( !empty( $this->entry['post_id'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
307
                $this->maybe_update_post_fields( $form );
308
            }
309
310
            // Process calculation fields
311
            $this->update_calculation_fields();
312
313
            // Perform actions normally performed after updating a lead
314
            $this->after_update();
315
316
            /**
317
             * @action `gravityview/edit_entry/after_update` Perform an action after the entry has been updated using Edit Entry
318
             * @param array $form Gravity Forms form array
319
             * @param string $entry_id Numeric ID of the entry that was updated
320
             */
321
            do_action( 'gravityview/edit_entry/after_update', $this->form, $this->entry['id'] );
322
        }
323
324
    } // process_save
325
326
327
    /**
328
     * Have GF handle file uploads
329
     *
330
     * Copy of code from GFFormDisplay::process_form()
331
     *
332
     * @param int $form_id
333
     */
334
    function process_save_process_files( $form_id ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
335
336
        //Loading files that have been uploaded to temp folder
337
        $files = GFCommon::json_decode( stripslashes( RGForms::post( 'gform_uploaded_files' ) ) );
338
        if ( ! is_array( $files ) ) {
339
            $files = array();
340
        }
341
342
        RGFormsModel::$uploaded_files[ $form_id ] = $files;
343
    }
344
345
    /**
346
     * Remove max_files validation (done on gravityforms.js) to avoid conflicts with GravityView
347
     * Late validation done on self::custom_validation
348
     *
349
     * @param $plupload_init array Plupload settings
350
     * @param $form_id
351
     * @param $instance
352
     * @return mixed
353
     */
354
    public function modify_fileupload_settings( $plupload_init, $form_id, $instance ) {
0 ignored issues
show
Unused Code introduced by
The parameter $form_id is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $instance is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
355
        if( ! $this->is_edit_entry() ) {
356
            return $plupload_init;
357
        }
358
359
        $plupload_init['gf_vars']['max_files'] = 0;
360
361
        return $plupload_init;
362
    }
363
364
365
    /**
366
     * Unset adminOnly and convert field input key to string
367
     * @return array $form
368
     */
369
    private function form_prepare_for_save() {
370
371
        $form = $this->form;
372
373
        foreach( $form['fields'] as $k => &$field ) {
374
375
            // Remove the fields with calculation formulas before save to avoid conflicts with GF logic
376
            // @since 1.16.3
377
            if( $field->has_calculation() ) {
378
                unset( $form['fields'][ $k ] );
379
            }
380
381
            $field->adminOnly = false;
382
383
            if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
384
                foreach( $field->inputs as $key => $input ) {
385
                    $field->inputs[ $key ][ 'id' ] = (string)$input['id'];
0 ignored issues
show
introduced by
Array keys should NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
386
                }
387
            }
388
        }
389
390
        return $form;
391
    }
392
393
    private function update_calculation_fields() {
394
395
        $form = $this->original_form;
396
        $update = false;
397
398
        // get the most up to date entry values
399
        $entry = GFAPI::get_entry( $this->entry['id'] );
400
401
        if( !empty( $this->fields_with_calculation ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
402
            $update = true;
403
            foreach ( $this->fields_with_calculation as $calc_field ) {
404
                $inputs = $calc_field->get_entry_inputs();
405
                if ( is_array( $inputs ) ) {
406
                    foreach ( $inputs as $input ) {
407
                        $input_name = 'input_' . str_replace( '.', '_', $input['id'] );
408
                        $entry[ strval( $input['id'] ) ] = RGFormsModel::prepare_value( $form, $calc_field, '', $input_name, $entry['id'], $entry );
409
                    }
410
                } else {
411
                    $input_name = 'input_' . str_replace( '.', '_', $calc_field->id);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
412
                    $entry[ strval( $calc_field->id ) ] = RGFormsModel::prepare_value( $form, $calc_field, '', $input_name, $entry['id'], $entry );
413
                }
414
            }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
415
416
        }
417
418
        //saving total field as the last field of the form.
419
        if ( ! empty( $this->total_fields ) ) {
420
            $update = true;
421
            foreach ( $this->total_fields as $total_field ) {
422
                $input_name = 'input_' . str_replace( '.', '_', $total_field->id);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
423
                $entry[ strval( $total_field->id ) ] = RGFormsModel::prepare_value( $form, $total_field, '', $input_name, $entry['id'], $entry );
424
            }
425
        }
426
427
        if( $update ) {
428
429
            $return_entry = GFAPI::update_entry( $entry );
430
431
            if( is_wp_error( $return_entry ) ) {
432
                do_action( 'gravityview_log_error', 'Updating the entry calculation and total fields failed', $return_entry );
433
            } else {
434
                do_action( 'gravityview_log_debug', 'Updating the entry calculation and total fields succeeded' );
435
            }
436
        }
437
    }
438
439
    /**
440
     * Handle updating the Post Image field
441
     *
442
     * Sets a new Featured Image if configured in Gravity Forms; otherwise uploads/updates media
443
     *
444
     * @since 1.17
445
     *
446
     * @uses GFFormsModel::media_handle_upload
447
     * @uses set_post_thumbnail
448
     * 
449
     * @param array $form GF Form array
450
     * @param GF_Field $field GF Field
451
     * @param string $field_id Numeric ID of the field
452
     * @param string $value
453
     * @param array $entry GF Entry currently being edited
454
     * @param int $post_id ID of the Post being edited
455
     *
456
     * @return mixed|string
457
     */
458
    private function update_post_image( $form, $field, $field_id, $value, $entry, $post_id ) {
459
460
        $input_name = 'input_' . $field_id;
461
462
        if ( !empty( $_FILES[ $input_name ]['name'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
463
464
            // We have a new image
465
466
            $value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
467
468
            $ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
469
            $img_url = rgar( $ary, 0 );
470
471
            $img_title       = count( $ary ) > 1 ? $ary[1] : '';
472
            $img_caption     = count( $ary ) > 2 ? $ary[2] : '';
473
            $img_description = count( $ary ) > 3 ? $ary[3] : '';
474
475
            $image_meta = array(
476
                'post_excerpt' => $img_caption,
477
                'post_content' => $img_description,
478
            );
479
480
            //adding title only if it is not empty. It will default to the file name if it is not in the array
481
            if ( ! empty( $img_title ) ) {
482
                $image_meta['post_title'] = $img_title;
483
            }
484
485
            /**
486
             * todo: As soon as \GFFormsModel::media_handle_upload becomes a public method, move this call to \GFFormsModel::media_handle_upload and remove the hack from this class.
487
             * Note: the method became public in GF 1.9.17.7, but we don't require that version yet.
488
             */
489
            require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
490
            $media_id = GravityView_GFFormsModel::media_handle_upload( $img_url, $post_id, $image_meta );
491
492
            // is this field set as featured image?
493
            if ( $media_id && $field->postFeaturedImage ) {
494
                set_post_thumbnail( $post_id, $media_id );
495
            }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
496
497
        } elseif ( !empty( $_POST[ $input_name ] ) && is_array( $value ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
498
499
            // Same image although the image title, caption or description might have changed
500
501
            $ary = array();
502
            if( ! empty( $entry[ $field_id ] ) ) {
503
                $ary = is_array( $entry[ $field_id ] ) ? $entry[ $field_id ] : explode( '|:|', $entry[ $field_id ] );
504
            }
505
            $img_url = rgar( $ary, 0 );
506
507
            // is this really the same image or something went wrong ?
508
            if( $img_url === $_POST[ $input_name ] ) {
509
510
                $img_title       = rgar( $value, $field_id .'.1' );
511
                $img_caption     = rgar( $value, $field_id .'.4' );
512
                $img_description = rgar( $value, $field_id .'.7' );
513
514
                $value = ! empty( $img_url ) ? $img_url . "|:|" . $img_title . "|:|" . $img_caption . "|:|" . $img_description : '';
0 ignored issues
show
Coding Style Comprehensibility introduced by
The string literal |:| does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
515
516
                if ( $field->postFeaturedImage ) {
517
518
                    $image_meta = array(
519
                        'ID' => get_post_thumbnail_id( $post_id ),
520
                        'post_title' => $img_title,
521
                        'post_excerpt' => $img_caption,
522
                        'post_content' => $img_description,
523
                    );
524
525
                    // update image title, caption or description
526
                    wp_update_post( $image_meta );
527
                }
528
            }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
529
530
        } else {
531
532
            // if we get here, image was removed or not set.
533
            $value = '';
534
535
            if ( $field->postFeaturedImage ) {
536
                delete_post_thumbnail( $post_id );
537
            }
538
        }
539
540
        return $value;
541
    }
542
543
    /**
544
     * Loop through the fields being edited and if they include Post fields, update the Entry's post object
545
     *
546
     * @param array $form Gravity Forms form
547
     *
548
     * @return void
549
     */
550
    private function maybe_update_post_fields( $form ) {
551
552
        $post_id = $this->entry['post_id'];
553
554
        // Security check
555
        if( false === GVCommon::has_cap( 'edit_post', $post_id ) ) {
556
            do_action( 'gravityview_log_error', 'The current user does not have the ability to edit Post #'.$post_id );
557
            return;
558
        }
559
560
        $update_entry = false;
561
562
        $updated_post = $original_post = get_post( $post_id );
563
564
        foreach ( $this->entry as $field_id => $value ) {
565
566
            $field = RGFormsModel::get_field( $form, $field_id );
567
568
            if( ! $field ) {
569
                continue;
570
            }
571
572
            if( GFCommon::is_post_field( $field ) && 'post_category' !== $field->type ) {
573
574
                // Get the value of the field, including $_POSTed value
575
                $value = RGFormsModel::get_field_value( $field );
576
577
                // Use temporary entry variable, to make values available to fill_post_template() and update_post_image()
578
                $entry_tmp = $this->entry;
579
                $entry_tmp["{$field_id}"] = $value;
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
580
581
                switch( $field->type ) {
582
583
                    case 'post_title':
584
                        $post_title = $value;
585
                        if( rgar( $form, 'postTitleTemplateEnabled' ) ) {
586
                            $post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
587
                        }
588
                        $updated_post->post_title = $post_title;
589
                        $updated_post->post_name  = $post_title;
590
                        unset( $post_title );
591
                        break;
592
593
                    case 'post_content':
594
                        $post_content = $value;
595
                        if( rgar( $form, 'postContentTemplateEnabled' ) ) {
596
                            $post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
597
                        }
598
                        $updated_post->post_content = $post_content;
599
                        unset( $post_content );
600
                        break;
601
                    case 'post_excerpt':
602
                        $updated_post->post_excerpt = $value;
603
                        break;
604
                    case 'post_tags':
605
                        wp_set_post_tags( $post_id, $value, false );
606
                        break;
607
                    case 'post_category':
608
                        break;
609
                    case 'post_custom_field':
610
                        if( ! empty( $field->customFieldTemplateEnabled ) ) {
611
                            $value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
612
                        }
613
614
                        $input_type = RGFormsModel::get_input_type( $field );
615
616
                        // Only certain custom field types are supported
617
                        switch( $input_type ) {
618
                            case 'fileupload':
619
                            case 'list':
620
                            case 'multiselect':
621
                                if( ! is_string( $value ) ) {
622
                                    $value = function_exists('wp_json_encode') ? wp_json_encode( $value ) : json_encode( $value );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
623
                                }
624
                            // break; left intentionally out
625
                            default:
626
                                update_post_meta( $post_id, $field->postCustomFieldName, $value );
627
                        }
628
629
                        break;
630
631
                    case 'post_image':
632
                        $value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
633
                        break;
634
635
                }
636
637
                // update entry after
638
                $this->entry["{$field_id}"] = $value;
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
639
640
                $update_entry = true;
641
642
                unset( $entry_tmp );
643
            }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
644
645
        }
646
647
        if( $update_entry ) {
648
649
            $return_entry = GFAPI::update_entry( $this->entry );
650
651
            if( is_wp_error( $return_entry ) ) {
652
               do_action( 'gravityview_log_error', 'Updating the entry post fields failed', array( '$this->entry' => $this->entry, '$return_entry' => $return_entry ) );
653
            } else {
654
                do_action( 'gravityview_log_debug', 'Updating the entry post fields for post #'.$post_id.' succeeded' );
655
            }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
656
657
        }
658
659
        $return_post = wp_update_post( $updated_post, true );
660
661
        if( is_wp_error( $return_post ) ) {
662
            $return_post->add_data( $updated_post, '$updated_post' );
663
            do_action( 'gravityview_log_error', 'Updating the post content failed', compact( 'updated_post', 'return_post' ) );
664
        } else {
665
            do_action( 'gravityview_log_debug', 'Updating the post content for post #'.$post_id.' succeeded', $updated_post );
666
        }
667
    }
668
669
    /**
670
     * Convert a field content template into prepared output
671
     *
672
     * @uses GravityView_GFFormsModel::get_post_field_images()
673
     *
674
     * @since 1.17
675
     *
676
     * @param string $template The content template for the field
677
     * @param array $form Gravity Forms form
678
     * @param bool $do_shortcode Whether to process shortcode inside content. In GF, only run on Custom Field and Post Content fields
679
     *
680
     * @return mixed|string|void
681
     */
682
    function fill_post_template( $template, $form, $entry, $do_shortcode = false ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
683
684
        require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
685
686
        $post_images = GravityView_GFFormsModel::get_post_field_images( $form, $entry );
687
688
        //replacing post image variables
689
        $output = GFCommon::replace_variables_post_image( $template, $post_images, $entry );
690
691
        //replacing all other variables
692
        $output = GFCommon::replace_variables( $output, $form, $entry, false, false, false );
693
694
        // replace conditional shortcodes
695
        if( $do_shortcode ) {
696
            $output = do_shortcode( $output );
697
        }
698
699
        return $output;
700
    }
701
702
703
    /**
704
     * Perform actions normally performed after updating a lead
705
     *
706
     * @since 1.8
707
     *
708
     * @see GFEntryDetail::lead_detail_page()
709
     *
710
     * @return void
711
     */
712
    function after_update() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
713
714
        do_action( 'gform_after_update_entry', $this->form, $this->entry['id'] );
715
        do_action( "gform_after_update_entry_{$this->form['id']}", $this->form, $this->entry['id'] );
716
717
        // Re-define the entry now that we've updated it.
718
        $entry = RGFormsModel::get_lead( $this->entry['id'] );
719
720
        $entry = GFFormsModel::set_entry_meta( $entry, $this->form );
721
722
        // We need to clear the cache because Gravity Forms caches the field values, which
723
        // we have just updated.
724
        foreach ($this->form['fields'] as $key => $field) {
0 ignored issues
show
introduced by
No space after opening parenthesis is prohibited
Loading history...
introduced by
No space before closing parenthesis is prohibited
Loading history...
725
            GFFormsModel::refresh_lead_field_value( $entry['id'], $field->id );
726
        }
727
728
        $this->entry = $entry;
729
    }
730
731
732
    /**
733
     * Display the Edit Entry form
734
     *
735
     * @return [type] [description]
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
736
     */
737
    public function edit_entry_form() {
738
739
        ?>
740
741
        <div class="gv-edit-entry-wrapper"><?php
742
743
            $javascript = gravityview_ob_include( GravityView_Edit_Entry::$file .'/partials/inline-javascript.php', $this );
0 ignored issues
show
Bug introduced by
The property file cannot be accessed from this context as it is declared private in class GravityView_Edit_Entry.

This check looks for access to properties that are not accessible from the current context.

If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class.

Loading history...
744
745
            /**
746
             * Fixes weird wpautop() issue
747
             * @see https://github.com/katzwebservices/GravityView/issues/451
748
             */
749
            echo gravityview_strip_whitespace( $javascript );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'gravityview_strip_whitespace'
Loading history...
750
751
            ?><h2 class="gv-edit-entry-title">
752
                <span><?php
753
754
                    /**
755
                     * @filter `gravityview_edit_entry_title` Modify the edit entry title
756
                     * @param string $edit_entry_title Modify the "Edit Entry" title
757
                     * @param GravityView_Edit_Entry_Render $this This object
758
                     */
759
                    $edit_entry_title = apply_filters('gravityview_edit_entry_title', __('Edit Entry', 'gravityview'), $this );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
760
761
                    echo esc_attr( $edit_entry_title );
762
            ?></span>
763
            </h2>
764
765
            <?php $this->maybe_print_message(); ?>
766
767
            <?php // The ID of the form needs to be `gform_{form_id}` for the pluploader ?>
768
769
            <form method="post" id="gform_<?php echo $this->form_id; ?>" enctype="multipart/form-data">
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$this'
Loading history...
770
771
                <?php
772
773
                wp_nonce_field( self::$nonce_key, self::$nonce_key );
774
775
                wp_nonce_field( self::$nonce_field, self::$nonce_field, false );
776
777
                // Print the actual form HTML
778
                $this->render_edit_form();
779
780
                ?>
781
            </form>
782
783
        </div>
784
785
    <?php
786
    }
787
788
    /**
789
     * Display success or error message if the form has been submitted
790
     *
791
     * @uses GVCommon::generate_notice
792
     *
793
     * @since 1.16.2.2
794
     *
795
     * @return void
796
     */
797
    private function maybe_print_message() {
798
799
        if( rgpost('action') === 'update' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
800
801
            $back_link = esc_url( remove_query_arg( array( 'page', 'view', 'edit' ) ) );
802
803
            if( ! $this->is_valid ){
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->is_valid of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
804
805
                // Keeping this compatible with Gravity Forms.
806
                $validation_message = "<div class='validation_error'>" . __('There was a problem with your submission.', 'gravityview') . " " . __('Errors have been highlighted below.', 'gravityview') . "</div>";
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
Coding Style Comprehensibility introduced by
The string literal does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw '__'
Loading history...
Coding Style Comprehensibility introduced by
The string literal </div> does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
807
                $message = apply_filters("gform_validation_message_{$this->form['id']}", apply_filters("gform_validation_message", $validation_message, $this->form), $this->form);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
Coding Style Comprehensibility introduced by
The string literal gform_validation_message does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
808
809
                echo GVCommon::generate_notice( $message , 'gv-error' );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
810
811
            } else {
812
                $entry_updated_message = sprintf( esc_attr__('Entry Updated. %sReturn to Entry%s', 'gravityview'), '<a href="'. $back_link .'">', '</a>' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
813
814
                /**
815
                 * @filter `gravityview/edit_entry/success` Modify the edit entry success message (including the anchor link)
816
                 * @since 1.5.4
817
                 * @param string $entry_updated_message Existing message
818
                 * @param int $view_id View ID
819
                 * @param array $entry Gravity Forms entry array
820
                 * @param string $back_link URL to return to the original entry. @since 1.6
821
                 */
822
                $message = apply_filters( 'gravityview/edit_entry/success', $entry_updated_message , $this->view_id, $this->entry, $back_link );
823
824
                echo GVCommon::generate_notice( $message );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
825
            }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
826
827
        }
828
    }
829
830
    /**
831
     * Display the Edit Entry form in the original Gravity Forms format
832
     *
833
     * @since 1.9
834
     *
835
     * @return void
836
     */
837
    private function render_edit_form() {
838
839
        /**
840
         * @action `gravityview/edit-entry/render/before` Before rendering the Edit Entry form
841
         * @since 1.17
842
         * @param GravityView_Edit_Entry_Render $this
843
         */
844
        do_action( 'gravityview/edit-entry/render/before', $this );
845
846
        add_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields'), 5000, 3 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
847
        add_filter( 'gform_submit_button', array( $this, 'render_form_buttons') );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
848
        add_filter( 'gform_disable_view_counter', '__return_true' );
849
850
        add_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5, 5 );
851
        add_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10, 5 );
852
853
        add_filter( 'gform_field_value', array( $this, 'fix_survey_fields_value'), 10, 3 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
854
855
        // We need to remove the fake $_GET['page'] arg to avoid rendering form as if in admin.
856
        unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
857
858
        // TODO: Verify multiple-page forms
859
        // TODO: Product fields are not editable
860
861
        $html = GFFormDisplay::get_form( $this->form['id'], false, false, true, $this->entry );
862
863
        remove_filter( 'gform_field_value', array( $this, 'fix_survey_fields_value'), 10 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
864
	    remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
865
        remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
866
        remove_filter( 'gform_disable_view_counter', '__return_true' );
867
        remove_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5 );
868
        remove_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10 );
869
870
        echo $html;
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$html'
Loading history...
871
872
        /**
873
         * @action `gravityview/edit-entry/render/after` After rendering the Edit Entry form
874
         * @since 1.17
875
         * @param GravityView_Edit_Entry_Render $this
876
         */
877
        do_action( 'gravityview/edit-entry/render/after', $this );
878
    }
879
880
    /**
881
     * Survey fields inject their output using `gform_field_input` filter, but in Edit Entry, the values were empty.
882
     * We filter the values here because it was the easiest access point: tell the survey field the correct value, GF outputs it.
883
     *
884
     * @since 1.16.4
885
     *
886
     * @param string $value Existing value
887
     * @param GF_Field $field
888
     * @param string $name Field custom parameter name, normally blank.
889
     *
890
     * @return mixed
891
     */
892
    function fix_survey_fields_value( $value, $field, $name ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
893
        
894
        if( 'survey' === $field->type ) {
895
896
	        // We need to run through each survey row until we find a match for expected values
897
	        foreach ( $this->entry as $field_id => $field_value ) {
898
899
		        if ( floor( $field_id ) !== floor( $field->id ) ) {
900
			        continue;
901
		        }
902
903
		        if( rgar( $field, 'gsurveyLikertEnableMultipleRows' ) ) {
904
			        list( $row_val, $col_val ) = explode( ':', $field_value, 2 );
905
906
		            // If the $name matches the $row_val, we are processing the correct row
907
			        if( $row_val === $name ) {
908
				        $value = $field_value;
909
				        break;
910
			        }
911
		        } else {
912
			        // When not processing multiple rows, the value is the $entry[ $field_id ] value.
913
			        $value = $field_value;
914
				    break;
915
		        }
916
			}
917
        }
918
919
        return $value;
920
    }
921
922
    /**
923
     * Display the Update/Cancel/Delete buttons for the Edit Entry form
924
     * @since 1.8
925
     * @return string
926
     */
927
    public function render_form_buttons() {
928
        return gravityview_ob_include( GravityView_Edit_Entry::$file .'/partials/form-buttons.php', $this );
0 ignored issues
show
Bug introduced by
The property file cannot be accessed from this context as it is declared private in class GravityView_Edit_Entry.

This check looks for access to properties that are not accessible from the current context.

If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class.

Loading history...
929
    }
930
931
932
    /**
933
     * Modify the form fields that are shown when using GFFormDisplay::get_form()
934
     *
935
     * By default, all fields will be shown. We only want the Edit Tab configured fields to be shown.
936
     *
937
     * @param array $form
938
     * @param boolean $ajax Whether in AJAX mode
939
     * @param array|string $field_values Passed parameters to the form
940
     *
941
     * @since 1.9
942
     *
943
     * @return array Modified form array
944
     */
945
    public function filter_modify_form_fields( $form, $ajax = false, $field_values = '' ) {
0 ignored issues
show
Unused Code introduced by
The parameter $ajax is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $field_values is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
946
947
        // In case we have validated the form, use it to inject the validation results into the form render
948
        if( isset( $this->form_after_validation ) ) {
949
            $form = $this->form_after_validation;
950
        } else {
951
            $form['fields'] = $this->get_configured_edit_fields( $form, $this->view_id );
952
        }
953
954
        $form = $this->filter_conditional_logic( $form );
955
956
        // for now we don't support Save and Continue feature.
957
        if( ! self::$supports_save_and_continue ) {
958
	        unset( $form['save'] );
959
        }
960
961
        return $form;
962
    }
963
964
    /**
965
     * When displaying a field, check if it's a Post Field, and if so, make sure the post exists and current user has edit rights.
966
     *
967
     * @since 1.16.2.2
968
     *
969
     * @param string $field_content Always empty. Returning not-empty overrides the input.
970
     * @param GF_Field $field
971
     * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
972
     * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
973
     * @param int $form_id Form ID
974
     *
975
     * @return string If error, the error message. If no error, blank string (modify_edit_field_input() runs next)
976
     */
977
    function verify_user_can_edit_post( $field_content = '', $field, $value, $lead_id = 0, $form_id ) {
0 ignored issues
show
Unused Code introduced by
The parameter $value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $lead_id is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $form_id is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
978
979
        if( GFCommon::is_post_field( $field ) ) {
980
981
            $message = null;
982
983
            // First, make sure they have the capability to edit the post.
984
            if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
985
986
                /**
987
                 * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
988
                 * @param string $message The existing "You don't have permission..." text
989
                 */
990
                $message = apply_filters('gravityview/edit_entry/unsupported_post_field_text', __('You don&rsquo;t have permission to edit this post.', 'gravityview') );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
991
992
            } elseif( null === get_post( $this->entry['post_id'] ) ) {
993
                /**
994
                 * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
995
                 * @param string $message The existing "This field is not editable; the post no longer exists." text
996
                 */
997
                $message = apply_filters('gravityview/edit_entry/no_post_text', __('This field is not editable; the post no longer exists.', 'gravityview' ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
998
            }
999
1000
            if( $message ) {
1001
                $field_content = sprintf('<div class="ginput_container ginput_container_' . $field->type . '">%s</div>', wpautop( $message ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1002
            }
1003
        }
1004
1005
        return $field_content;
1006
    }
1007
1008
    /**
1009
     *
1010
     * Fill-in the saved values into the form inputs
1011
     *
1012
     * @param string $field_content Always empty. Returning not-empty overrides the input.
1013
     * @param GF_Field $field
1014
     * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1015
     * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1016
     * @param int $form_id Form ID
1017
     *
1018
     * @return mixed
1019
     */
1020
    function modify_edit_field_input( $field_content = '', $field, $value, $lead_id = 0, $form_id ) {
0 ignored issues
show
Unused Code introduced by
The parameter $lead_id is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $form_id is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
1021
1022
        $gv_field = GravityView_Fields::get_associated_field( $field );
1023
1024
        // If the form has been submitted, then we don't need to pre-fill the values,
1025
        // Except for fileupload type and when a field input is overridden- run always!!
1026
        if(
1027
            ( $this->is_edit_entry_submission() && !in_array( $field->type, array( 'fileupload', 'post_image' ) ) )
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1028
            && false === ( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) )
1029
            || ! empty( $field_content )
1030
            || in_array( $field->type, array( 'honeypot' ) )
1031
            || GFCommon::is_product_field( $field->type ) // Prevent product fields from appearing editable
1032
        ) {
1033
	        return $field_content;
1034
        }
1035
1036
        // Turn on Admin-style display for file upload fields only
1037
        if( 'fileupload' === $field->type ) {
1038
            $_GET['page'] = 'gf_entries';
1039
        }
1040
1041
        // SET SOME FIELD DEFAULTS TO PREVENT ISSUES
1042
        $field->adminOnly = false; /** @see GFFormDisplay::get_counter_init_script() need to prevent adminOnly */
1043
1044
        // add categories as choices for Post Category field
1045
        if ( 'post_category' === $field->type ) {
1046
            $field = GFCommon::add_categories_as_choices( $field, $value );
1047
        }
1048
1049
        $field_value = $this->get_field_value( $field );
1050
1051
        /**
1052
         * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
1053
         * @since 1.11
1054
         * @param mixed $field_value field value used to populate the input
1055
         * @param object $field Gravity Forms field object ( Class GF_Field )
1056
         */
1057
        $field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field );
1058
1059
        /**
1060
         * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
1061
         * @since 1.17
1062
         * @param mixed $field_value field value used to populate the input
1063
         * @param GF_Field $field Gravity Forms field object
1064
         */
1065
        $field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field );
1066
1067
	    // Prevent any PHP warnings, like undefined index
1068
	    ob_start();
1069
1070
        if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
1071
            /** @var GF_Field $gv_field */
1072
            $return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
1073
        } else {
1074
	        $return = $field->get_field_input( $this->form, $field_value, $this->entry );
1075
        }
1076
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1077
1078
	    // If there was output, it's an error
1079
	    $warnings = ob_get_clean();
1080
1081
	    if( !empty( $warnings ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1082
		    do_action( 'gravityview_log_error', __METHOD__ . $warnings, $field_value );
1083
	    }
1084
1085
        /**
1086
         * Unset hack $_GET['page'] = 'gf_entries'
1087
         * We need the fileupload html field to render with the proper id
1088
         *  ( <li id="field_80_16" ... > )
1089
         */
1090
        unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
1091
1092
        return $return;
1093
    }
1094
1095
    /**
1096
     * Modify the value for the current field input
1097
     *
1098
     * @param GF_Field $field
1099
     *
1100
     * @return array|mixed|string|void
1101
     */
1102
    private function get_field_value( $field ) {
1103
1104
        /**
1105
         * @filter `gravityview/edit_entry/pre_populate/override` Allow the pre-populated value to override saved value in Edit Entry form. By default, pre-populate mechanism only kicks on empty fields.
1106
         * @param boolean True: override saved values; False: don't override (default)
1107
         * @param $field GF_Field object Gravity Forms field object
1108
         * @since 1.13
1109
         */
1110
        $override_saved_value = apply_filters( 'gravityview/edit_entry/pre_populate/override', false, $field );
1111
1112
        // We're dealing with multiple inputs (e.g. checkbox) but not time or date (as it doesn't store data in input IDs)
1113
        if( isset( $field->inputs ) && is_array( $field->inputs ) && !in_array( $field->type, array( 'time', 'date' ) ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1114
1115
            $field_value = array();
1116
1117
            // only accept pre-populated values if the field doesn't have any choice selected.
1118
            $allow_pre_populated = $field->allowsPrepopulate;
1119
1120
            foreach ( (array)$field->inputs as $input ) {
0 ignored issues
show
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
1121
1122
                $input_id = strval( $input['id'] );
1123
                
1124
                if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
1125
                    $field_value[ $input_id ] =  'post_category' === $field->type ? GFCommon::format_post_category( $this->entry[ $input_id ], true ) : $this->entry[ $input_id ];
0 ignored issues
show
introduced by
Expected 1 space after "="; 2 found
Loading history...
1126
                    $allow_pre_populated = false;
1127
                }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
1128
1129
            }
1130
1131
            $pre_value = $field->get_value_submission( array(), false );
1132
1133
            $field_value = ! $allow_pre_populated && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $field_value : $pre_value;
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1134
1135
        } else {
1136
1137
            $id = intval( $field->id );
1138
1139
            // get pre-populated value if exists
1140
            $pre_value = $field->allowsPrepopulate ? GFFormsModel::get_parameter_value( $field->inputName, array(), $field ) : '';
1141
1142
            // saved field entry value (if empty, fallback to the pre-populated value, if exists)
1143
            // or pre-populated value if not empty and set to override saved value
1144
            $field_value = !gv_empty( $this->entry[ $id ], false, false ) && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $this->entry[ $id ] : $pre_value;
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1145
1146
            // in case field is post_category but inputType is select, multi-select or radio, convert value into array of category IDs.
1147
            if ( 'post_category' === $field->type && !gv_empty( $field_value, false, false ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1148
                $categories = array();
1149
                foreach ( explode( ',', $field_value ) as $cat_string ) {
1150
                    $categories[] = GFCommon::format_post_category( $cat_string, true );
1151
                }
1152
                $field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
1153
            }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
1154
1155
        }
1156
1157
        // if value is empty get the default value if defined
1158
        $field_value = $field->get_value_default_if_empty( $field_value );
1159
1160
        return $field_value;
1161
    }
1162
1163
1164
    // ---- Entry validation
1165
1166
    /**
1167
     * Add field keys that Gravity Forms expects.
1168
     *
1169
     * @see GFFormDisplay::validate()
1170
     * @param  array $form GF Form
1171
     * @return array       Modified GF Form
1172
     */
1173
    function gform_pre_validation( $form ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
1174
1175
        if( ! $this->verify_nonce() ) {
1176
            return $form;
1177
        }
1178
1179
        // Fix PHP warning regarding undefined index.
1180
        foreach ( $form['fields'] as &$field) {
0 ignored issues
show
introduced by
No space before closing parenthesis is prohibited
Loading history...
1181
1182
            // This is because we're doing admin form pretending to be front-end, so Gravity Forms
1183
            // expects certain field array items to be set.
1184
            foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
1185
	            $field->{$key} = isset( $field->{$key} ) ? $field->{$key} : NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1186
            }
1187
1188
            // unset emailConfirmEnabled for email type fields
1189
           /* if( 'email' === $field['type'] && !empty( $field['emailConfirmEnabled'] ) ) {
0 ignored issues
show
Unused Code Comprehensibility introduced by
61% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1190
                $field['emailConfirmEnabled'] = '';
1191
            }*/
1192
1193
            switch( RGFormsModel::get_input_type( $field ) ) {
1194
1195
                /**
1196
                 * this whole fileupload hack is because in the admin, Gravity Forms simply doesn't update any fileupload field if it's empty, but it DOES in the frontend.
1197
                 *
1198
                 * What we have to do is set the value so that it doesn't get overwritten as empty on save and appears immediately in the Edit Entry screen again.
1199
                 *
1200
                 * @hack
1201
                 */
1202
                case 'fileupload':
1203
1204
                    // Set the previous value
1205
                    $entry = $this->get_entry();
1206
1207
                    $input_name = 'input_'.$field->id;
1208
                    $form_id = $form['id'];
1209
1210
                    $value = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1211
1212
                    // Use the previous entry value as the default.
1213
                    if( isset( $entry[ $field->id ] ) ) {
1214
                        $value = $entry[ $field->id ];
1215
                    }
1216
1217
                    // If this is a single upload file
1218
                    if( !empty( $_FILES[ $input_name ] ) && !empty( $_FILES[ $input_name ]['name'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1219
                        $file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
1220
                        $value = $file_path['url'];
1221
1222
                    } else {
1223
1224
                        // Fix PHP warning on line 1498 of form_display.php for post_image fields
1225
                        // Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
1226
                        $_FILES[ $input_name ] = array('name' => '', 'size' => '' );
0 ignored issues
show
introduced by
No space after opening parenthesis of array is bad style
Loading history...
1227
1228
                    }
1229
1230
                    if( rgar($field, "multipleFiles") ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
Coding Style Comprehensibility introduced by
The string literal multipleFiles does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
1231
1232
                        // If there are fresh uploads, process and merge them.
1233
                        // Otherwise, use the passed values, which should be json-encoded array of URLs
1234
                        if( isset( GFFormsModel::$uploaded_files[$form_id][$input_name] ) ) {
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
1235
                            $value = empty( $value ) ? '[]' : $value;
1236
                            $value = stripslashes_deep( $value );
1237
                            $value = GFFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'], array());
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1238
                        }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
1239
1240
                    } else {
1241
1242
                        // A file already exists when editing an entry
1243
                        // We set this to solve issue when file upload fields are required.
1244
                        GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
1245
1246
                    }
1247
1248
                    $this->entry[ $input_name ] = $value;
1249
                    $_POST[ $input_name ] = $value;
1250
1251
                    break;
1252
1253
                case 'number':
1254
                    // Fix "undefined index" issue at line 1286 in form_display.php
1255
                    if( !isset( $_POST['input_'.$field->id ] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
1256
                        $_POST['input_'.$field->id ] = NULL;
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1257
                    }
1258
                    break;
1259
                case 'captcha':
1260
                    // Fix issue with recaptcha_check_answer() on line 1458 in form_display.php
1261
                    $_POST['recaptcha_challenge_field'] = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1262
                    $_POST['recaptcha_response_field'] = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1263
                    break;
1264
            }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
1265
1266
        }
1267
1268
        return $form;
1269
    }
1270
1271
1272
    /**
1273
     * Process validation for a edit entry submission
1274
     *
1275
     * Sets the `is_valid` object var
1276
     *
1277
     * @return void
1278
     */
1279
    function validate() {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
1280
1281
        /**
1282
         * If using GF User Registration Add-on, remove the validation step, otherwise generates error when updating the entry
1283
         * GF User Registration Add-on version > 3.x has a different class name
1284
         * @since 1.16.2
1285
         */
1286
        if ( class_exists( 'GF_User_Registration' ) ) {
1287
            remove_filter( 'gform_validation', array( GF_User_Registration::get_instance(), 'validate' ) );
1288
        } else  if ( class_exists( 'GFUser' ) ) {
1289
            remove_filter( 'gform_validation', array( 'GFUser', 'user_registration_validation' ) );
1290
        }
1291
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1292
1293
        /**
1294
         * For some crazy reason, Gravity Forms doesn't validate Edit Entry form submissions.
1295
         * You can enter whatever you want!
1296
         * We try validating, and customize the results using `self::custom_validation()`
1297
         */
1298
        add_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10, 4);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1299
1300
        // Needed by the validate funtion
1301
        $failed_validation_page = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1302
        $field_values = RGForms::post( 'gform_field_values' );
1303
1304
        // Prevent entry limit from running when editing an entry, also
1305
        // prevent form scheduling from preventing editing
1306
        unset( $this->form['limitEntries'], $this->form['scheduleForm'] );
1307
1308
        // Hide fields depending on Edit Entry settings
1309
        $this->form['fields'] = $this->get_configured_edit_fields( $this->form, $this->view_id );
1310
1311
        $this->is_valid = GFFormDisplay::validate( $this->form, $field_values, 1, $failed_validation_page );
1312
1313
        remove_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10 );
1314
    }
1315
1316
1317
    /**
1318
     * Make validation work for Edit Entry
1319
     *
1320
     * Because we're calling the GFFormDisplay::validate() in an unusual way (as a front-end
1321
     * form pretending to be a back-end form), validate() doesn't know we _can't_ edit post
1322
     * fields. This goes through all the fields and if they're an invalid post field, we
1323
     * set them as valid. If there are still issues, we'll return false.
1324
     *
1325
     * @param  [type] $validation_results [description]
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
1326
     * @return [type]                     [description]
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
1327
     */
1328
    function custom_validation( $validation_results ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
1329
1330
        do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Validation results: ', $validation_results );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1331
1332
        do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] $_POSTed data (sanitized): ', esc_html( print_r( $_POST, true ) ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
introduced by
The use of function print_r() is discouraged
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
1333
1334
        $gv_valid = true;
1335
1336
        foreach ( $validation_results['form']['fields'] as $key => &$field ) {
1337
1338
            $value = RGFormsModel::get_field_value( $field );
1339
            $field_type = RGFormsModel::get_input_type( $field );
1340
1341
            // Validate always
1342
            switch ( $field_type ) {
1343
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1344
1345
                case 'fileupload' :
1346
                case 'post_image':
1347
1348
                    // in case nothing is uploaded but there are already files saved
1349
                    if( !empty( $field->failed_validation ) && !empty( $field->isRequired ) && !empty( $value ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1350
                        $field->failed_validation = false;
1351
                        unset( $field->validation_message );
1352
                    }
1353
1354
                    // validate if multi file upload reached max number of files [maxFiles] => 2
1355
                    if( rgobj( $field, 'maxFiles') && rgobj( $field, 'multipleFiles') ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1356
1357
                        $input_name = 'input_' . $field->id;
1358
                        //uploaded
1359
                        $file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
1360
1361
                        //existent
1362
                        $entry = $this->get_entry();
1363
                        $value = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1364
                        if( isset( $entry[ $field->id ] ) ) {
1365
                            $value = json_decode( $entry[ $field->id ], true );
1366
                        }
1367
1368
                        // count uploaded files and existent entry files
1369
                        $count_files = count( $file_names ) + count( $value );
1370
1371
                        if( $count_files > $field->maxFiles ) {
1372
                            $field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
1373
                            $field->failed_validation = 1;
1374
                            $gv_valid = false;
1375
1376
                            // in case of error make sure the newest upload files are removed from the upload input
1377
                            GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
1378
                        }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
1379
1380
                    }
1381
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1382
1383
                    break;
1384
1385
            }
1386
1387
            // This field has failed validation.
1388
            if( !empty( $field->failed_validation ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1389
1390
                do_action( 'gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Field is invalid.', array( 'field' => $field, 'value' => $value ) );
1391
1392
                switch ( $field_type ) {
1393
1394
                    // Captchas don't need to be re-entered.
1395
                    case 'captcha':
1396
1397
                        // Post Image fields aren't editable, so we un-fail them.
1398
                    case 'post_image':
1399
                        $field->failed_validation = false;
1400
                        unset( $field->validation_message );
1401
                        break;
1402
1403
                }
1404
1405
                // You can't continue inside a switch, so we do it after.
1406
                if( empty( $field->failed_validation ) ) {
1407
                    continue;
1408
                }
1409
1410
                // checks if the No Duplicates option is not validating entry against itself, since
1411
                // we're editing a stored entry, it would also assume it's a duplicate.
1412
                if( !empty( $field->noDuplicates ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1413
1414
                    $entry = $this->get_entry();
1415
1416
                    // If the value of the entry is the same as the stored value
1417
                    // Then we can assume it's not a duplicate, it's the same.
1418
                    if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1419
                        //if value submitted was not changed, then don't validate
1420
                        $field->failed_validation = false;
1421
1422
                        unset( $field->validation_message );
1423
1424
                        do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', $entry );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1425
1426
                        continue;
1427
                    }
1428
                }
1429
1430
                // if here then probably we are facing the validation 'At least one field must be filled out'
1431
                if( GFFormDisplay::is_empty( $field, $this->form_id  ) && empty( $field->isRequired ) ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 2 found
Loading history...
1432
                    unset( $field->validation_message );
1433
	                $field->validation_message = false;
1434
                    continue;
1435
                }
1436
1437
                $gv_valid = false;
1438
1439
            }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
1440
1441
        }
1442
1443
        $validation_results['is_valid'] = $gv_valid;
1444
1445
        do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Validation results.', $validation_results );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1446
1447
        // We'll need this result when rendering the form ( on GFFormDisplay::get_form )
1448
        $this->form_after_validation = $validation_results['form'];
1449
1450
        return $validation_results;
1451
    }
1452
1453
1454
    /**
1455
     * TODO: This seems to be hacky... we should remove it. Entry is set when updating the form using setup_vars()!
1456
     * Get the current entry and set it if it's not yet set.
1457
     * @return array Gravity Forms entry array
1458
     */
1459
    public function get_entry() {
1460
1461
        if( empty( $this->entry ) ) {
1462
            // Get the database value of the entry that's being edited
1463
            $this->entry = gravityview_get_entry( GravityView_frontend::is_single_entry() );
1464
        }
1465
1466
        return $this->entry;
1467
    }
1468
1469
1470
1471
    // --- Filters
1472
1473
    /**
1474
     * Get the Edit Entry fields as configured in the View
1475
     *
1476
     * @since 1.8
1477
     *
1478
     * @param int $view_id
1479
     *
1480
     * @return array Array of fields that are configured in the Edit tab in the Admin
1481
     */
1482
    private function get_configured_edit_fields( $form, $view_id ) {
1483
1484
        // Get all fields for form
1485
        $properties = GravityView_View_Data::getInstance()->get_fields( $view_id );
1486
1487
        // If edit tab not yet configured, show all fields
1488
        $edit_fields = !empty( $properties['edit_edit-fields'] ) ? $properties['edit_edit-fields'] : NULL;
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1489
1490
        // Show hidden fields as text fields
1491
        $form = $this->fix_survey_fields( $form );
1492
1493
        // Hide fields depending on admin settings
1494
        $fields = $this->filter_fields( $form['fields'], $edit_fields );
1495
1496
	    // If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
1497
	    $fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
1498
1499
        /**
1500
         * @filter `gravityview/edit_entry/form_fields` Modify the fields displayed in Edit Entry form
1501
         * @since 1.17
1502
         * @param GF_Field[] $fields Gravity Forms form fields
1503
         * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1504
         * @param array $form GF Form array (`fields` key modified to have only fields configured to show in Edit Entry)
1505
         * @param int $view_id View ID
1506
         */
1507
        $fields = apply_filters( 'gravityview/edit_entry/form_fields', $fields, $edit_fields, $form, $view_id );
1508
1509
        return $fields;
1510
    }
1511
1512
    /**
1513
     * Make sure Survey fields accept pre-populating values; otherwise existing values won't be filled-in
1514
     *
1515
     * @since 1.16.4
1516
     *
1517
     * @param array $form
1518
     *
1519
     * @return array Form, with all fields set to `allowsPrepopulate => true`
1520
     */
1521
    private function fix_survey_fields( $form ) {
1522
1523
        /** @var GF_Field $field */
1524
        foreach( $form['fields'] as &$field ) {
1525
            $field->allowsPrepopulate = true;
1526
        }
1527
1528
        return $form;
1529
    }
1530
    
1531
1532
    /**
1533
     * Filter area fields based on specified conditions
1534
     *  - This filter removes the fields that have calculation configured
1535
     *
1536
     * @uses GravityView_Edit_Entry::user_can_edit_field() Check caps
1537
     * @access private
1538
     * @param GF_Field[] $fields
1539
     * @param array $configured_fields
1540
     * @since  1.5
1541
     * @return array $fields
1542
     */
1543
    private function filter_fields( $fields, $configured_fields ) {
1544
1545
        if( empty( $fields ) || !is_array( $fields ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1546
            return $fields;
1547
        }
1548
1549
        $edit_fields = array();
1550
1551
        $field_type_blacklist = array(
1552
            'page',
1553
        );
1554
1555
	    /**
1556
	     * @filter `gravityview/edit_entry/hide-product-fields` Hide product fields from being editable.
1557
	     * @since 1.9.1
1558
         * @param boolean $hide_product_fields Whether to hide product fields in the editor.  Default: false
1559
	     */
1560
	    $hide_product_fields = apply_filters( 'gravityview/edit_entry/hide-product-fields', empty( self::$supports_product_fields ) );
1561
1562
	    if( $hide_product_fields ) {
1563
		    $field_type_blacklist[] = 'option';
1564
		    $field_type_blacklist[] = 'quantity';
1565
            $field_type_blacklist[] = 'product';
1566
            $field_type_blacklist[] = 'total';
1567
            $field_type_blacklist[] = 'shipping';
1568
            $field_type_blacklist[] = 'calculation';
1569
	    }
1570
1571
        // First, remove blacklist or calculation fields
1572
        foreach ( $fields as $key => $field ) {
1573
1574
            // Remove the fields that have calculation properties and keep them to be used later
1575
            // @since 1.16.2
1576
            if( $field->has_calculation() ) {
1577
                $this->fields_with_calculation[] = $field;
1578
                // don't remove the calculation fields on form render.
1579
            }
1580
1581
            // process total field after all fields have been saved
1582
            if ( $field->type == 'total' ) {
0 ignored issues
show
introduced by
Found "== '". Use Yoda Condition checks, you must
Loading history...
1583
                $this->total_fields[] = $field;
1584
                unset( $fields[ $key ] );
1585
            }
1586
1587
            if( in_array( $field->type, $field_type_blacklist ) ) {
1588
                unset( $fields[ $key ] );
1589
            }
1590
        }
1591
1592
        // The Edit tab has not been configured, so we return all fields by default.
1593
        if( empty( $configured_fields ) ) {
1594
            return $fields;
1595
        }
1596
1597
        // The edit tab has been configured, so we loop through to configured settings
1598
        foreach ( $configured_fields as $configured_field ) {
1599
1600
	        /** @var GF_Field $field */
1601
	        foreach ( $fields as $field ) {
1602
1603
                if( intval( $configured_field['id'] ) === intval( $field->id ) && $this->user_can_edit_field( $configured_field, false ) ) {
1604
                    $edit_fields[] = $this->merge_field_properties( $field, $configured_field );
1605
                    break;
1606
                }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
1607
1608
            }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
1609
1610
        }
1611
1612
        return $edit_fields;
1613
1614
    }
1615
1616
    /**
1617
     * Override GF Form field properties with the ones defined on the View
1618
     * @param  GF_Field $field GF Form field object
1619
     * @param  array $setting  GV field options
0 ignored issues
show
Documentation introduced by
There is no parameter named $setting. Did you maybe mean $field_setting?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.

Consider the following example. The parameter $ireland is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was changed, but the annotation was not.

Loading history...
1620
     * @since  1.5
1621
     * @return array
1622
     */
1623
    private function merge_field_properties( $field, $field_setting ) {
1624
1625
        $return_field = $field;
1626
1627
        if( empty( $field_setting['show_label'] ) ) {
1628
            $return_field->label = '';
1629
        } elseif ( !empty( $field_setting['custom_label'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1630
            $return_field->label = $field_setting['custom_label'];
1631
        }
1632
1633
        if( !empty( $field_setting['custom_class'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1634
            $return_field->cssClass .= ' '. gravityview_sanitize_html_class( $field_setting['custom_class'] );
1635
        }
1636
1637
        /**
1638
         * Normalize page numbers - avoid conflicts with page validation
1639
         * @since 1.6
1640
         */
1641
        $return_field->pageNumber = 1;
1642
1643
        return $return_field;
1644
1645
    }
1646
1647
    /**
1648
     * Remove fields that shouldn't be visible based on the Gravity Forms adminOnly field property
1649
     *
1650
     * @since 1.9.1
1651
     *
1652
     * @param array|GF_Field[] $fields Gravity Forms form fields
1653
     * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1654
     * @param array $form GF Form array
1655
     * @param int $view_id View ID
1656
     *
1657
     * @return array Possibly modified form array
1658
     */
1659
    function filter_admin_only_fields( $fields = array(), $edit_fields = null, $form = array(), $view_id = 0 ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
1660
1661
	    /**
1662
         * @filter `gravityview/edit_entry/use_gf_admin_only_setting` When Edit tab isn't configured, should the Gravity Forms "Admin Only" field settings be used to control field display to non-admins? Default: true
1663
	     * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
1664
	     * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
1665
	     * @since 1.9.1
1666
	     * @param boolean $use_gf_adminonly_setting True: Hide field if set to Admin Only in GF and the user is not an admin. False: show field based on GV permissions, ignoring GF permissions.
1667
	     * @param array $form GF Form array
1668
	     * @param int $view_id View ID
1669
	     */
1670
	    $use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
1671
1672
	    if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
1673
            foreach( $fields as $k => $field ) {
1674
                if( $field->adminOnly ) {
1675
                    unset( $fields[ $k ] );
1676
                }
1677
            }
1678
            return $fields;
1679
        }
1680
1681
	    foreach( $fields as &$field ) {
1682
		    $field->adminOnly = false;
1683
        }
1684
1685
        return $fields;
1686
    }
1687
1688
    // --- Conditional Logic
1689
1690
    /**
1691
     * Remove the conditional logic rules from the form button and the form fields, if needed.
1692
     *
1693
     * @since 1.9
1694
     *
1695
     * @param array $form Gravity Forms form
1696
     * @return array Modified form, if not using Conditional Logic
1697
     */
1698
    function filter_conditional_logic( $form ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
1699
1700
        /**
1701
         * @filter `gravityview/edit_entry/conditional_logic` Should the Edit Entry form use Gravity Forms conditional logic showing/hiding of fields?
1702
         * @since 1.9
1703
         * @param bool $use_conditional_logic True: Gravity Forms will show/hide fields just like in the original form; False: conditional logic will be disabled and fields will be shown based on configuration. Default: true
1704
         * @param array $form Gravity Forms form
1705
         */
1706
        $use_conditional_logic = apply_filters( 'gravityview/edit_entry/conditional_logic', true, $form );
1707
1708
        if( $use_conditional_logic ) {
1709
            return $form;
1710
        }
1711
1712
        foreach( $form['fields'] as &$field ) {
1713
            /* @var GF_Field $field */
1714
            $field->conditionalLogic = null;
1715
        }
1716
1717
        unset( $form['button']['conditionalLogic'] );
1718
1719
        return $form;
1720
1721
    }
1722
1723
    /**
1724
     * Disable the Gravity Forms conditional logic script and features on the Edit Entry screen
1725
     *
1726
     * @since 1.9
1727
     *
1728
     * @param $has_conditional_logic
1729
     * @param $form
1730
     * @return mixed|void
1731
     */
1732
    function manage_conditional_logic( $has_conditional_logic, $form ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
1733
1734
        if( ! $this->is_edit_entry() ) {
1735
            return $has_conditional_logic;
1736
        }
1737
1738
        return apply_filters( 'gravityview/edit_entry/conditional_logic', $has_conditional_logic, $form );
1739
    }
1740
1741
1742
    // --- User checks and nonces
1743
1744
    /**
1745
     * Check if the user can edit the entry
1746
     *
1747
     * - Is the nonce valid?
1748
     * - Does the user have the right caps for the entry
1749
     * - Is the entry in the trash?
1750
     *
1751
     * @todo Move to GVCommon
1752
     *
1753
     * @param  boolean $echo Show error messages in the form?
1754
     * @return boolean        True: can edit form. False: nope.
1755
     */
1756
    function user_can_edit_entry( $echo = false ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
1757
1758
        $error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1759
1760
        /**
1761
         *  1. Permalinks are turned off
1762
         *  2. There are two entries embedded using oEmbed
1763
         *  3. One of the entries has just been saved
1764
         */
1765
        if( !empty( $_POST['lid'] ) && !empty( $_GET['entry'] ) && ( $_POST['lid'] !== $_GET['entry'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1766
1767
            $error = true;
1768
1769
        }
1770
1771
        if( !empty( $_GET['entry'] ) && (string)$this->entry['id'] !== $_GET['entry'] ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
1772
1773
            $error = true;
1774
1775
        } elseif( ! $this->verify_nonce() ) {
1776
1777
            /**
1778
             * If the Entry is embedded, there may be two entries on the same page.
1779
             * If that's the case, and one is being edited, the other should fail gracefully and not display an error.
1780
             */
1781
            if( GravityView_oEmbed::getInstance()->get_entry_id() ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \GravityView_oEmbed::get...tance()->get_entry_id() of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
1782
                $error = true;
1783
            } else {
1784
                $error = __( 'The link to edit this entry is not valid; it may have expired.', 'gravityview');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1785
            }
1 ignored issue
show
introduced by
Blank line found after control structure
Loading history...
1786
1787
        }
1788
1789
        if( ! GravityView_Edit_Entry::check_user_cap_edit_entry( $this->entry ) ) {
1790
            $error = __( 'You do not have permission to edit this entry.', 'gravityview');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1791
        }
1792
1793
        if( $this->entry['status'] === 'trash' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
1794
            $error = __('You cannot edit the entry; it is in the trash.', 'gravityview' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1795
        }
1796
1797
        // No errors; everything's fine here!
1798
        if( empty( $error ) ) {
1799
            return true;
1800
        }
1801
1802
        if( $echo && $error !== true ) {
0 ignored issues
show
introduced by
Found "!== true". Use Yoda Condition checks, you must
Loading history...
1803
1804
	        $error = esc_html( $error );
1805
1806
	        /**
1807
	         * @since 1.9
1808
	         */
1809
	        if ( ! empty( $this->entry ) ) {
1810
		        $error .= ' ' . gravityview_get_link( '#', _x('Go back.', 'Link shown when invalid Edit Entry link is clicked', 'gravityview' ), array( 'onclick' => "window.history.go(-1); return false;" ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style Comprehensibility introduced by
The string literal window.history.go(-1); return false; does not require double quotes, as per coding-style, please use single quotes.

PHP provides two ways to mark string literals. Either with single quotes 'literal' or with double quotes "literal". The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences.

String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (\') and the backslash (\\). Every other character is displayed as is.

Double quoted string literals may contain other variables or more complex escape sequences.

<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

will print an indented: Single is Value

If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear.

For more information on PHP string literals and available escape sequences see the PHP core documentation.

Loading history...
1811
	        }
1812
1813
            echo GVCommon::generate_notice( wpautop( $error ), 'gv-error error');
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1814
        }
1815
1816
        do_action('gravityview_log_error', 'GravityView_Edit_Entry[user_can_edit_entry]' . $error );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1817
1818
        return false;
1819
    }
1820
1821
1822
    /**
1823
     * Check whether a field is editable by the current user, and optionally display an error message
1824
     * @uses  GravityView_Edit_Entry->check_user_cap_edit_field() Check user capabilities
1825
     * @param  array  $field Field or field settings array
1826
     * @param  boolean $echo  Whether to show error message telling user they aren't allowed
1827
     * @return boolean         True: user can edit the current field; False: nope, they can't.
1828
     */
1829
    private function user_can_edit_field( $field, $echo = false ) {
1830
1831
        $error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1832
1833
        if( ! $this->check_user_cap_edit_field( $field ) ) {
1834
            $error = __( 'You do not have permission to edit this field.', 'gravityview');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1835
        }
1836
1837
        // No errors; everything's fine here!
1838
        if( empty( $error ) ) {
1839
            return true;
1840
        }
1841
1842
        if( $echo ) {
1843
            echo GVCommon::generate_notice( wpautop( esc_html( $error ) ), 'gv-error error');
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1844
        }
1845
1846
        do_action('gravityview_log_error', 'GravityView_Edit_Entry[user_can_edit_field]' . $error );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1847
1848
        return false;
1849
1850
    }
1851
1852
1853
    /**
1854
     * checks if user has permissions to edit a specific field
1855
     *
1856
     * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_field for maximum security!!
1857
     *
1858
     * @param  [type] $field [description]
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
1859
     * @return bool
1860
     */
1861
    private function check_user_cap_edit_field( $field ) {
1862
1863
        // If they can edit any entries (as defined in Gravity Forms), we're good.
1864
        if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ) ) ) {
1865
            return true;
1866
        }
1867
1868
        $field_cap = isset( $field['allow_edit_cap'] ) ? $field['allow_edit_cap'] : false;
1869
1870
        // If the field has custom editing capaibilities set, check those
1871
        if( $field_cap ) {
1872
            return GVCommon::has_cap( $field['allow_edit_cap'] );
1873
        }
1874
1875
        return false;
1876
    }
1877
1878
1879
    /**
1880
     * Is the current nonce valid for editing the entry?
1881
     * @return boolean
1882
     */
1883
    public function verify_nonce() {
1884
1885
        // Verify form submitted for editing single
1886
        if( $this->is_edit_entry_submission() ) {
1887
            $valid = wp_verify_nonce( $_POST[ self::$nonce_field ], self::$nonce_field );
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-validated input variable: $_POST
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_POST
Loading history...
1888
        }
1889
1890
        // Verify
1891
        else if( ! $this->is_edit_entry() ) {
1892
            $valid = false;
1893
        }
1894
1895
        else {
1896
            $valid = wp_verify_nonce( $_GET['edit'], self::$nonce_key );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-validated input variable: $_GET
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_GET
Loading history...
1897
        }
1898
1899
        /**
1900
         * @filter `gravityview/edit_entry/verify_nonce` Override Edit Entry nonce validation. Return true to declare nonce valid.
1901
         * @since 1.13
1902
         * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
1903
         * @param string $nonce_field Key used when validating submissions. Default: is_gv_edit_entry
1904
         */
1905
        $valid = apply_filters( 'gravityview/edit_entry/verify_nonce', $valid, self::$nonce_field );
1906
1907
        return $valid;
1908
    }
1909
1910
1911
1912
} //end class