Completed
Push — develop ( 0f41f0...4939cc )
by Zack
25:11 queued 19:29
created

GravityView_Edit_Entry_Render::get_field_value()   D

Complexity

Conditions 20
Paths 46

Size

Total Lines 80

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 20
CRAP Score 21.8529

Importance

Changes 0
Metric Value
cc 20
nc 46
nop 1
dl 0
loc 80
ccs 20
cts 24
cp 0.8333
crap 21.8529
rs 4.1666
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
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
class GravityView_Edit_Entry_Render {
17
18
	/**
19
	 * @var GravityView_Edit_Entry
20
	 */
21
	protected $loader;
22
23
	/**
24
	 * @var string String used to generate unique nonce for the entry/form/view combination. Allows access to edit page.
25
	 */
26
	static $nonce_key;
27
28
	/**
29
	 * @since 1.9
30
	 * @var string String used for check valid edit entry form submission. Allows saving edit form values.
31
	 */
32
	private static $nonce_field = 'is_gv_edit_entry';
33
34
	/**
35
	 * @since 1.9
36
	 * @var bool Whether to allow save and continue functionality
37
	 */
38
	private static $supports_save_and_continue = false;
39
40
	/**
41
	 * Gravity Forms entry array
42
	 *
43
	 * @var array
44
	 */
45
	public $entry;
46
47
	/**
48
	 * The View.
49
	 *
50
	 * @var \GV\View.
51
	 * @since develop
52
	 */
53
	public $view;
54
55
	/**
56
	 * Gravity Forms entry array (it won't get changed during this class lifecycle)
57
	 * @since 1.17.2
58
	 * @var array
59
	 */
60
	private static $original_entry = array();
61
62
	/**
63
	 * Gravity Forms form array (GravityView modifies the content through this class lifecycle)
64
	 *
65
	 * @var array
66
	 */
67
	public $form;
68
69
	/**
70
	 * Gravity Forms form array (it won't get changed during this class lifecycle)
71
	 * @since 1.16.2.1
72
	 * @var array
73
	 */
74
	private static $original_form;
75
76
	/**
77
	 * Gravity Forms form array after the form validation process
78
	 * @since 1.13
79
	 * @var array
80
	 */
81
	public $form_after_validation = null;
82
83
	/**
84
	 * Hold an array of GF field objects that have calculation rules
85
	 * @var array
86
	 */
87
	public $fields_with_calculation = array();
88
89
	/**
90
	 * Gravity Forms form id
91
	 *
92
	 * @var int
93
	 */
94
	public $form_id;
95
96
	/**
97
	 * ID of the current view
98
	 *
99
	 * @var int
100
	 */
101
	public $view_id;
102
103
	/**
104
	 * ID of the current post. May also be ID of the current View.
105
     *
106
     * @since 2.0.13
107
     * 
108
     * @var int
109
	 */
110
	public $post_id;
111
112
	/**
113
	 * Updated entry is valid (GF Validation object)
114
	 *
115
	 * @var array
116
	 */
117
	public $is_valid = NULL;
118
119
	/**
120
	 * Internal page button states.
121
	 *
122
	 * @var bool
123
	 *
124
	 * @since develop
125
	 */
126
	public $show_previous_button;
127
	public $show_next_button;
128
	public $show_update_button;
129
	public $is_paged_submitted;
130
131 21
	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...
132 21
		$this->loader = $loader;
133 21
	}
134
135 21
	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...
136
137
		/** @define "GRAVITYVIEW_DIR" "../../../" */
138 21
		include_once( GRAVITYVIEW_DIR .'includes/class-admin-approve-entries.php' );
139
140
		// Don't display an embedded form when editing an entry
141 21
		add_action( 'wp_head', array( $this, 'prevent_render_form' ) );
142 21
		add_action( 'wp_footer', array( $this, 'prevent_render_form' ) );
143
144
		// Stop Gravity Forms processing what is ours!
145 21
		add_filter( 'wp', array( $this, 'prevent_maybe_process_form'), 8 );
146
147 21
		add_filter( 'gravityview_is_edit_entry', array( $this, 'is_edit_entry') );
148
149 21
		add_action( 'gravityview_edit_entry', array( $this, 'init' ), 10, 4 );
150
151
		// Disable conditional logic if needed (since 1.9)
152 21
		add_filter( 'gform_has_conditional_logic', array( $this, 'manage_conditional_logic' ), 10, 2 );
153
154
		// Make sure GF doesn't validate max files (since 1.9)
155 21
		add_filter( 'gform_plupload_settings', array( $this, 'modify_fileupload_settings' ), 10, 3 );
156
157
		// Add fields expected by GFFormDisplay::validate()
158 21
		add_filter( 'gform_pre_validation', array( $this, 'gform_pre_validation') );
159
160
		// Fix multiselect value for GF 2.2
161 21
		add_filter( 'gravityview/edit_entry/field_value_multiselect', array( $this, 'fix_multiselect_value_serialization' ), 10, 3 );
162 21
	}
163
164
	/**
165
	 * Don't show any forms embedded on a page when GravityView is in Edit Entry mode
166
	 *
167
	 * Adds a `__return_empty_string` filter on the Gravity Forms shortcode on the `wp_head` action
168
	 * And then removes it on the `wp_footer` action
169
	 *
170
	 * @since 1.16.1
171
	 *
172
	 * @return void
173
	 */
174 1
	public function prevent_render_form() {
175 1
		if( $this->is_edit_entry() ) {
176 1
			if( 'wp_head' === current_filter() ) {
177 1
				add_filter( 'gform_shortcode_form', '__return_empty_string' );
178
			} else {
179 1
				remove_filter( 'gform_shortcode_form', '__return_empty_string' );
180
			}
181
		}
182 1
	}
183
184
	/**
185
	 * Because we're mimicking being a front-end Gravity Forms form while using a Gravity Forms
186
	 * backend form, we need to prevent them from saving twice.
187
	 * @return void
188
	 */
189 1
	public function prevent_maybe_process_form() {
190
191 1
	    if( ! $this->is_edit_entry_submission() ) {
192 1
			return;
193
		}
194
195
		gravityview()->log->debug( 'GravityView_Edit_Entry[prevent_maybe_process_form] Removing GFForms::maybe_process_form() action.' );
196
197
		remove_action( 'wp',  array( 'RGForms', 'maybe_process_form'), 9 );
198
		remove_action( 'wp',  array( 'GFForms', 'maybe_process_form'), 9 );
199
	}
200
201
	/**
202
	 * Is the current page an Edit Entry page?
203
	 * @return boolean
204
	 */
205 26
	public function is_edit_entry() {
206
207 26
		$is_edit_entry = GravityView_frontend::is_single_entry() && ! empty( $_GET['edit'] );
208
209 26
		return ( $is_edit_entry || $this->is_edit_entry_submission() );
210
	}
211
212
	/**
213
	 * Is the current page an Edit Entry page?
214
	 * @since 1.9
215
	 * @return boolean
216
	 */
217 26
	public function is_edit_entry_submission() {
218 26
		return !empty( $_POST[ self::$nonce_field ] );
219
	}
220
221
	/**
222
	 * When Edit entry view is requested setup the vars
223
	 */
224 21
	private function setup_vars() {
225 21
        global $post;
226
227 21
		$gravityview_view = GravityView_View::getInstance();
228
229
230 21
		$entries = $gravityview_view->getEntries();
231 21
	    self::$original_entry = $entries[0];
232 21
	    $this->entry = $entries[0];
233
234 21
		self::$original_form = $gravityview_view->getForm();
235 21
		$this->form = $gravityview_view->getForm();
236 21
		$this->form_id = $this->entry['form_id'];
237 21
		$this->view_id = $gravityview_view->getViewId();
238 21
		$this->post_id = \GV\Utils::get( $post, 'ID', null );
239
240 21
		self::$nonce_key = GravityView_Edit_Entry::get_nonce_key( $this->view_id, $this->form_id, $this->entry['id'] );
241 21
	}
242
243
244
	/**
245
	 * Load required files and trigger edit flow
246
	 *
247
	 * Run when the is_edit_entry returns true.
248
	 *
249
	 * @param \GravityView_View_Data $gv_data GravityView Data object
250
	 * @param \GV\Entry   $entry   The Entry.
251
	 * @param \GV\View    $view    The View.
252
	 * @param \GV\Request $request The Request.
253
	 *
254
	 * @since develop Added $entry, $view, $request adhocs.
255
	 *
256
	 * @return void
257
	 */
258 22
	public function init( $gv_data = null, $entry = null, $view = null, $request = null ) {
259
260 22
		require_once( GFCommon::get_base_path() . '/form_display.php' );
261 22
		require_once( GFCommon::get_base_path() . '/entry_detail.php' );
262
263 22
		$this->setup_vars();
264
265 22
		if ( ! $gv_data ) {
266
			$gv_data = GravityView_View_Data::getInstance();
267
		}
268
269
		// Multiple Views embedded, don't proceed if nonce fails
270 22
		if ( $gv_data->has_multiple_views() && ! $this->verify_nonce() ) {
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View_Data::has_multiple_views() has been deprecated.

This method has been deprecated.

Loading history...
271
			gravityview()->log->error( 'Nonce validation failed for the Edit Entry request; returning' );
272
			return;
273
		}
274
275
		// Sorry, you're not allowed here.
276 22
		if ( false === $this->user_can_edit_entry( true ) ) {
277 2
			gravityview()->log->error( 'User is not allowed to edit this entry; returning', array( 'data' => $this->entry ) );
278 2
			return;
279
		}
280
281 22
		$this->view = $view;
282
283 22
		$this->print_scripts();
284
285 22
		$this->process_save( $gv_data );
286
287 22
		$this->edit_entry_form();
288
289 22
	}
290
291
292
	/**
293
	 * Force Gravity Forms to output scripts as if it were in the admin
294
	 * @return void
295
	 */
296 21
	private function print_scripts() {
297 21
		$gravityview_view = GravityView_View::getInstance();
298
299 21
		wp_register_script( 'gform_gravityforms', GFCommon::get_base_url().'/js/gravityforms.js', array( 'jquery', 'gform_json', 'gform_placeholder', 'sack', 'plupload-all', 'gravityview-fe-view' ) );
300
301 21
		GFFormDisplay::enqueue_form_scripts( $gravityview_view->getForm(), false);
302
303 21
		wp_localize_script( 'gravityview-fe-view', 'gvGlobals', array( 'cookiepath' => COOKIEPATH ) );
304
305
		// Sack is required for images
306 21
		wp_print_scripts( array( 'sack', 'gform_gravityforms', 'gravityview-fe-view' ) );
307 21
	}
308
309
310
	/**
311
	 * Process edit entry form save
312
	 *
313
	 * @param array $gv_data The View data.
314
	 */
