Completed
Pull Request — develop (#1609)
by Zack
23:11
created

GravityView_Edit_Entry_Render::verify_nonce()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 26

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 4
CRAP Score 3.072

Importance

Changes 0
Metric Value
cc 3
nc 3
nop 0
dl 0
loc 26
ccs 4
cts 5
cp 0.8
crap 3.072
rs 9.504
c 0
b 0
f 0
1
<?php
2
/**
3
 * GravityView Edit Entry - render frontend
4
 *
5
 * @package   GravityView
6
 * @license   GPL2+
7
 * @author    GravityView <[email protected]>
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 $nonce_key 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 $nonce_field 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 22
	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 22
		$this->loader = $loader;
133 22
	}
134
135 22
	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 22
		include_once( GRAVITYVIEW_DIR .'includes/class-admin-approve-entries.php' );
139
140
		// Don't display an embedded form when editing an entry
141 22
		add_action( 'wp_head', array( $this, 'prevent_render_form' ) );
142 22
		add_action( 'wp_footer', array( $this, 'prevent_render_form' ) );
143
144
		// Stop Gravity Forms processing what is ours!
145 22
		add_action( 'wp', array( $this, 'prevent_maybe_process_form' ), 8 );
146 22
		add_action( 'admin_init', array( $this, 'prevent_maybe_process_form' ), 8 );
147
148 22
		add_filter( 'gravityview_is_edit_entry', array( $this, 'is_edit_entry') );
149
150 22
		add_action( 'gravityview_edit_entry', array( $this, 'init' ), 10, 4 );
151
152
		// Disable conditional logic if needed (since 1.9)
153 22
		add_filter( 'gform_has_conditional_logic', array( $this, 'manage_conditional_logic' ), 10, 2 );
154
155
		// Make sure GF doesn't validate max files (since 1.9)
156 22
		add_filter( 'gform_plupload_settings', array( $this, 'modify_fileupload_settings' ), 10, 3 );
157
158
		// Add fields expected by GFFormDisplay::validate()
159 22
		add_filter( 'gform_pre_validation', array( $this, 'gform_pre_validation') );
160
161
		// Fix multiselect value for GF 2.2
162 22
		add_filter( 'gravityview/edit_entry/field_value_multiselect', array( $this, 'fix_multiselect_value_serialization' ), 10, 3 );
163 22
	}
164
165
	/**
166
	 * Don't show any forms embedded on a page when GravityView is in Edit Entry mode
167
	 *
168
	 * Adds a `__return_empty_string` filter on the Gravity Forms shortcode on the `wp_head` action
169
	 * And then removes it on the `wp_footer` action
170
	 *
171
	 * @since 1.16.1
172
	 *
173
	 * @return void
174
	 */
175 1
	public function prevent_render_form() {
176 1
		if( $this->is_edit_entry() ) {
177 1
			if( 'wp_head' === current_filter() ) {
178 1
				add_filter( 'gform_shortcode_form', '__return_empty_string' );
179
			} else {
180 1
				remove_filter( 'gform_shortcode_form', '__return_empty_string' );
181
			}
182
		}
183 1
	}
184
185
	/**
186
	 * Because we're mimicking being a front-end Gravity Forms form while using a Gravity Forms
187
	 * backend form, we need to prevent them from saving twice.
188
	 * @return void
189
	 */
190 2
	public function prevent_maybe_process_form() {
191
192 2
	    if( ! $this->is_edit_entry_submission() ) {
193 2
			return;
194
		}
195
196
		gravityview()->log->debug( 'GravityView_Edit_Entry[prevent_maybe_process_form] Removing GFForms::maybe_process_form() action.' );
197
198
		remove_action( 'wp',  array( 'RGForms', 'maybe_process_form'), 9 );
199
		remove_action( 'wp',  array( 'GFForms', 'maybe_process_form'), 9 );
200
201
		remove_action( 'admin_init',  array( 'GFForms', 'maybe_process_form'), 9 );
202
		remove_action( 'admin_init',  array( 'RGForms', 'maybe_process_form'), 9 );
203
	}
204
205
	/**
206
	 * Is the current page an Edit Entry page?
207
	 * @return boolean
208
	 */
209 27
	public function is_edit_entry() {
210
211
		$is_edit_entry =
212 27
			( GravityView_frontend::is_single_entry() || gravityview()->request->is_entry() )
213 27
			&& ( ! empty( $_GET['edit'] ) );
214
215 27
		return ( $is_edit_entry || $this->is_edit_entry_submission() );
216
	}
217
218
	/**
219
	 * Is the current page an Edit Entry page?
220
	 * @since 1.9
221
	 * @return boolean
222
	 */
223 28
	public function is_edit_entry_submission() {
224 28
		return !empty( $_POST[ self::$nonce_field ] );
225
	}
226
227
	/**
228
	 * When Edit entry view is requested setup the vars
229
	 */
230 22
	private function setup_vars() {
231 22
        global $post;
232
233 22
		$gravityview_view = GravityView_View::getInstance();
234
235
236 22
		$entries = $gravityview_view->getEntries();
237 22
	    self::$original_entry = $entries[0];
238 22
	    $this->entry = $entries[0];
239
240 22
		self::$original_form = GFAPI::get_form( $this->entry['form_id'] );
241 22
		$this->form = $gravityview_view->getForm();
242 22
		$this->form_id = $this->entry['form_id'];
243 22
		$this->view_id = $gravityview_view->getViewId();
244 22
		$this->post_id = \GV\Utils::get( $post, 'ID', null );
245
246 22
		self::$nonce_key = GravityView_Edit_Entry::get_nonce_key( $this->view_id, $this->form_id, $this->entry['id'] );
247 22
	}
248
249
250
	/**
251
	 * Load required files and trigger edit flow
252
	 *
253
	 * Run when the is_edit_entry returns true.
254
	 *
255
	 * @param \GravityView_View_Data $gv_data GravityView Data object
256
	 * @param \GV\Entry   $entry   The Entry.
257
	 * @param \GV\View    $view    The View.
258
	 * @param \GV\Request $request The Request.
259
	 *
260
	 * @since develop Added $entry, $view, $request adhocs.
261
	 *
262
	 * @return void
263
	 */
264 23
	public function init( $gv_data = null, $entry = null, $view = null, $request = null ) {
265
266 23
		require_once( GFCommon::get_base_path() . '/form_display.php' );
267 23
		require_once( GFCommon::get_base_path() . '/entry_detail.php' );
268
269 23
		$this->setup_vars();
270
271 23
		if ( ! $gv_data ) {
272
			$gv_data = GravityView_View_Data::getInstance();
273
		}
274
275
		// Multiple Views embedded, don't proceed if nonce fails
276 23
		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...
277
			gravityview()->log->error( 'Nonce validation failed for the Edit Entry request; returning' );
278
			return;
279
		}
280
281
		// Sorry, you're not allowed here.
282 23
		if ( false === $this->user_can_edit_entry( true ) ) {
283 2
			gravityview()->log->error( 'User is not allowed to edit this entry; returning', array( 'data' => $this->entry ) );
284 2
			return;
285
		}
286
287 23
		$this->view = $view;
288
289 23
		$this->print_scripts();
290
291 23
		$this->process_save( $gv_data );
292
293 23
		$this->edit_entry_form();
294
295 23
	}
296
297
298
	/**
299
	 * Force Gravity Forms to output scripts as if it were in the admin
300
	 * @return void
301
	 */
302 22
	private function print_scripts() {
303 22
		$gravityview_view = GravityView_View::getInstance();
304
305 22
		wp_register_script( 'gform_gravityforms', GFCommon::get_base_url().'/js/gravityforms.js', array( 'jquery', 'gform_json', 'gform_placeholder', 'sack', 'plupload-all', 'gravityview-fe-view' ) );
306
307 22
		GFFormDisplay::enqueue_form_scripts( $gravityview_view->getForm(), false);
308
309 22
		wp_localize_script( 'gravityview-fe-view', 'gvGlobals', array( 'cookiepath' => COOKIEPATH ) );
310
311
		// Sack is required for images
312 22
		wp_print_scripts( array( 'sack', 'gform_gravityforms', 'gravityview-fe-view' ) );
313 22
	}
314
315
316
	/**
317
	 * Process edit entry form save
318
	 *
319
	 * @param array $gv_data The View data.
320
	 */
321 23
	private function process_save( $gv_data ) {
322
323 23
		if ( empty( $_POST ) || ! isset( $_POST['lid'] ) ) {
324 5
			return;
325
		}
326
327
		// Make sure the entry, view, and form IDs are all correct
328 22
		$valid = $this->verify_nonce();
329
330 22
		if ( !$valid ) {
331
			gravityview()->log->error( 'Nonce validation failed.' );
332
			return;
333
		}
334
335 22
		if ( $this->entry['id'] !== $_POST['lid'] ) {
336
			gravityview()->log->error( 'Entry ID did not match posted entry ID.' );
337
			return;
338
		}
339
340 22
		gravityview()->log->debug( '$_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
341
342 22
		$this->process_save_process_files( $this->form_id );
343
344 22
		$this->validate();
345
346 22
		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...
347
348 22
			gravityview()->log->debug( 'Submission is valid.' );
349
350
			/**
351
			 * @hack This step is needed to unset the adminOnly from form fields, to add the calculation fields
352
			 */
353 22
			$form = $this->form_prepare_for_save();
354
355
			/**
356
			 * @hack to avoid the capability validation of the method save_lead for GF 1.9+
357
			 */
358 22
			unset( $_GET['page'] );
359
360 22
			$date_created = $this->entry['date_created'];
361
362
			/**
363
			 * @hack to force Gravity Forms to use $read_value_from_post in GFFormsModel::save_lead()
364
			 * @since 1.17.2
365
			 */
366 22
			unset( $this->entry['date_created'] );
367
368
			/**
369
			 * @action `gravityview/edit_entry/before_update` Perform an action before the entry has been updated using Edit Entry
370
			 * @since 2.1
371
			 * @param array $form Gravity Forms form array
372
			 * @param string $entry_id Numeric ID of the entry that is being updated
373
			 * @param GravityView_Edit_Entry_Render $this This object
374
			 * @param GravityView_View_Data $gv_data The View data
375
			 */
376 22
			do_action( 'gravityview/edit_entry/before_update', $form, $this->entry['id'], $this, $gv_data );
377
378 22
			GFFormsModel::save_lead( $form, $this->entry );
379
380
	        // Delete the values for hidden inputs
381 22
	        $this->unset_hidden_field_values();
382
383 22
			$this->entry['date_created'] = $date_created;
384
385
			// Process calculation fields
386 22
			$this->update_calculation_fields();
387
388
			// Handle hidden approval fields (or their absense)
389 22
			$this->preset_approval_fields();
390
391
			// Perform actions normally performed after updating a lead
392 22
			$this->after_update();
393
394
	        /**
395
			 * Must be AFTER after_update()!
396
			 * @see https://github.com/gravityview/GravityView/issues/764
397
			 */
398 22
			$this->maybe_update_post_fields( $form );
399
400
			/**
401
			 * @action `gravityview/edit_entry/after_update` Perform an action after the entry has been updated using Edit Entry
402
             * @since 2.1 Added $gv_data parameter
403
			 * @param array $form Gravity Forms form array
404
			 * @param string $entry_id Numeric ID of the entry that was updated
405
			 * @param GravityView_Edit_Entry_Render $this This object
406
			 * @param GravityView_View_Data $gv_data The View data
407
			 */
408 22
			do_action( 'gravityview/edit_entry/after_update', $this->form, $this->entry['id'], $this, $gv_data );
409
410
		} else {
411
			gravityview()->log->error( 'Submission is NOT valid.', array( 'entry' => $this->entry ) );
412
		}
413
414 22
	} // process_save
