Completed
Push — develop ( c38b5d...31c9ca )
by Zack
18:12
created

GravityView_Edit_Entry_Render::init()   B

Complexity

Conditions 6
Paths 12

Size

Total Lines 38

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 14
CRAP Score 6.1979

Importance

Changes 0
Metric Value
cc 6
nc 12
nop 4
dl 0
loc 38
ccs 14
cts 17
cp 0.8235
crap 6.1979
rs 8.6897
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 ( $entry instanceof \GV\Entry ) {
272
			$this->entry = $entry->as_entry();
273
			$this->form_id = (int) $entry->as_entry()['form_id'];
274
			$this->form = GFAPI::get_form( $this->form_id );
275
		}
276 23
277
		if ( ! $gv_data ) {
278
			$gv_data = GravityView_View_Data::getInstance();
279
		}
280
281
		// Multiple Views embedded, don't proceed if nonce fails
282 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...
283 2
			gravityview()->log->error( 'Nonce validation failed for the Edit Entry request; returning' );
284 2
			return;
285
		}
286
287 23
		// Sorry, you're not allowed here.
288
		if ( false === $this->user_can_edit_entry( true ) ) {
289 23
			gravityview()->log->error( 'User is not allowed to edit this entry; returning', array( 'data' => $this->entry ) );
290
			return;
291 23
		}
292
293 23
		$this->view = $view;
294
295 23
		$this->print_scripts();
296
297
		$this->process_save( $gv_data );
298
299
		$this->edit_entry_form();
300
301
	}
302 22
303 22
304
	/**
305 22
	 * Force Gravity Forms to output scripts as if it were in the admin
306
	 * @return void
307 22
	 */
308
	private function print_scripts() {
309 22
		$gravityview_view = GravityView_View::getInstance();
310
311
		wp_register_script( 'gform_gravityforms', GFCommon::get_base_url().'/js/gravityforms.js', array( 'jquery', 'gform_json', 'gform_placeholder', 'sack', 'plupload-all', 'gravityview-fe-view' ) );
312 22
313 22
		GFFormDisplay::enqueue_form_scripts( $gravityview_view->getForm(), false);
314
315
		wp_localize_script( 'gravityview-fe-view', 'gvGlobals', array( 'cookiepath' => COOKIEPATH ) );
316
317
		// Sack is required for images
318
		wp_print_scripts( array( 'sack', 'gform_gravityforms', 'gravityview-fe-view' ) );
319
	}
320
321 23
322
	/**
323 23
	 * Process edit entry form save
324 5
	 *
325
	 * @param GravityView_View_Data $gv_data The View data.
326
	 */
327
	private function process_save( $gv_data ) {
328 22
329
		if ( empty( $_POST ) || ! isset( $_POST['lid'] ) ) {
330 22
			return;
331
		}
332
333
		// Make sure the entry, view, and form IDs are all correct
334
		$valid = $this->verify_nonce();
335 22
336
		if ( !$valid ) {
337
			gravityview()->log->error( 'Nonce validation failed.' );
338
			return;
339
		}
340 22
341
		if ( $this->entry['id'] !== $_POST['lid'] ) {
342 22
			gravityview()->log->error( 'Entry ID did not match posted entry ID.' );
343
			return;
344 22
		}
345
346 22
		gravityview()->log->debug( '$_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
347
348 22
		$this->process_save_process_files( $this->form_id );
349
350
		$this->validate();
351
352
		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...
353 22
354
			gravityview()->log->debug( 'Submission is valid.' );
355
356
			/**
357
			 * @hack This step is needed to unset the adminOnly from form fields, to add the calculation fields
358 22
			 */
359
			$form = $this->form_prepare_for_save();
360 22
361
			/**
362
			 * @hack to avoid the capability validation of the method save_lead for GF 1.9+
363
			 */
364
			unset( $_GET['page'] );
365
366 22
			$date_created = $this->entry['date_created'];
367
368
			/**
369
			 * @hack to force Gravity Forms to use $read_value_from_post in GFFormsModel::save_lead()
370
			 * @since 1.17.2
371
			 */
372
			unset( $this->entry['date_created'] );
373
374
			/**
375
			 * @action `gravityview/edit_entry/before_update` Perform an action before the entry has been updated using Edit Entry
376 22
			 * @since 2.1
377
			 * @param array $form Gravity Forms form array
378 22
			 * @param string $entry_id Numeric ID of the entry that is being updated
379
			 * @param GravityView_Edit_Entry_Render $this This object
380
			 * @param GravityView_View_Data $gv_data The View data
381 22
			 */
382
			do_action( 'gravityview/edit_entry/before_update', $form, $this->entry['id'], $this, $gv_data );
383 22
384
			GFFormsModel::save_lead( $form, $this->entry );
385
386 22
	        // Delete the values for hidden inputs
387
	        $this->unset_hidden_field_values();
388
389 22
			$this->entry['date_created'] = $date_created;
390
391
			// Process calculation fields
392 22
			$this->update_calculation_fields();
393
394
			// Handle hidden approval fields (or their absense)
395
			$this->preset_approval_fields();
396
397
			// Perform actions normally performed after updating a lead
398 22
			$this->after_update();
399
400
	        /**
401
			 * Must be AFTER after_update()!
402
			 * @see https://github.com/gravityview/GravityView/issues/764
403
			 */
404
			$this->maybe_update_post_fields( $form );
405
406
			/**
407
			 * @action `gravityview/edit_entry/after_update` Perform an action after the entry has been updated using Edit Entry
408 22
             * @since 2.1 Added $gv_data parameter
409
			 * @param array $form Gravity Forms form array
410
			 * @param string $entry_id Numeric ID of the entry that was updated
411
			 * @param GravityView_Edit_Entry_Render $this This object
412
			 * @param GravityView_View_Data $gv_data The View data
413
			 */
414 22
			do_action( 'gravityview/edit_entry/after_update', $this->form, $this->entry['id'], $this, $gv_data );
415
416
		} else {
417
			gravityview()->log->error( 'Submission is NOT valid.', array( 'entry' => $this->entry ) );
418
		}
419
420
	} // process_save
421
422
	/**
423
	 * Delete the value of fields hidden by conditional logic when the entry is edited
424
	 *
425 21
	 * @uses GFFormsModel::update_lead_field_value()
426 21
	 *
427
	 * @since 1.17.4
428
	 *
429
	 * @return void
430
	 */
431
	private function unset_hidden_field_values() {
432
	    global $wpdb;
433
434 21
		/**
435
		 * @filter `gravityview/edit_entry/unset_hidden_field_values` Whether to delete values of fields hidden by conditional logic
436 21
		 * @since 1.22.2
437
		 * @param bool $unset_hidden_field_values Default: true
438 21
		 * @param GravityView_Edit_Entry_Render $this This object
439
		 */
440
		$unset_hidden_field_values = apply_filters( 'gravityview/edit_entry/unset_hidden_field_values', true, $this );
441
442 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...
443 21
444 21
		if ( ! $unset_hidden_field_values ) {
445
			return;
446
		}
447
448
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
449
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
450 21
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $this->entry['id'] ) );
451
		} else {
452 21
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
453 21
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $this->entry['id'] ) );
454
		}