315 22
	private function process_save( $gv_data ) {
316
317 22
		if ( empty( $_POST ) || ! isset( $_POST['lid'] ) ) {
318 5
			return;
319
		}
320
321
		// Make sure the entry, view, and form IDs are all correct
322 21
		$valid = $this->verify_nonce();
323
324 21
		if ( !$valid ) {
325
			gravityview()->log->error( 'Nonce validation failed.' );
326
			return;
327
		}
328
329 21
		if ( $this->entry['id'] !== $_POST['lid'] ) {
330
			gravityview()->log->error( 'Entry ID did not match posted entry ID.' );
331
			return;
332
		}
333
334 21
		gravityview()->log->debug( '$_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
335
336 21
		$this->process_save_process_files( $this->form_id );
337
338 21
		$this->validate();
339
340 21
		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...
341
342 21
			gravityview()->log->debug( 'Submission is valid.' );
343
344
			/**
345
			 * @hack This step is needed to unset the adminOnly from form fields, to add the calculation fields
346
			 */
347 21
			$form = $this->form_prepare_for_save();
348
349
			/**
350
			 * @hack to avoid the capability validation of the method save_lead for GF 1.9+
351
			 */
352 21
			unset( $_GET['page'] );
353
354 21
			$date_created = $this->entry['date_created'];
355
356
			/**
357
			 * @hack to force Gravity Forms to use $read_value_from_post in GFFormsModel::save_lead()
358
			 * @since 1.17.2
359
			 */
360 21
			unset( $this->entry['date_created'] );
361
362
			/**
363
			 * @action `gravityview/edit_entry/before_update` Perform an action after the entry has been updated using Edit Entry
364
			 * @since develop
365
			 * @param array $form Gravity Forms form array
366
			 * @param string $entry_id Numeric ID of the entry that is being updated
367
			 * @param GravityView_Edit_Entry_Render $this This object
368
			 * @param GravityView_View_Data $gv_data The View data
369
			 */
370 21
			do_action( 'gravityview/edit_entry/before_update', $form, $this->entry['id'], $this, $gv_data );
371
372 21
			GFFormsModel::save_lead( $form, $this->entry );
373
374
	        // Delete the values for hidden inputs
375 21
	        $this->unset_hidden_field_values();
376
			
377 21
			$this->entry['date_created'] = $date_created;
378
379
			// Process calculation fields
380 21
			$this->update_calculation_fields();
381
382
			// Perform actions normally performed after updating a lead
383 21
			$this->after_update();
384
385
	        /**
386
			 * Must be AFTER after_update()!
387
			 * @see https://github.com/gravityview/GravityView/issues/764
388
			 */
389 21
			$this->maybe_update_post_fields( $form );
390
391
			/**
392
			 * @action `gravityview/edit_entry/after_update` Perform an action after the entry has been updated using Edit Entry
393
             * @since 2.1 Added $gv_data parameter
394
			 * @param array $form Gravity Forms form array
395
			 * @param string $entry_id Numeric ID of the entry that was updated
396
			 * @param GravityView_Edit_Entry_Render $this This object
397
			 * @param GravityView_View_Data $gv_data The View data
398
			 */
399 21
			do_action( 'gravityview/edit_entry/after_update', $this->form, $this->entry['id'], $this, $gv_data );
400
401
		} else {
402
			gravityview()->log->error( 'Submission is NOT valid.', array( 'entry' => $this->entry ) );
403
		}
404
405 21
	} // process_save
406
407
	/**
408
	 * Delete the value of fields hidden by conditional logic when the entry is edited
409
	 *
410
	 * @uses GFFormsModel::update_lead_field_value()
411
	 *
412
	 * @since 1.17.4
413
	 *
414
	 * @return void
415
	 */
416 20
	private function unset_hidden_field_values() {
417 20
	    global $wpdb;
418
419
		/**
420
		 * @filter `gravityview/edit_entry/unset_hidden_field_values` Whether to delete values of fields hidden by conditional logic
421
		 * @since 1.22.2
422
		 * @param bool $unset_hidden_field_values Default: true
423
		 * @param GravityView_Edit_Entry_Render $this This object
424
		 */
425 20
		$unset_hidden_field_values = apply_filters( 'gravityview/edit_entry/unset_hidden_field_values', true, $this );
426
427 20
		$this->unset_hidden_calculations = array();
0 ignored issues
show
Bug introduced by
The property unset_hidden_calculations does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
428
429 20
		if ( ! $unset_hidden_field_values ) {
430
			return;
431
		}
432
433 20
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
434 20
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
435 20
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $this->entry['id'] ) );
436
		} else {
437
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
438
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $this->entry['id'] ) );
439
		}
440
441 20
	    foreach ( $this->entry as $input_id => $field_value ) {
442
443 20
			if ( ! is_numeric( $input_id ) ) {
444 20
				continue;
445
			}
446
447 20
			if ( ! $field = RGFormsModel::get_field( $this->form, $input_id ) ) {
448 7
				continue;
449
			}
450
451
		    // Reset fields that are or would be hidden
452 20
		    if ( GFFormsModel::is_field_hidden( $this->form, $field, array(), $this->entry ) ) {
453
454 3
				$empty_value = $field->get_value_save_entry(
455 3
					is_array( $field->get_entry_inputs() ) ? array() : '',
456 3
					$this->form, '', $this->entry['id'], $this->entry
457
				);
458
459 3
				if ( $field->has_calculation() ) {
460 1
					$this->unset_hidden_calculations[] = $field->id; // Unset
461 1
					$empty_value = '';
462
				}
463
464 3
			    $lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
465
466 3
			    GFFormsModel::update_lead_field_value( $this->form, $this->entry, $field, $lead_detail_id, $input_id, $empty_value );
467
468
			    // Prevent the $_POST values of hidden fields from being used as default values when rendering the form
469
				// after submission
470 3
			    $post_input_id = 'input_' . str_replace( '.', '_', $input_id );
471 3
			    $_POST[ $post_input_id ] = '';
472
		    }
473
	    }
474 20
	}
475
476
	/**
477
	 * Have GF handle file uploads
478
	 *
479
	 * Copy of code from GFFormDisplay::process_form()
480
	 *
481
	 * @param int $form_id
482
	 */
483 20
	private function process_save_process_files( $form_id ) {
484
485
		//Loading files that have been uploaded to temp folder
486 20
		$files = GFCommon::json_decode( stripslashes( RGForms::post( 'gform_uploaded_files' ) ) );
487 20
		if ( ! is_array( $files ) ) {
488 19
			$files = array();
489
		}
490
491
		/**
492
		 * Make sure the fileuploads are not overwritten if no such request was done.
493
		 * @since 1.20.1
494
		 */
495 20
		add_filter( "gform_save_field_value_$form_id", array( $this, 'save_field_value' ), 99, 5 );
496
497 20
		RGFormsModel::$uploaded_files[ $form_id ] = $files;
498 20
	}
499
500
	/**
501
	 * Make sure the fileuploads are not overwritten if no such request was done.
502
	 *
503
	 * TO ONLY BE USED INTERNALLY; DO NOT DEVELOP ON; MAY BE REMOVED AT ANY TIME.
504
	 *
505
	 * @since 1.20.1
506
	 *
507
	 * @param string $value Field value
508
	 * @param array $entry GF entry array
509
	 * @param GF_Field_FileUpload $field
510
	 * @param array $form GF form array
511
	 * @param string $input_id ID of the input being saved
512
	 *
513
	 * @return string
514
	 */
515 20
	public function save_field_value( $value = '', $entry = array(), $field = null, $form = array(), $input_id = '' ) {
516
517 20
		if ( ! $field || $field->type != 'fileupload' ) {
518 20
			return $value;
519
		}
520
521 1
		$input_name = 'input_' . str_replace( '.', '_', $input_id );
522
523 1
		if ( $field->multipleFiles ) {
524
			if ( empty( $value ) ) {
525
				return json_decode( $entry[ $input_id ], true );
526
			}
527
			return $value;
528
		}
529
530
		/** No file is being uploaded. */
531 1
		if ( empty( $_FILES[ $input_name ]['name'] ) ) {
532
			/** So return the original upload */
533 1
			return $entry[ $input_id ];
534
		}
535
536 1
		return $value;
537
	}
538
539
	/**
540
	 * Remove max_files validation (done on gravityforms.js) to avoid conflicts with GravityView
541
	 * Late validation done on self::custom_validation
542
	 *
543
	 * @param $plupload_init array Plupload settings
544
	 * @param $form_id
545
	 * @param $instance
546
	 * @return mixed
547
	 */
548 2
	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...
549 2
		if( ! $this->is_edit_entry() ) {
550
			return $plupload_init;
551
		}
552
553 2
		$plupload_init['gf_vars']['max_files'] = 0;
554
555 2
		return $plupload_init;
556
	}
557
558
559
	/**
560
	 * Set visibility to visible and convert field input key to string
561
	 * @return array $form
562
	 */
563 20
	private function form_prepare_for_save() {
564
565 20
		$form = $this->filter_conditional_logic( $this->form );
566
567
	    /** @var GF_Field $field */
568 20
		foreach( $form['fields'] as $k => &$field ) {
569
570
			/**
571
			 * Remove the fields with calculation formulas before save to avoid conflicts with GF logic
572
			 * @since 1.16.3
573
			 * @var GF_Field $field
574
			 */
575 20
			if( $field->has_calculation() ) {
576 4
				unset( $form['fields'][ $k ] );
577
			}
578
579 20
			$field->adminOnly = false;
580
581 20
			if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
582 2
				foreach( $field->inputs as $key => $input ) {
583 2
				    $field->inputs[ $key ][ 'id' ] = (string)$input['id'];
584
				}
585
			}
586
		}
587
588 20
		$form['fields'] = array_values( $form['fields'] );
589
590 20
		return $form;
591
	}
592
593 20
	private function update_calculation_fields() {
594 20
		global $wpdb;
595
596 20
		$form = self::$original_form;
597 20
		$update = false;
598
599
		// get the most up to date entry values
600 20
		$entry = GFAPI::get_entry( $this->entry['id'] );
601
602 20
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
603 20
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
604 20
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $entry['id'] ) );
605
		} else {
606
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
607
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $entry['id'] ) );
608
		}
609
610
611 20
		if ( ! empty( $this->fields_with_calculation ) ) {
612 5
			$allowed_fields = $this->get_configured_edit_fields( $form, $this->view_id );
613 5
			$allowed_fields = wp_list_pluck( $allowed_fields, 'id' );
614
615 5
			foreach ( $this->fields_with_calculation as $field ) {
616
617 5
				if ( in_array( $field->id, $this->unset_hidden_calculations, true ) ) {
618 1
					continue;
619
				}
620
621 5
				$inputs = $field->get_entry_inputs();
622 5
				if ( is_array( $inputs ) ) {
623 4
				    foreach ( $inputs as $input ) {
624 4
						list( $field_id, $input_id ) = rgexplode( '.', $input['id'], 2 );
625
626 4
						if ( 'product' === $field->type ) {
627 4
							$input_name = 'input_' . str_replace( '.', '_', $input['id'] );
628
629
							// Only allow quantity to be set if it's allowed to be edited
630 4
							if ( in_array( $field_id, $allowed_fields ) && $input_id == 3 ) {
631
							} else { // otherwise set to what it previously was
632 4
								$_POST[ $input_name ] = $entry[ $input['id'] ];
633
							}
634
						} else {
635
							// Set to what it previously was if it's not editable
636
							if ( ! in_array( $field_id, $allowed_fields ) ) {
637
								$_POST[ $input_name ] = $entry[ $input['id'] ];
0 ignored issues
show
Bug introduced by
The variable $input_name does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
638
							}
639
						}
640
641 4
						GFFormsModel::save_input( $form, $field, $entry, $current_fields, $input['id'] );
642
				    }
643
				} else {
644
					// Set to what it previously was if it's not editable
645 3
					if ( ! in_array( $field->id, $allowed_fields ) ) {
646 2
						$_POST[ 'input_' . $field->id ] = $entry[ $field->id ];
647
					}
648 3
					GFFormsModel::save_input( $form, $field, $entry, $current_fields, $field->id );
649
				}
650
			}
651
652 5
			if ( method_exists( 'GFFormsModel', 'commit_batch_field_operations' ) ) {
653 5
				GFFormsModel::commit_batch_field_operations();
654
			}
655
		}