415
416
	/**
417
	 * Delete the value of fields hidden by conditional logic when the entry is edited
418
	 *
419
	 * @uses GFFormsModel::update_lead_field_value()
420
	 *
421
	 * @since 1.17.4
422
	 *
423
	 * @return void
424
	 */
425 21
	private function unset_hidden_field_values() {
426 21
	    global $wpdb;
427
428
		/**
429
		 * @filter `gravityview/edit_entry/unset_hidden_field_values` Whether to delete values of fields hidden by conditional logic
430
		 * @since 1.22.2
431
		 * @param bool $unset_hidden_field_values Default: true
432
		 * @param GravityView_Edit_Entry_Render $this This object
433
		 */
434 21
		$unset_hidden_field_values = apply_filters( 'gravityview/edit_entry/unset_hidden_field_values', true, $this );
435
436 21
		$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...
437
438 21
		if ( ! $unset_hidden_field_values ) {
439
			return;
440
		}
441
442 21
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
443 21
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
444 21
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $this->entry['id'] ) );
445
		} else {
446
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
447
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $this->entry['id'] ) );
448
		}
449
450 21
	    foreach ( $this->entry as $input_id => $field_value ) {
451
452 21
			if ( ! is_numeric( $input_id ) ) {
453 21
				continue;
454
			}
455
456 21
			if ( ! $field = RGFormsModel::get_field( $this->form, $input_id ) ) {
457 7
				continue;
458
			}
459
460
		    // Reset fields that are or would be hidden
461 21
		    if ( GFFormsModel::is_field_hidden( $this->form, $field, array(), $this->entry ) ) {
462
463 3
				$empty_value = $field->get_value_save_entry(
464 3
					is_array( $field->get_entry_inputs() ) ? array() : '',
465 3
					$this->form, '', $this->entry['id'], $this->entry
466
				);
467
468 3
				if ( $field->has_calculation() ) {
469 1
					$this->unset_hidden_calculations[] = $field->id; // Unset
470 1
					$empty_value = '';
471
				}
472
473 3
			    $lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
474
475 3
			    GFFormsModel::update_lead_field_value( $this->form, $this->entry, $field, $lead_detail_id, $input_id, $empty_value );
476
477
			    // Prevent the $_POST values of hidden fields from being used as default values when rendering the form
478
				// after submission
479 3
			    $post_input_id = 'input_' . str_replace( '.', '_', $input_id );
480 3
			    $_POST[ $post_input_id ] = '';
481
		    }
482
	    }
483 21
	}
484
485
	/**
486
	 * Leverage `gravityview/approve_entries/update_unapproved_meta` to prevent
487
	 * the missing/empty approval field to affect is_approved meta at all.
488
	 *
489
	 * Called before the Gravity Forms after_update triggers.
490
	 *
491
	 * @since 2.5
492
	 *
493
	 * @return void
494
	 */
495 21
	private function preset_approval_fields() {
496 21
		$has_approved_field = false;
497
498 21
		foreach ( self::$original_form['fields'] as $field ) {
499 21
			if ( $field->gravityview_approved ) {
500 1
				$has_approved_field = true;
501 1
				break;
502
			}
503
		}
504
505 21
		if ( ! $has_approved_field ) {
506 20
			return;
507
		}
508
509 1
		$is_field_hidden = true;
510
511 1
		foreach ( $this->form['fields'] as $field ) {
512 1
			if ( $field->gravityview_approved ) {
513 1
				$is_field_hidden = false;
514 1
				break;
515
			}
516
		}
517
518 1
		if ( ! $is_field_hidden ) {
519 1
			return;
520
		}
521
522 1
		add_filter( 'gravityview/approve_entries/update_unapproved_meta', array( $this, 'prevent_update_unapproved_meta' ), 9, 3 );
523 1
	}
524
525
	/**
526
	 * Done once from self::preset_approval_fields
527
	 *
528
	 * @since 2.5
529
	 *
530
	 * @return string UNAPPROVED unless something else is inside the entry.
531
	 */
532 1
	public function prevent_update_unapproved_meta( $value, $form, $entry ) {
533
534 1
		remove_filter( 'gravityview/approve_entries/update_unapproved_meta', array( $this, 'prevent_update_unapproved_meta' ), 9 );
535
536 1
		if ( ! $value = gform_get_meta( $entry['id'], 'is_approved' ) ) {
537
538
			$value = GravityView_Entry_Approval_Status::UNAPPROVED;
539
540
			$value = apply_filters( 'gravityview/approve_entries/after_submission/default_status', $value );
541
		}
542
543 1
		return $value;
544
	}
545
546
	/**
547
	 * Have GF handle file uploads
548
	 *
549
	 * Copy of code from GFFormDisplay::process_form()
550
	 *
551
	 * @param int $form_id
552
	 */
553 21
	private function process_save_process_files( $form_id ) {
554
555
		//Loading files that have been uploaded to temp folder
556 21
		$files = GFCommon::json_decode( stripslashes( RGForms::post( 'gform_uploaded_files' ) ) );
557 21
		if ( ! is_array( $files ) ) {
558 20
			$files = array();
559
		}
560
561
		/**
562
		 * Make sure the fileuploads are not overwritten if no such request was done.
563
		 * @since 1.20.1
564
		 */
565 21
		add_filter( "gform_save_field_value_$form_id", array( $this, 'save_field_value' ), 99, 5 );
566
567 21
		RGFormsModel::$uploaded_files[ $form_id ] = $files;
568 21
	}
569
570
	/**
571
	 * Make sure the fileuploads are not overwritten if no such request was done.
572
	 *
573
	 * TO ONLY BE USED INTERNALLY; DO NOT DEVELOP ON; MAY BE REMOVED AT ANY TIME.
574
	 *
575
	 * @since 1.20.1
576
	 *
577
	 * @param string $value Field value
578
	 * @param array $entry GF entry array
579
	 * @param GF_Field_FileUpload $field
580
	 * @param array $form GF form array
581
	 * @param string $input_id ID of the input being saved
582
	 *
583
	 * @return string
584
	 */
585 21
	public function save_field_value( $value = '', $entry = array(), $field = null, $form = array(), $input_id = '' ) {
586
587 21
		if ( ! $field || $field->type != 'fileupload' ) {
588 21
			return $value;
589
		}
590
591 1
		$input_name = 'input_' . str_replace( '.', '_', $input_id );
592
593 1
		if ( $field->multipleFiles ) {
594
			if ( empty( $value ) ) {
595
				return json_decode( \GV\Utils::get( $entry, $input_id, '' ), true );
596
			}
597
			return $value;
598
		}
599
600
		/** No file is being uploaded. */
601 1
		if ( empty( $_FILES[ $input_name ]['name'] ) ) {
602
			/** So return the original upload, with $value as backup (it can be empty during edit form rendering) */
603 1
			return rgar( $entry, $input_id, $value );
604
		}
605
606 1
		return $value;
607
	}
608
609
	/**
610
	 * Remove max_files validation (done on gravityforms.js) to avoid conflicts with GravityView
611
	 * Late validation done on self::custom_validation
612
	 *
613
	 * @param $plupload_init array Plupload settings
614
	 * @param $form_id
615
	 * @param $instance
616
	 * @return mixed
617
	 */
618 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...
619 2
		if( ! $this->is_edit_entry() ) {
620
			return $plupload_init;
621
		}
622
623 2
		$plupload_init['gf_vars']['max_files'] = 0;
624
625 2
		return $plupload_init;
626
	}
627
628
629
	/**
630
	 * Set visibility to visible and convert field input key to string
631
	 * @return array $form
632
	 */
633 21
	private function form_prepare_for_save() {
634
635 21
		$form = $this->filter_conditional_logic( $this->form );
636
637
	    /** @type GF_Field $field */
638 21
		foreach( $form['fields'] as $k => &$field ) {
639
640
			/**
641
			 * Remove the fields with calculation formulas before save to avoid conflicts with GF logic
642
			 * @since 1.16.3
643
			 */
644 21
			if( $field->has_calculation() ) {
645 4
				unset( $form['fields'][ $k ] );
646
			}
647
648 21
			$field->adminOnly = false;
649
650 21
			if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
651 3
				foreach( $field->inputs as $key => $input ) {
652 3
				    $field->inputs[ $key ][ 'id' ] = (string)$input['id'];
653
				}
654
			}
655
		}
656
657 21
		$form['fields'] = array_values( $form['fields'] );
658
659 21
		return $form;
660
	}
661
662 21
	private function update_calculation_fields() {
663 21
		global $wpdb;
664
665 21
		$form = self::$original_form;
666 21
		$update = false;
667
668
		// get the most up to date entry values
669 21
		$entry = GFAPI::get_entry( $this->entry['id'] );
670
671 21
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
672 21
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
673 21
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $entry['id'] ) );
674
		} else {
675
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
676
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $entry['id'] ) );
677
		}
678
679
680 21
		if ( ! empty( $this->fields_with_calculation ) ) {
681 5
			$allowed_fields = $this->get_configured_edit_fields( $form, $this->view_id );
682 5
			$allowed_fields = wp_list_pluck( $allowed_fields, 'id' );
683
684 5
			foreach ( $this->fields_with_calculation as $field ) {
685
686 5
				if ( in_array( $field->id, $this->unset_hidden_calculations, true ) ) {
687 1
					continue;
688
				}
689
690 5
				$inputs = $field->get_entry_inputs();
691 5
				if ( is_array( $inputs ) ) {
692 4
				    foreach ( $inputs as $input ) {
693 4
						list( $field_id, $input_id ) = rgexplode( '.', $input['id'], 2 );
694
695 4
						if ( 'product' === $field->type ) {
696 4
							$input_name = 'input_' . str_replace( '.', '_', $input['id'] );
697
698
							// Only allow quantity to be set if it's allowed to be edited
699 4
							if ( in_array( $field_id, $allowed_fields ) && $input_id == 3 ) {
700
							} else { // otherwise set to what it previously was
701 4
								$_POST[ $input_name ] = $entry[ $input['id'] ];
702
							}
703
						} else {
704
							// Set to what it previously was if it's not editable
705
							if ( ! in_array( $field_id, $allowed_fields ) ) {
706
								$_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...
707
							}
708
						}
709
710 4
						GFFormsModel::save_input( $form, $field, $entry, $current_fields, $input['id'] );
711
				    }
712
				} else {
713
					// Set to what it previously was if it's not editable
714 3
					if ( ! in_array( $field->id, $allowed_fields ) ) {
715 2
						$_POST[ 'input_' . $field->id ] = $entry[ $field->id ];
716
					}
717 3
					GFFormsModel::save_input( $form, $field, $entry, $current_fields, $field->id );
718
				}
719
			}
720
721 5
			if ( method_exists( 'GFFormsModel', 'commit_batch_field_operations' ) ) {
722 5
				GFFormsModel::commit_batch_field_operations();
723
			}
724
		}
725 21
	}