455
456 21
	    foreach ( $this->entry as $input_id => $field_value ) {
457 7
458
			if ( ! is_numeric( $input_id ) ) {
459
				continue;
460
			}
461 21
462
			if ( ! $field = RGFormsModel::get_field( $this->form, $input_id ) ) {
463 3
				continue;
464 3
			}
465 3
466
		    // Reset fields that are or would be hidden
467
		    if ( GFFormsModel::is_field_hidden( $this->form, $field, array(), $this->entry ) ) {
468 3
469 1
				$empty_value = $field->get_value_save_entry(
470 1
					is_array( $field->get_entry_inputs() ) ? array() : '',
471
					$this->form, '', $this->entry['id'], $this->entry
472
				);
473 3
474
				if ( $field->has_calculation() ) {
475 3
					$this->unset_hidden_calculations[] = $field->id; // Unset
476
					$empty_value = '';
477
				}
478
479 3
			    $lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
480 3
481
			    GFFormsModel::update_lead_field_value( $this->form, $this->entry, $field, $lead_detail_id, $input_id, $empty_value );
482
483 21
			    // Prevent the $_POST values of hidden fields from being used as default values when rendering the form
484
				// after submission
485
			    $post_input_id = 'input_' . str_replace( '.', '_', $input_id );
486
			    $_POST[ $post_input_id ] = '';
487
		    }
488
	    }
489
	}
490
491
	/**
492
	 * Leverage `gravityview/approve_entries/update_unapproved_meta` to prevent
493
	 * the missing/empty approval field to affect is_approved meta at all.
494
	 *
495 21
	 * Called before the Gravity Forms after_update triggers.
496 21
	 *
497
	 * @since 2.5
498 21
	 *
499 21
	 * @return void
500 1
	 */
501 1
	private function preset_approval_fields() {
502
		$has_approved_field = false;
503
504
		foreach ( self::$original_form['fields'] as $field ) {
505 21
			if ( $field->gravityview_approved ) {
506 20
				$has_approved_field = true;
507
				break;
508
			}
509 1
		}
510
511 1
		if ( ! $has_approved_field ) {
512 1
			return;
513 1
		}
514 1
515
		$is_field_hidden = true;
516
517
		foreach ( $this->form['fields'] as $field ) {
518 1
			if ( $field->gravityview_approved ) {
519 1
				$is_field_hidden = false;
520
				break;
521
			}
522 1
		}
523 1
524
		if ( ! $is_field_hidden ) {
525
			return;
526
		}
527
528
		add_filter( 'gravityview/approve_entries/update_unapproved_meta', array( $this, 'prevent_update_unapproved_meta' ), 9, 3 );
529
	}
530
531
	/**
532 1
	 * Done once from self::preset_approval_fields
533
	 *
534 1
	 * @since 2.5
535
	 *
536 1
	 * @return string UNAPPROVED unless something else is inside the entry.
537
	 */
538
	public function prevent_update_unapproved_meta( $value, $form, $entry ) {
539
540
		remove_filter( 'gravityview/approve_entries/update_unapproved_meta', array( $this, 'prevent_update_unapproved_meta' ), 9 );
541
542
		if ( ! $value = gform_get_meta( $entry['id'], 'is_approved' ) ) {
543 1
544
			$value = GravityView_Entry_Approval_Status::UNAPPROVED;
545
546
			$value = apply_filters( 'gravityview/approve_entries/after_submission/default_status', $value );
547
		}
548
549
		return $value;
550
	}
551
552
	/**
553 21
	 * Have GF handle file uploads
554
	 *
555
	 * Copy of code from GFFormDisplay::process_form()
556 21
	 *
557 21
	 * @param int $form_id
558 20
	 */
559
	private function process_save_process_files( $form_id ) {
560
561
		//Loading files that have been uploaded to temp folder
562
		$files = GFCommon::json_decode( stripslashes( RGForms::post( 'gform_uploaded_files' ) ) );
563
		if ( ! is_array( $files ) ) {
564
			$files = array();
565 21
		}
566
567 21
		/**
568 21
		 * Make sure the fileuploads are not overwritten if no such request was done.
569
		 * @since 1.20.1
570
		 */
571
		add_filter( "gform_save_field_value_$form_id", array( $this, 'save_field_value' ), 99, 5 );
572
573
		RGFormsModel::$uploaded_files[ $form_id ] = $files;
574
	}
575
576
	/**
577
	 * Make sure the fileuploads are not overwritten if no such request was done.
578
	 *
579
	 * TO ONLY BE USED INTERNALLY; DO NOT DEVELOP ON; MAY BE REMOVED AT ANY TIME.
580
	 *
581
	 * @since 1.20.1
582
	 *
583
	 * @param string $value Field value
584
	 * @param array $entry GF entry array
585 21
	 * @param GF_Field_FileUpload $field
586
	 * @param array $form GF form array
587 21
	 * @param string $input_id ID of the input being saved
588 21
	 *
589
	 * @return string
590
	 */
591 1
	public function save_field_value( $value = '', $entry = array(), $field = null, $form = array(), $input_id = '' ) {
592
593 1
		if ( ! $field || $field->type != 'fileupload' ) {
594
			return $value;
595
		}
596
597
		$input_name = 'input_' . str_replace( '.', '_', $input_id );
598
599
		if ( $field->multipleFiles ) {
600
			if ( empty( $value ) ) {
601 1
				return json_decode( \GV\Utils::get( $entry, $input_id, '' ), true );
602
			}
603 1
			return $value;
604
		}
605
606 1
		/** No file is being uploaded. */
607
		if ( empty( $_FILES[ $input_name ]['name'] ) ) {
608
			/** So return the original upload, with $value as backup (it can be empty during edit form rendering) */
609
			return rgar( $entry, $input_id, $value );
610
		}
611
612
		return $value;
613
	}
614
615
	/**
616
	 * Remove max_files validation (done on gravityforms.js) to avoid conflicts with GravityView
617
	 * Late validation done on self::custom_validation
618 2
	 *
619 2
	 * @param $plupload_init array Plupload settings
620
	 * @param $form_id
621
	 * @param $instance
622
	 * @return mixed
623 2
	 */
624
	public function modify_fileupload_settings( $plupload_init, $form_id, $instance ) {
0 ignored issues
show
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...
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...
625 2
		if( ! $this->is_edit_entry() ) {
626
			return $plupload_init;
627
		}
628
629
		$plupload_init['gf_vars']['max_files'] = 0;
630
631
		return $plupload_init;
632
	}
633 21
634
635 21
	/**
636
	 * Set visibility to visible and convert field input key to string
637
	 * @return array $form
638 21
	 */
639
	private function form_prepare_for_save() {
640
641
		$form = $this->filter_conditional_logic( $this->form );
642
643
	    /** @type GF_Field $field */
644 21
		foreach( $form['fields'] as $k => &$field ) {
645 4
646
			/**
647
			 * Remove the fields with calculation formulas before save to avoid conflicts with GF logic
648 21
			 * @since 1.16.3
649
			 */
650 21
			if( $field->has_calculation() ) {
651 3
				unset( $form['fields'][ $k ] );
652 3
			}
653
654
			$field->adminOnly = false;
655
656
			if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
657 21
				foreach( $field->inputs as $key => $input ) {
658
				    $field->inputs[ $key ][ 'id' ] = (string)$input['id'];
659 21
				}
660
			}
661
		}
662 21
663 21
		$form['fields'] = array_values( $form['fields'] );
664
665 21
		return $form;
666 21
	}
667
668
	private function update_calculation_fields() {
669 21
		global $wpdb;
670
671 21
		$form = self::$original_form;
672 21
		$update = false;
673 21
674
		// get the most up to date entry values
675
		$entry = GFAPI::get_entry( $this->entry['id'] );
676
677
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
678
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
679
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id=%d", $entry['id'] ) );
680 21
		} else {
681 5
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
682 5
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $lead_detail_table WHERE lead_id=%d", $entry['id'] ) );
683
		}