656 20
	}
657
658
	/**
659
	 * Handle updating the Post Image field
660
	 *
661
	 * Sets a new Featured Image if configured in Gravity Forms; otherwise uploads/updates media
662
	 *
663
	 * @since 1.17
664
	 *
665
	 * @uses GFFormsModel::media_handle_upload
666
	 * @uses set_post_thumbnail
667
	 *
668
	 * @param array $form GF Form array
669
	 * @param GF_Field $field GF Field
670
	 * @param string $field_id Numeric ID of the field
671
	 * @param string $value
672
	 * @param array $entry GF Entry currently being edited
673
	 * @param int $post_id ID of the Post being edited
674
	 *
675
	 * @return mixed|string
676
	 */
677 1
	private function update_post_image( $form, $field, $field_id, $value, $entry, $post_id ) {
678
679 1
		$input_name = 'input_' . $field_id;
680
681 1
		if ( !empty( $_FILES[ $input_name ]['name'] ) ) {
682
683
			// We have a new image
684
685
			$value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
686
687
			$ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
688
	        $ary = stripslashes_deep( $ary );
689
			$img_url = \GV\Utils::get( $ary, 0 );
690
691
			$img_title       = count( $ary ) > 1 ? $ary[1] : '';
692
			$img_caption     = count( $ary ) > 2 ? $ary[2] : '';
693
			$img_description = count( $ary ) > 3 ? $ary[3] : '';
694
695
			$image_meta = array(
696
				'post_excerpt' => $img_caption,
697
				'post_content' => $img_description,
698
			);
699
700
			//adding title only if it is not empty. It will default to the file name if it is not in the array
701
			if ( ! empty( $img_title ) ) {
702
				$image_meta['post_title'] = $img_title;
703
			}
704
705
			/**
706
			 * 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.
707
			 * Note: the method became public in GF 1.9.17.7, but we don't require that version yet.
708
			 */
709
			require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
710
			$media_id = GravityView_GFFormsModel::media_handle_upload( $img_url, $post_id, $image_meta );
711
712
			// is this field set as featured image?
713
			if ( $media_id && $field->postFeaturedImage ) {
714
				set_post_thumbnail( $post_id, $media_id );
715
			}
716
717 1
		} elseif ( ! empty( $_POST[ $input_name ] ) && is_array( $value ) ) {
718
719 1
			$img_url         = stripslashes_deep( $_POST[ $input_name ] );
720 1
			$img_title       = stripslashes_deep( \GV\Utils::_POST( $input_name . '_1' ) );
721 1
			$img_caption     = stripslashes_deep( \GV\Utils::_POST( $input_name . '_4' ) );
722 1
			$img_description = stripslashes_deep( \GV\Utils::_POST( $input_name . '_7' ) );
723
724 1
			$value = ! empty( $img_url ) ? $img_url . "|:|" . $img_title . "|:|" . $img_caption . "|:|" . $img_description : '';
725
726 1
			if ( $field->postFeaturedImage ) {
727
728
				$image_meta = array(
729 1
					'ID' => get_post_thumbnail_id( $post_id ),
730 1
					'post_title' => $img_title,
731 1
					'post_excerpt' => $img_caption,
732 1
					'post_content' => $img_description,
733
				);
734
735
				// update image title, caption or description
736 1
				wp_update_post( $image_meta );
737
			}
738
		} else {
739
740
			// if we get here, image was removed or not set.
741
			$value = '';
742
743
			if ( $field->postFeaturedImage ) {
744
				delete_post_thumbnail( $post_id );
745
			}
746
		}
747
748 1
		return $value;
749
	}
750
751
	/**
752
	 * Loop through the fields being edited and if they include Post fields, update the Entry's post object
753
	 *
754
	 * @param array $form Gravity Forms form
755
	 *
756
	 * @return void
757
	 */
758 20
	private function maybe_update_post_fields( $form ) {
759
760 20
		if( empty( $this->entry['post_id'] ) ) {
761 19
	        gravityview()->log->debug( 'This entry has no post fields. Continuing...' );
762 19
			return;
763
		}
764
765 1
		$post_id = $this->entry['post_id'];
766
767
		// Security check
768 1
		if( false === GVCommon::has_cap( 'edit_post', $post_id ) ) {
769
			gravityview()->log->error( 'The current user does not have the ability to edit Post #{post_id}', array( 'post_id' => $post_id ) );
770
			return;
771
		}
772
773 1
		$update_entry = false;
774
775 1
		$updated_post = $original_post = get_post( $post_id );
776
777 1
		foreach ( $this->entry as $field_id => $value ) {
778
779 1
			$field = RGFormsModel::get_field( $form, $field_id );
780
781 1
			if( ! $field ) {
782 1
				continue;
783
			}
784
785 1
			if( GFCommon::is_post_field( $field ) && 'post_category' !== $field->type ) {
786
787
				// Get the value of the field, including $_POSTed value
788 1
				$value = RGFormsModel::get_field_value( $field );
789
790
				// Use temporary entry variable, to make values available to fill_post_template() and update_post_image()
791 1
				$entry_tmp = $this->entry;
792 1
				$entry_tmp["{$field_id}"] = $value;
793
794 1
				switch( $field->type ) {
795
796 1
				    case 'post_title':
797
				        $post_title = $value;
798
				        if ( \GV\Utils::get( $form, 'postTitleTemplateEnabled' ) ) {
799
				            $post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
800
				        }
801
				        $updated_post->post_title = $post_title;
802
				        $updated_post->post_name  = $post_title;
803
				        unset( $post_title );
804
				        break;
805
806 1
				    case 'post_content':
807
				        $post_content = $value;
808
				        if ( \GV\Utils::get( $form, 'postContentTemplateEnabled' ) ) {
809
				            $post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
810
				        }
811
				        $updated_post->post_content = $post_content;
812
				        unset( $post_content );
813
				        break;
814 1
				    case 'post_excerpt':
815
				        $updated_post->post_excerpt = $value;
816
				        break;
817 1
				    case 'post_tags':
818
				        wp_set_post_tags( $post_id, $value, false );
819
				        break;
820 1
				    case 'post_category':
821
				        break;
822 1
				    case 'post_custom_field':
823
						if ( is_array( $value ) && ( floatval( $field_id ) !== floatval( $field->id ) ) ) {
824
							$value = $value[ $field_id ];
825
						}
826
827
				        if( ! empty( $field->customFieldTemplateEnabled ) ) {
828
				            $value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
829
				        }
830
831
						$value = $field->get_value_save_entry( $value, $form, '', $this->entry['id'], $this->entry );
832
833
				        update_post_meta( $post_id, $field->postCustomFieldName, $value );
834
				        break;
835
836 1
				    case 'post_image':
837 1
				        $value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
838 1
				        break;
839
840
				}
841
842
				// update entry after
843 1
				$this->entry["{$field_id}"] = $value;
844
845 1
				$update_entry = true;
846
847 1
				unset( $entry_tmp );
848
			}
849
850
		}
851
852 1
		if( $update_entry ) {
853
854 1
			$return_entry = GFAPI::update_entry( $this->entry );
855
856 1
			if( is_wp_error( $return_entry ) ) {
857
				gravityview()->log->error( 'Updating the entry post fields failed', array( 'data' => array( '$this->entry' => $this->entry, '$return_entry' => $return_entry ) ) );
858
			} else {
859 1
				gravityview()->log->debug( 'Updating the entry post fields for post #{post_id} succeeded', array( 'post_id' => $post_id ) );
860
			}
861
862
		}
863
864 1
		$return_post = wp_update_post( $updated_post, true );
865
866 1
		if( is_wp_error( $return_post ) ) {
867
			$return_post->add_data( $updated_post, '$updated_post' );
868
			gravityview()->log->error( 'Updating the post content failed', array( 'data' => compact( 'updated_post', 'return_post' ) ) );
869
		} else {
870 1
			gravityview()->log->debug( 'Updating the post content for post #{post_id} succeeded', array( 'post_id' => $post_id, 'data' => $updated_post ) );
871
		}
872 1
	}
873
874
	/**
875
	 * Convert a field content template into prepared output
876
	 *
877
	 * @uses GravityView_GFFormsModel::get_post_field_images()
878
	 *
879
	 * @since 1.17
880
	 *
881
	 * @param string $template The content template for the field
882
	 * @param array $form Gravity Forms form
883
	 * @param bool $do_shortcode Whether to process shortcode inside content. In GF, only run on Custom Field and Post Content fields
884
	 *
885
	 * @return string
886
	 */
887
	private function fill_post_template( $template, $form, $entry, $do_shortcode = false ) {
888
889
		require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
890
891
		$post_images = GravityView_GFFormsModel::get_post_field_images( $form, $entry );
892
893
		//replacing post image variables
894
		$output = GFCommon::replace_variables_post_image( $template, $post_images, $entry );
895
896
		//replacing all other variables
897
		$output = GFCommon::replace_variables( $output, $form, $entry, false, false, false );
898
899
		// replace conditional shortcodes
900
		if( $do_shortcode ) {
901
			$output = do_shortcode( $output );
902
		}
903
904
		return $output;
905
	}
906
907
908
	/**
909
	 * Perform actions normally performed after updating a lead
910
	 *
911
	 * @since 1.8
912
	 *
913
	 * @see GFEntryDetail::lead_detail_page()
914
	 *
915
	 * @return void
916
	 */
917 20
	private function after_update() {
918
919 20
		do_action( 'gform_after_update_entry', self::$original_form, $this->entry['id'], self::$original_entry );
920 20
		do_action( "gform_after_update_entry_{$this->form['id']}", self::$original_form, $this->entry['id'], self::$original_entry );
921
922
		// Re-define the entry now that we've updated it.
923 20
		$entry = RGFormsModel::get_lead( $this->entry['id'] );
924
925 20
		$entry = GFFormsModel::set_entry_meta( $entry, self::$original_form );
926
927 20
		if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '<' ) ) {
928
			// We need to clear the cache because Gravity Forms caches the field values, which
929
			// we have just updated.
930
			foreach ($this->form['fields'] as $key => $field) {
931
				GFFormsModel::refresh_lead_field_value( $entry['id'], $field->id );
932
			}
933
		}
934
935
		/**
936
		 * Maybe process feeds.
937
		 *
938
		 * @since develop
939
		 */