726
727
	/**
728
	 * Handle updating the Post Image field
729
	 *
730
	 * Sets a new Featured Image if configured in Gravity Forms; otherwise uploads/updates media
731
	 *
732
	 * @since 1.17
733
	 *
734
	 * @uses GFFormsModel::media_handle_upload
735
	 * @uses set_post_thumbnail
736
	 *
737
	 * @param array $form GF Form array
738
	 * @param GF_Field $field GF Field
739
	 * @param string $field_id Numeric ID of the field
740
	 * @param string $value
741
	 * @param array $entry GF Entry currently being edited
742
	 * @param int $post_id ID of the Post being edited
743
	 *
744
	 * @return mixed|string
745
	 */
746 1
	private function update_post_image( $form, $field, $field_id, $value, $entry, $post_id ) {
747
748 1
		$input_name = 'input_' . $field_id;
749
750 1
		if ( !empty( $_FILES[ $input_name ]['name'] ) ) {
751
752
			// We have a new image
753
754
			$value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
755
756
			$ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
757
	        $ary = stripslashes_deep( $ary );
758
			$img_url = \GV\Utils::get( $ary, 0 );
759
760
			$img_title       = count( $ary ) > 1 ? $ary[1] : '';
761
			$img_caption     = count( $ary ) > 2 ? $ary[2] : '';
762
			$img_description = count( $ary ) > 3 ? $ary[3] : '';
763
764
			$image_meta = array(
765
				'post_excerpt' => $img_caption,
766
				'post_content' => $img_description,
767
			);
768
769
			//adding title only if it is not empty. It will default to the file name if it is not in the array
770
			if ( ! empty( $img_title ) ) {
771
				$image_meta['post_title'] = $img_title;
772
			}
773
774
			/**
775
			 * 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.
776
			 * Note: the method became public in GF 1.9.17.7, but we don't require that version yet.
777
			 */
778
			require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
779
			$media_id = GravityView_GFFormsModel::media_handle_upload( $img_url, $post_id, $image_meta );
780
781
			// is this field set as featured image?
782
			if ( $media_id && $field->postFeaturedImage ) {
783
				set_post_thumbnail( $post_id, $media_id );
784
			}
785
786 1
		} elseif ( ! empty( $_POST[ $input_name ] ) && is_array( $value ) ) {
787
788 1
			$img_url         = stripslashes_deep( $_POST[ $input_name ] );
789 1
			$img_title       = stripslashes_deep( \GV\Utils::_POST( $input_name . '_1' ) );
790 1
			$img_caption     = stripslashes_deep( \GV\Utils::_POST( $input_name . '_4' ) );
791 1
			$img_description = stripslashes_deep( \GV\Utils::_POST( $input_name . '_7' ) );
792
793 1
			$value = ! empty( $img_url ) ? $img_url . "|:|" . $img_title . "|:|" . $img_caption . "|:|" . $img_description : '';
794
795 1
			if ( $field->postFeaturedImage ) {
796
797
				$image_meta = array(
798 1
					'ID' => get_post_thumbnail_id( $post_id ),
799 1
					'post_title' => $img_title,
800 1
					'post_excerpt' => $img_caption,
801 1
					'post_content' => $img_description,
802
				);
803
804
				// update image title, caption or description
805 1
				wp_update_post( $image_meta );
806
			}
807
		} else {
808
809
			// if we get here, image was removed or not set.
810
			$value = '';
811
812
			if ( $field->postFeaturedImage ) {
813
				delete_post_thumbnail( $post_id );
814
			}
815
		}
816
817 1
		return $value;
818
	}
819
820
	/**
821
	 * Loop through the fields being edited and if they include Post fields, update the Entry's post object
822
	 *
823
	 * @param array $form Gravity Forms form
824
	 *
825
	 * @return void
826
	 */
827 21
	private function maybe_update_post_fields( $form ) {
828
829 21
		if( empty( $this->entry['post_id'] ) ) {
830 20
	        gravityview()->log->debug( 'This entry has no post fields. Continuing...' );
831 20
			return;
832
		}
833
834 1
		$post_id = $this->entry['post_id'];
835
836
		// Security check
837 1
		if( false === GVCommon::has_cap( 'edit_post', $post_id ) ) {
838
			gravityview()->log->error( 'The current user does not have the ability to edit Post #{post_id}', array( 'post_id' => $post_id ) );
839
			return;
840
		}
841
842 1
		$update_entry = false;
843
844 1
		$updated_post = $original_post = get_post( $post_id );
845
846 1
		foreach ( $this->entry as $field_id => $value ) {
847
848 1
			$field = RGFormsModel::get_field( $form, $field_id );
849
850 1
			if( ! $field ) {
851 1
				continue;
852
			}
853
854 1
			if( GFCommon::is_post_field( $field ) && 'post_category' !== $field->type ) {
855
856
				// Get the value of the field, including $_POSTed value
857 1
				$value = RGFormsModel::get_field_value( $field );
858
859
				// Use temporary entry variable, to make values available to fill_post_template() and update_post_image()
860 1
				$entry_tmp = $this->entry;
861 1
				$entry_tmp["{$field_id}"] = $value;
862
863 1
				switch( $field->type ) {
864
865 1
				    case 'post_title':
866
				        $post_title = $value;
867
				        if ( \GV\Utils::get( $form, 'postTitleTemplateEnabled' ) ) {
868
				            $post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
869
				        }
870
				        $updated_post->post_title = $post_title;
871
				        $updated_post->post_name  = $post_title;
872
				        unset( $post_title );
873
				        break;
874
875 1
				    case 'post_content':
876
				        $post_content = $value;
877
				        if ( \GV\Utils::get( $form, 'postContentTemplateEnabled' ) ) {
878
				            $post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
879
				        }
880
				        $updated_post->post_content = $post_content;
881
				        unset( $post_content );
882
				        break;
883 1
				    case 'post_excerpt':
884
				        $updated_post->post_excerpt = $value;
885
				        break;
886 1
				    case 'post_tags':
887
				        wp_set_post_tags( $post_id, $value, false );
888
				        break;
889 1
				    case 'post_category':
890
				        break;
891 1
				    case 'post_custom_field':
892
						if ( is_array( $value ) && ( floatval( $field_id ) !== floatval( $field->id ) ) ) {
893
							$value = $value[ $field_id ];
894
						}
895
896
				        if( ! empty( $field->customFieldTemplateEnabled ) ) {
897
				            $value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
898
				        }
899
900
						$value = $field->get_value_save_entry( $value, $form, '', $this->entry['id'], $this->entry );
901
902
				        update_post_meta( $post_id, $field->postCustomFieldName, $value );
903
				        break;
904
905 1
				    case 'post_image':
906 1
				        $value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
907 1
				        break;
908
909
				}
910
911
				// update entry after
912 1
				$this->entry["{$field_id}"] = $value;
913
914 1
				$update_entry = true;
915
916 1
				unset( $entry_tmp );
917
			}
918
919
		}
920
921 1
		if( $update_entry ) {
922
923 1
			$return_entry = GFAPI::update_entry( $this->entry );
924
925 1
			if( is_wp_error( $return_entry ) ) {
926
				gravityview()->log->error( 'Updating the entry post fields failed', array( 'data' => array( '$this->entry' => $this->entry, '$return_entry' => $return_entry ) ) );
927
			} else {
928 1
				gravityview()->log->debug( 'Updating the entry post fields for post #{post_id} succeeded', array( 'post_id' => $post_id ) );
929
			}
930
931
		}
932
933 1
		$return_post = wp_update_post( $updated_post, true );
934
935 1
		if( is_wp_error( $return_post ) ) {
936
			$return_post->add_data( $updated_post, '$updated_post' );
937
			gravityview()->log->error( 'Updating the post content failed', array( 'data' => compact( 'updated_post', 'return_post' ) ) );
938
		} else {
939 1
			gravityview()->log->debug( 'Updating the post content for post #{post_id} succeeded', array( 'post_id' => $post_id, 'data' => $updated_post ) );
940
		}
941 1
	}
942
943
	/**
944
	 * Convert a field content template into prepared output
945
	 *
946
	 * @uses GravityView_GFFormsModel::get_post_field_images()
947
	 *
948
	 * @since 1.17
949
	 *
950
	 * @param string $template The content template for the field
951
	 * @param array $form Gravity Forms form
952
	 * @param bool $do_shortcode Whether to process shortcode inside content. In GF, only run on Custom Field and Post Content fields
953
	 *
954
	 * @return string
955
	 */
956
	private function fill_post_template( $template, $form, $entry, $do_shortcode = false ) {
957
958
		require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
959
960
		$post_images = GravityView_GFFormsModel::get_post_field_images( $form, $entry );
961
962
		//replacing post image variables
963
		$output = GFCommon::replace_variables_post_image( $template, $post_images, $entry );
964
965
		//replacing all other variables
966
		$output = GFCommon::replace_variables( $output, $form, $entry, false, false, false );
967
968
		// replace conditional shortcodes
969
		if( $do_shortcode ) {
970
			$output = do_shortcode( $output );
971
		}
972
973
		return $output;
974
	}
975
976
977
	/**
978
	 * Perform actions normally performed after updating a lead
979
	 *
980
	 * @since 1.8
981
	 *
982
	 * @see GFEntryDetail::lead_detail_page()
983
	 *
984
	 * @return void
985
	 */
986 21
	private function after_update() {
987
988 21
		do_action( 'gform_after_update_entry', self::$original_form, $this->entry['id'], self::$original_entry );
989 21
		do_action( "gform_after_update_entry_{$this->form['id']}", self::$original_form, $this->entry['id'], self::$original_entry );
990
991
		// Re-define the entry now that we've updated it.
992 21
		$entry = RGFormsModel::get_lead( $this->entry['id'] );
993
994 21
		$entry = GFFormsModel::set_entry_meta( $entry, self::$original_form );
995
996 21
		if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '<' ) ) {
997
			// We need to clear the cache because Gravity Forms caches the field values, which
998
			// we have just updated.
999
			foreach ($this->form['fields'] as $key => $field) {
1000
				GFFormsModel::refresh_lead_field_value( $entry['id'], $field->id );
1001
			}
1002
		}
1003
1004
		/**
1005
		 * Maybe process feeds.
1006
		 *
1007
		 * @since develop
1008
		 */
1009 21
		if ( $allowed_feeds = $this->view->settings->get( 'edit_feeds', array() ) ) {
1010 1
			$feeds = GFAPI::get_feeds( null, $entry['form_id'] );
1011 1
			if ( ! is_wp_error( $feeds ) ) {
1012 1
				$registered_feeds = array();
1013 1
				foreach ( GFAddOn::get_registered_addons() as $registered_feed ) {
1014 1
					if ( is_subclass_of( $registered_feed,  'GFFeedAddOn' ) ) {
1015 1
						if ( method_exists( $registered_feed, 'get_instance' ) ) {
1016 1
							$registered_feed = call_user_func( array( $registered_feed, 'get_instance' ) );
1017 1
							$registered_feeds[ $registered_feed->get_slug() ] = $registered_feed;
1018
						}
1019
					}
1020
				}
1021 1
				foreach ( $feeds as $feed ) {
1022 1
					if ( in_array( $feed['id'], $allowed_feeds ) ) {
1023 1
						if ( $feed_object = \GV\Utils::get( $registered_feeds, $feed['addon_slug'] ) ) {
1024 1
							$returned_entry = $feed_object->process_feed( $feed, $entry, self::$original_form );
1025 1
							if ( is_array( $returned_entry ) && rgar( $returned_entry, 'id' ) ) {
1026
								$entry = $returned_entry;
1027
							}
1028
1029 1
							do_action( 'gform_post_process_feed', $feed, $entry, self::$original_form, $feed_object );
1030 1
							$slug = $feed_object->get_slug();
1031 1
							do_action( "gform_{$slug}_post_process_feed", $feed, $entry, self::$original_form, $feed_object );
1032
						}
1033
					}
1034
				}
1035
			}
1036
		}