684 5
685
686 5
		if ( ! empty( $this->fields_with_calculation ) ) {
687 1
			$allowed_fields = $this->get_configured_edit_fields( $form, $this->view_id );
688
			$allowed_fields = wp_list_pluck( $allowed_fields, 'id' );
689
690 5
			foreach ( $this->fields_with_calculation as $field ) {
691 5
692 4
				if ( in_array( $field->id, $this->unset_hidden_calculations, true ) ) {
693 4
					continue;
694
				}
695 4
696 4
				$inputs = $field->get_entry_inputs();
697
				if ( is_array( $inputs ) ) {
698
				    foreach ( $inputs as $input ) {
699 4
						list( $field_id, $input_id ) = rgexplode( '.', $input['id'], 2 );
700
701 4
						if ( 'product' === $field->type ) {
702
							$input_name = 'input_' . str_replace( '.', '_', $input['id'] );
703
704
							// Only allow quantity to be set if it's allowed to be edited
705
							if ( in_array( $field_id, $allowed_fields ) && $input_id == 3 ) {
706
							} else { // otherwise set to what it previously was
707
								$_POST[ $input_name ] = $entry[ $input['id'] ];
708
							}
709
						} else {
710 4
							// Set to what it previously was if it's not editable
711
							if ( ! in_array( $field_id, $allowed_fields ) ) {
712
								$_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...
713
							}
714 3
						}
715 2
716
						GFFormsModel::save_input( $form, $field, $entry, $current_fields, $input['id'] );
717 3
				    }
718
				} else {
719
					// Set to what it previously was if it's not editable
720
					if ( ! in_array( $field->id, $allowed_fields ) ) {
721 5
						$_POST[ 'input_' . $field->id ] = $entry[ $field->id ];
722 5
					}
723
					GFFormsModel::save_input( $form, $field, $entry, $current_fields, $field->id );
724
				}
725 21
			}
726
727
			if ( method_exists( 'GFFormsModel', 'commit_batch_field_operations' ) ) {
728
				GFFormsModel::commit_batch_field_operations();
729
			}
730
		}
731
	}
732
733
	/**
734
	 * Handle updating the Post Image field
735
	 *
736
	 * Sets a new Featured Image if configured in Gravity Forms; otherwise uploads/updates media
737
	 *
738
	 * @since 1.17
739
	 *
740
	 * @uses GFFormsModel::media_handle_upload
741
	 * @uses set_post_thumbnail
742
	 *
743
	 * @param array $form GF Form array
744
	 * @param GF_Field $field GF Field
745
	 * @param string $field_id Numeric ID of the field
746 1
	 * @param string $value
747
	 * @param array $entry GF Entry currently being edited
748 1
	 * @param int $post_id ID of the Post being edited
749
	 *
750 1
	 * @return mixed|string
751
	 */
752
	private function update_post_image( $form, $field, $field_id, $value, $entry, $post_id ) {
753
754
		$input_name = 'input_' . $field_id;
755
756
		if ( !empty( $_FILES[ $input_name ]['name'] ) ) {
757
758
			// We have a new image
759
760
			$value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
761
762
			$ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
763
	        $ary = stripslashes_deep( $ary );
764
			$img_url = \GV\Utils::get( $ary, 0 );
765
766
			$img_title       = count( $ary ) > 1 ? $ary[1] : '';
767
			$img_caption     = count( $ary ) > 2 ? $ary[2] : '';
768
			$img_description = count( $ary ) > 3 ? $ary[3] : '';
769
770
			$image_meta = array(
771
				'post_excerpt' => $img_caption,
772
				'post_content' => $img_description,
773
			);
774
775
			//adding title only if it is not empty. It will default to the file name if it is not in the array
776
			if ( ! empty( $img_title ) ) {
777
				$image_meta['post_title'] = $img_title;
778
			}
779
780
			/**
781
			 * 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.
782
			 * Note: the method became public in GF 1.9.17.7, but we don't require that version yet.
783
			 */
784
			require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
785
			$media_id = GravityView_GFFormsModel::media_handle_upload( $img_url, $post_id, $image_meta );
786 1
787
			// is this field set as featured image?
788 1
			if ( $media_id && $field->postFeaturedImage ) {
789 1
				set_post_thumbnail( $post_id, $media_id );
790 1
			}
791 1
792
		} elseif ( ! empty( $_POST[ $input_name ] ) && is_array( $value ) ) {
793 1
794
			$img_url         = stripslashes_deep( $_POST[ $input_name ] );
795 1
			$img_title       = stripslashes_deep( \GV\Utils::_POST( $input_name . '_1' ) );
796
			$img_caption     = stripslashes_deep( \GV\Utils::_POST( $input_name . '_4' ) );
797
			$img_description = stripslashes_deep( \GV\Utils::_POST( $input_name . '_7' ) );
798 1
799 1
			$value = ! empty( $img_url ) ? $img_url . "|:|" . $img_title . "|:|" . $img_caption . "|:|" . $img_description : '';
800 1
801 1
			if ( $field->postFeaturedImage ) {
802
803
				$image_meta = array(
804
					'ID' => get_post_thumbnail_id( $post_id ),
805 1
					'post_title' => $img_title,
806
					'post_excerpt' => $img_caption,
807
					'post_content' => $img_description,
808
				);
809
810
				// update image title, caption or description
811
				wp_update_post( $image_meta );
812
			}
813
		} else {
814
815
			// if we get here, image was removed or not set.
816
			$value = '';
817 1
818
			if ( $field->postFeaturedImage ) {
819
				delete_post_thumbnail( $post_id );
820
			}
821
		}
822
823
		return $value;
824
	}
825
826
	/**
827 21
	 * Loop through the fields being edited and if they include Post fields, update the Entry's post object
828
	 *
829 21
	 * @param array $form Gravity Forms form
830 20
	 *
831 20
	 * @return void
832
	 */