940 20
		if ( $allowed_feeds = $this->view->settings->get( 'edit_feeds', array() ) ) {
941 1
			$feeds = GFAPI::get_feeds( null, $entry['form_id'] );
942 1
			if ( ! is_wp_error( $feeds ) ) {
943 1
				$registered_feeds = array();
944 1
				foreach ( GFAddOn::get_registered_addons() as $registered_feed ) {
945 1
					if ( is_subclass_of( $registered_feed,  'GFFeedAddOn' ) ) {
946 1
						if ( method_exists( $registered_feed, 'get_instance' ) ) {
947 1
							$registered_feed = call_user_func( array( $registered_feed, 'get_instance' ) );
948 1
							$registered_feeds[ $registered_feed->get_slug() ] = $registered_feed;
949
						}
950
					}
951
				}
952 1
				foreach ( $feeds as $feed ) {
953 1
					if ( in_array( $feed['id'], $allowed_feeds ) ) {
954 1
						if ( $feed_object = \GV\Utils::get( $registered_feeds, $feed['addon_slug'] ) ) {
955 1
							$returned_entry = $feed_object->process_feed( $feed, $entry, self::$original_form );
956 1
							if ( is_array( $returned_entry ) && rgar( $returned_entry, 'id' ) ) {
957
								$entry = $returned_entry;
958
							}
959
960 1
							do_action( 'gform_post_process_feed', $feed, $entry, self::$original_form, $feed_object );
961 1
							$slug = $feed_object->get_slug();
962 1
							do_action( "gform_{$slug}_post_process_feed", $feed, $entry, self::$original_form, $feed_object );
963
						}
964
					}
965
				}
966
			}
967
		}
968
969 20
		$this->entry = $entry;
970 20
	}
971
972
973
	/**
974
	 * Display the Edit Entry form
975
	 *
976
	 * @return void
977
	 */
978 21
	public function edit_entry_form() {
979
980
		?>
981
982
		<div class="gv-edit-entry-wrapper"><?php
983
984 21
			$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...
985
986
			/**
987
			 * Fixes weird wpautop() issue
988
			 * @see https://github.com/katzwebservices/GravityView/issues/451
989
			 */
990 21
			echo gravityview_strip_whitespace( $javascript );
991
992
			?><h2 class="gv-edit-entry-title">
993
				<span><?php
994
995
				    /**
996
				     * @filter `gravityview_edit_entry_title` Modify the edit entry title
997
				     * @param string $edit_entry_title Modify the "Edit Entry" title
998
				     * @param GravityView_Edit_Entry_Render $this This object
999
				     */
1000 21
				    $edit_entry_title = apply_filters('gravityview_edit_entry_title', __('Edit Entry', 'gravityview'), $this );
1001
1002 21
				    echo esc_attr( $edit_entry_title );
1003
			?></span>
1004
			</h2>
1005
1006
			<?php $this->maybe_print_message(); ?>
1007
1008
			<?php // The ID of the form needs to be `gform_{form_id}` for the pluploader ?>
1009
1010
			<form method="post" id="gform_<?php echo $this->form_id; ?>" enctype="multipart/form-data">
1011
1012
				<?php
1013
1014 21
				wp_nonce_field( self::$nonce_key, self::$nonce_key );
1015
1016 21
				wp_nonce_field( self::$nonce_field, self::$nonce_field, false );
1017
1018
				// Print the actual form HTML
1019 21
				$this->render_edit_form();
1020
1021
				?>
1022 21
			</form>
1023
1024
			<script>
1025
				gform.addFilter('gform_reset_pre_conditional_logic_field_action', function ( reset, formId, targetId, defaultValues, isInit ) {
1026
				    return false;
1027
				});
1028
			</script>
1029
1030
		</div>
1031
1032
	<?php
1033 21
	}
1034
1035
	/**
1036
	 * Display success or error message if the form has been submitted
1037
	 *
1038
	 * @uses GVCommon::generate_notice
1039
	 *
1040
	 * @since 1.16.2.2
1041
	 *
1042
	 * @return void
1043
	 */
1044 21
	private function maybe_print_message() {
1045
1046 21
		if ( \GV\Utils::_POST( 'action' ) === 'update' ) {
1047
1048 20
			if ( GFCommon::has_pages( $this->form ) && apply_filters( 'gravityview/features/paged-edit', false ) ) {
1049
				$labels = array(
1050
					'cancel'   => __( 'Cancel', 'gravityview' ),
1051
					'submit'   => __( 'Update', 'gravityview' ),
1052
					'next'     => __( 'Next', 'gravityview' ),
1053
					'previous' => __( 'Previous', 'gravityview' ),
1054
				);
1055
1056
				/**
1057
				* @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
1058
				* @since 1.16.3
1059
				* @param array $labels Default button labels associative array
1060
				* @param array $form The Gravity Forms form
1061
				* @param array $entry The Gravity Forms entry
1062
				* @param int $view_id The current View ID
1063
				*/
1064
				$labels = apply_filters( 'gravityview/edit_entry/button_labels', $labels, $this->form, $this->entry, $this->view_id );
1065
1066
				$this->is_paged_submitted = \GV\Utils::_POST( 'save' ) === $labels['submit'];
1067
			}
1068
1069 20
			$back_link = remove_query_arg( array( 'page', 'view', 'edit' ) );
1070
1071 20
			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...
1072
1073
				// Keeping this compatible with Gravity Forms.
1074
				$validation_message = "<div class='validation_error'>" . __('There was a problem with your submission.', 'gravityview') . " " . __('Errors have been highlighted below.', 'gravityview') . "</div>";
1075
				$message = apply_filters("gform_validation_message_{$this->form['id']}", apply_filters("gform_validation_message", $validation_message, $this->form), $this->form);
1076
1077
				echo GVCommon::generate_notice( $message , 'gv-error' );
1078
1079 20
			} elseif ( false === $this->is_paged_submitted ) {
1080
				// Paged form that hasn't been submitted on the last page yet
1081
				$entry_updated_message = sprintf( esc_attr__( 'Entry Updated.', 'gravityview' ), '<a href="' . esc_url( $back_link ) . '">', '</a>' );
1082
1083
				/**
1084
				 * @filter `gravityview/edit_entry/page/success` Modify the edit entry success message on pages
1085
				 * @since develop
1086
				 * @param string $entry_updated_message Existing message
1087
				 * @param int $view_id View ID
1088
				 * @param array $entry Gravity Forms entry array
1089
				 */
1090
				$message = apply_filters( 'gravityview/edit_entry/page/success', $entry_updated_message , $this->view_id, $this->entry );
1091
1092
				echo GVCommon::generate_notice( $message );
1093
			} else {
1094 20
				$view = \GV\View::by_id( $this->view_id );
1095 20
				$edit_redirect = $view->settings->get( 'edit_redirect' );
1096 20
				$edit_redirect_url = $view->settings->get( 'edit_redirect_url' );
1097
1098
				switch ( $edit_redirect ) {
1099
1100 20
                    case '0':
1101 1
	                    $redirect_url = $back_link;
1102 1
	                    $entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sReturning to Entry%s', 'Replacements are HTML', 'gravityview'), '<a href="'. esc_url( $redirect_url ) .'">', '</a>' );
1103 1
                        break;
1104
1105 19
                    case '1':
1106 1
	                    $redirect_url = $directory_link = GravityView_API::directory_link();
1107 1
	                    $entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sReturning to %s%s', 'Replacement 1 is HTML. Replacement 2 is the title of the page where the user will be taken. Replacement 3 is HTML.','gravityview'), '<a href="'. esc_url( $redirect_url ) . '">', esc_html( $view->post_title ), '</a>' );
0 ignored issues
show
Documentation introduced by
The property post_title does not exist on object<GV\View>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
1108 1
	                    break;
1109
1110 18
                    case '2':
1111 1
	                    $redirect_url = $edit_redirect_url;
1112 1
	                    $redirect_url = GFCommon::replace_variables( $redirect_url, $this->form, $this->entry, false, false, false, 'text' );
1113 1
	                    $entry_updated_message = sprintf( esc_attr_x('Entry Updated. %sRedirecting to %s%s', 'Replacement 1 is HTML. Replacement 2 is the URL where the user will be taken. Replacement 3 is HTML.','gravityview'), '<a href="'. esc_url( $redirect_url ) . '">', esc_html( $edit_redirect_url ), '</a>' );
1114 1
                        break;
1115
1116 17
                    case '':
1117
                    default:
1118 17
					    $entry_updated_message = sprintf( esc_attr__('Entry Updated. %sReturn to Entry%s', 'gravityview'), '<a href="'. esc_url( $back_link ) .'">', '</a>' );
1119 17
                        break;
1120
				}
1121
1122 20
				if ( isset( $redirect_url ) ) {
1123 3
					$entry_updated_message .= sprintf( '<script>window.location.href = %s;</script><noscript><meta http-equiv="refresh" content="0;URL=%s" /></noscript>', json_encode( $redirect_url ), esc_attr( $redirect_url ) );
1124
				}
1125
1126
				/**
1127
				 * @filter `gravityview/edit_entry/success` Modify the edit entry success message (including the anchor link)
1128
				 * @since 1.5.4
1129
				 * @param string $entry_updated_message Existing message
1130
				 * @param int $view_id View ID
1131
				 * @param array $entry Gravity Forms entry array
1132
				 * @param string $back_link URL to return to the original entry. @since 1.6
1133
				 */
1134 20
				$message = apply_filters( 'gravityview/edit_entry/success', $entry_updated_message , $this->view_id, $this->entry, $back_link );
1135
1136 20
				echo GVCommon::generate_notice( $message );
1137
			}
1138
1139
		}
1140 21
	}
1141
1142
	/**
1143
	 * Display the Edit Entry form in the original Gravity Forms format
1144
	 *
1145
	 * @since 1.9
1146
	 *
1147
	 * @return void
1148
	 */
1149 21
	private function render_edit_form() {
1150
1151
		/**
1152
		 * @action `gravityview/edit-entry/render/before` Before rendering the Edit Entry form
1153
		 * @since 1.17
1154
		 * @param GravityView_Edit_Entry_Render $this
1155
		 */
1156 21
		do_action( 'gravityview/edit-entry/render/before', $this );
1157
1158 21
		add_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields'), 5000, 3 );
1159 21
		add_filter( 'gform_submit_button', array( $this, 'render_form_buttons') );
1160 21
		add_filter( 'gform_next_button', array( $this, 'render_form_buttons' ) );
1161 21
		add_filter( 'gform_previous_button', array( $this, 'render_form_buttons' ) );
1162 21
		add_filter( 'gform_disable_view_counter', '__return_true' );
1163
1164 21
		add_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5, 5 );
1165 21
		add_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10, 5 );
1166
1167
		// We need to remove the fake $_GET['page'] arg to avoid rendering form as if in admin.
1168 21
		unset( $_GET['page'] );
1169
1170 21
		$this->show_next_button = false;
1171 21
		$this->show_previous_button = false;
1172
1173
		// TODO: Verify multiple-page forms