1037
1038 21
		$this->entry = $entry;
1039 21
	}
1040
1041
1042
	/**
1043
	 * Display the Edit Entry form
1044
	 *
1045
	 * @return void
1046
	 */
1047 22
	public function edit_entry_form() {
1048
1049 22
		$view = \GV\View::by_id( $this->view_id );
1050
1051 22
		if( $view->settings->get( 'edit_locking' ) ) {
1052 22
			$locking = new GravityView_Edit_Entry_Locking();
1053 22
			$locking->maybe_lock_object( $this->entry['id'] );
1054
		}
1055
1056
		?>
1057
1058
		<div id="wpfooter"></div><!-- used for locking message -->
1059
1060
		<script>
1061
			var ajaxurl = '<?php echo admin_url( 'admin-ajax.php', 'relative' ); ?>';
1062
		</script>
1063
1064
		<div class="gv-edit-entry-wrapper"><?php
1065
1066 22
			$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...
1067
1068
			/**
1069
			 * Fixes weird wpautop() issue
1070
			 * @see https://github.com/katzwebservices/GravityView/issues/451
1071
			 */
1072 22
			echo gravityview_strip_whitespace( $javascript );
1073
1074
			?><h2 class="gv-edit-entry-title">
1075
				<span><?php
1076
1077
				    /**
1078
				     * @filter `gravityview_edit_entry_title` Modify the edit entry title
1079
				     * @param string $edit_entry_title Modify the "Edit Entry" title
1080
				     * @param GravityView_Edit_Entry_Render $this This object
1081
				     */
1082 22
				    $edit_entry_title = apply_filters('gravityview_edit_entry_title', __('Edit Entry', 'gravityview'), $this );
1083
1084 22
				    echo esc_attr( $edit_entry_title );
1085
			?></span>
1086
			</h2>
1087
1088
			<?php $this->maybe_print_message(); ?>
1089
1090
			<?php // The ID of the form needs to be `gform_{form_id}` for the pluploader ?>
1091
1092
			<form method="post" id="gform_<?php echo $this->form_id; ?>" enctype="multipart/form-data">
1093
1094
				<?php
1095
1096 22
				wp_nonce_field( self::$nonce_key, self::$nonce_key );
1097
1098 22
				wp_nonce_field( self::$nonce_field, self::$nonce_field, false );
1099
1100
				// Print the actual form HTML
1101 22
				$this->render_edit_form();
1102
1103
				?>
1104 22
			</form>
1105
1106
			<script>
1107
				gform.addFilter('gform_reset_pre_conditional_logic_field_action', function ( reset, formId, targetId, defaultValues, isInit ) {
1108
				    return false;
1109
				});
1110
			</script>
1111
1112
		</div>
1113
1114
	<?php
1115 22
	}
1116
1117
	/**
1118
	 * Display success or error message if the form has been submitted
1119
	 *
1120
	 * @uses GVCommon::generate_notice
1121
	 *
1122
	 * @since 1.16.2.2
1123
	 *
1124
	 * @return void
1125
	 */
1126 22
	private function maybe_print_message() {
1127
1128 22
		if ( \GV\Utils::_POST( 'action' ) === 'update' ) {
1129
1130 21
			if ( GFCommon::has_pages( $this->form ) && apply_filters( 'gravityview/features/paged-edit', false ) ) {
1131
				$labels = array(
1132
					'cancel'   => __( 'Cancel', 'gravityview' ),
1133
					'submit'   => __( 'Update', 'gravityview' ),
1134
					'next'     => __( 'Next', 'gravityview' ),
1135
					'previous' => __( 'Previous', 'gravityview' ),
1136
				);
1137
1138
				/**
1139
				* @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
1140
				* @since 1.16.3
1141
				* @param array $labels Default button labels associative array
1142
				* @param array $form The Gravity Forms form
1143
				* @param array $entry The Gravity Forms entry
1144
				* @param int $view_id The current View ID
1145
				*/
1146
				$labels = apply_filters( 'gravityview/edit_entry/button_labels', $labels, $this->form, $this->entry, $this->view_id );
1147
1148
				$this->is_paged_submitted = \GV\Utils::_POST( 'save' ) === $labels['submit'];
1149
			}
1150
1151 21
			$back_link = remove_query_arg( array( 'page', 'view', 'edit' ) );
1152
1153 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...
1154
1155
				// Keeping this compatible with Gravity Forms.
1156
				$validation_message = "<div class='validation_error'>" . __('There was a problem with your submission.', 'gravityview') . " " . __('Errors have been highlighted below.', 'gravityview') . "</div>";
1157
				$message = apply_filters("gform_validation_message_{$this->form['id']}", apply_filters("gform_validation_message", $validation_message, $this->form), $this->form);
1158
1159
				echo GVCommon::generate_notice( $message , 'gv-error' );
1160
1161 21
			} elseif ( false === $this->is_paged_submitted ) {
1162
				// Paged form that hasn't been submitted on the last page yet
1163
				$entry_updated_message = sprintf( esc_attr__( 'Entry Updated.', 'gravityview' ), '<a href="' . esc_url( $back_link ) . '">', '</a>' );
1164
1165
				/**
1166
				 * @filter `gravityview/edit_entry/page/success` Modify the edit entry success message on pages
1167
				 * @since develop
1168
				 * @param string $entry_updated_message Existing message
1169
				 * @param int $view_id View ID
1170
				 * @param array $entry Gravity Forms entry array
1171
				 */
1172
				$message = apply_filters( 'gravityview/edit_entry/page/success', $entry_updated_message , $this->view_id, $this->entry );
1173
1174
				echo GVCommon::generate_notice( $message );
1175
			} else {
1176 21
				$view = \GV\View::by_id( $this->view_id );
1177 21
				$edit_redirect = $view->settings->get( 'edit_redirect' );
1178 21
				$edit_redirect_url = $view->settings->get( 'edit_redirect_url' );
1179
1180
				switch ( $edit_redirect ) {
1181
1182 21
                    case '0':
1183 1
	                    $redirect_url = $back_link;
1184 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>' );
1185 1
                        break;
1186
1187 20
                    case '1':
1188 1
	                    $redirect_url = $directory_link = GravityView_API::directory_link();
1189 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...
1190 1
	                    break;
1191
1192 19
                    case '2':
1193 1
	                    $redirect_url = $edit_redirect_url;
1194 1
	                    $redirect_url = GFCommon::replace_variables( $redirect_url, $this->form, $this->entry, false, false, false, 'text' );
1195 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>' );
1196 1
                        break;
1197
1198 18
                    case '':
1199
                    default:
1200 18
					    $entry_updated_message = sprintf( esc_attr__('Entry Updated. %sReturn to Entry%s', 'gravityview'), '<a href="'. esc_url( $back_link ) .'">', '</a>' );
1201 18
                        break;
1202
				}
1203
1204 21
				if ( isset( $redirect_url ) ) {
1205 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 ) );
1206
				}
1207
1208
				/**
1209
				 * @filter `gravityview/edit_entry/success` Modify the edit entry success message (including the anchor link)
1210
				 * @since 1.5.4
1211
				 * @param string $entry_updated_message Existing message
1212
				 * @param int $view_id View ID
1213
				 * @param array $entry Gravity Forms entry array
1214
				 * @param string $back_link URL to return to the original entry. @since 1.6
1215
				 */
1216 21
				$message = apply_filters( 'gravityview/edit_entry/success', $entry_updated_message , $this->view_id, $this->entry, $back_link );
1217
1218 21
				echo GVCommon::generate_notice( $message );
1219
			}
1220
1221
		}
1222 22
	}
1223
1224
	/**
1225
	 * Display the Edit Entry form in the original Gravity Forms format
1226
	 *
1227
	 * @since 1.9
1228
	 *
1229
	 * @return void
1230
	 */
1231 22
	private function render_edit_form() {
1232
1233
		/**
1234
		 * @action `gravityview/edit-entry/render/before` Before rendering the Edit Entry form
1235
		 * @since 1.17
1236
		 * @param GravityView_Edit_Entry_Render $this
1237
		 */
1238 22
		do_action( 'gravityview/edit-entry/render/before', $this );
1239
1240 22
		add_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields'), 5000, 3 );
1241 22
		add_filter( 'gform_submit_button', array( $this, 'render_form_buttons') );
1242 22
		add_filter( 'gform_next_button', array( $this, 'render_form_buttons' ) );
1243 22
		add_filter( 'gform_previous_button', array( $this, 'render_form_buttons' ) );
1244 22
		add_filter( 'gform_disable_view_counter', '__return_true' );
1245
1246 22
		add_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5, 5 );
1247 22
		add_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10, 5 );
1248
1249
		// We need to remove the fake $_GET['page'] arg to avoid rendering form as if in admin.
1250 22
		unset( $_GET['page'] );
1251
1252 22
		$this->show_next_button = false;
1253 22
		$this->show_previous_button = false;
1254
1255
		// TODO: Verify multiple-page forms
1256 22
		if ( GFCommon::has_pages( $this->form ) && apply_filters( 'gravityview/features/paged-edit', false ) ) {
1257
			if ( intval( $page_number = \GV\Utils::_POST( 'gform_source_page_number_' . $this->form['id'], 0 ) ) ) {
1258
1259
				$labels = array(
1260
					'cancel'   => __( 'Cancel', 'gravityview' ),
1261
					'submit'   => __( 'Update', 'gravityview' ),
1262
					'next'     => __( 'Next', 'gravityview' ),
1263
					'previous' => __( 'Previous', 'gravityview' ),
1264
				);
1265
1266
				/**
1267
				* @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
1268
				* @since 1.16.3
1269
				* @param array $labels Default button labels associative array
1270
				* @param array $form The Gravity Forms form
1271
				* @param array $entry The Gravity Forms entry
1272
				* @param int $view_id The current View ID
1273
				*/
1274
				$labels = apply_filters( 'gravityview/edit_entry/button_labels', $labels, $this->form, $this->entry, $this->view_id );
1275
1276
				GFFormDisplay::$submission[ $this->form['id'] ][ 'form' ] = $this->form;
1277
				GFFormDisplay::$submission[ $this->form['id'] ][ 'is_valid' ] = true;
1278
1279
				if ( \GV\Utils::_POST( 'save' ) === $labels['next'] ) {
1280
					$last_page = \GFFormDisplay::get_max_page_number( $this->form );
1281
1282
					while ( ++$page_number < $last_page && RGFormsModel::is_page_hidden( $this->form, $page_number, \GV\Utils::_POST( 'gform_field_values' ) ) ) {
1283
					} // Advance to next visible page
1284
				} elseif ( \GV\Utils::_POST( 'save' ) === $labels['previous'] ) {
1285
					while ( --$page_number > 1 && RGFormsModel::is_page_hidden( $this->form, $page_number, \GV\Utils::_POST( 'gform_field_values' ) ) ) {
1286
					} // Advance to next visible page
1287
				}
1288
1289
				GFFormDisplay::$submission[ $this->form['id'] ]['page_number'] = $page_number;
1290
			}
1291
1292
			if ( ( $page_number = intval( $page_number ) ) < 2 ) {
1293
				$this->show_next_button = true; // First page
1294
			}
1295
1296
			$last_page = \GFFormDisplay::get_max_page_number( $this->form );
1297
1298
			$has_more_pages = $page_number < $last_page;
1299
1300
			if ( $has_more_pages ) {
1301
				$this->show_next_button = true; // Not the last page
1302
			} else {
1303
				$this->show_update_button = true; // The last page
1304
			}
1305
1306
			if ( $page_number > 1 ) {
1307
				$this->show_previous_button = true; // Not the first page
1308
			}
1309
		} else {
1310 22
			$this->show_update_button = true;
1311
		}