833
	private function maybe_update_post_fields( $form ) {
834 1
835
		if( empty( $this->entry['post_id'] ) ) {
836
	        gravityview()->log->debug( 'This entry has no post fields. Continuing...' );
837 1
			return;
838
		}
839
840
		$post_id = $this->entry['post_id'];
841
842 1
		// Security check
843
		if( false === GVCommon::has_cap( 'edit_post', $post_id ) ) {
844 1
			gravityview()->log->error( 'The current user does not have the ability to edit Post #{post_id}', array( 'post_id' => $post_id ) );
845
			return;
846 1
		}
847
848 1
		$update_entry = false;
849
850 1
		$updated_post = $original_post = get_post( $post_id );
851 1
852
		foreach ( $this->entry as $field_id => $value ) {
853
854 1
			$field = RGFormsModel::get_field( $form, $field_id );
855
856
			if( ! $field ) {
857 1
				continue;
858
			}
859
860 1
			if( GFCommon::is_post_field( $field ) && 'post_category' !== $field->type ) {
861 1
862
				// Get the value of the field, including $_POSTed value
863 1
				$value = RGFormsModel::get_field_value( $field );
864
865 1
				// Use temporary entry variable, to make values available to fill_post_template() and update_post_image()
866
				$entry_tmp = $this->entry;
867
				$entry_tmp["{$field_id}"] = $value;
868
869
				switch( $field->type ) {
870
871
				    case 'post_title':
872
				        $post_title = $value;
873
				        if ( \GV\Utils::get( $form, 'postTitleTemplateEnabled' ) ) {
874
				            $post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
875 1
				        }
876
				        $updated_post->post_title = $post_title;
877
				        $updated_post->post_name  = $post_title;
878
				        unset( $post_title );
879
				        break;
880
881
				    case 'post_content':
882
				        $post_content = $value;
883 1
				        if ( \GV\Utils::get( $form, 'postContentTemplateEnabled' ) ) {
884
				            $post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
885
				        }
886 1
				        $updated_post->post_content = $post_content;
887
				        unset( $post_content );
888
				        break;
889 1
				    case 'post_excerpt':
890
				        $updated_post->post_excerpt = $value;
891 1
				        break;
892
				    case 'post_tags':
893
				        wp_set_post_tags( $post_id, $value, false );
894
				        break;
895
				    case 'post_category':
896
				        break;
897
				    case 'post_custom_field':
898
						if ( is_array( $value ) && ( floatval( $field_id ) !== floatval( $field->id ) ) ) {
899
							$value = $value[ $field_id ];
900
						}
901
902
				        if( ! empty( $field->customFieldTemplateEnabled ) ) {
903
				            $value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
904
				        }
905 1
906 1
						$value = $field->get_value_save_entry( $value, $form, '', $this->entry['id'], $this->entry );
907 1
908
				        update_post_meta( $post_id, $field->postCustomFieldName, $value );
909
				        break;
910
911
				    case 'post_image':
912 1
				        $value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
913
				        break;
914 1
915
				}
916 1
917
				// update entry after
918
				$this->entry["{$field_id}"] = $value;
919
920
				$update_entry = true;
921 1
922
				unset( $entry_tmp );
923 1
			}
924
925 1
		}
926
927
		if( $update_entry ) {
928 1
929
			$return_entry = GFAPI::update_entry( $this->entry );
930
931
			if( is_wp_error( $return_entry ) ) {
932
				gravityview()->log->error( 'Updating the entry post fields failed', array( 'data' => array( '$this->entry' => $this->entry, '$return_entry' => $return_entry ) ) );
933 1
			} else {
934
				gravityview()->log->debug( 'Updating the entry post fields for post #{post_id} succeeded', array( 'post_id' => $post_id ) );
935 1
			}
936
937
		}
938
939 1
		$return_post = wp_update_post( $updated_post, true );
940
941 1
		if( is_wp_error( $return_post ) ) {
942
			$return_post->add_data( $updated_post, '$updated_post' );
943
			gravityview()->log->error( 'Updating the post content failed', array( 'data' => compact( 'updated_post', 'return_post' ) ) );
944
		} else {
945
			gravityview()->log->debug( 'Updating the post content for post #{post_id} succeeded', array( 'post_id' => $post_id, 'data' => $updated_post ) );
946
		}
947
	}
948
949
	/**
950
	 * Convert a field content template into prepared output
951
	 *
952
	 * @uses GravityView_GFFormsModel::get_post_field_images()
953
	 *
954
	 * @since 1.17
955
	 *
956
	 * @param string $template The content template for the field
957
	 * @param array $form Gravity Forms form
958
	 * @param bool $do_shortcode Whether to process shortcode inside content. In GF, only run on Custom Field and Post Content fields
959
	 *
960
	 * @return string
961
	 */
962
	private function fill_post_template( $template, $form, $entry, $do_shortcode = false ) {
963
964
		require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
965
966
		$post_images = GravityView_GFFormsModel::get_post_field_images( $form, $entry );
967
968
		//replacing post image variables
969
		$output = GFCommon::replace_variables_post_image( $template, $post_images, $entry );
970
971
		//replacing all other variables
972
		$output = GFCommon::replace_variables( $output, $form, $entry, false, false, false );
973
974
		// replace conditional shortcodes
975
		if( $do_shortcode ) {
976
			$output = do_shortcode( $output );
977
		}
978
979
		return $output;
980
	}
981
982
983
	/**
984
	 * Perform actions normally performed after updating a lead
985
	 *
986 21
	 * @since 1.8
987
	 *
988 21
	 * @see GFEntryDetail::lead_detail_page()
989 21
	 *
990
	 * @return void
991
	 */
992 21
	private function after_update() {
993
994 21
		do_action( 'gform_after_update_entry', self::$original_form, $this->entry['id'], self::$original_entry );
995
		do_action( "gform_after_update_entry_{$this->form['id']}", self::$original_form, $this->entry['id'], self::$original_entry );
996 21
997
		// Re-define the entry now that we've updated it.
998
		$entry = RGFormsModel::get_lead( $this->entry['id'] );
999
1000
		$entry = GFFormsModel::set_entry_meta( $entry, self::$original_form );
1001
1002
		if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '<' ) ) {
1003
			// We need to clear the cache because Gravity Forms caches the field values, which
1004
			// we have just updated.
1005
			foreach ($this->form['fields'] as $key => $field) {
1006
				GFFormsModel::refresh_lead_field_value( $entry['id'], $field->id );
1007
			}
1008
		}
1009 21
1010 1
		/**
1011 1
		 * Maybe process feeds.
1012 1
		 *
1013 1
		 * @since develop
1014 1
		 */
1015 1
		if ( $allowed_feeds = $this->view->settings->get( 'edit_feeds', array() ) ) {
1016 1
			$feeds = GFAPI::get_feeds( null, $entry['form_id'] );
1017 1
			if ( ! is_wp_error( $feeds ) ) {
1018
				$registered_feeds = array();
1019
				foreach ( GFAddOn::get_registered_addons() as $registered_feed ) {
1020
					if ( is_subclass_of( $registered_feed,  'GFFeedAddOn' ) ) {
1021 1
						if ( method_exists( $registered_feed, 'get_instance' ) ) {
1022 1
							$registered_feed = call_user_func( array( $registered_feed, 'get_instance' ) );
1023 1
							$registered_feeds[ $registered_feed->get_slug() ] = $registered_feed;
1024 1
						}
1025 1
					}
1026
				}
1027
				foreach ( $feeds as $feed ) {
1028
					if ( in_array( $feed['id'], $allowed_feeds ) ) {
1029 1
						if ( $feed_object = \GV\Utils::get( $registered_feeds, $feed['addon_slug'] ) ) {
1030 1
							$returned_entry = $feed_object->process_feed( $feed, $entry, self::$original_form );
1031 1
							if ( is_array( $returned_entry ) && rgar( $returned_entry, 'id' ) ) {
1032
								$entry = $returned_entry;
1033
							}
1034
1035
							do_action( 'gform_post_process_feed', $feed, $entry, self::$original_form, $feed_object );
1036
							$slug = $feed_object->get_slug();
1037
							do_action( "gform_{$slug}_post_process_feed", $feed, $entry, self::$original_form, $feed_object );
1038 21
						}
1039 21
					}
1040
				}
1041
			}
1042
		}
1043
1044
		$this->entry = $entry;
1045
	}
1046
1047 22
1048
	/**
1049 22
	 * Display the Edit Entry form
1050
	 *
1051 22
	 * @return void
1052 22
	 */