1174 21
		if ( GFCommon::has_pages( $this->form ) && apply_filters( 'gravityview/features/paged-edit', false ) ) {
1175
			if ( intval( $page_number = \GV\Utils::_POST( 'gform_source_page_number_' . $this->form['id'], 0 ) ) ) {
1176
1177
				$labels = array(
1178
					'cancel'   => __( 'Cancel', 'gravityview' ),
1179
					'submit'   => __( 'Update', 'gravityview' ),
1180
					'next'     => __( 'Next', 'gravityview' ),
1181
					'previous' => __( 'Previous', 'gravityview' ),
1182
				);
1183
1184
				/**
1185
				* @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
1186
				* @since 1.16.3
1187
				* @param array $labels Default button labels associative array
1188
				* @param array $form The Gravity Forms form
1189
				* @param array $entry The Gravity Forms entry
1190
				* @param int $view_id The current View ID
1191
				*/
1192
				$labels = apply_filters( 'gravityview/edit_entry/button_labels', $labels, $this->form, $this->entry, $this->view_id );
1193
1194
				GFFormDisplay::$submission[ $this->form['id'] ][ 'form' ] = $this->form;
1195
				GFFormDisplay::$submission[ $this->form['id'] ][ 'is_valid' ] = true;
1196
1197
				if ( \GV\Utils::_POST( 'save' ) === $labels['next'] ) {
1198
					$page_number++;
1199
				} elseif ( \GV\Utils::_POST( 'save' ) === $labels['previous'] ) {
1200
					$page_number--;
1201
				}
1202
1203
				GFFormDisplay::$submission[ $this->form['id'] ][ 'page_number' ] = $page_number;
1204
			}
1205
1206
			if ( ( $page_number = intval( $page_number ) ) < 2 ) {
1207
				$this->show_next_button = true; // First page
1208
			}
1209
1210
			$last_page = \GFFormDisplay::get_max_page_number( $this->form );
1211
1212
			$has_more_pages = $page_number < $last_page;
1213
1214
			if ( $has_more_pages ) {
1215
				$this->show_next_button = true; // Not the last page
1216
			} else {
1217
				$this->show_update_button = true; // The last page
1218
			}
1219
1220
			if ( $page_number > 1 ) {
1221
				$this->show_previous_button = true; // Not the first page
1222
			}
1223
		} else {
1224 21
			$this->show_update_button = true;
1225
		}
1226
1227 21
		ob_start(); // Prevent PHP warnings possibly caused by prefilling list fields for conditional logic
1228
1229 21
		$html = GFFormDisplay::get_form( $this->form['id'], false, false, true, $this->entry );
1230
1231 21
		ob_get_clean();
1232
1233 21
	    remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
1234 21
		remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
1235 21
		remove_filter( 'gform_next_button', array( $this, 'render_form_buttons' ) );
1236 21
		remove_filter( 'gform_previous_button', array( $this, 'render_form_buttons' ) );
1237 21
		remove_filter( 'gform_disable_view_counter', '__return_true' );
1238 21
		remove_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5 );
1239 21
		remove_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10 );
1240
1241 21
		echo $html;
1242
1243
		/**
1244
		 * @action `gravityview/edit-entry/render/after` After rendering the Edit Entry form
1245
		 * @since 1.17
1246
		 * @param GravityView_Edit_Entry_Render $this
1247
		 */
1248 21
		do_action( 'gravityview/edit-entry/render/after', $this );
1249 21
	}
1250
1251
	/**
1252
	 * Display the Update/Cancel/Delete buttons for the Edit Entry form
1253
	 * @since 1.8
1254
	 * @return string
1255
	 */
1256 21
	public function render_form_buttons() {
1257 21
		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...
1258
	}
1259
1260
1261
	/**
1262
	 * Modify the form fields that are shown when using GFFormDisplay::get_form()
1263
	 *
1264
	 * By default, all fields will be shown. We only want the Edit Tab configured fields to be shown.
1265
	 *
1266
	 * @param array $form
1267
	 * @param boolean $ajax Whether in AJAX mode
1268
	 * @param array|string $field_values Passed parameters to the form
1269
	 *
1270
	 * @since 1.9
1271
	 *
1272
	 * @return array Modified form array
1273
	 */
1274 21
	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...
1275
1276 21
		if( $form['id'] != $this->form_id ) {
1277
			return $form;
1278
		}
1279
1280
		// In case we have validated the form, use it to inject the validation results into the form render
1281 21
		if( isset( $this->form_after_validation ) && $this->form_after_validation['id'] === $form['id'] ) {
1282 20
			$form = $this->form_after_validation;
1283
		} else {
1284 4
			$form['fields'] = $this->get_configured_edit_fields( $form, $this->view_id );
1285
		}
1286
1287 21
		$form = $this->filter_conditional_logic( $form );
1288
1289 21
		$form = $this->prefill_conditional_logic( $form );
1290
1291
		// for now we don't support Save and Continue feature.
1292 21
		if( ! self::$supports_save_and_continue ) {
1293 21
	        unset( $form['save'] );
1294
		}
1295
1296 21
		$form = $this->unselect_default_values( $form );
1297
1298 21
		return $form;
1299
	}
1300
1301
	/**
1302
	 * 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.
1303
	 *
1304
	 * @since 1.16.2.2
1305
	 *
1306
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1307
	 * @param GF_Field $field
1308
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1309
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1310
	 * @param int $form_id Form ID
1311
	 *
1312
	 * @return string If error, the error message. If no error, blank string (modify_edit_field_input() runs next)
1313
	 */
1314 21
	public 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...
1315
1316 21
		if( ! GFCommon::is_post_field( $field ) ) {
1317 21
			return $field_content;
1318
		}
1319
1320 2
        $message = null;
1321
1322
        // First, make sure they have the capability to edit the post.
1323 2
        if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
1324
1325
            /**
1326
             * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
1327
             * @param string $message The existing "You don't have permission..." text
1328
             */
1329 1
            $message = apply_filters('gravityview/edit_entry/unsupported_post_field_text', __('You don&rsquo;t have permission to edit this post.', 'gravityview') );
1330
1331 1
        } elseif( null === get_post( $this->entry['post_id'] ) ) {
1332
            /**
1333
             * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
1334
             * @param string $message The existing "This field is not editable; the post no longer exists." text
1335
             */
1336
            $message = apply_filters('gravityview/edit_entry/no_post_text', __('This field is not editable; the post no longer exists.', 'gravityview' ) );
1337
        }
1338
1339 2
        if( $message ) {
1340 1
            $field_content = sprintf('<div class="ginput_container ginput_container_' . $field->type . '">%s</div>', wpautop( $message ) );
1341
        }
1342
1343 2
        return $field_content;
1344
	}
1345
1346
	/**
1347
	 *
1348
	 * Fill-in the saved values into the form inputs
1349
	 *
1350
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1351
	 * @param GF_Field $field
1352
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1353
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1354
	 * @param int $form_id Form ID
1355
	 *
1356
	 * @return mixed
1357
	 */
1358 21
	public function modify_edit_field_input( $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...
1359
1360 21
		$gv_field = GravityView_Fields::get_associated_field( $field );
1361
1362
		// If the form has been submitted, then we don't need to pre-fill the values,
1363
		// Except for fileupload type and when a field input is overridden- run always!!
1364
		if(
1365 21
			( $this->is_edit_entry_submission() && !in_array( $field->type, array( 'fileupload', 'post_image' ) ) )
1366 21
			&& false === ( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) )
1367
			&& ! GFCommon::is_product_field( $field->type )
1368 21
			|| ! empty( $field_content )
1369 21
			|| in_array( $field->type, array( 'honeypot' ) )
1370
		) {
1371 1
	        return $field_content;
1372
		}
1373
1374
		// SET SOME FIELD DEFAULTS TO PREVENT ISSUES
1375 21
		$field->adminOnly = false; /** @see GFFormDisplay::get_counter_init_script() need to prevent adminOnly */
1376
1377 21
		$field_value = $this->get_field_value( $field );
1378
1379
	    // Prevent any PHP warnings, like undefined index
1380 21
	    ob_start();
1381
1382 21
	    $return = null;
1383
1384
		/** @var GravityView_Field $gv_field */
1385 21
		if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
1386 3
			$return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
1387
		} else {
1388 21
	        $return = $field->get_field_input( $this->form, $field_value, $this->entry );
1389
	    }
1390
1391
	    // If there was output, it's an error
1392 21
	    $warnings = ob_get_clean();
1393
1394 21
	    if( !empty( $warnings ) ) {
1395
		    gravityview()->log->error( '{warning}', array( 'warning' => $warnings, 'data' => $field_value ) );
1396
	    }
1397
1398 21
		return $return;
1399
	}
1400
1401
	/**
1402
	 * Modify the value for the current field input
1403
	 *
1404
	 * @param GF_Field $field
1405
	 *
1406
	 * @return array|mixed|string
1407
	 */
1408 21
	private function get_field_value( $field ) {
1409
1410
		/**
1411
		 * @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.
1412
		 * @param boolean True: override saved values; False: don't override (default)
1413
		 * @param $field GF_Field object Gravity Forms field object
1414
		 * @since 1.13
1415
		 */
1416 21
		$override_saved_value = apply_filters( 'gravityview/edit_entry/pre_populate/override', false, $field );
1417
1418
		// We're dealing with multiple inputs (e.g. checkbox) but not time or date (as it doesn't store data in input IDs)
1419 21
		if( isset( $field->inputs ) && is_array( $field->inputs ) && !in_array( $field->type, array( 'time', 'date' ) ) ) {
1420
1421 3
			$field_value = array();
1422
1423
			// only accept pre-populated values if the field doesn't have any choice selected.
1424 3
			$allow_pre_populated = $field->allowsPrepopulate;
1425
1426 3
			foreach ( (array)$field->inputs as $input ) {
1427
1428 3
				$input_id = strval( $input['id'] );
1429
1430 3
				if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
1431 3
				    $field_value[ $input_id ] =  'post_category' === $field->type ? GFCommon::format_post_category( $this->entry[ $input_id ], true ) : $this->entry[ $input_id ];
1432 3
				    $allow_pre_populated = false;
1433
				}
1434
1435
			}
1436
1437 3
			$pre_value = $field->get_value_submission( array(), false );
1438
1439 3
			$field_value = ! $allow_pre_populated && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $field_value : $pre_value;
1440
1441
		} else {
1442
1443 21
			$id = intval( $field->id );
1444
1445
			// get pre-populated value if exists
1446 21
			$pre_value = $field->allowsPrepopulate ? GFFormsModel::get_parameter_value( $field->inputName, array(), $field ) : '';
1447
1448
			// saved field entry value (if empty, fallback to the pre-populated value, if exists)
1449
			// or pre-populated value if not empty and set to override saved value
1450 21
			$field_value = isset( $this->entry[ $id ] ) && ! gv_empty( $this->entry[ $id ], false, false ) && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $this->entry[ $id ] : $pre_value;
1451
1452
			// in case field is post_category but inputType is select, multi-select or radio, convert value into array of category IDs.
1453 21
			if ( 'post_category' === $field->type && !gv_empty( $field_value, false, false ) ) {
1454
				$categories = array();
1455
				foreach ( explode( ',', $field_value ) as $cat_string ) {
1456
				    $categories[] = GFCommon::format_post_category( $cat_string, true );
1457
				}
1458
				$field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
1459
			}
1460
1461
		}