1312
1313 22
		ob_start(); // Prevent PHP warnings possibly caused by prefilling list fields for conditional logic
1314
1315 22
		$html = GFFormDisplay::get_form( $this->form['id'], false, false, true, $this->entry );
1316
1317 22
		ob_get_clean();
1318
1319 22
	    remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
1320 22
		remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
1321 22
		remove_filter( 'gform_next_button', array( $this, 'render_form_buttons' ) );
1322 22
		remove_filter( 'gform_previous_button', array( $this, 'render_form_buttons' ) );
1323 22
		remove_filter( 'gform_disable_view_counter', '__return_true' );
1324 22
		remove_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5 );
1325 22
		remove_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10 );
1326
1327 22
		echo $html;
1328
1329
		/**
1330
		 * @action `gravityview/edit-entry/render/after` After rendering the Edit Entry form
1331
		 * @since 1.17
1332
		 * @param GravityView_Edit_Entry_Render $this
1333
		 */
1334 22
		do_action( 'gravityview/edit-entry/render/after', $this );
1335 22
	}
1336
1337
	/**
1338
	 * Display the Update/Cancel/Delete buttons for the Edit Entry form
1339
	 * @since 1.8
1340
	 * @return string
1341
	 */
1342 22
	public function render_form_buttons() {
1343 22
		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...
1344
	}
1345
1346
1347
	/**
1348
	 * Modify the form fields that are shown when using GFFormDisplay::get_form()
1349
	 *
1350
	 * By default, all fields will be shown. We only want the Edit Tab configured fields to be shown.
1351
	 *
1352
	 * @param array $form
1353
	 * @param boolean $ajax Whether in AJAX mode
1354
	 * @param array|string $field_values Passed parameters to the form
1355
	 *
1356
	 * @since 1.9
1357
	 *
1358
	 * @return array Modified form array
1359
	 */
1360 22
	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...
1361
1362 22
		if( $form['id'] != $this->form_id ) {
1363
			return $form;
1364
		}
1365
1366
		// In case we have validated the form, use it to inject the validation results into the form render
1367 22
		if( isset( $this->form_after_validation ) && $this->form_after_validation['id'] === $form['id'] ) {
1368 21
			$form = $this->form_after_validation;
1369
		} else {
1370 4
			$form['fields'] = $this->get_configured_edit_fields( $form, $this->view_id );
1371
		}
1372
1373 22
		$form = $this->filter_conditional_logic( $form );
1374
1375 22
		$form = $this->prefill_conditional_logic( $form );
1376
1377
		// for now we don't support Save and Continue feature.
1378 22
		if( ! self::$supports_save_and_continue ) {
1379 22
	        unset( $form['save'] );
1380
		}
1381
1382 22
		$form = $this->unselect_default_values( $form );
1383
1384 22
		return $form;
1385
	}
1386
1387
	/**
1388
	 * 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.
1389
	 *
1390
	 * @since 1.16.2.2
1391
	 *
1392
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1393
	 * @param GF_Field $field
1394
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1395
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1396
	 * @param int $form_id Form ID
1397
	 *
1398
	 * @return string If error, the error message. If no error, blank string (modify_edit_field_input() runs next)
1399
	 */
1400 22
	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...
1401
1402 22
		if( ! GFCommon::is_post_field( $field ) ) {
1403 22
			return $field_content;
1404
		}
1405
1406 2
        $message = null;
1407
1408
        // First, make sure they have the capability to edit the post.
1409 2
        if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
1410
1411
            /**
1412
             * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
1413
             * @param string $message The existing "You don't have permission..." text
1414
             */
1415 1
            $message = apply_filters('gravityview/edit_entry/unsupported_post_field_text', __('You don&rsquo;t have permission to edit this post.', 'gravityview') );
1416
1417 1
        } elseif( null === get_post( $this->entry['post_id'] ) ) {
1418
            /**
1419
             * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
1420
             * @param string $message The existing "This field is not editable; the post no longer exists." text
1421
             */
1422
            $message = apply_filters('gravityview/edit_entry/no_post_text', __('This field is not editable; the post no longer exists.', 'gravityview' ) );
1423
        }
1424
1425 2
        if( $message ) {
1426 1
            $field_content = sprintf('<div class="ginput_container ginput_container_' . $field->type . '">%s</div>', wpautop( $message ) );
1427
        }
1428
1429 2
        return $field_content;
1430
	}
1431
1432
	/**
1433
	 *
1434
	 * Fill-in the saved values into the form inputs
1435
	 *
1436
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1437
	 * @param GF_Field $field
1438
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1439
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1440
	 * @param int $form_id Form ID
1441
	 *
1442
	 * @return mixed
1443
	 */
1444 22
	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...
1445
1446 22
		$gv_field = GravityView_Fields::get_associated_field( $field );
1447
1448
		// If the form has been submitted, then we don't need to pre-fill the values,
1449
		// Except for fileupload type and when a field input is overridden- run always!!
1450
		if(
1451 22
			( $this->is_edit_entry_submission() && !in_array( $field->type, array( 'fileupload', 'post_image' ) ) )
1452 22
			&& false === ( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) )
1453
			&& ! GFCommon::is_product_field( $field->type )
1454 22
			|| ! empty( $field_content )
1455 22
			|| in_array( $field->type, array( 'honeypot' ) )
1456
		) {
1457 1
	        return $field_content;
1458
		}
1459
1460
		// SET SOME FIELD DEFAULTS TO PREVENT ISSUES
1461 22
		$field->adminOnly = false; /** @see GFFormDisplay::get_counter_init_script() need to prevent adminOnly */
1462
1463 22
		$field_value = $this->get_field_value( $field );
1464
1465
	    // Prevent any PHP warnings, like undefined index
1466 22
	    ob_start();
1467
1468 22
	    $return = null;
1469
1470
		/** @var GravityView_Field $gv_field */
1471 22
		if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
1472 3
			$return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
1473
		} else {
1474 22
	        $return = $field->get_field_input( $this->form, $field_value, $this->entry );
1475
	    }
1476
1477
	    // If there was output, it's an error
1478 22
	    $warnings = ob_get_clean();
1479
1480 22
	    if( !empty( $warnings ) ) {
1481
		    gravityview()->log->error( '{warning}', array( 'warning' => $warnings, 'data' => $field_value ) );
1482
	    }
1483
1484 22
		return $return;
1485
	}
1486
1487
	/**
1488
	 * Modify the value for the current field input
1489
	 *
1490
	 * @param GF_Field $field
1491
	 *
1492
	 * @return array|mixed|string
1493
	 */
1494 22
	private function get_field_value( $field ) {
1495
1496
		/**
1497
		 * @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.
1498
		 * @param boolean True: override saved values; False: don't override (default)
1499
		 * @param $field GF_Field object Gravity Forms field object
1500
		 * @since 1.13
1501
		 */
1502 22
		$override_saved_value = apply_filters( 'gravityview/edit_entry/pre_populate/override', false, $field );
1503
1504
		// We're dealing with multiple inputs (e.g. checkbox) but not time or date (as it doesn't store data in input IDs)
1505 22
		if( isset( $field->inputs ) && is_array( $field->inputs ) && !in_array( $field->type, array( 'time', 'date' ) ) ) {
1506
1507 4
			$field_value = array();
1508
1509
			// only accept pre-populated values if the field doesn't have any choice selected.
1510 4
			$allow_pre_populated = $field->allowsPrepopulate;
1511
1512 4
			foreach ( (array)$field->inputs as $input ) {
1513
1514 4
				$input_id = strval( $input['id'] );
1515
1516 4
				if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
1517 4
				    $field_value[ $input_id ] =  'post_category' === $field->type ? GFCommon::format_post_category( $this->entry[ $input_id ], true ) : $this->entry[ $input_id ];
1518 4
				    $allow_pre_populated = false;
1519
				}
1520
1521
			}
1522
1523 4
			$pre_value = $field->get_value_submission( array(), false );
1524
1525 4
			$field_value = ! $allow_pre_populated && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $field_value : $pre_value;
1526
1527
		} else {
1528
1529 22
			$id = intval( $field->id );
1530
1531
			// get pre-populated value if exists
1532 22
			$pre_value = $field->allowsPrepopulate ? GFFormsModel::get_parameter_value( $field->inputName, array(), $field ) : '';
1533
1534
			// saved field entry value (if empty, fallback to the pre-populated value, if exists)
1535
			// or pre-populated value if not empty and set to override saved value
1536 22
			$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;
1537
1538
			// in case field is post_category but inputType is select, multi-select or radio, convert value into array of category IDs.
1539 22
			if ( 'post_category' === $field->type && !gv_empty( $field_value, false, false ) ) {
1540
				$categories = array();
1541
				foreach ( explode( ',', $field_value ) as $cat_string ) {
1542
				    $categories[] = GFCommon::format_post_category( $cat_string, true );
1543
				}
1544
				$field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
1545
			}
1546
1547
		}
1548
1549
		// if value is empty get the default value if defined
1550 22
		$field_value = $field->get_value_default_if_empty( $field_value );
1551
1552
	    /**
1553
	     * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
1554
	     * @since 1.11
1555
	     * @since 1.20 Added third param
1556
	     * @param mixed $field_value field value used to populate the input
1557
	     * @param object $field Gravity Forms field object ( Class GF_Field )
1558
	     * @param GravityView_Edit_Entry_Render $this Current object
1559
	     */
1560 22
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
1561
1562
	    /**
1563
	     * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
1564
	     * @since 1.17
1565
	     * @since 1.20 Added third param
1566
	     * @param mixed $field_value field value used to populate the input
1567
	     * @param GF_Field $field Gravity Forms field object
1568
	     * @param GravityView_Edit_Entry_Render $this Current object
1569
	     */
1570 22
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
1571
1572 22
		return $field_value;
1573
	}
1574
1575
1576
	// ---- Entry validation
1577
1578
	/**
1579
	 * Add field keys that Gravity Forms expects.
1580
	 *
1581
	 * @see GFFormDisplay::validate()
1582
	 * @param  array $form GF Form
1583
	 * @return array       Modified GF Form
1584
	 */