1053 22
	public function edit_entry_form() {
1054
1055
		$view = \GV\View::by_id( $this->view_id );
1056
1057
		if( $view->settings->get( 'edit_locking' ) ) {
1058
			$locking = new GravityView_Edit_Entry_Locking();
1059
			$locking->maybe_lock_object( $this->entry['id'] );
1060
		}
1061
1062
		?>
1063
1064
		<div id="wpfooter"></div><!-- used for locking message -->
1065
1066 22
		<script>
1067
			var ajaxurl = '<?php echo admin_url( 'admin-ajax.php', 'relative' ); ?>';
1068
		</script>
1069
1070
		<div class="gv-edit-entry-wrapper"><?php
1071
1072 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...
1073
1074
			/**
1075
			 * Fixes weird wpautop() issue
1076
			 * @see https://github.com/katzwebservices/GravityView/issues/451
1077
			 */
1078
			echo gravityview_strip_whitespace( $javascript );
1079
1080
			?><h2 class="gv-edit-entry-title">
1081
				<span><?php
1082 22
1083
				    /**
1084 22
				     * @filter `gravityview_edit_entry_title` Modify the edit entry title
1085
				     * @param string $edit_entry_title Modify the "Edit Entry" title
1086
				     * @param GravityView_Edit_Entry_Render $this This object
1087
				     */
1088
				    $edit_entry_title = apply_filters('gravityview_edit_entry_title', __('Edit Entry', 'gravityview'), $this );
1089
1090
				    echo esc_attr( $edit_entry_title );
1091
			?></span>
1092
			</h2>
1093
1094
			<?php $this->maybe_print_message(); ?>
1095
1096 22
			<?php // The ID of the form needs to be `gform_{form_id}` for the pluploader ?>
1097
1098 22
			<form method="post" id="gform_<?php echo $this->form_id; ?>" enctype="multipart/form-data">
1099
1100
				<?php
1101 22
1102
				wp_nonce_field( self::$nonce_key, self::$nonce_key );
1103
1104 22
				wp_nonce_field( self::$nonce_field, self::$nonce_field, false );
1105
1106
				// Print the actual form HTML
1107
				$this->render_edit_form();
1108
1109
				?>
1110
			</form>
1111
1112
			<script>
1113
				gform.addFilter('gform_reset_pre_conditional_logic_field_action', function ( reset, formId, targetId, defaultValues, isInit ) {
1114
				    return false;
1115 22
				});
1116
			</script>
1117
1118
		</div>
1119
1120
	<?php
1121
	}
1122
1123
	/**
1124
	 * Display success or error message if the form has been submitted
1125
	 *
1126 22
	 * @uses GVCommon::generate_notice
1127
	 *
1128 22
	 * @since 1.16.2.2
1129
	 *
1130 21
	 * @return void
1131
	 */
1132
	private function maybe_print_message() {
1133
1134
		if ( \GV\Utils::_POST( 'action' ) === 'update' ) {
1135
1136
			if ( GFCommon::has_pages( $this->form ) && apply_filters( 'gravityview/features/paged-edit', false ) ) {
1137
				$labels = array(
1138
					'cancel'   => __( 'Cancel', 'gravityview' ),
1139
					'submit'   => __( 'Update', 'gravityview' ),
1140
					'next'     => __( 'Next', 'gravityview' ),
1141
					'previous' => __( 'Previous', 'gravityview' ),
1142
				);
1143
1144
				/**
1145
				* @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
1146
				* @since 1.16.3
1147
				* @param array $labels Default button labels associative array
1148
				* @param array $form The Gravity Forms form
1149
				* @param array $entry The Gravity Forms entry
1150
				* @param int $view_id The current View ID
1151 21
				*/
1152
				$labels = apply_filters( 'gravityview/edit_entry/button_labels', $labels, $this->form, $this->entry, $this->view_id );
1153 21
1154
				$this->is_paged_submitted = \GV\Utils::_POST( 'save' ) === $labels['submit'];
1155
			}
1156
1157
			$back_link = remove_query_arg( array( 'page', 'view', 'edit' ) );
1158
1159
			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...
1160
1161 21
				// Keeping this compatible with Gravity Forms.
1162
				$validation_message = "<div class='validation_error'>" . __('There was a problem with your submission.', 'gravityview') . " " . __('Errors have been highlighted below.', 'gravityview') . "</div>";
1163
				$message = apply_filters("gform_validation_message_{$this->form['id']}", apply_filters("gform_validation_message", $validation_message, $this->form), $this->form);
1164
1165
				echo GVCommon::generate_notice( $message , 'gv-error' );
1166
1167
			} elseif ( false === $this->is_paged_submitted ) {
1168
				// Paged form that hasn't been submitted on the last page yet
1169
				$entry_updated_message = sprintf( esc_attr__( 'Entry Updated.', 'gravityview' ), '<a href="' . esc_url( $back_link ) . '">', '</a>' );
1170
1171
				/**
1172
				 * @filter `gravityview/edit_entry/page/success` Modify the edit entry success message on pages
1173
				 * @since develop
1174
				 * @param string $entry_updated_message Existing message
1175
				 * @param int $view_id View ID
1176 21
				 * @param array $entry Gravity Forms entry array
1177 21
				 */
1178 21
				$message = apply_filters( 'gravityview/edit_entry/page/success', $entry_updated_message , $this->view_id, $this->entry );
1179
1180
				echo GVCommon::generate_notice( $message );
1181
			} else {
1182 21
				$view = \GV\View::by_id( $this->view_id );
1183 1
				$edit_redirect = $view->settings->get( 'edit_redirect' );
1184 1
				$edit_redirect_url = $view->settings->get( 'edit_redirect_url' );
1185 1
1186
				switch ( $edit_redirect ) {
1187 20
1188 1
                    case '0':
1189 1
	                    $redirect_url = $back_link;
1190 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>' );
1191
                        break;
1192 19
1193 1
                    case '1':
1194 1
	                    $redirect_url = $directory_link = GravityView_API::directory_link();
1195 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...
1196 1
	                    break;
1197
1198 18
                    case '2':
1199
	                    $redirect_url = $edit_redirect_url;
1200 18
	                    $redirect_url = GFCommon::replace_variables( $redirect_url, $this->form, $this->entry, false, false, false, 'text' );
1201 18
	                    $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>' );
1202
                        break;
1203
1204 21
                    case '':
1205 3
                    default:
1206
					    $entry_updated_message = sprintf( esc_attr__('Entry Updated. %sReturn to Entry%s', 'gravityview'), '<a href="'. esc_url( $back_link ) .'">', '</a>' );
1207
                        break;
1208
				}
1209
1210
				if ( isset( $redirect_url ) ) {
1211
					$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 ) );
1212
				}
1213
1214
				/**
1215
				 * @filter `gravityview/edit_entry/success` Modify the edit entry success message (including the anchor link)
1216 21
				 * @since 1.5.4
1217
				 * @param string $entry_updated_message Existing message
1218 21
				 * @param int $view_id View ID
1219
				 * @param array $entry Gravity Forms entry array
1220
				 * @param string $back_link URL to return to the original entry. @since 1.6
1221
				 */
1222 22
				$message = apply_filters( 'gravityview/edit_entry/success', $entry_updated_message , $this->view_id, $this->entry, $back_link );
1223
1224
				echo GVCommon::generate_notice( $message );
1225
			}
1226
1227
		}
1228
	}
1229
1230
	/**
1231 22
	 * Display the Edit Entry form in the original Gravity Forms format
1232
	 *
1233
	 * @since 1.9
1234
	 *
1235
	 * @return void
1236
	 */
1237
	private function render_edit_form() {
1238 22
1239
		/**
1240 22
		 * @action `gravityview/edit-entry/render/before` Before rendering the Edit Entry form
1241 22
		 * @since 1.17
1242 22
		 * @param GravityView_Edit_Entry_Render $this
1243 22
		 */
1244 22
		do_action( 'gravityview/edit-entry/render/before', $this );
1245
1246 22
		add_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields'), 5000, 3 );
1247 22
		add_filter( 'gform_submit_button', array( $this, 'render_form_buttons') );
1248
		add_filter( 'gform_next_button', array( $this, 'render_form_buttons' ) );
1249
		add_filter( 'gform_previous_button', array( $this, 'render_form_buttons' ) );
1250 22
		add_filter( 'gform_disable_view_counter', '__return_true' );
1251
1252 22
		add_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5, 5 );
1253 22
		add_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10, 5 );
1254
1255
		// We need to remove the fake $_GET['page'] arg to avoid rendering form as if in admin.
1256 22
		unset( $_GET['page'] );