1462
1463
		// if value is empty get the default value if defined
1464 21
		$field_value = $field->get_value_default_if_empty( $field_value );
1465
1466
	    /**
1467
	     * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
1468
	     * @since 1.11
1469
	     * @since 1.20 Added third param
1470
	     * @param mixed $field_value field value used to populate the input
1471
	     * @param object $field Gravity Forms field object ( Class GF_Field )
1472
	     * @param GravityView_Edit_Entry_Render $this Current object
1473
	     */
1474 21
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
1475
1476
	    /**
1477
	     * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
1478
	     * @since 1.17
1479
	     * @since 1.20 Added third param
1480
	     * @param mixed $field_value field value used to populate the input
1481
	     * @param GF_Field $field Gravity Forms field object
1482
	     * @param GravityView_Edit_Entry_Render $this Current object
1483
	     */
1484 21
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
1485
1486 21
		return $field_value;
1487
	}
1488
1489
1490
	// ---- Entry validation
1491
1492
	/**
1493
	 * Add field keys that Gravity Forms expects.
1494
	 *
1495
	 * @see GFFormDisplay::validate()
1496
	 * @param  array $form GF Form
1497
	 * @return array       Modified GF Form
1498
	 */
1499 20
	public function gform_pre_validation( $form ) {
1500
1501 20
		if( ! $this->verify_nonce() ) {
1502
			return $form;
1503
		}
1504
1505
		// Fix PHP warning regarding undefined index.
1506 20
		foreach ( $form['fields'] as &$field) {
1507
1508
			// This is because we're doing admin form pretending to be front-end, so Gravity Forms
1509
			// expects certain field array items to be set.
1510 20
			foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
1511 20
	            $field->{$key} = isset( $field->{$key} ) ? $field->{$key} : NULL;
1512
			}
1513
1514 20
			switch( RGFormsModel::get_input_type( $field ) ) {
1515
1516
				/**
1517
				 * 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.
1518
				 *
1519
				 * 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.
1520
				 *
1521
				 * @hack
1522
				 */
1523 20
				case 'fileupload':
1524
1525
				    // Set the previous value
1526 1
				    $entry = $this->get_entry();
1527
1528 1
				    $input_name = 'input_'.$field->id;
1529 1
				    $form_id = $form['id'];
1530
1531 1
				    $value = NULL;
1532
1533
				    // Use the previous entry value as the default.
1534 1
				    if( isset( $entry[ $field->id ] ) ) {
1535 1
				        $value = $entry[ $field->id ];
1536
				    }
1537
1538
				    // If this is a single upload file
1539 1
				    if( !empty( $_FILES[ $input_name ] ) && !empty( $_FILES[ $input_name ]['name'] ) ) {
1540 1
				        $file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
1541 1
				        $value = $file_path['url'];
1542
1543
				    } else {
1544
1545
				        // Fix PHP warning on line 1498 of form_display.php for post_image fields
1546
				        // Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
1547 1
				        $_FILES[ $input_name ] = array('name' => '', 'size' => '' );
1548
1549
				    }
1550
1551 1
				    if ( \GV\Utils::get( $field, "multipleFiles" ) ) {
1552
1553
				        // If there are fresh uploads, process and merge them.
1554
				        // Otherwise, use the passed values, which should be json-encoded array of URLs
1555 1
				        if( isset( GFFormsModel::$uploaded_files[$form_id][$input_name] ) ) {
1556
				            $value = empty( $value ) ? '[]' : $value;
1557
				            $value = stripslashes_deep( $value );
1558 1
				            $value = GFFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'], array());
1559
				        }
1560
1561
				    } else {
1562
1563
				        // A file already exists when editing an entry
1564
				        // We set this to solve issue when file upload fields are required.
1565 1
				        GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
1566
1567
				    }
1568
1569 1
				    $this->entry[ $input_name ] = $value;
1570 1
				    $_POST[ $input_name ] = $value;
1571
1572 1
				    break;
1573
1574 20
				case 'number':
1575
				    // Fix "undefined index" issue at line 1286 in form_display.php
1576 12
				    if( !isset( $_POST['input_'.$field->id ] ) ) {
1577 7
				        $_POST['input_'.$field->id ] = NULL;
1578
				    }
1579 12
				    break;
1580
			}
1581
1582
		}
1583
1584 20
		return $form;
1585
	}
1586
1587
1588
	/**
1589
	 * Process validation for a edit entry submission
1590
	 *
1591
	 * Sets the `is_valid` object var
1592
	 *
1593
	 * @return void
1594
	 */
1595 21
	private function validate() {
1596
1597
		/**
1598
		 * If using GF User Registration Add-on, remove the validation step, otherwise generates error when updating the entry
1599
		 * GF User Registration Add-on version > 3.x has a different class name
1600
		 * @since 1.16.2
1601
		 */
1602 21
		if ( class_exists( 'GF_User_Registration' ) ) {
1603 21
			remove_filter( 'gform_validation', array( GF_User_Registration::get_instance(), 'validate' ) );
1604
		} else  if ( class_exists( 'GFUser' ) ) {
1605
			remove_filter( 'gform_validation', array( 'GFUser', 'user_registration_validation' ) );
1606
		}
1607
1608
1609
		/**
1610
		 * For some crazy reason, Gravity Forms doesn't validate Edit Entry form submissions.
1611
		 * You can enter whatever you want!
1612
		 * We try validating, and customize the results using `self::custom_validation()`
1613
		 */
1614 21
		add_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10, 4);
1615
1616
		// Needed by the validate funtion
1617 21
		$failed_validation_page = NULL;
1618 21
		$field_values = RGForms::post( 'gform_field_values' );
1619
1620
		// Prevent entry limit from running when editing an entry, also
1621
		// prevent form scheduling from preventing editing
1622 21
		unset( $this->form['limitEntries'], $this->form['scheduleForm'] );
1623
1624
		// Hide fields depending on Edit Entry settings
1625 21
		$this->form['fields'] = $this->get_configured_edit_fields( $this->form, $this->view_id );
1626
1627 21
		$this->is_valid = GFFormDisplay::validate( $this->form, $field_values, 1, $failed_validation_page );
1628
1629 21
		remove_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10 );
1630 21
	}
1631
1632
1633
	/**
1634
	 * Make validation work for Edit Entry
1635
	 *
1636
	 * Because we're calling the GFFormDisplay::validate() in an unusual way (as a front-end
1637
	 * form pretending to be a back-end form), validate() doesn't know we _can't_ edit post
1638
	 * fields. This goes through all the fields and if they're an invalid post field, we
1639
	 * set them as valid. If there are still issues, we'll return false.
1640
	 *
1641
	 * @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...
1642
	 * @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...
1643
	 */
1644 21
	public function custom_validation( $validation_results ) {
1645
1646 21
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results: ', array( 'data' => $validation_results ) );
1647
1648 21
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] $_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
1649
1650 21
		$gv_valid = true;
1651
1652 21
		foreach ( $validation_results['form']['fields'] as $key => &$field ) {
1653
1654 21
			$value = RGFormsModel::get_field_value( $field );
1655 21
			$field_type = RGFormsModel::get_input_type( $field );
1656
1657
			// Validate always
1658 21
			switch ( $field_type ) {
1659
1660
1661 21
				case 'fileupload' :
1662 21
				case 'post_image':
1663
1664
				    // in case nothing is uploaded but there are already files saved
1665 2
				    if( !empty( $field->failed_validation ) && !empty( $field->isRequired ) && !empty( $value ) ) {
1666
				        $field->failed_validation = false;
1667
				        unset( $field->validation_message );
1668
				    }
1669
1670
				    // validate if multi file upload reached max number of files [maxFiles] => 2
1671 2
				    if( \GV\Utils::get( $field, 'maxFiles') && \GV\Utils::get( $field, 'multipleFiles') ) {
1672
1673
				        $input_name = 'input_' . $field->id;
1674
				        //uploaded
1675
				        $file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
1676
1677
				        //existent
1678
				        $entry = $this->get_entry();
1679
				        $value = NULL;
1680
				        if( isset( $entry[ $field->id ] ) ) {
1681
				            $value = json_decode( $entry[ $field->id ], true );
1682
				        }
1683
1684
				        // count uploaded files and existent entry files
1685
				        $count_files = ( is_array( $file_names ) ? count( $file_names ) : 0 ) +
1686
						               ( is_array( $value ) ? count( $value ) : 0 );
1687
1688
				        if( $count_files > $field->maxFiles ) {
1689
				            $field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
1690
				            $field->failed_validation = 1;
1691
				            $gv_valid = false;
1692
1693
				            // in case of error make sure the newest upload files are removed from the upload input
1694
				            GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
1695
				        }
1696
1697
				    }
1698
1699
1700 2
				    break;
1701
1702
			}
1703
1704
			// This field has failed validation.
1705 21
			if( !empty( $field->failed_validation ) ) {
1706
1707 1
				gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field is invalid.', array( 'data' => array( 'field' => $field, 'value' => $value ) ) );
1708
1709 1
				switch ( $field_type ) {
1710
1711
				    // Captchas don't need to be re-entered.
1712 1
				    case 'captcha':
1713
1714
				        // Post Image fields aren't editable, so we un-fail them.
1715 1
				    case 'post_image':
1716
				        $field->failed_validation = false;
1717
				        unset( $field->validation_message );
1718
				        break;
1719
1720
				}
1721
1722
				// You can't continue inside a switch, so we do it after.
1723 1
				if( empty( $field->failed_validation ) ) {
1724
				    continue;
1725
				}
1726
1727
				// checks if the No Duplicates option is not validating entry against itself, since
1728
				// we're editing a stored entry, it would also assume it's a duplicate.
1729 1
				if( !empty( $field->noDuplicates ) ) {
1730
1731
				    $entry = $this->get_entry();
1732
1733
				    // If the value of the entry is the same as the stored value
1734
				    // Then we can assume it's not a duplicate, it's the same.
1735
				    if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
1736
				        //if value submitted was not changed, then don't validate
1737
				        $field->failed_validation = false;
1738
1739
				        unset( $field->validation_message );
1740
1741
				        gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', array( 'data' => $entry ) );
1742
1743
				        continue;
1744
				    }
1745
				}
1746
1747
				// if here then probably we are facing the validation 'At least one field must be filled out'
1748 1
				if( GFFormDisplay::is_empty( $field, $this->form_id  ) && empty( $field->isRequired ) ) {
1749
				    unset( $field->validation_message );
1750
	                $field->validation_message = false;
1751
				    continue;
1752
				}
1753
1754 1
				$gv_valid = false;
1755
1756
			}
1757
1758
		}
1759
1760 21
		$validation_results['is_valid'] = $gv_valid;
1761
1762 21
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results.', array( 'data' => $validation_results ) );
1763
1764
		// We'll need this result when rendering the form ( on GFFormDisplay::get_form )
1765 21
		$this->form_after_validation = $validation_results['form'];
1766
1767 21
		return $validation_results;
1768
	}
1769
1770
1771
	/**
1772
	 * TODO: This seems to be hacky... we should remove it. Entry is set when updating the form using setup_vars()!
1773
	 * Get the current entry and set it if it's not yet set.
1774
	 * @return array Gravity Forms entry array
1775
	 */