1585 21
	public function gform_pre_validation( $form ) {
1586
1587 21
		if( ! $this->verify_nonce() ) {
1588
			return $form;
1589
		}
1590
1591
		// Fix PHP warning regarding undefined index.
1592 21
		foreach ( $form['fields'] as &$field) {
1593
1594
			// This is because we're doing admin form pretending to be front-end, so Gravity Forms
1595
			// expects certain field array items to be set.
1596 21
			foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
1597 21
	            $field->{$key} = isset( $field->{$key} ) ? $field->{$key} : NULL;
1598
			}
1599
1600 21
			switch( RGFormsModel::get_input_type( $field ) ) {
1601
1602
				/**
1603
				 * 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.
1604
				 *
1605
				 * 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.
1606
				 *
1607
				 * @hack
1608
				 */
1609 21
				case 'fileupload':
1610
1611
				    // Set the previous value
1612 1
				    $entry = $this->get_entry();
1613
1614 1
				    $input_name = 'input_'.$field->id;
1615 1
				    $form_id = $form['id'];
1616
1617 1
				    $value = NULL;
1618
1619
				    // Use the previous entry value as the default.
1620 1
				    if( isset( $entry[ $field->id ] ) ) {
1621 1
				        $value = $entry[ $field->id ];
1622
				    }
1623
1624
				    // If this is a single upload file
1625 1
				    if( !empty( $_FILES[ $input_name ] ) && !empty( $_FILES[ $input_name ]['name'] ) ) {
1626 1
				        $file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
1627 1
				        $value = $file_path['url'];
1628
1629
				    } else {
1630
1631
				        // Fix PHP warning on line 1498 of form_display.php for post_image fields
1632
				        // Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
1633 1
				        $_FILES[ $input_name ] = array('name' => '', 'size' => '' );
1634
1635
				    }
1636
1637 1
				    if ( \GV\Utils::get( $field, "multipleFiles" ) ) {
1638
1639
				        // If there are fresh uploads, process and merge them.
1640
				        // Otherwise, use the passed values, which should be json-encoded array of URLs
1641 1
				        if( isset( GFFormsModel::$uploaded_files[$form_id][$input_name] ) ) {
1642
				            $value = empty( $value ) ? '[]' : $value;
1643
				            $value = stripslashes_deep( $value );
1644 1
				            $value = GFFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'], array());
1645
				        }
1646
1647
				    } else {
1648
1649
				        // A file already exists when editing an entry
1650
				        // We set this to solve issue when file upload fields are required.
1651 1
				        GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
1652
1653
				    }
1654
1655 1
				    $this->entry[ $input_name ] = $value;
1656 1
				    $_POST[ $input_name ] = $value;
1657
1658 1
				    break;
1659
1660 21
				case 'number':
1661
				    // Fix "undefined index" issue at line 1286 in form_display.php
1662 12
				    if( !isset( $_POST['input_'.$field->id ] ) ) {
1663 7
				        $_POST['input_'.$field->id ] = NULL;
1664
				    }
1665 12
				    break;
1666
			}
1667
1668
		}
1669
1670 21
		return $form;
1671
	}
1672
1673
1674
	/**
1675
	 * Process validation for a edit entry submission
1676
	 *
1677
	 * Sets the `is_valid` object var
1678
	 *
1679
	 * @return void
1680
	 */
1681 22
	private function validate() {
1682
1683
		/**
1684
		 * If using GF User Registration Add-on, remove the validation step, otherwise generates error when updating the entry
1685
		 * GF User Registration Add-on version > 3.x has a different class name
1686
		 * @since 1.16.2
1687
		 */
1688 22
		if ( class_exists( 'GF_User_Registration' ) ) {
1689 22
			remove_filter( 'gform_validation', array( GF_User_Registration::get_instance(), 'validate' ) );
1690
		} else  if ( class_exists( 'GFUser' ) ) {
1691
			remove_filter( 'gform_validation', array( 'GFUser', 'user_registration_validation' ) );
1692
		}
1693
1694
1695
		/**
1696
		 * For some crazy reason, Gravity Forms doesn't validate Edit Entry form submissions.
1697
		 * You can enter whatever you want!
1698
		 * We try validating, and customize the results using `self::custom_validation()`
1699
		 */
1700 22
		add_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10, 4);
1701
1702
		// Needed by the validate funtion
1703 22
		$failed_validation_page = NULL;
1704 22
		$field_values = RGForms::post( 'gform_field_values' );
1705
1706
		// Prevent entry limit from running when editing an entry, also
1707
		// prevent form scheduling from preventing editing
1708 22
		unset( $this->form['limitEntries'], $this->form['scheduleForm'] );
1709
1710
		// Hide fields depending on Edit Entry settings
1711 22
		$this->form['fields'] = $this->get_configured_edit_fields( $this->form, $this->view_id );
1712
1713 22
		$this->is_valid = GFFormDisplay::validate( $this->form, $field_values, 1, $failed_validation_page );
1714
1715 22
		remove_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10 );
1716 22
	}
1717
1718
1719
	/**
1720
	 * Make validation work for Edit Entry
1721
	 *
1722
	 * Because we're calling the GFFormDisplay::validate() in an unusual way (as a front-end
1723
	 * form pretending to be a back-end form), validate() doesn't know we _can't_ edit post
1724
	 * fields. This goes through all the fields and if they're an invalid post field, we
1725
	 * set them as valid. If there are still issues, we'll return false.
1726
	 *
1727
	 * @param  $validation_results {
1728
	 *   @type bool $is_valid
1729
	 *   @type array $form
1730
	 *   @type int $failed_validation_page The page number which has failed validation.
1731
	 * }
1732
	 *
1733
	 * @return array
1734
	 */
1735 22
	public function custom_validation( $validation_results ) {
1736
1737 22
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results: ', array( 'data' => $validation_results ) );
1738
1739 22
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] $_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
1740
1741 22
		$gv_valid = true;
1742
1743 22
		foreach ( $validation_results['form']['fields'] as $key => &$field ) {
1744
			$value             = RGFormsModel::get_field_value( $field );
1745 22
			$field_type        = RGFormsModel::get_input_type( $field );
1746 22
			$is_required       = ! empty( $field->isRequired );
1747
			$failed_validation = ! empty( $field->failed_validation );
1748
1749 22
			// Manually validate required fields as they can be skipped be skipped by GF's validation
1750
			// This can happen when the field is considered "hidden" (see `GFFormDisplay::validate`) due to unmet conditional logic
1751
			if ( $is_required && !$failed_validation && empty( $value ) ) {
1752 22
				$field->failed_validation  = true;
1753 22
				$field->validation_message = esc_html__( 'This field is required.', 'gravityview' );
1754
1755
				continue;
1756 2
			}
1757
1758
			switch ( $field_type ) {
1759
				case 'fileupload':
1760
				case 'post_image':
1761
					// Clear "this field is required" validation result when no files were uploaded but already exist on the server
1762 2
					if ( $is_required && $failed_validation && ! empty( $value ) ) {
1763
						$field->failed_validation = false;
1764
1765
						unset( $field->validation_message );
1766
					}
1767
1768
					// Re-validate the field
1769
					$field->validate( $field, $this->form );
1770
1771
					// Validate if multi-file upload reached max number of files [maxFiles] => 2
1772
					if ( \GV\Utils::get( $field, 'maxFiles' ) && \GV\Utils::get( $field, 'multipleFiles' ) ) {
1773
						$input_name = 'input_' . $field->id;
1774
						//uploaded
1775
						$file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
1776
1777
						//existent
1778
						$entry = $this->get_entry();
1779
						$value = null;
1780
						if ( isset( $entry[ $field->id ] ) ) {
1781
							$value = json_decode( $entry[ $field->id ], true );
1782
						}
1783
1784
						// count uploaded files and existent entry files
1785
						$count_files = ( is_array( $file_names ) ? count( $file_names ) : 0 ) +
1786
						               ( is_array( $value ) ? count( $value ) : 0 );
1787
1788
						if ( $count_files > $field->maxFiles ) {
1789
							$field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
1790
							$field->failed_validation  = true;
1791 2
							$gv_valid                  = false;
1792
1793
							// in case of error make sure the newest upload files are removed from the upload input
1794
							GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
1795
						}
1796 22
					}
1797
1798 1
					break;
1799
			}
1800 1
1801
			// This field has failed validation.
1802
			if( !empty( $field->failed_validation ) ) {
1803 1
1804
				gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field is invalid.', array( 'data' => array( 'field' => $field, 'value' => $value ) ) );
1805
1806 1
				switch ( $field_type ) {
1807
1808
				    // Captchas don't need to be re-entered.
1809
				    case 'captcha':
1810
1811
				        // Post Image fields aren't editable, so we un-fail them.
1812
				    case 'post_image':
1813
				        $field->failed_validation = false;
1814 1
				        unset( $field->validation_message );
1815
				        break;
1816
1817
				}
1818
1819
				// You can't continue inside a switch, so we do it after.
1820 1
				if( empty( $field->failed_validation ) ) {
1821
				    continue;
1822
				}
1823
1824
				// checks if the No Duplicates option is not validating entry against itself, since
1825
				// we're editing a stored entry, it would also assume it's a duplicate.
1826
				if( !empty( $field->noDuplicates ) ) {
1827
1828
				    $entry = $this->get_entry();
1829
1830
				    // If the value of the entry is the same as the stored value
1831
				    // Then we can assume it's not a duplicate, it's the same.
1832
				    if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
1833
				        //if value submitted was not changed, then don't validate
1834
				        $field->failed_validation = false;
1835
1836
				        unset( $field->validation_message );
1837
1838
				        gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', array( 'data' => $entry ) );
1839 1
1840
				        continue;
1841
				    }
1842
				}
1843
1844
				// if here then probably we are facing the validation 'At least one field must be filled out'
1845 1
				if( GFFormDisplay::is_empty( $field, $this->form_id  ) && empty( $field->isRequired ) ) {
1846
				    unset( $field->validation_message );
1847
					$field->failed_validation = false;
1848
				    continue;
1849
				}
1850
1851 22
				$gv_valid = false;
1852
1853 22
			}
1854
1855
		}
1856 22
1857
		$validation_results['is_valid'] = $gv_valid;
1858 22
1859
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results.', array( 'data' => $validation_results ) );
1860
1861
		// We'll need this result when rendering the form ( on GFFormDisplay::get_form )
1862
		$this->form_after_validation = $validation_results['form'];
1863
1864
		return $validation_results;
1865
	}
1866
1867 2
1868
	/**
1869 2
	 * TODO: This seems to be hacky... we should remove it. Entry is set when updating the form using setup_vars()!
1870
	 * Get the current entry and set it if it's not yet set.
1871 1
	 * @return array Gravity Forms entry array
1872
	 */
1873
	public function get_entry() {
1874 2
1875
		if( empty( $this->entry ) ) {
1876
			// Get the database value of the entry that's being edited
1877
			$this->entry = gravityview_get_entry( GravityView_frontend::is_single_entry() );
1878
		}
1879
1880
		return $this->entry;
1881
	}
1882
1883
1884
1885
	// --- Filters
1886
1887
	/**
1888
	 * Get the Edit Entry fields as configured in the View
1889
	 *
1890 23
	 * @since 1.8
1891
	 *
1892
	 * @param int $view_id
1893 23
	 *
1894 23
	 * @return array Array of fields that are configured in the Edit tab in the Admin
1895 23
	 */