1257
1258
		$this->show_next_button = false;
1259
		$this->show_previous_button = false;
1260
1261
		// TODO: Verify multiple-page forms
1262
		if ( GFCommon::has_pages( $this->form ) && apply_filters( 'gravityview/features/paged-edit', false ) ) {
1263
			if ( intval( $page_number = \GV\Utils::_POST( 'gform_source_page_number_' . $this->form['id'], 0 ) ) ) {
1264
1265
				$labels = array(
1266
					'cancel'   => __( 'Cancel', 'gravityview' ),
1267
					'submit'   => __( 'Update', 'gravityview' ),
1268
					'next'     => __( 'Next', 'gravityview' ),
1269
					'previous' => __( 'Previous', 'gravityview' ),
1270
				);
1271
1272
				/**
1273
				* @filter `gravityview/edit_entry/button_labels` Modify the cancel/submit buttons' labels
1274
				* @since 1.16.3
1275
				* @param array $labels Default button labels associative array
1276
				* @param array $form The Gravity Forms form
1277
				* @param array $entry The Gravity Forms entry
1278
				* @param int $view_id The current View ID
1279
				*/
1280
				$labels = apply_filters( 'gravityview/edit_entry/button_labels', $labels, $this->form, $this->entry, $this->view_id );
1281
1282
				GFFormDisplay::$submission[ $this->form['id'] ][ 'form' ] = $this->form;
1283
				GFFormDisplay::$submission[ $this->form['id'] ][ 'is_valid' ] = true;
1284
1285
				if ( \GV\Utils::_POST( 'save' ) === $labels['next'] ) {
1286
					$last_page = \GFFormDisplay::get_max_page_number( $this->form );
1287
1288
					while ( ++$page_number < $last_page && RGFormsModel::is_page_hidden( $this->form, $page_number, \GV\Utils::_POST( 'gform_field_values' ) ) ) {
1289
					} // Advance to next visible page
1290
				} elseif ( \GV\Utils::_POST( 'save' ) === $labels['previous'] ) {
1291
					while ( --$page_number > 1 && RGFormsModel::is_page_hidden( $this->form, $page_number, \GV\Utils::_POST( 'gform_field_values' ) ) ) {
1292
					} // Advance to next visible page
1293
				}
1294
1295
				GFFormDisplay::$submission[ $this->form['id'] ]['page_number'] = $page_number;
1296
			}
1297
1298
			if ( ( $page_number = intval( $page_number ) ) < 2 ) {
1299
				$this->show_next_button = true; // First page
1300
			}
1301
1302
			$last_page = \GFFormDisplay::get_max_page_number( $this->form );
1303
1304
			$has_more_pages = $page_number < $last_page;
1305
1306
			if ( $has_more_pages ) {
1307
				$this->show_next_button = true; // Not the last page
1308
			} else {
1309
				$this->show_update_button = true; // The last page
1310 22
			}
1311
1312
			if ( $page_number > 1 ) {
1313 22
				$this->show_previous_button = true; // Not the first page
1314
			}
1315 22
		} else {
1316
			$this->show_update_button = true;
1317 22
		}
1318
1319 22
		ob_start(); // Prevent PHP warnings possibly caused by prefilling list fields for conditional logic
1320 22
1321 22
		$html = GFFormDisplay::get_form( $this->form['id'], false, false, true, $this->entry );
1322 22
1323 22
		ob_get_clean();
1324 22
1325 22
	    remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
1326
		remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
1327 22
		remove_filter( 'gform_next_button', array( $this, 'render_form_buttons' ) );
1328
		remove_filter( 'gform_previous_button', array( $this, 'render_form_buttons' ) );
1329
		remove_filter( 'gform_disable_view_counter', '__return_true' );
1330
		remove_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5 );
1331
		remove_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10 );
1332
1333
		echo $html;
1334 22
1335 22
		/**
1336
		 * @action `gravityview/edit-entry/render/after` After rendering the Edit Entry form
1337
		 * @since 1.17
1338
		 * @param GravityView_Edit_Entry_Render $this
1339
		 */
1340
		do_action( 'gravityview/edit-entry/render/after', $this );
1341
	}
1342 22
1343 22
	/**
1344
	 * Display the Update/Cancel/Delete buttons for the Edit Entry form
1345
	 * @since 1.8
1346
	 * @return string
1347
	 */
1348
	public function render_form_buttons() {
1349
		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...
1350
	}
1351
1352
1353
	/**
1354
	 * Modify the form fields that are shown when using GFFormDisplay::get_form()
1355
	 *
1356
	 * By default, all fields will be shown. We only want the Edit Tab configured fields to be shown.
1357
	 *
1358
	 * @param array $form
1359
	 * @param boolean $ajax Whether in AJAX mode
1360 22
	 * @param array|string $field_values Passed parameters to the form
1361
	 *
1362 22
	 * @since 1.9
1363
	 *
1364
	 * @return array Modified form array
1365
	 */
1366
	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...
1367 22
1368 21
		if( $form['id'] != $this->form_id ) {
1369
			return $form;
1370 4
		}
1371
1372
		// In case we have validated the form, use it to inject the validation results into the form render
1373 22
		if( isset( $this->form_after_validation ) && $this->form_after_validation['id'] === $form['id'] ) {
1374
			$form = $this->form_after_validation;
1375 22
		} else {
1376
			$form['fields'] = $this->get_configured_edit_fields( $form, $this->view_id );
1377
		}
1378 22
1379 22
		$form = $this->filter_conditional_logic( $form );
1380
1381
		$form = $this->prefill_conditional_logic( $form );
1382 22
1383
		// for now we don't support Save and Continue feature.
1384 22
		if( ! self::$supports_save_and_continue ) {
1385
	        unset( $form['save'] );
1386
		}
1387
1388
		$form = $this->unselect_default_values( $form );
1389
1390
		return $form;
1391
	}
1392
1393
	/**
1394
	 * 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.
1395
	 *
1396
	 * @since 1.16.2.2
1397
	 *
1398
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1399
	 * @param GF_Field $field
1400 22
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1401
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1402 22
	 * @param int $form_id Form ID
1403 22
	 *
1404
	 * @return string If error, the error message. If no error, blank string (modify_edit_field_input() runs next)
1405
	 */
1406 2
	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 $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 $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 $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...
1407
1408
		if( ! GFCommon::is_post_field( $field ) ) {
1409 2
			return $field_content;
1410
		}
1411
1412
        $message = null;
1413
1414
        // First, make sure they have the capability to edit the post.
1415 1
        if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
1416
1417 1
            /**
1418
             * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
1419
             * @param string $message The existing "You don't have permission..." text
1420
             */
1421
            $message = apply_filters('gravityview/edit_entry/unsupported_post_field_text', __('You don&rsquo;t have permission to edit this post.', 'gravityview') );
1422
1423
        } elseif( null === get_post( $this->entry['post_id'] ) ) {
1424
            /**
1425 2
             * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
1426 1
             * @param string $message The existing "This field is not editable; the post no longer exists." text
1427
             */
1428
            $message = apply_filters('gravityview/edit_entry/no_post_text', __('This field is not editable; the post no longer exists.', 'gravityview' ) );
1429 2
        }
1430
1431
        if( $message ) {
1432
            $field_content = sprintf('<div class="ginput_container ginput_container_' . $field->type . '">%s</div>', wpautop( $message ) );
1433
        }
1434
1435
        return $field_content;
1436
	}
1437
1438
	/**
1439
	 *
1440
	 * Fill-in the saved values into the form inputs
1441
	 *
1442
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1443
	 * @param GF_Field $field
1444 22
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1445
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1446 22
	 * @param int $form_id Form ID
1447
	 *
1448
	 * @return mixed
1449
	 */