1776 2
	public function get_entry() {
1777
1778 2
		if( empty( $this->entry ) ) {
1779
			// Get the database value of the entry that's being edited
1780 1
			$this->entry = gravityview_get_entry( GravityView_frontend::is_single_entry() );
1781
		}
1782
1783 2
		return $this->entry;
1784
	}
1785
1786
1787
1788
	// --- Filters
1789
1790
	/**
1791
	 * Get the Edit Entry fields as configured in the View
1792
	 *
1793
	 * @since 1.8
1794
	 *
1795
	 * @param int $view_id
1796
	 *
1797
	 * @return array Array of fields that are configured in the Edit tab in the Admin
1798
	 */
1799 22
	private function get_configured_edit_fields( $form, $view_id ) {
1800
1801
		// Get all fields for form
1802 22
		if ( \GV\View::exists( $view_id ) ) {
1803 22
			$view = \GV\View::by_id( $view_id );
1804 22
			$properties = $view->fields ? $view->fields->as_configuration() : array();
1805
		} else {
1806
			$properties = null;
1807
		}
1808
1809
		// If edit tab not yet configured, show all fields
1810 22
		$edit_fields = !empty( $properties['edit_edit-fields'] ) ? $properties['edit_edit-fields'] : NULL;
1811
1812
		// Hide fields depending on admin settings
1813 22
		$fields = $this->filter_fields( $form['fields'], $edit_fields );
1814
1815
	    // If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
1816 22
	    $fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
1817
1818
		/**
1819
		 * @filter `gravityview/edit_entry/form_fields` Modify the fields displayed in Edit Entry form
1820
		 * @since 1.17
1821
		 * @param GF_Field[] $fields Gravity Forms form fields
1822
		 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1823
		 * @param array $form GF Form array (`fields` key modified to have only fields configured to show in Edit Entry)
1824
		 * @param int $view_id View ID
1825
		 */
1826 22
		$fields = apply_filters( 'gravityview/edit_entry/form_fields', $fields, $edit_fields, $form, $view_id );
1827
1828 22
		return $fields;
1829
	}
1830
1831
1832
	/**
1833
	 * Filter area fields based on specified conditions
1834
	 *  - This filter removes the fields that have calculation configured
1835
	 *  - Hides fields that are hidden, etc.
1836
	 *
1837
	 * @uses GravityView_Edit_Entry::user_can_edit_field() Check caps
1838
	 * @access private
1839
	 * @param GF_Field[] $fields
1840
	 * @param array $configured_fields
1841
	 * @since  1.5
1842
	 * @return array $fields
1843
	 */
1844 21
	private function filter_fields( $fields, $configured_fields ) {
1845
1846 21
		if( empty( $fields ) || !is_array( $fields ) ) {
1847
			return $fields;
1848
		}
1849
1850 21
		$edit_fields = array();
1851
1852 21
		$field_type_blacklist = $this->loader->get_field_blacklist( $this->entry );
1853
1854 21
		if ( empty( $configured_fields ) && apply_filters( 'gravityview/features/paged-edit', false ) ) {
1855
			$field_type_blacklist = array_diff( $field_type_blacklist, array( 'page' ) );
1856
		}
1857
1858
		// First, remove blacklist or calculation fields
1859 21
		foreach ( $fields as $key => $field ) {
1860
1861
			// Remove the fields that have calculation properties and keep them to be used later
1862
			// @since 1.16.2
1863 21
			if( $field->has_calculation() ) {
1864 5
				$this->fields_with_calculation[] = $field;
1865
				// don't remove the calculation fields on form render.
1866
			}
1867
1868 21
			if( in_array( $field->type, $field_type_blacklist ) ) {
1869 3
				unset( $fields[ $key ] );
1870
			}
1871
		}
1872
1873
		// The Edit tab has not been configured, so we return all fields by default.
1874
		// But we do keep the hidden ones hidden please, for everyone :)
1875 21
		if ( empty( $configured_fields ) ) {
1876 16
			$out_fields = array();
1877 16
			foreach ( $fields as &$field ) {
1878 16
				if ( 'hidden' === $field->type ) {
1879 3
					continue; // A hidden field is just hidden
1880
				}
1881
1882 16
				if ( 'hidden' == $field->visibility ) {
1883 2
					continue; // Same
1884
				}
1885
1886 14
				$out_fields[] = $field;
1887
			}
1888
1889 16
			return array_values( $out_fields );
1890
		}
1891
1892
		// The edit tab has been configured, so we loop through to configured settings
1893 7
		foreach ( $configured_fields as $configured_field ) {
1894
1895
	        /** @var GF_Field $field */
1896 7
	        foreach ( $fields as $field ) {
1897 7
				if( intval( $configured_field['id'] ) === intval( $field->id ) && $this->user_can_edit_field( $configured_field, false ) ) {
1898 7
				    $edit_fields[] = $this->merge_field_properties( $field, $configured_field );
1899 7
				    break;
1900
				}
1901
1902
			}
1903
1904
		}
1905
1906 7
		return $edit_fields;
1907
1908
	}
1909
1910
	/**
1911
	 * Override GF Form field properties with the ones defined on the View
1912
	 * @param  GF_Field $field GF Form field object
1913
	 * @param  array $field_setting  GV field options
1914
	 * @since  1.5
1915
	 * @return array|GF_Field
1916
	 */
1917 7
	private function merge_field_properties( $field, $field_setting ) {
1918
1919 7
		$return_field = $field;
1920
1921 7
		if( empty( $field_setting['show_label'] ) ) {
1922
			$return_field->label = '';
1923 7
		} elseif ( !empty( $field_setting['custom_label'] ) ) {
1924
			$return_field->label = $field_setting['custom_label'];
1925
		}
1926
1927 7
		if( !empty( $field_setting['custom_class'] ) ) {
1928
			$return_field->cssClass .= ' '. gravityview_sanitize_html_class( $field_setting['custom_class'] );
1929
		}
1930
1931
		/**
1932
		 * Normalize page numbers - avoid conflicts with page validation
1933
		 * @since 1.6
1934
		 */
1935 7
		$return_field->pageNumber = 1;
1936
1937 7
		return $return_field;
1938
1939
	}
1940
1941
	/**
1942
	 * Remove fields that shouldn't be visible based on the Gravity Forms adminOnly field property
1943
	 *
1944
	 * @since 1.9.1
1945
	 *
1946
	 * @param array|GF_Field[] $fields Gravity Forms form fields
1947
	 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1948
	 * @param array $form GF Form array
1949
	 * @param int $view_id View ID
1950
	 *
1951
	 * @return array Possibly modified form array
1952
	 */
1953 21
	private function filter_admin_only_fields( $fields = array(), $edit_fields = null, $form = array(), $view_id = 0 ) {
1954
1955
	    /**
1956
		 * @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
1957
	     * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
1958
	     * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
1959
	     * @since 1.9.1
1960
	     * @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.
1961
	     * @param array $form GF Form array
1962
	     * @param int $view_id View ID
1963
	     */
1964 21
	    $use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
1965
1966 21
	    if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
1967 1
			foreach( $fields as $k => $field ) {
1968
				if( $field->adminOnly ) {
1969
				    unset( $fields[ $k ] );
1970
				}
1971
			}
1972 1
			return array_values( $fields );
1973
		}
1974
1975 21
	    foreach( $fields as &$field ) {
1976 21
		    $field->adminOnly = false;
1977
		}
1978
1979 21
		return $fields;
1980
	}
1981
1982
	/**
1983
	 * Checkboxes and other checkbox-based controls should not
1984
	 * display default checks in edit mode.
1985
	 *
1986
	 * https://github.com/gravityview/GravityView/1149
1987
	 *
1988
	 * @since 2.1
1989
	 *
1990
	 * @param array $form Gravity Forms array object
1991
	 *
1992
	 * @return array $form, modified to default checkboxes, radios from showing up.
1993
	 */
1994 21
	private function unselect_default_values( $form ) {
1995
1996 21
	    foreach ( $form['fields'] as &$field ) {
1997
1998 21
			if ( empty( $field->choices ) ) {
1999 18
                continue;
2000
			}
2001
2002 5
            foreach ( $field->choices as &$choice ) {
2003 5
				if ( \GV\Utils::get( $choice, 'isSelected' ) ) {
2004 1
					$choice['isSelected'] = false;
2005
				}
2006
			}
2007
		}
2008
2009 21
		return $form;
2010
	}
2011
2012
	// --- Conditional Logic
2013
2014
	/**
2015
	 * Conditional logic isn't designed to work with forms that already have content. When switching input values,
2016
	 * the dependent fields will be blank.
2017
	 *
2018
	 * Note: This is because GF populates a JavaScript variable with the input values. This is tough to filter at the input level;
2019
	 * via the `gform_field_value` filter; it requires lots of legwork. Doing it at the form level is easier.
2020
	 *
2021
	 * @since 1.17.4
2022
	 *
2023
	 * @param array $form Gravity Forms array object
2024
	 *
2025
	 * @return array $form, modified to fix conditional
2026
	 */
2027 21
	function prefill_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...
2028
2029 21
		if( ! GFFormDisplay::has_conditional_logic( $form ) ) {
2030 18
			return $form;
2031
		}
2032
2033
		// Have Conditional Logic pre-fill fields as if the data were default values
2034
		/** @var GF_Field $field */
2035 3
		foreach ( $form['fields'] as &$field ) {
2036
2037 3
			if( 'checkbox' === $field->type ) {
2038
				foreach ( $field->get_entry_inputs() as $key => $input ) {
2039
				    $input_id = $input['id'];
2040
				    $choice = $field->choices[ $key ];
2041
				    $value = \GV\Utils::get( $this->entry, $input_id );
2042
				    $match = RGFormsModel::choice_value_match( $field, $choice, $value );
2043
				    if( $match ) {
2044
				        $field->choices[ $key ]['isSelected'] = true;
2045
				    }
2046
				}
2047
			} else {
2048
2049
				// We need to run through each field to set the default values
2050 3
				foreach ( $this->entry as $field_id => $field_value ) {
2051
2052 3
				    if( floatval( $field_id ) === floatval( $field->id ) ) {
2053
2054 3
				        if( 'list' === $field->type ) {
2055
				            $list_rows = maybe_unserialize( $field_value );
2056
2057
				            $list_field_value = array();
2058
				            foreach ( (array) $list_rows as $row ) {
2059
				                foreach ( (array) $row as $column ) {
2060
				                    $list_field_value[] = $column;
2061
				                }
2062
				            }
2063
2064
				            $field->defaultValue = serialize( $list_field_value );
2065
				        } else {
2066 3
				            $field->defaultValue = $field_value;
2067
				        }
2068
				    }
2069
				}
2070
			}
2071
		}
2072
2073 3
		return $form;
2074
	}
2075
2076
	/**
2077
	 * Remove the conditional logic rules from the form button and the form fields, if needed.
2078
	 *
2079
	 * @todo Merge with caller method
2080
	 * @since 1.9
2081
	 *
2082
	 * @param array $form Gravity Forms form
2083
	 * @return array Modified form, if not using Conditional Logic
2084
	 */