1896
	private function get_configured_edit_fields( $form, $view_id ) {
1897
1898
		// Get all fields for form
1899
		if ( \GV\View::exists( $view_id ) ) {
1900
			$view = \GV\View::by_id( $view_id );
1901 23
			$properties = $view->fields ? $view->fields->as_configuration() : array();
1902
		} else {
1903
			$properties = null;
1904 23
		}
1905
1906
		// If edit tab not yet configured, show all fields
1907 23
		$edit_fields = !empty( $properties['edit_edit-fields'] ) ? $properties['edit_edit-fields'] : NULL;
1908
1909
		// Hide fields depending on admin settings
1910
		$fields = $this->filter_fields( $form['fields'], $edit_fields );
1911
1912
	    // If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
1913
	    $fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
1914
1915
		/**
1916
		 * @filter `gravityview/edit_entry/form_fields` Modify the fields displayed in Edit Entry form
1917 23
		 * @since 1.17
1918
		 * @param GF_Field[] $fields Gravity Forms form fields
1919 23
		 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1920
		 * @param array $form GF Form array (`fields` key modified to have only fields configured to show in Edit Entry)
1921
		 * @param int $view_id View ID
1922
		 */
1923
		$fields = apply_filters( 'gravityview/edit_entry/form_fields', $fields, $edit_fields, $form, $view_id );
1924
1925
		return $fields;
1926
	}
1927
1928
1929
	/**
1930
	 * Filter area fields based on specified conditions
1931
	 *  - This filter removes the fields that have calculation configured
1932
	 *  - Hides fields that are hidden, etc.
1933
	 *
1934
	 * @uses GravityView_Edit_Entry::user_can_edit_field() Check caps
1935 22
	 * @access private
1936
	 * @param GF_Field[] $fields
1937 22
	 * @param array $configured_fields
1938
	 * @since  1.5
1939
	 * @return array $fields
1940
	 */
1941 22
	private function filter_fields( $fields, $configured_fields ) {
1942
1943 22
		if( empty( $fields ) || !is_array( $fields ) ) {
1944
			return $fields;
1945 22
		}
1946
1947
		$edit_fields = array();
1948
1949
		$field_type_blacklist = $this->loader->get_field_blacklist( $this->entry );
1950 22
1951
		if ( empty( $configured_fields ) && apply_filters( 'gravityview/features/paged-edit', false ) ) {
1952
			$field_type_blacklist = array_diff( $field_type_blacklist, array( 'page' ) );
1953
		}
1954 22
1955 5
		// First, remove blacklist or calculation fields
1956
		foreach ( $fields as $key => $field ) {
1957
1958
			// Remove the fields that have calculation properties and keep them to be used later
1959 22
			// @since 1.16.2
1960 3
			if( $field->has_calculation() ) {
1961
				$this->fields_with_calculation[] = $field;
1962
				// don't remove the calculation fields on form render.
1963
			}
1964
1965
			if( in_array( $field->type, $field_type_blacklist ) ) {
1966 22
				unset( $fields[ $key ] );
1967
			}
1968 17
		}
1969
1970 17
		// The Edit tab has not been configured, so we return all fields by default.
1971
		// But we do keep the hidden ones hidden please, for everyone :)
1972
		if ( empty( $configured_fields ) ) {
1973
1974
			$out_fields = array();
1975
1976
			foreach ( $fields as &$field ) {
1977
1978
				/**
1979 17
				 * @filter `gravityview/edit_entry/render_hidden_field`
1980
				 * @see https://docs.gravityview.co/article/678-edit-entry-hidden-fields-field-visibility
1981 17
				 * @since 2.7
1982 2
				 * @param[in,out] bool $render_hidden_field Whether to render this Hidden field in HTML. Default: true
1983
				 * @param GF_Field $field The field to possibly remove
1984
				 */
1985 17
				$render_hidden_field = apply_filters( 'gravityview/edit_entry/render_hidden_field', true, $field );
1986 2
1987
				if ( 'hidden' === $field->type && ! $render_hidden_field ) {
1988
					continue; // Don't include hidden fields in the output
1989 16
				}
1990
1991
				if ( 'hidden' == $field->visibility ) {
1992 17
					continue; // Never include when no fields are configured
1993
				}
1994
1995
				$out_fields[] = $field;
1996 8
			}
1997
1998
			return array_values( $out_fields );
1999 8
		}
2000 8
2001 8
		// The edit tab has been configured, so we loop through to configured settings
2002 8
		foreach ( $configured_fields as $configured_field ) {
2003
2004
	        /** @var GF_Field $field */
2005
	        foreach ( $fields as $field ) {
2006
				if( intval( $configured_field['id'] ) === intval( $field->id ) && $this->user_can_edit_field( $configured_field, false ) ) {
2007
				    $edit_fields[] = $this->merge_field_properties( $field, $configured_field );
2008
				    break;
2009 8
				}
2010
2011
			}
2012
2013
		}
2014
2015
		return $edit_fields;
2016
2017
	}
2018
2019
	/**
2020 8
	 * Override GF Form field properties with the ones defined on the View
2021
	 * @param  GF_Field $field GF Form field object
2022 8
	 * @param  array $field_setting  GV field options
2023
	 * @since  1.5
2024 8
	 * @return array|GF_Field
2025
	 */
2026 8
	private function merge_field_properties( $field, $field_setting ) {
2027
2028
		$return_field = $field;
2029
2030 8
		if( empty( $field_setting['show_label'] ) ) {
2031
			$return_field->label = '';
2032
		} elseif ( !empty( $field_setting['custom_label'] ) ) {
2033
			$return_field->label = $field_setting['custom_label'];
2034
		}
2035
2036
		if( !empty( $field_setting['custom_class'] ) ) {
2037
			$return_field->cssClass .= ' '. gravityview_sanitize_html_class( $field_setting['custom_class'] );
2038 8
		}
2039
2040 8
		/**
2041
		 * Normalize page numbers - avoid conflicts with page validation
2042
		 * @since 1.6
2043
		 */
2044
		$return_field->pageNumber = 1;
2045
2046
		return $return_field;
2047
2048
	}
2049
2050
	/**
2051
	 * Remove fields that shouldn't be visible based on the Gravity Forms adminOnly field property
2052
	 *
2053
	 * @since 1.9.1
2054
	 *
2055
	 * @param array|GF_Field[] $fields Gravity Forms form fields
2056 22
	 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
2057
	 * @param array $form GF Form array
2058
	 * @param int $view_id View ID
2059
	 *
2060
	 * @return array Possibly modified form array
2061
	 */
2062
	private function filter_admin_only_fields( $fields = array(), $edit_fields = null, $form = array(), $view_id = 0 ) {
2063
2064
	    /**
2065
		 * @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
2066
	     * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
2067 22
	     * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
2068
	     * @since 1.9.1
2069 22
	     * @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.
2070 1
	     * @param array $form GF Form array
2071
	     * @param int $view_id View ID
2072
	     */
2073
	    $use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
2074
2075 1
	    if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
2076
			foreach( $fields as $k => $field ) {
2077
				if( $field->adminOnly ) {
2078 22
				    unset( $fields[ $k ] );
2079 22
				}
2080
			}
2081
			return array_values( $fields );
2082 22
		}
2083
2084
	    foreach( $fields as &$field ) {
2085
		    $field->adminOnly = false;
2086
		}
2087
2088
		return $fields;
2089
	}
2090
2091
	/**
2092
	 * Checkboxes and other checkbox-based controls should not
2093
	 * display default checks in edit mode.
2094
	 *
2095
	 * https://github.com/gravityview/GravityView/1149
2096
	 *
2097 22
	 * @since 2.1
2098
	 *
2099 22
	 * @param array $form Gravity Forms array object
2100
	 *
2101 22
	 * @return array $form, modified to default checkboxes, radios from showing up.
2102 19
	 */
2103
	private function unselect_default_values( $form ) {
2104
2105 6
	    foreach ( $form['fields'] as &$field ) {
2106 6
2107 2
			if ( empty( $field->choices ) ) {
2108
                continue;
2109
			}
2110
2111
            foreach ( $field->choices as &$choice ) {
2112 22
				if ( \GV\Utils::get( $choice, 'isSelected' ) ) {
2113
					$choice['isSelected'] = false;
2114
				}
2115
			}
2116
		}
2117
2118
		return $form;
2119
	}
2120
2121
	// --- Conditional Logic
2122
2123
	/**
2124
	 * Conditional logic isn't designed to work with forms that already have content. When switching input values,
2125
	 * the dependent fields will be blank.
2126
	 *
2127
	 * Note: This is because GF populates a JavaScript variable with the input values. This is tough to filter at the input level;
2128
	 * via the `gform_field_value` filter; it requires lots of legwork. Doing it at the form level is easier.
2129
	 *
2130 22
	 * @since 1.17.4
2131
	 *
2132 22
	 * @param array $form Gravity Forms array object
2133 19
	 *
2134
	 * @return array $form, modified to fix conditional
2135
	 */
2136
	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...
2137
2138 3
		if( ! GFFormDisplay::has_conditional_logic( $form ) ) {
2139
			return $form;
2140 3
		}
2141
2142
		// Have Conditional Logic pre-fill fields as if the data were default values
2143
		/** @var GF_Field $field */
2144
		foreach ( $form['fields'] as &$field ) {
2145
2146
			if( 'checkbox' === $field->type ) {
2147
				foreach ( $field->get_entry_inputs() as $key => $input ) {
2148
				    $input_id = $input['id'];
2149
				    $choice = $field->choices[ $key ];
2150
				    $value = \GV\Utils::get( $this->entry, $input_id );
2151
				    $match = RGFormsModel::choice_value_match( $field, $choice, $value );
2152
				    if( $match ) {
2153 3
				        $field->choices[ $key ]['isSelected'] = true;
2154
				    }
2155 3
				}
2156
			} else {
2157 3
2158
				// We need to run through each field to set the default values
2159
				foreach ( $this->entry as $field_id => $field_value ) {
2160
2161
				    if( floatval( $field_id ) === floatval( $field->id ) ) {
2162
2163
				        if( 'list' === $field->type ) {
2164
				            $list_rows = maybe_unserialize( $field_value );
2165
2166
				            $list_field_value = array();
2167
				            foreach ( (array) $list_rows as $row ) {
2168
				                foreach ( (array) $row as $column ) {
2169 3
				                    $list_field_value[] = $column;
2170
				                }
2171
				            }
2172
2173
				            $field->defaultValue = serialize( $list_field_value );
2174
				        } else {
2175
				            $field->defaultValue = $field_value;
2176 3
				        }
2177
				    }
2178
				}
2179
			}
2180
		}
2181
2182
		return $form;
2183
	}
2184
2185
	/**
2186
	 * Remove the conditional logic rules from the form button and the form fields, if needed.
2187
	 *
2188 22
	 * @todo Merge with caller method
2189
	 * @since 1.9
2190
	 *
2191
	 * @param array $form Gravity Forms form
2192
	 * @return array Modified form, if not using Conditional Logic
2193
	 */