1450
	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...
1451 22
1452 22
		$gv_field = GravityView_Fields::get_associated_field( $field );
1453
1454 22
		// If the form has been submitted, then we don't need to pre-fill the values,
1455 22
		// Except for fileupload type and when a field input is overridden- run always!!
1456
		if(
1457 1
			( $this->is_edit_entry_submission() && !in_array( $field->type, array( 'fileupload', 'post_image' ) ) )
1458
			&& false === ( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) )
1459
			&& ! GFCommon::is_product_field( $field->type )
1460
			|| ! empty( $field_content )
1461 22
			|| in_array( $field->type, array( 'honeypot' ) )
1462
		) {
1463 22
	        return $field_content;
1464
		}
1465
1466 22
		// SET SOME FIELD DEFAULTS TO PREVENT ISSUES
1467
		$field->adminOnly = false; /** @see GFFormDisplay::get_counter_init_script() need to prevent adminOnly */
1468 22
1469
		$field_value = $this->get_field_value( $field );
1470
1471 22
	    // Prevent any PHP warnings, like undefined index
1472 3
	    ob_start();
1473
1474 22
	    $return = null;
1475
1476
		/** @var GravityView_Field $gv_field */
1477
		if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
1478 22
			$return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
1479
		} else {
1480 22
	        $return = $field->get_field_input( $this->form, $field_value, $this->entry );
1481
	    }
1482
1483
	    // If there was output, it's an error
1484 22
	    $warnings = ob_get_clean();
1485
1486
	    if( !empty( $warnings ) ) {
1487
		    gravityview()->log->error( '{warning}', array( 'warning' => $warnings, 'data' => $field_value ) );
1488
	    }
1489
1490
		return $return;
1491
	}
1492
1493
	/**
1494 22
	 * Modify the value for the current field input
1495
	 *
1496
	 * @param GF_Field $field
1497
	 *
1498
	 * @return array|mixed|string
1499
	 */
1500
	private function get_field_value( $field ) {
1501
1502 22
		/**
1503
		 * @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.
1504
		 * @param boolean True: override saved values; False: don't override (default)
1505 22
		 * @param $field GF_Field object Gravity Forms field object
1506
		 * @since 1.13
1507 4
		 */
1508
		$override_saved_value = apply_filters( 'gravityview/edit_entry/pre_populate/override', false, $field );
1509
1510 4
		// We're dealing with multiple inputs (e.g. checkbox) but not time or date (as it doesn't store data in input IDs)
1511
		if( isset( $field->inputs ) && is_array( $field->inputs ) && !in_array( $field->type, array( 'time', 'date' ) ) ) {
1512 4
1513
			$field_value = array();
1514 4
1515
			// only accept pre-populated values if the field doesn't have any choice selected.
1516 4
			$allow_pre_populated = $field->allowsPrepopulate;
1517 4
1518 4
			foreach ( (array)$field->inputs as $input ) {
1519
1520
				$input_id = strval( $input['id'] );
1521
1522
				if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
1523 4
				    $field_value[ $input_id ] =  'post_category' === $field->type ? GFCommon::format_post_category( $this->entry[ $input_id ], true ) : $this->entry[ $input_id ];
1524
				    $allow_pre_populated = false;
1525 4
				}
1526
1527
			}
1528
1529 22
			$pre_value = $field->get_value_submission( array(), false );
1530
1531
			$field_value = ! $allow_pre_populated && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $field_value : $pre_value;
1532 22
1533
		} else {
1534
1535
			$id = intval( $field->id );
1536 22
1537
			// get pre-populated value if exists
1538
			$pre_value = $field->allowsPrepopulate ? GFFormsModel::get_parameter_value( $field->inputName, array(), $field ) : '';
1539 22
1540
			// saved field entry value (if empty, fallback to the pre-populated value, if exists)
1541
			// or pre-populated value if not empty and set to override saved value
1542
			$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;
1543
1544
			// in case field is post_category but inputType is select, multi-select or radio, convert value into array of category IDs.
1545
			if ( 'post_category' === $field->type && !gv_empty( $field_value, false, false ) ) {
1546
				$categories = array();
1547
				foreach ( explode( ',', $field_value ) as $cat_string ) {
1548
				    $categories[] = GFCommon::format_post_category( $cat_string, true );
1549
				}
1550 22
				$field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
1551
			}
1552
1553
		}
1554
1555
		// if value is empty get the default value if defined
1556
		$field_value = $field->get_value_default_if_empty( $field_value );
1557
1558
	    /**
1559
	     * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
1560 22
	     * @since 1.11
1561
	     * @since 1.20 Added third param
1562
	     * @param mixed $field_value field value used to populate the input
1563
	     * @param object $field Gravity Forms field object ( Class GF_Field )
1564
	     * @param GravityView_Edit_Entry_Render $this Current object
1565
	     */
1566
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
1567
1568
	    /**
1569
	     * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
1570 22
	     * @since 1.17
1571
	     * @since 1.20 Added third param
1572 22
	     * @param mixed $field_value field value used to populate the input
1573
	     * @param GF_Field $field Gravity Forms field object
1574
	     * @param GravityView_Edit_Entry_Render $this Current object
1575
	     */
1576
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
1577
1578
		return $field_value;
1579
	}
1580
1581
1582
	// ---- Entry validation
1583
1584
	/**
1585 21
	 * Add field keys that Gravity Forms expects.
1586
	 *
1587 21
	 * @see GFFormDisplay::validate()
1588
	 * @param  array $form GF Form
1589
	 * @return array       Modified GF Form
1590
	 */
1591
	public function gform_pre_validation( $form ) {
1592 21
1593
		if( ! $this->verify_nonce() ) {
1594
			return $form;
1595
		}
1596 21
1597 21
		// Fix PHP warning regarding undefined index.
1598
		foreach ( $form['fields'] as &$field) {
1599
1600 21
			// This is because we're doing admin form pretending to be front-end, so Gravity Forms
1601
			// expects certain field array items to be set.
1602
			foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
1603
	            $field->{$key} = isset( $field->{$key} ) ? $field->{$key} : NULL;
1604
			}
1605
1606
			switch( RGFormsModel::get_input_type( $field ) ) {
1607
1608
				/**
1609 21
				 * 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.
1610
				 *
1611
				 * 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.
1612 1
				 *
1613
				 * @hack
1614 1
				 */
1615 1
				case 'fileupload':
1616
1617 1
				    // Set the previous value
1618
				    $entry = $this->get_entry();
1619
1620 1
				    $input_name = 'input_'.$field->id;
1621 1
				    $form_id = $form['id'];
1622
1623
				    $value = NULL;
1624
1625 1
				    // Use the previous entry value as the default.
1626 1
				    if( isset( $entry[ $field->id ] ) ) {
1627 1
				        $value = $entry[ $field->id ];
1628
				    }
1629
1630
				    // If this is a single upload file
1631
				    if( !empty( $_FILES[ $input_name ] ) && !empty( $_FILES[ $input_name ]['name'] ) ) {
1632
				        $file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
1633 1
				        $value = $file_path['url'];
1634
1635
				    } else {
1636
1637 1
				        // Fix PHP warning on line 1498 of form_display.php for post_image fields
1638
				        // Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
1639
				        $_FILES[ $input_name ] = array('name' => '', 'size' => '' );
1640
1641 1
				    }
1642
1643
				    if ( \GV\Utils::get( $field, "multipleFiles" ) ) {
1644 1
1645
				        // If there are fresh uploads, process and merge them.
1646
				        // Otherwise, use the passed values, which should be json-encoded array of URLs
1647
				        if( isset( GFFormsModel::$uploaded_files[$form_id][$input_name] ) ) {
1648
				            $value = empty( $value ) ? '[]' : $value;
1649
				            $value = stripslashes_deep( $value );
1650
				            $value = GFFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'], array());
1651 1
				        }
1652
1653
				    } else {
1654
1655 1
				        // A file already exists when editing an entry
1656 1
				        // We set this to solve issue when file upload fields are required.
1657
				        GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
1658 1
1659
				    }
1660 21
1661
				    $this->entry[ $input_name ] = $value;
1662 12
				    $_POST[ $input_name ] = $value;
1663 7
1664
				    break;
1665 12
1666
				case 'number':
1667
				    // Fix "undefined index" issue at line 1286 in form_display.php
1668
				    if( !isset( $_POST['input_'.$field->id ] ) ) {
1669
				        $_POST['input_'.$field->id ] = NULL;
1670 21
				    }
1671
				    break;
1672
			}
1673
1674
		}