2085 21
	private function filter_conditional_logic( $form ) {
2086
		/**
2087
		 * Fields that are tied to a conditional logic field that is not present in the view
2088
		 * have to still be displayed, if the condition is met.
2089
		 *
2090
		 * @see https://github.com/gravityview/GravityView/issues/840
2091
		 * @since develop
2092
		 */
2093 21
		$the_form = GFAPI::get_form( $form['id'] );
2094 21
		$editable_ids = array();
2095 21
		foreach ( $form['fields'] as $field ) {
2096 21
			$editable_ids[] = $field['id']; // wp_list_pluck is destructive in this context
2097
		}
2098 21
		$remove_conditions_rule = array();
2099 21
		foreach ( $the_form['fields'] as $field ) {
2100 21
			if ( ! empty( $field->conditionalLogic ) && ! empty( $field->conditionalLogic['rules'] ) ) {
2101 6
				foreach ( $field->conditionalLogic['rules'] as $i => $rule ) {
2102 6
					if ( ! in_array( $rule['fieldId'], $editable_ids ) ) {
2103
						/**
2104
						 * This conditional field is not editable in this View.
2105
						 * We need to remove the rule, but only if it matches.
2106
						 */
2107 4
						if ( $_field = GFAPI::get_field( $the_form, $rule['fieldId'] ) ) {
2108 4
							$value = $_field->get_value_export( $this->entry );
2109
						} elseif ( isset( $this->entry[ $rule['fieldId'] ] ) ) {
2110
							$value = $this->entry[ $rule['fieldId'] ];
2111
						} else {
2112
							$value = gform_get_meta( $this->entry['id'], $rule['fieldId'] );
2113
						}
2114
2115 4
						$match = GFFormsModel::matches_operation( $value, $rule['value'], $rule['operator'] );
2116
						
2117 4
						if ( $match ) {
2118 4
							$remove_conditions_rule[] = array( $field['id'], $i );
2119
						}
2120
					}
2121
				}
2122
			}
2123
		}
2124
2125 21
		if ( $remove_conditions_rule ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $remove_conditions_rule 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...
2126 4
			foreach ( $form['fields'] as &$field ) {
2127 4
				foreach ( $remove_conditions_rule as $_remove_conditions_r ) {
2128
2129 4
				    list( $rule_field_id, $rule_i ) = $_remove_conditions_r;
2130
2131 4
					if ( $field['id'] == $rule_field_id ) {
2132 1
						unset( $field->conditionalLogic['rules'][ $rule_i ] );
2133 1
						gravityview()->log->debug( 'Removed conditional rule #{rule} for field {field_id}', array( 'rule' => $rule_i, 'field_id' => $field['id'] ) );
2134
					}
2135
				}
2136
			}
2137
		}
2138
2139
		/** Normalize the indices... */
2140 21
		$form['fields'] = array_values( $form['fields'] );
2141
2142
		/**
2143
		 * @filter `gravityview/edit_entry/conditional_logic` Should the Edit Entry form use Gravity Forms conditional logic showing/hiding of fields?
2144
		 * @since 1.9
2145
		 * @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
2146
		 * @param array $form Gravity Forms form
2147
		 */
2148 21
		$use_conditional_logic = apply_filters( 'gravityview/edit_entry/conditional_logic', true, $form );
2149
2150 21
		if( $use_conditional_logic ) {
2151 21
			return $form;
2152
		}
2153
2154
		foreach( $form['fields'] as &$field ) {
2155
			/* @var GF_Field $field */
2156
			$field->conditionalLogic = null;
2157
		}
2158
2159
		unset( $form['button']['conditionalLogic'] );
2160
2161
		return $form;
2162
2163
	}
2164
2165
	/**
2166
	 * Disable the Gravity Forms conditional logic script and features on the Edit Entry screen
2167
	 *
2168
	 * @since 1.9
2169
	 *
2170
	 * @param $has_conditional_logic
2171
	 * @param $form
2172
	 * @return mixed
2173
	 */
2174 21
	public function manage_conditional_logic( $has_conditional_logic, $form ) {
2175
2176 21
		if( ! $this->is_edit_entry() ) {
2177
			return $has_conditional_logic;
2178
		}
2179
2180
	    /** @see GravityView_Edit_Entry_Render::filter_conditional_logic for filter documentation */
2181 21
		return apply_filters( 'gravityview/edit_entry/conditional_logic', $has_conditional_logic, $form );
2182
	}
2183
2184
2185
	// --- User checks and nonces
2186
2187
	/**
2188
	 * Check if the user can edit the entry
2189
	 *
2190
	 * - Is the nonce valid?
2191
	 * - Does the user have the right caps for the entry
2192
	 * - Is the entry in the trash?
2193
	 *
2194
	 * @todo Move to GVCommon
2195
	 *
2196
	 * @param  boolean $echo Show error messages in the form?
2197
	 * @return boolean        True: can edit form. False: nope.
2198
	 */
2199 22
	private function user_can_edit_entry( $echo = false ) {
2200
2201 22
		$error = NULL;
2202
2203
		/**
2204
		 *  1. Permalinks are turned off
2205
		 *  2. There are two entries embedded using oEmbed
2206
		 *  3. One of the entries has just been saved
2207
		 */
2208 22
		if( !empty( $_POST['lid'] ) && !empty( $_GET['entry'] ) && ( $_POST['lid'] !== $_GET['entry'] ) ) {
2209
2210
			$error = true;
2211
2212
		}
2213
2214 22
		if( !empty( $_GET['entry'] ) && (string)$this->entry['id'] !== $_GET['entry'] ) {
2215
2216
			$error = true;
2217
2218 22
		} elseif( ! $this->verify_nonce() ) {
2219
2220
			/**
2221
			 * If the Entry is embedded, there may be two entries on the same page.
2222
			 * If that's the case, and one is being edited, the other should fail gracefully and not display an error.
2223
			 */
2224
			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...
Deprecated Code introduced by
The method GravityView_oEmbed::getInstance() has been deprecated with message: Use \GV\oEmbed instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
Deprecated Code introduced by
The method GravityView_oEmbed::get_entry_id() has been deprecated with message: Use \GV\oEmbed instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
2225
				$error = true;
2226
			} else {
2227
				$error = __( 'The link to edit this entry is not valid; it may have expired.', 'gravityview');
2228
			}
2229
2230
		}
2231
2232 22
		if( ! GravityView_Edit_Entry::check_user_cap_edit_entry( $this->entry ) ) {
2233 2
			$error = __( 'You do not have permission to edit this entry.', 'gravityview');
2234
		}
2235
2236 22
		if( $this->entry['status'] === 'trash' ) {
2237
			$error = __('You cannot edit the entry; it is in the trash.', 'gravityview' );
2238
		}
2239
2240
		// No errors; everything's fine here!
2241 22
		if( empty( $error ) ) {
2242 22
			return true;
2243
		}
2244
2245 2
		if( $echo && $error !== true ) {
2246
2247 2
	        $error = esc_html( $error );
2248
2249
	        /**
2250
	         * @since 1.9
2251
	         */
2252 2
	        if ( ! empty( $this->entry ) ) {
2253 2
		        $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;" ) );
2254
	        }
2255
2256 2
			echo GVCommon::generate_notice( wpautop( $error ), 'gv-error error');
2257
		}
2258
2259 2
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2260
2261 2
		return false;
2262
	}
2263
2264
2265
	/**
2266
	 * Check whether a field is editable by the current user, and optionally display an error message
2267
	 * @uses  GravityView_Edit_Entry->check_user_cap_edit_field() Check user capabilities
2268
	 * @param  array  $field Field or field settings array
2269
	 * @param  boolean $echo  Whether to show error message telling user they aren't allowed
2270
	 * @return boolean         True: user can edit the current field; False: nope, they can't.
2271
	 */
2272 7
	private function user_can_edit_field( $field, $echo = false ) {
2273
2274 7
		$error = NULL;
2275
2276 7
		if( ! $this->check_user_cap_edit_field( $field ) ) {
2277 1
			$error = __( 'You do not have permission to edit this field.', 'gravityview');
2278
		}
2279
2280
		// No errors; everything's fine here!
2281 7
		if( empty( $error ) ) {
2282 7
			return true;
2283
		}
2284
2285 1
		if( $echo ) {
2286
			echo GVCommon::generate_notice( wpautop( esc_html( $error ) ), 'gv-error error');
2287
		}
2288
2289 1
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2290
2291 1
		return false;
2292
2293
	}
2294
2295
2296
	/**
2297
	 * checks if user has permissions to edit a specific field
2298
	 *
2299
	 * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_field for maximum security!!
2300
	 *
2301
	 * @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...
2302
	 * @return bool
2303
	 */
2304 7
	private function check_user_cap_edit_field( $field ) {
2305
2306
		// If they can edit any entries (as defined in Gravity Forms), we're good.
2307 7
		if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ) ) ) {
2308 6
			return true;
2309
		}
2310
2311 1
		$field_cap = isset( $field['allow_edit_cap'] ) ? $field['allow_edit_cap'] : false;
2312
2313 1
		if( $field_cap ) {
2314 1
			return GVCommon::has_cap( $field['allow_edit_cap'] );
2315
		}
2316
2317
		return false;
2318
	}
2319
2320
2321
	/**
2322
	 * Is the current nonce valid for editing the entry?
2323
	 * @return boolean
2324
	 */
2325 21
	public function verify_nonce() {
2326
2327
		// Verify form submitted for editing single
2328 21
		if( $this->is_edit_entry_submission() ) {
2329
			$valid = wp_verify_nonce( $_POST[ self::$nonce_field ], self::$nonce_field );
2330
		}
2331
2332
		// Verify
2333 21
		else if( ! $this->is_edit_entry() ) {
2334
			$valid = false;
2335
		}
2336
2337
		else {
2338 21
			$valid = wp_verify_nonce( $_GET['edit'], self::$nonce_key );
2339
		}
2340
2341
		/**
2342
		 * @filter `gravityview/edit_entry/verify_nonce` Override Edit Entry nonce validation. Return true to declare nonce valid.
2343
		 * @since 1.13
2344
		 * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
2345
		 * @param string $nonce_field Key used when validating submissions. Default: is_gv_edit_entry
2346
		 */
2347 21
		$valid = apply_filters( 'gravityview/edit_entry/verify_nonce', $valid, self::$nonce_field );
2348
2349 21
		return $valid;
2350
	}
2351
2352
2353
	/**
2354
	 * Multiselect in GF 2.2 became a json_encoded value. Fix it.
2355
	 *
2356
	 * As a hack for now we'll implode it back.
2357
	 */
2358
	public function fix_multiselect_value_serialization( $field_value, $field, $_this ) {
0 ignored issues
show
Unused Code introduced by
The parameter $_this 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...
2359
		if ( empty ( $field->storageType ) || $field->storageType != 'json' ) {
2360
			return $field_value;
2361
		}
2362
2363
		$maybe_json = @json_decode( $field_value, true );
2364
2365
		if ( $maybe_json ) {
2366
			return implode( ',', $maybe_json );
2367
		}
2368
2369
		return $field_value;
2370
	}
2371
2372
2373
2374
} //end class
2375