2194
	private function filter_conditional_logic( $form ) {
2195
		/**
2196 22
		 * Fields that are tied to a conditional logic field that is not present in the view
2197 22
		 * have to still be displayed, if the condition is met.
2198 22
		 *
2199 22
		 * @see https://github.com/gravityview/GravityView/issues/840
2200
		 * @since develop
2201 22
		 */
2202 22
		$the_form = GFAPI::get_form( $form['id'] );
2203 22
		$editable_ids = array();
2204 6
		foreach ( $form['fields'] as $field ) {
2205 6
			$editable_ids[] = $field['id']; // wp_list_pluck is destructive in this context
2206
		}
2207
		$remove_conditions_rule = array();
2208
		foreach ( $the_form['fields'] as $field ) {
2209
			if ( ! empty( $field->conditionalLogic ) && ! empty( $field->conditionalLogic['rules'] ) ) {
2210 4
				foreach ( $field->conditionalLogic['rules'] as $i => $rule ) {
2211 4
					if ( ! in_array( $rule['fieldId'], $editable_ids ) ) {
2212
						/**
2213
						 * This conditional field is not editable in this View.
2214
						 * We need to remove the rule, but only if it matches.
2215
						 */
2216
						if ( $_field = GFAPI::get_field( $the_form, $rule['fieldId'] ) ) {
2217
							$value = $_field->get_value_export( $this->entry );
2218 4
						} elseif ( isset( $this->entry[ $rule['fieldId'] ] ) ) {
2219
							$value = $this->entry[ $rule['fieldId'] ];
2220 4
						} else {
2221 4
							$value = gform_get_meta( $this->entry['id'], $rule['fieldId'] );
2222
						}
2223
2224
						$match = GFFormsModel::matches_operation( $value, $rule['value'], $rule['operator'] );
2225
2226
						if ( $match ) {
2227
							$remove_conditions_rule[] = array( $field['id'], $i );
2228 22
						}
2229 4
					}
2230 4
				}
2231
			}
2232 4
		}
2233
2234 4
		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...
2235 1
			foreach ( $form['fields'] as &$field ) {
2236 1
				foreach ( $remove_conditions_rule as $_remove_conditions_r ) {
2237
2238
				    list( $rule_field_id, $rule_i ) = $_remove_conditions_r;
2239
2240
					if ( $field['id'] == $rule_field_id ) {
2241
						unset( $field->conditionalLogic['rules'][ $rule_i ] );
2242
						gravityview()->log->debug( 'Removed conditional rule #{rule} for field {field_id}', array( 'rule' => $rule_i, 'field_id' => $field['id'] ) );
2243 22
					}
2244
				}
2245
			}
2246
		}
2247
2248
		/** Normalize the indices... */
2249
		$form['fields'] = array_values( $form['fields'] );
2250
2251 22
		/**
2252
		 * @filter `gravityview/edit_entry/conditional_logic` Should the Edit Entry form use Gravity Forms conditional logic showing/hiding of fields?
2253 22
		 * @since 1.9
2254 22
		 * @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
2255
		 * @param array $form Gravity Forms form
2256
		 */
2257
		$use_conditional_logic = apply_filters( 'gravityview/edit_entry/conditional_logic', true, $form );
2258
2259
		if( $use_conditional_logic ) {
2260
			return $form;
2261
		}
2262
2263
		foreach( $form['fields'] as &$field ) {
2264
			/* @var GF_Field $field */
2265
			$field->conditionalLogic = null;
2266
		}
2267
2268
		unset( $form['button']['conditionalLogic'] );
2269
2270
		return $form;
2271
2272
	}
2273
2274
	/**
2275
	 * Disable the Gravity Forms conditional logic script and features on the Edit Entry screen
2276
	 *
2277 22
	 * @since 1.9
2278
	 *
2279 22
	 * @param $has_conditional_logic
2280
	 * @param $form
2281
	 * @return mixed
2282
	 */
2283
	public function manage_conditional_logic( $has_conditional_logic, $form ) {
2284 22
2285
		if( ! $this->is_edit_entry() ) {
2286
			return $has_conditional_logic;
2287
		}
2288
2289
	    /** @see GravityView_Edit_Entry_Render::filter_conditional_logic for filter documentation */
2290
		return apply_filters( 'gravityview/edit_entry/conditional_logic', $has_conditional_logic, $form );
2291
	}
2292
2293
2294
	// --- User checks and nonces
2295
2296
	/**
2297
	 * Check if the user can edit the entry
2298
	 *
2299
	 * - Is the nonce valid?
2300
	 * - Does the user have the right caps for the entry
2301
	 * - Is the entry in the trash?
2302 23
	 *
2303
	 * @todo Move to GVCommon
2304 23
	 *
2305
	 * @param  boolean $echo Show error messages in the form?
2306
	 * @return boolean        True: can edit form. False: nope.
2307
	 */
2308
	private function user_can_edit_entry( $echo = false ) {
2309
2310
		$error = NULL;
2311 23
2312
		/**
2313
		 *  1. Permalinks are turned off
2314
		 *  2. There are two entries embedded using oEmbed
2315
		 *  3. One of the entries has just been saved
2316
		 */
2317 23
		if( !empty( $_POST['lid'] ) && !empty( $_GET['entry'] ) && ( $_POST['lid'] !== $_GET['entry'] ) ) {
2318
2319
			$error = true;
2320
2321 23
		}
2322
2323
		if( !empty( $_GET['entry'] ) && (string)$this->entry['id'] !== $_GET['entry'] ) {
2324
2325
			$error = true;
2326
2327
		} elseif( ! $this->verify_nonce() ) {
2328
2329
			/**
2330
			 * If the Entry is embedded, there may be two entries on the same page.
2331
			 * If that's the case, and one is being edited, the other should fail gracefully and not display an error.
2332
			 */
2333
			if( GravityView_oEmbed::getInstance()->get_entry_id() ) {
0 ignored issues
show
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...
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...
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...
2334
				$error = true;
2335 23
			} else {
2336 2
				$error = __( 'The link to edit this entry is not valid; it may have expired.', 'gravityview');
2337
			}
2338
2339 23
		}
2340
2341
		if( ! GravityView_Edit_Entry::check_user_cap_edit_entry( $this->entry ) ) {
2342
			$error = __( 'You do not have permission to edit this entry.', 'gravityview');
2343
		}
2344 23
2345 23
		if( $this->entry['status'] === 'trash' ) {
2346
			$error = __('You cannot edit the entry; it is in the trash.', 'gravityview' );
2347
		}
2348 2
2349
		// No errors; everything's fine here!
2350 2
		if( empty( $error ) ) {
2351
			return true;
2352
		}
2353
2354
		if( $echo && $error !== true ) {
2355 2
2356 2
	        $error = esc_html( $error );
2357
2358
	        /**
2359 2
	         * @since 1.9
2360
	         */
2361
	        if ( ! empty( $this->entry ) ) {
2362 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;" ) );
2363
	        }
2364 2
2365
			echo GVCommon::generate_notice( wpautop( $error ), 'gv-error error');
2366
		}
2367
2368
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2369
2370
		return false;
2371
	}
2372
2373
2374
	/**
2375 8
	 * Check whether a field is editable by the current user, and optionally display an error message
2376
	 * @uses  GravityView_Edit_Entry->check_user_cap_edit_field() Check user capabilities
2377 8
	 * @param  array  $field Field or field settings array
2378
	 * @param  boolean $echo  Whether to show error message telling user they aren't allowed
2379 8
	 * @return boolean         True: user can edit the current field; False: nope, they can't.
2380 1
	 */
2381
	private function user_can_edit_field( $field, $echo = false ) {
2382
2383
		$error = NULL;
2384 8
2385 8
		if( ! $this->check_user_cap_edit_field( $field ) ) {
2386
			$error = __( 'You do not have permission to edit this field.', 'gravityview');
2387
		}
2388 1
2389
		// No errors; everything's fine here!
2390
		if( empty( $error ) ) {
2391
			return true;
2392 1
		}
2393
2394 1
		if( $echo ) {
2395
			echo GVCommon::generate_notice( wpautop( esc_html( $error ) ), 'gv-error error');
2396
		}
2397
2398
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
2399
2400
		return false;
2401
2402
	}
2403
2404
2405
	/**
2406
	 * checks if user has permissions to edit a specific field
2407 8
	 *
2408
	 * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_field for maximum security!!
2409
	 *
2410 8
	 * @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...
2411 7
	 * @return bool
2412
	 */
2413
	private function check_user_cap_edit_field( $field ) {
2414 1
2415
		// If they can edit any entries (as defined in Gravity Forms), we're good.
2416 1
		if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ) ) ) {
2417 1
			return true;
2418
		}
2419
2420
		$field_cap = isset( $field['allow_edit_cap'] ) ? $field['allow_edit_cap'] : false;
2421
2422
		if( $field_cap ) {
2423
			return GVCommon::has_cap( $field['allow_edit_cap'] );
2424
		}
2425
2426
		return false;
2427
	}
2428 22
2429
2430
	/**
2431 22
	 * Is the current nonce valid for editing the entry?
2432
	 * @return boolean
2433
	 */
2434
	public function verify_nonce() {
2435
2436 22
		// Verify form submitted for editing single
2437
		if( $this->is_edit_entry_submission() ) {
2438
			$valid = wp_verify_nonce( $_POST[ self::$nonce_field ], self::$nonce_field );
2439
		}
2440
2441 22
		// Verify
2442
		else if( ! $this->is_edit_entry() ) {
2443
			$valid = false;
2444
		}
2445
2446
		else {
2447
			$valid = wp_verify_nonce( $_GET['edit'], self::$nonce_key );
2448
		}
2449
2450 22
		/**
2451
		 * @filter `gravityview/edit_entry/verify_nonce` Override Edit Entry nonce validation. Return true to declare nonce valid.
2452 22
		 * @since 1.13
2453
		 * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
2454
		 * @param string $nonce_field Key used when validating submissions. Default: is_gv_edit_entry
2455
		 */
2456
		$valid = apply_filters( 'gravityview/edit_entry/verify_nonce', $valid, self::$nonce_field );
2457
2458
		return $valid;
2459
	}
2460
2461
2462
	/**
2463
	 * Multiselect in GF 2.2 became a json_encoded value. Fix it.
2464
	 *
2465
	 * As a hack for now we'll implode it back.
2466
	 */
2467
	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...
2468
		if ( empty ( $field->storageType ) || $field->storageType != 'json' ) {
2469
			return $field_value;
2470
		}
2471
2472
		$maybe_json = @json_decode( $field_value, true );
2473
2474
		if ( $maybe_json ) {
2475
			return implode( ',', $maybe_json );
2476
		}
2477
2478
		return $field_value;
2479
	}
2480
2481
	/**
2482
	 * Returns labels for the action links on Edit Entry
2483
	 *
2484
	 * @since 2.10.4
2485
	 *
2486
	 * @return array `cancel`, `submit`, `next`, `previous` array keys with associated labels.
2487
	 */
2488
	public function get_action_labels() {
2489
2490
		$labels = array(
2491
			'cancel'   => $this->view->settings->get( 'action_label_cancel', _x( 'Cancel', 'Shown when the user decides not to edit an entry', 'gravityview' ) ),
2492
			'submit'   => $this->view->settings->get( 'action_label_update', _x( 'Update', 'Button to update an entry the user is editing', 'gravityview' ) ),
2493
			'next'     => $this->view->settings->get( 'action_label_next', __( 'Next', 'Show the next page in a multi-page form', 'gravityview' ) ),
2494
			'previous' => $this->view->settings->get( 'action_label_previous', __( 'Previous', 'Show the previous page in a multi-page form', 'gravityview' ) ),
2495
		);
2496
2497
		/**
2498
		 * @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
2499
		 * @since 1.16.3
2500
		 * @param array $labels Default button labels associative array
2501
		 * @param array $form The Gravity Forms form
2502
		 * @param array $entry The Gravity Forms entry
2503
		 * @param int $view_id The current View ID
2504
		 */
2505
		$labels = apply_filters( 'gravityview/edit_entry/button_labels', $labels, $this->form, $this->entry, $this->view_id );
2506
2507
		return (array) $labels;
2508
	}
2509
2510
} //end class
2511