1675
1676
		return $form;
1677
	}
1678
1679
1680
	/**
1681 22
	 * Process validation for a edit entry submission
1682
	 *
1683
	 * Sets the `is_valid` object var
1684
	 *
1685
	 * @return void
1686
	 */
1687
	private function validate() {
1688 22
1689 22
		/**
1690
		 * If using GF User Registration Add-on, remove the validation step, otherwise generates error when updating the entry
1691
		 * GF User Registration Add-on version > 3.x has a different class name
1692
		 * @since 1.16.2
1693
		 */
1694
		if ( class_exists( 'GF_User_Registration' ) ) {
1695
			remove_filter( 'gform_validation', array( GF_User_Registration::get_instance(), 'validate' ) );
1696
		} else  if ( class_exists( 'GFUser' ) ) {
1697
			remove_filter( 'gform_validation', array( 'GFUser', 'user_registration_validation' ) );
1698
		}
1699
1700 22
1701
		/**
1702
		 * For some crazy reason, Gravity Forms doesn't validate Edit Entry form submissions.
1703 22
		 * You can enter whatever you want!
1704 22
		 * We try validating, and customize the results using `self::custom_validation()`
1705
		 */
1706
		add_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10, 4);
1707
1708 22
		// Needed by the validate funtion
1709
		$failed_validation_page = NULL;
1710
		$field_values = RGForms::post( 'gform_field_values' );
1711 22
1712
		// Prevent entry limit from running when editing an entry, also
1713 22
		// prevent form scheduling from preventing editing
1714
		unset( $this->form['limitEntries'], $this->form['scheduleForm'] );
1715 22
1716 22
		// Hide fields depending on Edit Entry settings
1717
		$this->form['fields'] = $this->get_configured_edit_fields( $this->form, $this->view_id );
1718
1719
		$this->is_valid = GFFormDisplay::validate( $this->form, $field_values, 1, $failed_validation_page );
1720
1721
		remove_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10 );
1722
	}
1723
1724
1725
	/**
1726
	 * Make validation work for Edit Entry
1727
	 *
1728
	 * Because we're calling the GFFormDisplay::validate() in an unusual way (as a front-end
1729
	 * form pretending to be a back-end form), validate() doesn't know we _can't_ edit post
1730
	 * fields. This goes through all the fields and if they're an invalid post field, we
1731
	 * set them as valid. If there are still issues, we'll return false.
1732
	 *
1733
	 * @param  $validation_results {
1734
	 *   @type bool $is_valid
1735 22
	 *   @type array $form
1736
	 *   @type int $failed_validation_page The page number which has failed validation.
1737 22
	 * }
1738
	 *
1739 22
	 * @return array
1740
	 */
1741 22
	public function custom_validation( $validation_results ) {
1742
1743 22
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results: ', array( 'data' => $validation_results ) );
1744
1745 22
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] $_POSTed data (sanitized): ', array( 'data' => esc_html( print_r( $_POST, true ) ) ) );
1746 22
1747
		$gv_valid = true;
1748
1749 22
		foreach ( $validation_results['form']['fields'] as $key => &$field ) {
1750
1751
			$value = RGFormsModel::get_field_value( $field );
1752 22
			$field_type = RGFormsModel::get_input_type( $field );
1753 22
1754
			// Validate always
1755
			switch ( $field_type ) {
1756 2
1757
1758
				case 'fileupload' :
1759
				case 'post_image':
1760
1761
				    // in case nothing is uploaded but there are already files saved
1762 2
				    if( !empty( $field->failed_validation ) && !empty( $field->isRequired ) && !empty( $value ) ) {
1763
				        $field->failed_validation = false;
1764
				        unset( $field->validation_message );
1765
				    }
1766
1767
				    // validate if multi file upload reached max number of files [maxFiles] => 2
1768
				    if( \GV\Utils::get( $field, 'maxFiles') && \GV\Utils::get( $field, 'multipleFiles') ) {
1769
1770
				        $input_name = 'input_' . $field->id;
1771
				        //uploaded
1772
				        $file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
1773
1774
				        //existent
1775
				        $entry = $this->get_entry();
1776
				        $value = NULL;
1777
				        if( isset( $entry[ $field->id ] ) ) {
1778
				            $value = json_decode( $entry[ $field->id ], true );
1779
				        }
1780
1781
				        // count uploaded files and existent entry files
1782
				        $count_files = ( is_array( $file_names ) ? count( $file_names ) : 0 ) +
1783
						               ( is_array( $value ) ? count( $value ) : 0 );
1784
1785
				        if( $count_files > $field->maxFiles ) {
1786
				            $field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
1787
				            $field->failed_validation = 1;
1788
				            $gv_valid = false;
1789
1790
				            // in case of error make sure the newest upload files are removed from the upload input
1791 2
				            GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
1792
				        }
1793
1794
				    }
1795
1796 22
1797
				    break;
1798 1
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
return true;
2436 22
2437
		// Verify form submitted for editing single
2438
		if( $this->is_edit_entry_submission() ) {
0 ignored issues
show
Unused Code introduced by
if ($this->is_edit_entry...f::$nonce_key); } } does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
2439
			$valid = wp_verify_nonce( $_POST[ self::$nonce_field ], self::$nonce_field );
2440
		}
2441 22
2442
		// Verify
2443
		else if( ! $this->is_edit_entry() ) {
2444
			$valid = false;
2445
		}
2446
2447
		else {
2448
			$valid = wp_verify_nonce( $_GET['edit'], self::$nonce_key );
2449
		}
2450 22
2451
		/**
2452 22
		 * @filter `gravityview/edit_entry/verify_nonce` Override Edit Entry nonce validation. Return true to declare nonce valid.
2453
		 * @since 1.13
2454
		 * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
2455
		 * @param string $nonce_field Key used when validating submissions. Default: is_gv_edit_entry
2456
		 */
2457
		$valid = apply_filters( 'gravityview/edit_entry/verify_nonce', $valid, self::$nonce_field );
2458
2459
		return $valid;
2460
	}
2461
2462
2463
	/**
2464
	 * Multiselect in GF 2.2 became a json_encoded value. Fix it.
2465
	 *
2466
	 * As a hack for now we'll implode it back.
2467
	 */
2468
	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...
2469
		if ( empty ( $field->storageType ) || $field->storageType != 'json' ) {
2470
			return $field_value;
2471
		}
2472
2473
		$maybe_json = @json_decode( $field_value, true );
2474
2475
		if ( $maybe_json ) {
2476
			return implode( ',', $maybe_json );
2477
		}
2478
2479
		return $field_value;
2480
	}
2481
2482
2483
2484
} //end class
2485