Completed
Push — develop ( 90f758...c778a7 )
by Zack
13:25
created

GravityView_Edit_Entry_Render::save_field_value()   B

Complexity

Conditions 6
Paths 5

Size

Total Lines 23
Code Lines 11

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 8
CRAP Score 6.73

Importance

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

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

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

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

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

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

class A {
    var $property;
}

the property is implicitly global.

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

Loading history...
27
28
	/**
29
	 * @since 1.9
30
	 * @var string String used for check valid edit entry form submission. Allows saving edit form values.
31
	 */
32
	private static $nonce_field = 'is_gv_edit_entry';
33
34
	/**
35
	 * @since 1.9
36
	 * @var bool Whether to allow save and continue functionality
37
	 */
38
	private static $supports_save_and_continue = false;
39
40
	/**
41
	 * Gravity Forms entry array
42
	 *
43
	 * @var array
44
	 */
45
	public $entry;
46
47
	/**
48
	 * Gravity Forms entry array (it won't get changed during this class lifecycle)
49
	 * @since 1.17.2
50
	 * @var array
51
	 */
52
	private static $original_entry = array();
53
54
	/**
55
	 * Gravity Forms form array (GravityView modifies the content through this class lifecycle)
56
	 *
57
	 * @var array
58
	 */
59
	public $form;
60
61
	/**
62
	 * Gravity Forms form array (it won't get changed during this class lifecycle)
63
	 * @since 1.16.2.1
64
	 * @var array
65
	 */
66
	private static $original_form;
67
68
	/**
69
	 * Gravity Forms form array after the form validation process
70
	 * @since 1.13
71
	 * @var array
72
	 */
73
	public $form_after_validation = null;
74
75
	/**
76
	 * Hold an array of GF field objects that have calculation rules
77
	 * @var array
78
	 */
79
	public $fields_with_calculation = array();
80
81
	/**
82
	 * Gravity Forms form id
83
	 *
84
	 * @var int
85
	 */
86
	public $form_id;
87
88
	/**
89
	 * ID of the current view
90
	 *
91
	 * @var int
92
	 */
93
	public $view_id;
94
95
	/**
96
	 * Updated entry is valid (GF Validation object)
97
	 *
98
	 * @var array
99
	 */
100
	public $is_valid = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
101
102 3
	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...
103 3
		$this->loader = $loader;
104 3
	}
105
106 3
	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...
107
108
		/** @define "GRAVITYVIEW_DIR" "../../../" */
109 3
		include_once( GRAVITYVIEW_DIR .'includes/class-admin-approve-entries.php' );
110
111
		// Don't display an embedded form when editing an entry
112 3
		add_action( 'wp_head', array( $this, 'prevent_render_form' ) );
113 3
		add_action( 'wp_footer', array( $this, 'prevent_render_form' ) );
114
115
		// Stop Gravity Forms processing what is ours!
116 3
		add_filter( 'wp', array( $this, 'prevent_maybe_process_form'), 8 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
117
118 3
		add_filter( 'gravityview_is_edit_entry', array( $this, 'is_edit_entry') );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
119
120 3
		add_action( 'gravityview_edit_entry', array( $this, 'init' ) );
121
122
		// Disable conditional logic if needed (since 1.9)
123 3
		add_filter( 'gform_has_conditional_logic', array( $this, 'manage_conditional_logic' ), 10, 2 );
124
125
		// Make sure GF doesn't validate max files (since 1.9)
126 3
		add_filter( 'gform_plupload_settings', array( $this, 'modify_fileupload_settings' ), 10, 3 );
127
128
		// Add fields expected by GFFormDisplay::validate()
129 3
		add_filter( 'gform_pre_validation', array( $this, 'gform_pre_validation') );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
130
131
		// Fix multiselect value for GF 2.2
132 3
		add_filter( 'gravityview/edit_entry/field_value_multiselect', array( $this, 'fix_multiselect_value_serialization' ), 10, 3 );
133 3
	}
134
135
	/**
136
	 * Don't show any forms embedded on a page when GravityView is in Edit Entry mode
137
	 *
138
	 * Adds a `__return_empty_string` filter on the Gravity Forms shortcode on the `wp_head` action
139
	 * And then removes it on the `wp_footer` action
140
	 *
141
	 * @since 1.16.1
142
	 *
143
	 * @return void
144
	 */
145 1
	public function prevent_render_form() {
146 1
		if( $this->is_edit_entry() ) {
147 1
			if( 'wp_head' === current_filter() ) {
148 1
				add_filter( 'gform_shortcode_form', '__return_empty_string' );
149
			} else {
150 1
				remove_filter( 'gform_shortcode_form', '__return_empty_string' );
151
			}
152
		}
153 1
	}
154
155
	/**
156
	 * Because we're mimicking being a front-end Gravity Forms form while using a Gravity Forms
157
	 * backend form, we need to prevent them from saving twice.
158
	 * @return void
159
	 */
160
	public function prevent_maybe_process_form() {
161
162
		if( ! empty( $_POST ) ) {
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
163
			do_action( 'gravityview_log_debug', 'GravityView_Edit_Entry[prevent_maybe_process_form] $_POSTed data (sanitized): ', esc_html( print_r( $_POST, true ) ) );
0 ignored issues
show
introduced by
The use of function print_r() is discouraged
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
164
		}
165
166
		if( $this->is_edit_entry_submission() ) {
167
			remove_action( 'wp',  array( 'RGForms', 'maybe_process_form'), 9 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
168
			remove_action( 'wp',  array( 'GFForms', 'maybe_process_form'), 9 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
169
		}
170
	}
171
172
	/**
173
	 * Is the current page an Edit Entry page?
174
	 * @return boolean
175
	 */
176 4
	public function is_edit_entry() {
177
178 4
		$is_edit_entry = GravityView_frontend::is_single_entry() && ! empty( $_GET['edit'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
179
180 4
		return ( $is_edit_entry || $this->is_edit_entry_submission() );
181
	}
182
183
	/**
184
	 * Is the current page an Edit Entry page?
185
	 * @since 1.9
186
	 * @return boolean
187
	 */
188 3
	public function is_edit_entry_submission() {
189 3
		return !empty( $_POST[ self::$nonce_field ] );
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
190
	}
191
192
	/**
193
	 * When Edit entry view is requested setup the vars
194
	 */
195 3
	private function setup_vars() {
196 3
		$gravityview_view = GravityView_View::getInstance();
197
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
198
199 3
		$entries = $gravityview_view->getEntries();
200 3
		self::$original_entry = $entries[0];
201 3
		$this->entry = $entries[0];
202
203 3
		self::$original_form = $gravityview_view->getForm();
204 3
		$this->form = $gravityview_view->getForm();
205 3
		$this->form_id = $gravityview_view->getFormId();
206 3
		$this->view_id = $gravityview_view->getViewId();
207
208 3
		self::$nonce_key = GravityView_Edit_Entry::get_nonce_key( $this->view_id, $this->form_id, $this->entry['id'] );
209 3
	}
210
211
212
	/**
213
	 * Load required files and trigger edit flow
214
	 *
215
	 * Run when the is_edit_entry returns true.
216
	 *
217
	 * @param GravityView_View_Data $gv_data GravityView Data object
218
	 * @return void
219
	 */
220 4
	public function init( $gv_data ) {
221
222 4
		require_once( GFCommon::get_base_path() . '/form_display.php' );
223 4
		require_once( GFCommon::get_base_path() . '/entry_detail.php' );
224
225 4
		$this->setup_vars();
226
227
		// Multiple Views embedded, don't proceed if nonce fails
228 4
		$multiple_views = defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ? gravityview()->views->count() > 1 : $gv_data->has_multiple_views();
0 ignored issues
show
Documentation introduced by
The property views does not exist on object<GV\Core>. 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...
Deprecated Code introduced by
The method GravityView_View_Data::has_multiple_views() has been deprecated.

This method has been deprecated.

Loading history...
229 4
		if( $multiple_views && ! wp_verify_nonce( $_GET['edit'], self::$nonce_key ) ) {
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-validated input variable: $_GET
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_GET
Loading history...
230
			do_action('gravityview_log_error', __METHOD__ . ': Nonce validation failed for the Edit Entry request; returning' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
231
			return;
232
		}
233
234
		// Sorry, you're not allowed here.
235 4
		if( false === $this->user_can_edit_entry( true ) ) {
236 1
			do_action('gravityview_log_error', __METHOD__ . ': User is not allowed to edit this entry; returning', $this->entry );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
237 1
			return;
238
		}
239
240 4
		$this->print_scripts();
241
242 4
		$this->process_save();
243
244 4
		$this->edit_entry_form();
245
246 4
	}
247
248
249
	/**
250
	 * Force Gravity Forms to output scripts as if it were in the admin
251
	 * @return void
252
	 */
253 3
	private function print_scripts() {
254 3
		$gravityview_view = GravityView_View::getInstance();
255
256 3
		wp_register_script( 'gform_gravityforms', GFCommon::get_base_url().'/js/gravityforms.js', array( 'jquery', 'gform_json', 'gform_placeholder', 'sack', 'plupload-all', 'gravityview-fe-view' ) );
257
258 3
		GFFormDisplay::enqueue_form_scripts($gravityview_view->getForm(), false);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
259
260
		// Sack is required for images
261 3
		wp_print_scripts( array( 'sack', 'gform_gravityforms' ) );
262 3
	}
263
264
265
	/**
266
	 * Process edit entry form save
267
	 */
268 4
	private function process_save() {
269
270 4
		if( empty( $_POST ) || ! isset( $_POST['lid'] ) ) {
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
271 4
			return;
272
		}
273
274
		// Make sure the entry, view, and form IDs are all correct
275 4
		$valid = $this->verify_nonce();
276
277 4
		if( !$valid ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
278
			do_action('gravityview_log_error', __METHOD__ . ' Nonce validation failed.' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
279
			return;
280
		}
281
282 4
		if( $this->entry['id'] !== $_POST['lid'] ) {
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_POST
Loading history...
283
			do_action('gravityview_log_error', __METHOD__ . ' Entry ID did not match posted entry ID.' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
284
			return;
285
		}
286
287 4
		do_action('gravityview_log_debug', __METHOD__ . ': $_POSTed data (sanitized): ', esc_html( print_r( $_POST, true ) ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
introduced by
The use of function print_r() is discouraged
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
288
289 4
		$this->process_save_process_files( $this->form_id );
290
291 4
		$this->validate();
292
293 4
		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...
294
295 4
			do_action('gravityview_log_debug', __METHOD__ . ': Submission is valid.' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
296
297
			/**
298
			 * @hack This step is needed to unset the adminOnly from form fields, to add the calculation fields
299
			 */
300 4
			$form = $this->form_prepare_for_save();
301
302
			/**
303
			 * @hack to avoid the capability validation of the method save_lead for GF 1.9+
304
			 */
305 4
			unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
306
307 4
			$date_created = $this->entry['date_created'];
308
309
			/**
310
			 * @hack to force Gravity Forms to use $read_value_from_post in GFFormsModel::save_lead()
311
			 * @since 1.17.2
312
			 */
313 4
			unset( $this->entry['date_created'] );
314
315 4
			GFFormsModel::save_lead( $form, $this->entry );
316
317
			// Delete the values for hidden inputs
318 4
			$this->unset_hidden_field_values();
319
			
320 4
			$this->entry['date_created'] = $date_created;
321
322
			// Process calculation fields
323 4
			$this->update_calculation_fields();
324
325
			// Perform actions normally performed after updating a lead
326 4
			$this->after_update();
327
328
			/**
329
			 * Must be AFTER after_update()!
330
			 * @see https://github.com/gravityview/GravityView/issues/764
331
			 */
332 4
			$this->maybe_update_post_fields( $form );
333
334
			/**
335
			 * @action `gravityview/edit_entry/after_update` Perform an action after the entry has been updated using Edit Entry
336
			 * @param array $form Gravity Forms form array
337
			 * @param string $entry_id Numeric ID of the entry that was updated
338
			 * @param GravityView_Edit_Entry_Render $this This object
339
			 */
340 4
			do_action( 'gravityview/edit_entry/after_update', $this->form, $this->entry['id'], $this );
341
342
		} else {
343
			do_action('gravityview_log_error', __METHOD__ . ': Submission is NOT valid.', $this->entry );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
344
		}
345
346 4
	} // process_save
347
348
	/**
349
	 * Delete the value of fields hidden by conditional logic when the entry is edited
350
	 *
351
	 * @uses GFFormsModel::update_lead_field_value()
352
	 *
353
	 * @since 1.17.4
354
	 *
355
	 * @return void
356
	 */
357 3
	private function unset_hidden_field_values() {
358 3
		global $wpdb;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
359
360
		/**
361
		 * @filter `gravityview/edit_entry/unset_hidden_field_values` Whether to delete values of fields hidden by conditional logic
362
         * @since 1.22.2
363
         * @param bool $unset_hidden_field_values Default: true
364
         * @param GravityView_Edit_Entry_Render $this This object
365
		 */
366 3
		$unset_hidden_field_values = apply_filters( 'gravityview/edit_entry/unset_hidden_field_values', true, $this );
367
368 3
		if( ! $unset_hidden_field_values ) {
369
			return;
370
		}
371
372 3
		if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) ) {
373
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
374
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT meta_key, meta_value FROM $entry_meta_table WHERE entry_id=%d", $this->entry['id'] ) );
0 ignored issues
show
introduced by
Usage of a direct database call is discouraged.
Loading history...
introduced by
Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set.
Loading history...
375
		} else {
376 3
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
377 3
			$current_fields = $wpdb->get_results( $wpdb->prepare( "SELECT id, field_number FROM $lead_detail_table WHERE lead_id=%d", $this->entry['id'] ) );
0 ignored issues
show
introduced by
Usage of a direct database call is discouraged.
Loading history...
introduced by
Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set.
Loading history...
378
		}
379
380 3
		foreach ( $this->entry as $input_id => $field_value ) {
381
382 3
			$field = RGFormsModel::get_field( $this->form, $input_id );
383
384
			// Reset fields that are hidden
385
			// Don't pass $entry as fourth parameter; force using $_POST values to calculate conditional logic
386 3
			if ( GFFormsModel::is_field_hidden( $this->form, $field, array(), NULL ) ) {
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
387
388
				// List fields are stored as empty arrays when empty
389
				$empty_value = $this->is_field_json_encoded( $field ) ? '[]' : '';
390
391
				$lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
392
393
				GFFormsModel::update_lead_field_value( $this->form, $this->entry, $field, $lead_detail_id, $input_id, $empty_value );
394
395
				// Prevent the $_POST values of hidden fields from being used as default values when rendering the form
396
				// after submission
397
				$post_input_id = 'input_' . str_replace( '.', '_', $input_id );
398 3
				$_POST[ $post_input_id ] = '';
399
			}
400
		}
401 3
	}
402
403
	/**
404
	 * Have GF handle file uploads
405
	 *
406
	 * Copy of code from GFFormDisplay::process_form()
407
	 *
408
	 * @param int $form_id
409
	 */
410 3
	private function process_save_process_files( $form_id ) {
411
412
		//Loading files that have been uploaded to temp folder
413 3
		$files = GFCommon::json_decode( stripslashes( RGForms::post( 'gform_uploaded_files' ) ) );
414 3
		if ( ! is_array( $files ) ) {
415 2
			$files = array();
416
		}
417
418
		/**
419
		 * Make sure the fileuploads are not overwritten if no such request was done.
420
		 * @since 1.20.1
421
		 */
422 3
		add_filter( "gform_save_field_value_$form_id", array( $this, 'save_field_value' ), 99, 5 );
423
424 3
		RGFormsModel::$uploaded_files[ $form_id ] = $files;
425 3
	}
426
427
	/**
428
	 * Make sure the fileuploads are not overwritten if no such request was done.
429
	 *
430
	 * TO ONLY BE USED INTERNALLY; DO NOT DEVELOP ON; MAY BE REMOVED AT ANY TIME.
431
	 *
432
	 * @since 1.20.1
433
	 *
434
	 * @param string $value Field value
435
	 * @param array $entry GF entry array
436
	 * @param GF_Field_FileUpload $field
437
	 * @param array $form GF form array
438
	 * @param string $input_id ID of the input being saved
439
	 *
440
	 * @return string
441
	 */
442 3
	public function save_field_value( $value = '', $entry = array(), $field = null, $form = array(), $input_id = '' ) {
443
444 3
		if ( ! $field || $field->type != 'fileupload' ) {
0 ignored issues
show
introduced by
Found "!= '". Use Yoda Condition checks, you must
Loading history...
445 3
			return $value;
446
		}
447
448 1
		$input_name = 'input_' . str_replace( '.', '_', $input_id );
449
450 1
		if ( $field->multipleFiles ) {
451
			if ( empty( $value ) ) {
452
				return json_decode( $entry[ $input_id ], true );
453
			}
454
			return $value;
455
		}
456
457
		/** No file is being uploaded. */
458 1
		if ( empty( $_FILES[ $input_name ]['name'] ) ) {
459
			/** So return the original upload */
460 1
			return $entry[ $input_id ];
461
		}
462
463 1
		return $value;
464
	}
465
466
	/**
467
	 * Remove max_files validation (done on gravityforms.js) to avoid conflicts with GravityView
468
	 * Late validation done on self::custom_validation
469
	 *
470
	 * @param $plupload_init array Plupload settings
471
	 * @param $form_id
472
	 * @param $instance
473
	 * @return mixed
474
	 */
475 1
	public function modify_fileupload_settings( $plupload_init, $form_id, $instance ) {
0 ignored issues
show
Unused Code introduced by
The parameter $form_id is not used and could be removed.

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

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

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

Loading history...
476 1
		if( ! $this->is_edit_entry() ) {
477
			return $plupload_init;
478
		}
479
480 1
		$plupload_init['gf_vars']['max_files'] = 0;
481
482 1
		return $plupload_init;
483
	}
484
485
486
	/**
487
	 * Unset adminOnly and convert field input key to string
488
	 * @return array $form
489
	 */
490 3
	private function form_prepare_for_save() {
491
492 3
		$form = $this->form;
493
494
		/** @var GF_Field $field */
495 3
		foreach( $form['fields'] as $k => &$field ) {
496
497
			/**
498
			 * Remove the fields with calculation formulas before save to avoid conflicts with GF logic
499
			 * @since 1.16.3
500
			 * @var GF_Field $field
501
			 */
502 3
			if( $field->has_calculation() ) {
503
				unset( $form['fields'][ $k ] );
504
			}
505
506 3
			$field->adminOnly = false;
507
508 3
			if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
509
				foreach( $field->inputs as $key => $input ) {
510 3
					$field->inputs[ $key ][ 'id' ] = (string)$input['id'];
0 ignored issues
show
introduced by
Array keys should NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
511
				}
512
			}
513
		}
514
515 3
		return $form;
516
	}
517
518 3
	private function update_calculation_fields() {
519
520 3
		$form = self::$original_form;
521 3
		$update = false;
522
523
		// get the most up to date entry values
524 3
		$entry = GFAPI::get_entry( $this->entry['id'] );
525
526 3
		if( !empty( $this->fields_with_calculation ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
527
			$update = true;
528
			foreach ( $this->fields_with_calculation as $calc_field ) {
529
				$inputs = $calc_field->get_entry_inputs();
530
				if ( is_array( $inputs ) ) {
531
					foreach ( $inputs as $input ) {
532
						$input_name = 'input_' . str_replace( '.', '_', $input['id'] );
533
						list( $prefix, $field_id, $input_id ) = rgexplode( '_', $input_name, 3 );
534
535
						switch ( $input_id ) {
536
							case 1:
537
								/** Never void the labels. */
538
								$value = $entry[ $input['id'] ];
539
								break;
540
							case 2:
541
								/** Always recalcualte the final price. */
542
								$value = '';
543
								break;
544
							case 3:
545
								/** Fetch the quantity form the request. */
546
								$value = rgpost( $input_name, $entry[ $input['id'] ] );
547
								break;
548
						}
549
550
						$entry[ strval( $input['id'] ) ] = RGFormsModel::prepare_value( $form, $calc_field, $value, $input_name, $entry['id'], $entry );
0 ignored issues
show
Bug introduced by
The variable $value 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...
551
					}
552
				} else {
553
					$input_name = 'input_' . str_replace( '.', '_', $calc_field->id);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
554
					$entry[ strval( $calc_field->id ) ] = RGFormsModel::prepare_value( $form, $calc_field, '', $input_name, $entry['id'], $entry );
555
				}
556
			}
557
558
		}
559
560 3
		if( $update ) {
561
562
			$return_entry = GFAPI::update_entry( $entry );
563
564
			if( is_wp_error( $return_entry ) ) {
565
				do_action( 'gravityview_log_error', 'Updating the entry calculation fields failed', $return_entry );
566
			} else {
567
				do_action( 'gravityview_log_debug', 'Updating the entry calculation fields succeeded' );
568
			}
569
		}
570 3
	}
571
572
	/**
573
	 * Handle updating the Post Image field
574
	 *
575
	 * Sets a new Featured Image if configured in Gravity Forms; otherwise uploads/updates media
576
	 *
577
	 * @since 1.17
578
	 *
579
	 * @uses GFFormsModel::media_handle_upload
580
	 * @uses set_post_thumbnail
581
	 * 
582
	 * @param array $form GF Form array
583
	 * @param GF_Field $field GF Field
584
	 * @param string $field_id Numeric ID of the field
585
	 * @param string $value
586
	 * @param array $entry GF Entry currently being edited
587
	 * @param int $post_id ID of the Post being edited
588
	 *
589
	 * @return mixed|string
590
	 */
591 1
	private function update_post_image( $form, $field, $field_id, $value, $entry, $post_id ) {
592
593 1
		$input_name = 'input_' . $field_id;
594
595 1
		if ( !empty( $_FILES[ $input_name ]['name'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
596
597
			// We have a new image
598
599
			$value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
600
601
			$ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
602
			$img_url = rgar( $ary, 0 );
603
604
			$img_title	   = count( $ary ) > 1 ? $ary[1] : '';
605
			$img_caption	 = count( $ary ) > 2 ? $ary[2] : '';
606
			$img_description = count( $ary ) > 3 ? $ary[3] : '';
607
608
			$image_meta = array(
609
				'post_excerpt' => $img_caption,
610
				'post_content' => $img_description,
611
			);
612
613
			//adding title only if it is not empty. It will default to the file name if it is not in the array
614
			if ( ! empty( $img_title ) ) {
615
				$image_meta['post_title'] = $img_title;
616
			}
617
618
			/**
619
			 * 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.
620
			 * Note: the method became public in GF 1.9.17.7, but we don't require that version yet.
621
			 */
622
			require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
623
			$media_id = GravityView_GFFormsModel::media_handle_upload( $img_url, $post_id, $image_meta );
624
625
			// is this field set as featured image?
626
			if ( $media_id && $field->postFeaturedImage ) {
627
				set_post_thumbnail( $post_id, $media_id );
628
			}
629
630 1
		} elseif ( !empty( $_POST[ $input_name ] ) && is_array( $value ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
631
632 1
			$img_url = $_POST[ $input_name ];
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_POST
Loading history...
633
634 1
			$img_title	   = rgar( $_POST, $input_name.'_1' );
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
635 1
			$img_caption	 = rgar( $_POST, $input_name .'_4' );
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
636 1
			$img_description = rgar( $_POST, $input_name .'_7' );
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
637
638 1
			$value = ! empty( $img_url ) ? $img_url . "|:|" . $img_title . "|:|" . $img_caption . "|:|" . $img_description : '';
0 ignored issues
show
Coding Style Comprehensibility introduced by
The string literal |:| does not require double quotes, as per coding-style, please use single quotes.

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

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

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

<?php

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

print $doubleQuoted;

will print an indented: Single is Value

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

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

Loading history...
639
640 1
			if ( $field->postFeaturedImage ) {
641
642
				$image_meta = array(
643 1
					'ID' => get_post_thumbnail_id( $post_id ),
644 1
					'post_title' => $img_title,
645 1
					'post_excerpt' => $img_caption,
646 1
					'post_content' => $img_description,
647
				);
648
649
				// update image title, caption or description
650 1
				wp_update_post( $image_meta );
651
			}
652
		} else {
653
654
			// if we get here, image was removed or not set.
655
			$value = '';
656
657
			if ( $field->postFeaturedImage ) {
658
				delete_post_thumbnail( $post_id );
659
			}
660
		}
661
662 1
		return $value;
663
	}
664
665
	/**
666
	 * Loop through the fields being edited and if they include Post fields, update the Entry's post object
667
	 *
668
	 * @param array $form Gravity Forms form
669
	 *
670
	 * @return void
671
	 */
672 3
	private function maybe_update_post_fields( $form ) {
673
674 3
		if( empty( $this->entry['post_id'] ) ) {
675 2
			do_action( 'gravityview_log_debug', __METHOD__ . ': This entry has no post fields. Continuing...' );
676 2
			return;
677
		}
678
679 1
		$post_id = $this->entry['post_id'];
680
681
		// Security check
682 1
		if( false === GVCommon::has_cap( 'edit_post', $post_id ) ) {
683
			do_action( 'gravityview_log_error', 'The current user does not have the ability to edit Post #'.$post_id );
684
			return;
685
		}
686
687 1
		$update_entry = false;
688
689 1
		$updated_post = $original_post = get_post( $post_id );
690
691 1
		foreach ( $this->entry as $field_id => $value ) {
692
693 1
			$field = RGFormsModel::get_field( $form, $field_id );
694
695 1
			if( ! $field ) {
696 1
				continue;
697
			}
698
699 1
			if( GFCommon::is_post_field( $field ) && 'post_category' !== $field->type ) {
700
701
				// Get the value of the field, including $_POSTed value
702 1
				$value = RGFormsModel::get_field_value( $field );
703
704
				// Use temporary entry variable, to make values available to fill_post_template() and update_post_image()
705 1
				$entry_tmp = $this->entry;
706 1
				$entry_tmp["{$field_id}"] = $value;
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
707
708 1
				switch( $field->type ) {
709
710 1
					case 'post_title':
711
						$post_title = $value;
712
						if( rgar( $form, 'postTitleTemplateEnabled' ) ) {
713
							$post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
714
						}
715
						$updated_post->post_title = $post_title;
716
						$updated_post->post_name  = $post_title;
717
						unset( $post_title );
718
						break;
719
720 1
					case 'post_content':
721
						$post_content = $value;
722
						if( rgar( $form, 'postContentTemplateEnabled' ) ) {
723
							$post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
724
						}
725
						$updated_post->post_content = $post_content;
726
						unset( $post_content );
727
						break;
728 1
					case 'post_excerpt':
729
						$updated_post->post_excerpt = $value;
730
						break;
731 1
					case 'post_tags':
732
						wp_set_post_tags( $post_id, $value, false );
733
						break;
734 1
					case 'post_category':
735
						break;
736 1
					case 'post_custom_field':
737
						if ( is_array( $value ) && ( floatval( $field_id ) !== floatval( $field->id ) ) ) {
738
							$value = $value[ $field_id ];
739
						}
740
741
						if( ! empty( $field->customFieldTemplateEnabled ) ) {
742
							$value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
743
						}
744
745
						if ( $this->is_field_json_encoded( $field ) && ! is_string( $value ) ) {
746
							$value = function_exists('wp_json_encode') ? wp_json_encode( $value ) : json_encode( $value );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
747
						}
748
749
						update_post_meta( $post_id, $field->postCustomFieldName, $value );
750
						break;
751
752 1
					case 'post_image':
753 1
						$value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
754 1
						break;
755
756
				}
757
758
				// update entry after
759 1
				$this->entry["{$field_id}"] = $value;
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
760
761 1
				$update_entry = true;
762
763 1
				unset( $entry_tmp );
764
			}
765
766
		}
767
768 1
		if( $update_entry ) {
769
770 1
			$return_entry = GFAPI::update_entry( $this->entry );
771
772 1
			if( is_wp_error( $return_entry ) ) {
773
			   do_action( 'gravityview_log_error', 'Updating the entry post fields failed', array( '$this->entry' => $this->entry, '$return_entry' => $return_entry ) );
774
			} else {
775 1
				do_action( 'gravityview_log_debug', 'Updating the entry post fields for post #'.$post_id.' succeeded' );
776
			}
777
778
		}
779
780 1
		$return_post = wp_update_post( $updated_post, true );
781
782 1
		if( is_wp_error( $return_post ) ) {
783
			$return_post->add_data( $updated_post, '$updated_post' );
784
			do_action( 'gravityview_log_error', 'Updating the post content failed', compact( 'updated_post', 'return_post' ) );
785
		} else {
786 1
			do_action( 'gravityview_log_debug', 'Updating the post content for post #'.$post_id.' succeeded', $updated_post );
787
		}
788 1
	}
789
790
	/**
791
	 * Is the field stored in a JSON-encoded manner?
792
	 *
793
	 * @param GF_Field $field
794
	 *
795
	 * @return bool True: stored in DB json_encode()'d; False: not encoded
796
	 */
797
	private function is_field_json_encoded( $field ) {
798
799
		$json_encoded = false;
800
801
		$input_type = RGFormsModel::get_input_type( $field );
802
803
		// Only certain custom field types are supported
804
		switch( $input_type ) {
805
			case 'fileupload':
806
			case 'list':
807
			case 'multiselect':
808
				$json_encoded = true;
809
				break;
810
		}
811
812
		return $json_encoded;
813
	}
814
815
	/**
816
	 * Convert a field content template into prepared output
817
	 *
818
	 * @uses GravityView_GFFormsModel::get_post_field_images()
819
	 *
820
	 * @since 1.17
821
	 *
822
	 * @param string $template The content template for the field
823
	 * @param array $form Gravity Forms form
824
	 * @param bool $do_shortcode Whether to process shortcode inside content. In GF, only run on Custom Field and Post Content fields
825
	 *
826
	 * @return string
827
	 */
828
	private function fill_post_template( $template, $form, $entry, $do_shortcode = false ) {
829
830
		require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
831
832
		$post_images = GravityView_GFFormsModel::get_post_field_images( $form, $entry );
833
834
		//replacing post image variables
835
		$output = GFCommon::replace_variables_post_image( $template, $post_images, $entry );
836
837
		//replacing all other variables
838
		$output = GFCommon::replace_variables( $output, $form, $entry, false, false, false );
839
840
		// replace conditional shortcodes
841
		if( $do_shortcode ) {
842
			$output = do_shortcode( $output );
843
		}
844
845
		return $output;
846
	}
847
848
849
	/**
850
	 * Perform actions normally performed after updating a lead
851
	 *
852
	 * @since 1.8
853
	 *
854
	 * @see GFEntryDetail::lead_detail_page()
855
	 *
856
	 * @return void
857
	 */
858 3
	private function after_update() {
859
860 3
		do_action( 'gform_after_update_entry', $this->form, $this->entry['id'], self::$original_entry );
861 3
		do_action( "gform_after_update_entry_{$this->form['id']}", $this->form, $this->entry['id'], self::$original_entry );
862
863
		// Re-define the entry now that we've updated it.
864 3
		$entry = RGFormsModel::get_lead( $this->entry['id'] );
865
866 3
		$entry = GFFormsModel::set_entry_meta( $entry, $this->form );
867
868 3
		if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '<' ) ) {
869
			// We need to clear the cache because Gravity Forms caches the field values, which
870
			// we have just updated.
871 3
			foreach ($this->form['fields'] as $key => $field) {
0 ignored issues
show
introduced by
No space after opening parenthesis is prohibited
Loading history...
introduced by
No space before closing parenthesis is prohibited
Loading history...
872 3
				GFFormsModel::refresh_lead_field_value( $entry['id'], $field->id );
873
			}
874
		}
875
876 3
		$this->entry = $entry;
877 3
	}
878
879
880
	/**
881
	 * Display the Edit Entry form
882
	 *
883
	 * @return void
884
	 */
885 3
	public function edit_entry_form() {
886
887
		?>
888
889
		<div class="gv-edit-entry-wrapper"><?php
890
891 3
			$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...
892
893
			/**
894
			 * Fixes weird wpautop() issue
895
			 * @see https://github.com/katzwebservices/GravityView/issues/451
896
			 */
897 3
			echo gravityview_strip_whitespace( $javascript );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'gravityview_strip_whitespace'
Loading history...
898
899
			?><h2 class="gv-edit-entry-title">
900
				<span><?php
901
902
					/**
903
					 * @filter `gravityview_edit_entry_title` Modify the edit entry title
904
					 * @param string $edit_entry_title Modify the "Edit Entry" title
905
					 * @param GravityView_Edit_Entry_Render $this This object
906
					 */
907 3
					$edit_entry_title = apply_filters('gravityview_edit_entry_title', __('Edit Entry', 'gravityview'), $this );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
908
909 3
					echo esc_attr( $edit_entry_title );
910
			?></span>
911
			</h2>
912
913
			<?php $this->maybe_print_message(); ?>
914
915
			<?php // The ID of the form needs to be `gform_{form_id}` for the pluploader ?>
916
917
			<form method="post" id="gform_<?php echo $this->form_id; ?>" enctype="multipart/form-data">
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$this'
Loading history...
918
919
				<?php
920
921 3
				wp_nonce_field( self::$nonce_key, self::$nonce_key );
922
923 3
				wp_nonce_field( self::$nonce_field, self::$nonce_field, false );
924
925
				// Print the actual form HTML
926 3
				$this->render_edit_form();
927
928
				?>
929 3
			</form>
930
931
			<script>
932
				gform.addFilter('gform_reset_pre_conditional_logic_field_action', function ( reset, formId, targetId, defaultValues, isInit ) {
933
					return false;
934
				});
935
			</script>
936
937
		</div>
938
939
	<?php
940 3
	}
941
942
	/**
943
	 * Display success or error message if the form has been submitted
944
	 *
945
	 * @uses GVCommon::generate_notice
946
	 *
947
	 * @since 1.16.2.2
948
	 *
949
	 * @return void
950
	 */
951 3
	private function maybe_print_message() {
952
953 3
		if( rgpost('action') === 'update' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
954
955
			$back_link = esc_url( remove_query_arg( array( 'page', 'view', 'edit' ) ) );
956
957
			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...
958
959
				// Keeping this compatible with Gravity Forms.
960
				$validation_message = "<div class='validation_error'>" . __('There was a problem with your submission.', 'gravityview') . " " . __('Errors have been highlighted below.', 'gravityview') . "</div>";
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
Coding Style Comprehensibility introduced by
The string literal does not require double quotes, as per coding-style, please use single quotes.

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

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

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

<?php

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

print $doubleQuoted;

will print an indented: Single is Value

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

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

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

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

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

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

<?php

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

print $doubleQuoted;

will print an indented: Single is Value

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

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

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

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

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

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

<?php

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

print $doubleQuoted;

will print an indented: Single is Value

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

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

Loading history...
962
963
				echo GVCommon::generate_notice( $message , 'gv-error' );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
964
965
			} else {
966
				$entry_updated_message = sprintf( esc_attr__('Entry Updated. %sReturn to Entry%s', 'gravityview'), '<a href="'. $back_link .'">', '</a>' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
967
968
				/**
969
				 * @filter `gravityview/edit_entry/success` Modify the edit entry success message (including the anchor link)
970
				 * @since 1.5.4
971
				 * @param string $entry_updated_message Existing message
972
				 * @param int $view_id View ID
973
				 * @param array $entry Gravity Forms entry array
974
				 * @param string $back_link URL to return to the original entry. @since 1.6
975
				 */
976
				$message = apply_filters( 'gravityview/edit_entry/success', $entry_updated_message , $this->view_id, $this->entry, $back_link );
977
978
				echo GVCommon::generate_notice( $message );
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
979
			}
980
981
		}
982 3
	}
983
984
	/**
985
	 * Display the Edit Entry form in the original Gravity Forms format
986
	 *
987
	 * @since 1.9
988
	 *
989
	 * @return void
990
	 */
991 3
	private function render_edit_form() {
992
993
		/**
994
		 * @action `gravityview/edit-entry/render/before` Before rendering the Edit Entry form
995
		 * @since 1.17
996
		 * @param GravityView_Edit_Entry_Render $this
997
		 */
998 3
		do_action( 'gravityview/edit-entry/render/before', $this );
999
1000 3
		add_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields'), 5000, 3 );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
1001 3
		add_filter( 'gform_submit_button', array( $this, 'render_form_buttons') );
0 ignored issues
show
introduced by
No space before closing parenthesis of array is bad style
Loading history...
1002 3
		add_filter( 'gform_disable_view_counter', '__return_true' );
1003
1004 3
		add_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5, 5 );
1005 3
		add_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10, 5 );
1006
1007
		// We need to remove the fake $_GET['page'] arg to avoid rendering form as if in admin.
1008 3
		unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
1009
1010
		// TODO: Verify multiple-page forms
1011
1012 3
		ob_start(); // Prevent PHP warnings possibly caused by prefilling list fields for conditional logic
1013
1014 3
		$html = GFFormDisplay::get_form( $this->form['id'], false, false, true, $this->entry );
1015
1016 3
		ob_get_clean();
1017
1018 3
		remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
1019 3
		remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
1020 3
		remove_filter( 'gform_disable_view_counter', '__return_true' );
1021 3
		remove_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5 );
1022 3
		remove_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10 );
1023
1024 3
		echo $html;
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$html'
Loading history...
1025
1026
		/**
1027
		 * @action `gravityview/edit-entry/render/after` After rendering the Edit Entry form
1028
		 * @since 1.17
1029
		 * @param GravityView_Edit_Entry_Render $this
1030
		 */
1031 3
		do_action( 'gravityview/edit-entry/render/after', $this );
1032 3
	}
1033
1034
	/**
1035
	 * Display the Update/Cancel/Delete buttons for the Edit Entry form
1036
	 * @since 1.8
1037
	 * @return string
1038
	 */
1039 3
	public function render_form_buttons() {
1040 3
		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...
1041
	}
1042
1043
1044
	/**
1045
	 * Modify the form fields that are shown when using GFFormDisplay::get_form()
1046
	 *
1047
	 * By default, all fields will be shown. We only want the Edit Tab configured fields to be shown.
1048
	 *
1049
	 * @param array $form
1050
	 * @param boolean $ajax Whether in AJAX mode
1051
	 * @param array|string $field_values Passed parameters to the form
1052
	 *
1053
	 * @since 1.9
1054
	 *
1055
	 * @return array Modified form array
1056
	 */
1057 3
	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...
1058
1059
		// In case we have validated the form, use it to inject the validation results into the form render
1060 3
		if( isset( $this->form_after_validation ) ) {
1061 3
			$form = $this->form_after_validation;
1062
		} else {
1063 3
			$form['fields'] = $this->get_configured_edit_fields( $form, $this->view_id );
1064
		}
1065
1066 3
		$form = $this->filter_conditional_logic( $form );
1067
1068 3
		$form = $this->prefill_conditional_logic( $form );
1069
1070
		// for now we don't support Save and Continue feature.
1071 3
		if( ! self::$supports_save_and_continue ) {
1072 3
			unset( $form['save'] );
1073
		}
1074
1075 3
		return $form;
1076
	}
1077
1078
	/**
1079
	 * 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.
1080
	 *
1081
	 * @since 1.16.2.2
1082
	 *
1083
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1084
	 * @param GF_Field $field
1085
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1086
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1087
	 * @param int $form_id Form ID
1088
	 *
1089
	 * @return string If error, the error message. If no error, blank string (modify_edit_field_input() runs next)
1090
	 */
1091 3
	public function verify_user_can_edit_post( $field_content = '', $field, $value, $lead_id = 0, $form_id ) {
0 ignored issues
show
Unused Code introduced by
The parameter $value is not used and could be removed.

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

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

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

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

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

Loading history...
1092
1093 3
		if( GFCommon::is_post_field( $field ) ) {
1094
1095 1
			$message = null;
1096
1097
			// First, make sure they have the capability to edit the post.
1098 1
			if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
1099
1100
				/**
1101
				 * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
1102
				 * @param string $message The existing "You don't have permission..." text
1103
				 */
1104
				$message = apply_filters('gravityview/edit_entry/unsupported_post_field_text', __('You don&rsquo;t have permission to edit this post.', 'gravityview') );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1105
1106 1
			} elseif( null === get_post( $this->entry['post_id'] ) ) {
1107
				/**
1108
				 * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
1109
				 * @param string $message The existing "This field is not editable; the post no longer exists." text
1110
				 */
1111
				$message = apply_filters('gravityview/edit_entry/no_post_text', __('This field is not editable; the post no longer exists.', 'gravityview' ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1112
			}
1113
1114 1
			if( $message ) {
1115
				$field_content = sprintf('<div class="ginput_container ginput_container_' . $field->type . '">%s</div>', wpautop( $message ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1116
			}
1117
		}
1118
1119 3
		return $field_content;
1120
	}
1121
1122
	/**
1123
	 *
1124
	 * Fill-in the saved values into the form inputs
1125
	 *
1126
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1127
	 * @param GF_Field $field
1128
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1129
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1130
	 * @param int $form_id Form ID
1131
	 *
1132
	 * @return mixed
1133
	 */
1134 3
	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...
1135
1136 3
		$gv_field = GravityView_Fields::get_associated_field( $field );
1137
1138
		// If the form has been submitted, then we don't need to pre-fill the values,
1139
		// Except for fileupload type and when a field input is overridden- run always!!
1140
		if(
1141 3
			( $this->is_edit_entry_submission() && !in_array( $field->type, array( 'fileupload', 'post_image' ) ) )
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1142 3
			&& false === ( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) )
1143
			&& ! GFCommon::is_product_field( $field->type )
1144 3
			|| ! empty( $field_content )
1145 3
			|| in_array( $field->type, array( 'honeypot' ) )
1146
		) {
1147
			return $field_content;
1148
		}
1149
1150
		// SET SOME FIELD DEFAULTS TO PREVENT ISSUES
1151 3
		$field->adminOnly = false; /** @see GFFormDisplay::get_counter_init_script() need to prevent adminOnly */
1152
1153 3
		$field_value = $this->get_field_value( $field );
1154
1155
		// Prevent any PHP warnings, like undefined index
1156 3
		ob_start();
1157
1158 3
		$return = null;
1159
1160
		/** @var GravityView_Field $gv_field */
1161 3
		if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
1162 2
			$return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
1163
		} else {
1164 3
			$return = $field->get_field_input( $this->form, $field_value, $this->entry );
1165
		}
1166
1167
		// If there was output, it's an error
1168 3
		$warnings = ob_get_clean();
1169
1170 3
		if( !empty( $warnings ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1171
			do_action( 'gravityview_log_error', __METHOD__ . $warnings, $field_value );
1172
		}
1173
1174 3
		return $return;
1175
	}
1176
1177
	/**
1178
	 * Modify the value for the current field input
1179
	 *
1180
	 * @param GF_Field $field
1181
	 *
1182
	 * @return array|mixed|string
1183
	 */
1184 3
	private function get_field_value( $field ) {
1185
1186
		/**
1187
		 * @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.
1188
		 * @param boolean True: override saved values; False: don't override (default)
1189
		 * @param $field GF_Field object Gravity Forms field object
1190
		 * @since 1.13
1191
		 */
1192 3
		$override_saved_value = apply_filters( 'gravityview/edit_entry/pre_populate/override', false, $field );
1193
1194
		// We're dealing with multiple inputs (e.g. checkbox) but not time or date (as it doesn't store data in input IDs)
1195 3
		if( isset( $field->inputs ) && is_array( $field->inputs ) && !in_array( $field->type, array( 'time', 'date' ) ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1196
1197
			$field_value = array();
1198
1199
			// only accept pre-populated values if the field doesn't have any choice selected.
1200
			$allow_pre_populated = $field->allowsPrepopulate;
1201
1202
			foreach ( (array)$field->inputs as $input ) {
0 ignored issues
show
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
1203
1204
				$input_id = strval( $input['id'] );
1205
				
1206
				if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
1207
					$field_value[ $input_id ] =  'post_category' === $field->type ? GFCommon::format_post_category( $this->entry[ $input_id ], true ) : $this->entry[ $input_id ];
0 ignored issues
show
introduced by
Expected 1 space after "="; 2 found
Loading history...
1208
					$allow_pre_populated = false;
1209
				}
1210
1211
			}
1212
1213
			$pre_value = $field->get_value_submission( array(), false );
1214
1215
			$field_value = ! $allow_pre_populated && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $field_value : $pre_value;
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1216
1217
		} else {
1218
1219 3
			$id = intval( $field->id );
1220
1221
			// get pre-populated value if exists
1222 3
			$pre_value = $field->allowsPrepopulate ? GFFormsModel::get_parameter_value( $field->inputName, array(), $field ) : '';
1223
1224
			// saved field entry value (if empty, fallback to the pre-populated value, if exists)
1225
			// or pre-populated value if not empty and set to override saved value
1226 3
			$field_value = !gv_empty( $this->entry[ $id ], false, false ) && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $this->entry[ $id ] : $pre_value;
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1227
1228
			// in case field is post_category but inputType is select, multi-select or radio, convert value into array of category IDs.
1229 3
			if ( 'post_category' === $field->type && !gv_empty( $field_value, false, false ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1230
				$categories = array();
1231
				foreach ( explode( ',', $field_value ) as $cat_string ) {
1232
					$categories[] = GFCommon::format_post_category( $cat_string, true );
1233
				}
1234
				$field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
1235
			}
1236
1237
		}
1238
1239
		// if value is empty get the default value if defined
1240 3
		$field_value = $field->get_value_default_if_empty( $field_value );
1241
1242
		/**
1243
		 * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
1244
		 * @since 1.11
1245
		 * @since 1.20 Added third param
1246
		 * @param mixed $field_value field value used to populate the input
1247
		 * @param object $field Gravity Forms field object ( Class GF_Field )
1248
		 * @param GravityView_Edit_Entry_Render $this Current object
1249
		 */
1250 3
		$field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
1251
1252
		/**
1253
		 * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
1254
		 * @since 1.17
1255
		 * @since 1.20 Added third param
1256
		 * @param mixed $field_value field value used to populate the input
1257
		 * @param GF_Field $field Gravity Forms field object
1258
		 * @param GravityView_Edit_Entry_Render $this Current object
1259
		 */
1260 3
		$field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
1261
1262 3
		return $field_value;
1263
	}
1264
1265
1266
	// ---- Entry validation
1267
1268
	/**
1269
	 * Add field keys that Gravity Forms expects.
1270
	 *
1271
	 * @see GFFormDisplay::validate()
1272
	 * @param  array $form GF Form
1273
	 * @return array	   Modified GF Form
1274
	 */
1275 3
	public function gform_pre_validation( $form ) {
1276
1277 3
		if( ! $this->verify_nonce() ) {
1278
			return $form;
1279
		}
1280
1281
		// Fix PHP warning regarding undefined index.
1282 3
		foreach ( $form['fields'] as &$field) {
0 ignored issues
show
introduced by
No space before closing parenthesis is prohibited
Loading history...
1283
1284
			// This is because we're doing admin form pretending to be front-end, so Gravity Forms
1285
			// expects certain field array items to be set.
1286 3
			foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
1287 3
				$field->{$key} = isset( $field->{$key} ) ? $field->{$key} : NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1288
			}
1289
1290 3
			switch( RGFormsModel::get_input_type( $field ) ) {
1291
1292
				/**
1293
				 * 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.
1294
				 *
1295
				 * 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.
1296
				 *
1297
				 * @hack
1298
				 */
1299 3
				case 'fileupload':
1300
1301
					// Set the previous value
1302 1
					$entry = $this->get_entry();
1303
1304 1
					$input_name = 'input_'.$field->id;
1305 1
					$form_id = $form['id'];
1306
1307 1
					$value = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1308
1309
					// Use the previous entry value as the default.
1310 1
					if( isset( $entry[ $field->id ] ) ) {
1311 1
						$value = $entry[ $field->id ];
1312
					}
1313
1314
					// If this is a single upload file
1315 1
					if( !empty( $_FILES[ $input_name ] ) && !empty( $_FILES[ $input_name ]['name'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1316 1
						$file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
1317 1
						$value = $file_path['url'];
1318
1319
					} else {
1320
1321
						// Fix PHP warning on line 1498 of form_display.php for post_image fields
1322
						// Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
1323 1
						$_FILES[ $input_name ] = array('name' => '', 'size' => '' );
0 ignored issues
show
introduced by
No space after opening parenthesis of array is bad style
Loading history...
1324
1325
					}
1326
1327 1
					if( rgar($field, "multipleFiles") ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
Coding Style Comprehensibility introduced by
The string literal multipleFiles does not require double quotes, as per coding-style, please use single quotes.

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

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

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

<?php

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

print $doubleQuoted;

will print an indented: Single is Value

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

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

Loading history...
1328
1329
						// If there are fresh uploads, process and merge them.
1330
						// Otherwise, use the passed values, which should be json-encoded array of URLs
1331 1
						if( isset( GFFormsModel::$uploaded_files[$form_id][$input_name] ) ) {
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
1332
							$value = empty( $value ) ? '[]' : $value;
1333
							$value = stripslashes_deep( $value );
1334 1
							$value = GFFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'], array());
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1335
						}
1336
1337
					} else {
1338
1339
						// A file already exists when editing an entry
1340
						// We set this to solve issue when file upload fields are required.
1341 1
						GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
1342
1343
					}
1344
1345 1
					$this->entry[ $input_name ] = $value;
1346 1
					$_POST[ $input_name ] = $value;
1347
1348 1
					break;
1349
1350 3
				case 'number':
1351
					// Fix "undefined index" issue at line 1286 in form_display.php
1352 1
					if( !isset( $_POST['input_'.$field->id ] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
1353
						$_POST['input_'.$field->id ] = NULL;
0 ignored issues
show
introduced by
Array keys should be surrounded by spaces unless they contain a string or an integer.
Loading history...
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1354
					}
1355 3
					break;
1356
			}
1357
1358
		}
1359
1360 3
		return $form;
1361
	}
1362
1363
1364
	/**
1365
	 * Process validation for a edit entry submission
1366
	 *
1367
	 * Sets the `is_valid` object var
1368
	 *
1369
	 * @return void
1370
	 */
1371 4
	private function validate() {
1372
1373
		/**
1374
		 * If using GF User Registration Add-on, remove the validation step, otherwise generates error when updating the entry
1375
		 * GF User Registration Add-on version > 3.x has a different class name
1376
		 * @since 1.16.2
1377
		 */
1378 4
		if ( class_exists( 'GF_User_Registration' ) ) {
1379 4
			remove_filter( 'gform_validation', array( GF_User_Registration::get_instance(), 'validate' ) );
1380
			/**
1381
			 * Add some custom validation either way.
1382
			 * https://secure.helpscout.net/conversation/430858351/10957/?folderId=1210164
1383
			 */
1384 4
			add_filter( 'gform_validation_' . $this->form_id, array( $this, 'user_registration_validation' ), 10, 4 );
1385
		} else  if ( class_exists( 'GFUser' ) ) {
1386
			remove_filter( 'gform_validation', array( 'GFUser', 'user_registration_validation' ) );
1387
		}
1388
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1389
1390
		/**
1391
		 * For some crazy reason, Gravity Forms doesn't validate Edit Entry form submissions.
1392
		 * You can enter whatever you want!
1393
		 * We try validating, and customize the results using `self::custom_validation()`
1394
		 */
1395 4
		add_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10, 4);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1396
1397
		// Needed by the validate funtion
1398 4
		$failed_validation_page = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1399 4
		$field_values = RGForms::post( 'gform_field_values' );
1400
1401
		// Prevent entry limit from running when editing an entry, also
1402
		// prevent form scheduling from preventing editing
1403 4
		unset( $this->form['limitEntries'], $this->form['scheduleForm'] );
1404
1405
		// Hide fields depending on Edit Entry settings
1406 4
		$this->form['fields'] = $this->get_configured_edit_fields( $this->form, $this->view_id );
1407
1408 4
		$this->is_valid = GFFormDisplay::validate( $this->form, $field_values, 1, $failed_validation_page );
1409
1410 4
		remove_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10 );
1411 4
		remove_filter( 'gform_validation_' . $this->form_id, array( $this, 'user_registration_validation' ), 10 );
1412 4
	}
1413
1414
	/**
1415
	 * Make validation work for User Registration feeds.
1416
	 *
1417
	 * The default validation does a bit too much for our liking.
1418
	 * Email, username validation should work. Called on the `gform_validation` filter.
1419
	 *
1420
	 * @param array $validation_results The validation results.
1421
	 * @return array The modified validation results.
1422
	 */
1423 3
	public function user_registration_validation( $validation_results ) {
1424 3
		$user_registration = GF_User_Registration::get_instance();
1425
1426 3
		$entry = $this->get_entry();
1427 3
		$form = $validation_results['form'];
1428
1429 3
		if ( ! $feed = $user_registration->get_single_submission_feed( $entry, $form ) ) {
1430
			return $validation_results;
1431
		}
1432
1433 3
		$username_field = GFFormsModel::get_field( $form, rgars( $feed, 'meta/username' ) );
1434 3
		$email_field    = GFFormsModel::get_field( $form, rgars( $feed, 'meta/email' ) );
1435
1436 3
		$username   = $user_registration->get_meta_value( 'username', $feed, $form, $entry );
1437 3
		$user_email = $user_registration->get_meta_value( 'email', $feed, $form, $entry );
1438
1439 3
		$value = RGFormsModel::get_field_value( $email_field );
1440 3
		if ( $user_email != $value && email_exists( $value ) ) {
1441
			$email_field->failed_validation = 1;
1442
			$email_field->validation_message = __( 'This email is already in use', 'gravityview' );
1443
			$validation_results['is_valid'] = false;
1444
		}
1445
1446 3
		$value = RGFormsModel::get_field_value( $username_field );
1447 3
		if ( $username != $value ) {
1448
			$username_field->failed_validation = 1;
1449
			$username_field->validation_message = __( 'Usernames cannot be changed', 'gravityview' );
1450
			$validation_results['is_valid'] = false;
1451
		}
1452
1453
		// We'll need this result when rendering the form ( on GFFormDisplay::get_form )
1454 3
		$this->form_after_validation = $validation_results['form'];
1455
1456 3
		return $validation_results;
1457
	}
1458
1459
	/**
1460
	 * Make validation work for Edit Entry
1461
	 *
1462
	 * Because we're calling the GFFormDisplay::validate() in an unusual way (as a front-end
1463
	 * form pretending to be a back-end form), validate() doesn't know we _can't_ edit post
1464
	 * fields. This goes through all the fields and if they're an invalid post field, we
1465
	 * set them as valid. If there are still issues, we'll return false.
1466
	 *
1467
	 * @param  [type] $validation_results [description]
0 ignored issues
show
Documentation introduced by
The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

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

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

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

Loading history...
1469
	 */
1470 4
	public function custom_validation( $validation_results ) {
1471
1472 4
		do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Validation results: ', $validation_results );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1473
1474 4
		do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] $_POSTed data (sanitized): ', esc_html( print_r( $_POST, true ) ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
introduced by
The use of function print_r() is discouraged
Loading history...
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
1475
1476 4
		$gv_valid = true;
1477
1478 4
		foreach ( $validation_results['form']['fields'] as $key => &$field ) {
1479
1480 4
			$value = RGFormsModel::get_field_value( $field );
1481 4
			$field_type = RGFormsModel::get_input_type( $field );
1482
1483
			// Validate always
1484
			switch ( $field_type ) {
1485
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1486
1487 4
				case 'fileupload' :
1488 4
				case 'post_image':
1489
1490
					// in case nothing is uploaded but there are already files saved
1491 2
					if( !empty( $field->failed_validation ) && !empty( $field->isRequired ) && !empty( $value ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1492
						$field->failed_validation = false;
1493
						unset( $field->validation_message );
1494
					}
1495
1496
					// validate if multi file upload reached max number of files [maxFiles] => 2
1497 2
					if( rgobj( $field, 'maxFiles') && rgobj( $field, 'multipleFiles') ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1498
1499
						$input_name = 'input_' . $field->id;
1500
						//uploaded
1501
						$file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
1502
1503
						//existent
1504
						$entry = $this->get_entry();
1505
						$value = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1506
						if( isset( $entry[ $field->id ] ) ) {
1507
							$value = json_decode( $entry[ $field->id ], true );
1508
						}
1509
1510
						// count uploaded files and existent entry files
1511
						$count_files = count( $file_names ) + count( $value );
1512
1513
						if( $count_files > $field->maxFiles ) {
1514
							$field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
1515
							$field->failed_validation = 1;
1516
							$gv_valid = false;
1517
1518
							// in case of error make sure the newest upload files are removed from the upload input
1519
							GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
1520
						}
1521
1522
					}
1523
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1524
1525 2
					break;
1526
1527
			}
1528
1529
			// This field has failed validation.
1530 4
			if( !empty( $field->failed_validation ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1531
1532 1
				do_action( 'gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Field is invalid.', array( 'field' => $field, 'value' => $value ) );
1533
1534
				switch ( $field_type ) {
1535
1536
					// Captchas don't need to be re-entered.
1537 1
					case 'captcha':
1538
1539
						// Post Image fields aren't editable, so we un-fail them.
1540 1
					case 'post_image':
1541
						$field->failed_validation = false;
1542
						unset( $field->validation_message );
1543
						break;
1544
1545
				}
1546
1547
				// You can't continue inside a switch, so we do it after.
1548 1
				if( empty( $field->failed_validation ) ) {
1549
					continue;
1550
				}
1551
1552
				// checks if the No Duplicates option is not validating entry against itself, since
1553
				// we're editing a stored entry, it would also assume it's a duplicate.
1554 1
				if( !empty( $field->noDuplicates ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1555
1556
					$entry = $this->get_entry();
1557
1558
					// If the value of the entry is the same as the stored value
1559
					// Then we can assume it's not a duplicate, it's the same.
1560
					if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1561
						//if value submitted was not changed, then don't validate
1562
						$field->failed_validation = false;
1563
1564
						unset( $field->validation_message );
1565
1566
						do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', $entry );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1567
1568
						continue;
1569
					}
1570
				}
1571
1572
				// if here then probably we are facing the validation 'At least one field must be filled out'
1573 1
				if( GFFormDisplay::is_empty( $field, $this->form_id  ) && empty( $field->isRequired ) ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 2 found
Loading history...
1574
					unset( $field->validation_message );
1575
					$field->validation_message = false;
1576
					continue;
1577
				}
1578
1579 4
				$gv_valid = false;
1580
1581
			}
1582
1583
		}
1584
1585 4
		$validation_results['is_valid'] = $gv_valid;
1586
1587 4
		do_action('gravityview_log_debug', 'GravityView_Edit_Entry[custom_validation] Validation results.', $validation_results );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1588
1589
		// We'll need this result when rendering the form ( on GFFormDisplay::get_form )
1590 4
		$this->form_after_validation = $validation_results['form'];
1591
1592 4
		return $validation_results;
1593
	}
1594
1595
1596
	/**
1597
	 * TODO: This seems to be hacky... we should remove it. Entry is set when updating the form using setup_vars()!
1598
	 * Get the current entry and set it if it's not yet set.
1599
	 * @return array Gravity Forms entry array
1600
	 */
1601 3
	public function get_entry() {
1602
1603 3
		if( empty( $this->entry ) ) {
1604
			// Get the database value of the entry that's being edited
1605 1
			$this->entry = gravityview_get_entry( GravityView_frontend::is_single_entry() );
1606
		}
1607
1608 3
		return $this->entry;
1609
	}
1610
1611
1612
1613
	// --- Filters
1614
1615
	/**
1616
	 * Get the Edit Entry fields as configured in the View
1617
	 *
1618
	 * @since 1.8
1619
	 *
1620
	 * @param int $view_id
1621
	 *
1622
	 * @return array Array of fields that are configured in the Edit tab in the Admin
1623
	 */
1624 4
	private function get_configured_edit_fields( $form, $view_id ) {
1625
1626
		// Get all fields for form
1627 4
		if ( defined( 'GRAVITYVIEW_FUTURE_CORE_LOADED' ) ) {
1628 4
			if ( \GV\View::exists( $view_id ) ) {
1629 4
				$view = \GV\View::by_id( $view_id );
1630 4
				$properties = $view->fields->as_configuration();
1631
			}
1632
		} else {
1633
			/** GravityView_View_Data is deprecated. */
1634
			$properties = GravityView_View_Data::getInstance()->get_fields( $view_id );
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View_Data::get_fields() has been deprecated.

This method has been deprecated.

Loading history...
1635
		}
1636
1637
		// If edit tab not yet configured, show all fields
1638 4
		$edit_fields = !empty( $properties['edit_edit-fields'] ) ? $properties['edit_edit-fields'] : NULL;
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1639
1640
		// Hide fields depending on admin settings
1641 4
		$fields = $this->filter_fields( $form['fields'], $edit_fields );
1642
1643
		// If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
1644 4
		$fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
1645
1646
		/**
1647
		 * @filter `gravityview/edit_entry/form_fields` Modify the fields displayed in Edit Entry form
1648
		 * @since 1.17
1649
		 * @param GF_Field[] $fields Gravity Forms form fields
1650
		 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1651
		 * @param array $form GF Form array (`fields` key modified to have only fields configured to show in Edit Entry)
1652
		 * @param int $view_id View ID
1653
		 */
1654 4
		$fields = apply_filters( 'gravityview/edit_entry/form_fields', $fields, $edit_fields, $form, $view_id );
1655
1656 4
		return $fields;
1657
	}
1658
1659
1660
	/**
1661
	 * Filter area fields based on specified conditions
1662
	 *  - This filter removes the fields that have calculation configured
1663
	 *
1664
	 * @uses GravityView_Edit_Entry::user_can_edit_field() Check caps
1665
	 * @access private
1666
	 * @param GF_Field[] $fields
1667
	 * @param array $configured_fields
1668
	 * @since  1.5
1669
	 * @return array $fields
1670
	 */
1671 3
	private function filter_fields( $fields, $configured_fields ) {
1672
1673 3
		if( empty( $fields ) || !is_array( $fields ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1674
			return $fields;
1675
		}
1676
1677 3
		$edit_fields = array();
1678
1679 3
		$field_type_blacklist = $this->loader->get_field_blacklist( $this->entry );
1680
1681
		// First, remove blacklist or calculation fields
1682 3
		foreach ( $fields as $key => $field ) {
1683
1684
			// Remove the fields that have calculation properties and keep them to be used later
1685
			// @since 1.16.2
1686 3
			if( $field->has_calculation() ) {
1687
				$this->fields_with_calculation[] = $field;
1688
				// don't remove the calculation fields on form render.
1689
			}
1690
1691 3
			if( in_array( $field->type, $field_type_blacklist ) ) {
1692 3
				unset( $fields[ $key ] );
1693
			}
1694
		}
1695
1696
		// The Edit tab has not been configured, so we return all fields by default.
1697 3
		if( empty( $configured_fields ) ) {
1698 3
			return $fields;
1699
		}
1700
1701
		// The edit tab has been configured, so we loop through to configured settings
1702
		foreach ( $configured_fields as $configured_field ) {
1703
1704
			/** @var GF_Field $field */
1705
			foreach ( $fields as $field ) {
1706
1707
				if( intval( $configured_field['id'] ) === intval( $field->id ) && $this->user_can_edit_field( $configured_field, false ) ) {
1708
					$edit_fields[] = $this->merge_field_properties( $field, $configured_field );
1709
					break;
1710
				}
1711
1712
			}
1713
1714
		}
1715
1716
		return $edit_fields;
1717
1718
	}
1719
1720
	/**
1721
	 * Override GF Form field properties with the ones defined on the View
1722
	 * @param  GF_Field $field GF Form field object
1723
	 * @param  array $field_setting  GV field options
1724
	 * @since  1.5
1725
	 * @return array|GF_Field
1726
	 */
1727
	private function merge_field_properties( $field, $field_setting ) {
1728
1729
		$return_field = $field;
1730
1731
		if( empty( $field_setting['show_label'] ) ) {
1732
			$return_field->label = '';
1733
		} elseif ( !empty( $field_setting['custom_label'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1734
			$return_field->label = $field_setting['custom_label'];
1735
		}
1736
1737
		if( !empty( $field_setting['custom_class'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1738
			$return_field->cssClass .= ' '. gravityview_sanitize_html_class( $field_setting['custom_class'] );
1739
		}
1740
1741
		/**
1742
		 * Normalize page numbers - avoid conflicts with page validation
1743
		 * @since 1.6
1744
		 */
1745
		$return_field->pageNumber = 1;
1746
1747
		return $return_field;
1748
1749
	}
1750
1751
	/**
1752
	 * Remove fields that shouldn't be visible based on the Gravity Forms adminOnly field property
1753
	 *
1754
	 * @since 1.9.1
1755
	 *
1756
	 * @param array|GF_Field[] $fields Gravity Forms form fields
1757
	 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1758
	 * @param array $form GF Form array
1759
	 * @param int $view_id View ID
1760
	 *
1761
	 * @return array Possibly modified form array
1762
	 */
1763 3
	private function filter_admin_only_fields( $fields = array(), $edit_fields = null, $form = array(), $view_id = 0 ) {
1764
1765
		/**
1766
		 * @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
1767
		 * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
1768
		 * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
1769
		 * @since 1.9.1
1770
		 * @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.
1771
		 * @param array $form GF Form array
1772
		 * @param int $view_id View ID
1773
		 */
1774 3
		$use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
1775
1776 3
		if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
1777
			foreach( $fields as $k => $field ) {
1778
				if( $field->adminOnly ) {
1779
					unset( $fields[ $k ] );
1780
				}
1781
			}
1782
			return $fields;
1783
		}
1784
1785 3
		foreach( $fields as &$field ) {
1786 3
			$field->adminOnly = false;
1787
		}
1788
1789 3
		return $fields;
1790
	}
1791
1792
	// --- Conditional Logic
1793
1794
	/**
1795
	 * Conditional logic isn't designed to work with forms that already have content. When switching input values,
1796
	 * the dependent fields will be blank.
1797
	 *
1798
	 * Note: This is because GF populates a JavaScript variable with the input values. This is tough to filter at the input level;
1799
	 * via the `gform_field_value` filter; it requires lots of legwork. Doing it at the form level is easier.
1800
	 *
1801
	 * @since 1.17.4
1802
	 *
1803
	 * @param array $form Gravity Forms array object
1804
	 *
1805
	 * @return array $form, modified to fix conditional
1806
	 */
1807 3
	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...
1808
1809 3
		if( ! GFFormDisplay::has_conditional_logic( $form ) ) {
1810 3
			return $form;
1811
		}
1812
1813
		// Have Conditional Logic pre-fill fields as if the data were default values
1814
		/** @var GF_Field $field */
1815
		foreach ( $form['fields'] as &$field ) {
1816
1817
			if( 'checkbox' === $field->type ) {
1818
				foreach ( $field->get_entry_inputs() as $key => $input ) {
1819
					$input_id = $input['id'];
1820
					$choice = $field->choices[ $key ];
1821
					$value = rgar( $this->entry, $input_id );
1822
					$match = RGFormsModel::choice_value_match( $field, $choice, $value );
1823
					if( $match ) {
1824
						$field->choices[ $key ]['isSelected'] = true;
1825
					}
1826
				}
1827
			} else {
1828
1829
				// We need to run through each field to set the default values
1830
				foreach ( $this->entry as $field_id => $field_value ) {
1831
1832
					if( floatval( $field_id ) === floatval( $field->id ) ) {
1833
1834
						if( 'list' === $field->type ) {
1835
							$list_rows = maybe_unserialize( $field_value );
1836
1837
							$list_field_value = array();
1838
							foreach ( (array) $list_rows as $row ) {
1839
								foreach ( (array) $row as $column ) {
1840
									$list_field_value[] = $column;
1841
								}
1842
							}
1843
1844
							$field->defaultValue = serialize( $list_field_value );
1845
						} else {
1846
							$field->defaultValue = $field_value;
1847
						}
1848
					}
1849
				}
1850
			}
1851
		}
1852
1853
		return $form;
1854
	}
1855
1856
	/**
1857
	 * Remove the conditional logic rules from the form button and the form fields, if needed.
1858
	 *
1859
	 * @todo Merge with caller method
1860
	 * @since 1.9
1861
	 *
1862
	 * @param array $form Gravity Forms form
1863
	 * @return array Modified form, if not using Conditional Logic
1864
	 */
1865 3
	private function filter_conditional_logic( $form ) {
1866
1867
		/**
1868
		 * @filter `gravityview/edit_entry/conditional_logic` Should the Edit Entry form use Gravity Forms conditional logic showing/hiding of fields?
1869
		 * @since 1.9
1870
		 * @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
1871
		 * @param array $form Gravity Forms form
1872
		 */
1873 3
		$use_conditional_logic = apply_filters( 'gravityview/edit_entry/conditional_logic', true, $form );
1874
1875 3
		if( $use_conditional_logic ) {
1876 3
			return $form;
1877
		}
1878
1879
		foreach( $form['fields'] as &$field ) {
1880
			/* @var GF_Field $field */
1881
			$field->conditionalLogic = null;
1882
		}
1883
1884
		unset( $form['button']['conditionalLogic'] );
1885
1886
		return $form;
1887
1888
	}
1889
1890
	/**
1891
	 * Disable the Gravity Forms conditional logic script and features on the Edit Entry screen
1892
	 *
1893
	 * @since 1.9
1894
	 *
1895
	 * @param $has_conditional_logic
1896
	 * @param $form
1897
	 * @return mixed
1898
	 */
1899 3
	public function manage_conditional_logic( $has_conditional_logic, $form ) {
1900
1901 3
		if( ! $this->is_edit_entry() ) {
1902
			return $has_conditional_logic;
1903
		}
1904
1905
		/** @see GravityView_Edit_Entry_Render::filter_conditional_logic for filter documentation */
1906 3
		return apply_filters( 'gravityview/edit_entry/conditional_logic', $has_conditional_logic, $form );
1907
	}
1908
1909
1910
	// --- User checks and nonces
1911
1912
	/**
1913
	 * Check if the user can edit the entry
1914
	 *
1915
	 * - Is the nonce valid?
1916
	 * - Does the user have the right caps for the entry
1917
	 * - Is the entry in the trash?
1918
	 *
1919
	 * @todo Move to GVCommon
1920
	 *
1921
	 * @param  boolean $echo Show error messages in the form?
1922
	 * @return boolean		True: can edit form. False: nope.
1923
	 */
1924 4
	private function user_can_edit_entry( $echo = false ) {
1925
1926 4
		$error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1927
1928
		/**
1929
		 *  1. Permalinks are turned off
1930
		 *  2. There are two entries embedded using oEmbed
1931
		 *  3. One of the entries has just been saved
1932
		 */
1933 4
		if( !empty( $_POST['lid'] ) && !empty( $_GET['entry'] ) && ( $_POST['lid'] !== $_GET['entry'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1934
1935
			$error = true;
1936
1937
		}
1938
1939 4
		if( !empty( $_GET['entry'] ) && (string)$this->entry['id'] !== $_GET['entry'] ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
1940
1941
			$error = true;
1942
1943 4
		} elseif( ! $this->verify_nonce() ) {
1944
1945
			/**
1946
			 * If the Entry is embedded, there may be two entries on the same page.
1947
			 * If that's the case, and one is being edited, the other should fail gracefully and not display an error.
1948
			 */
1949
			if( GravityView_oEmbed::getInstance()->get_entry_id() ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \GravityView_oEmbed::get...tance()->get_entry_id() of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

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

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

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

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
1950
				$error = true;
1951
			} else {
1952
				$error = __( 'The link to edit this entry is not valid; it may have expired.', 'gravityview');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1953
			}
1954
1955
		}
1956
1957 4
		if( ! GravityView_Edit_Entry::check_user_cap_edit_entry( $this->entry ) ) {
1958 1
			$error = __( 'You do not have permission to edit this entry.', 'gravityview');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1959
		}
1960
1961 4
		if( $this->entry['status'] === 'trash' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
1962
			$error = __('You cannot edit the entry; it is in the trash.', 'gravityview' );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1963
		}
1964
1965
		// No errors; everything's fine here!
1966 4
		if( empty( $error ) ) {
1967 4
			return true;
1968
		}
1969
1970 1
		if( $echo && $error !== true ) {
0 ignored issues
show
introduced by
Found "!== true". Use Yoda Condition checks, you must
Loading history...
1971
1972 1
			$error = esc_html( $error );
1973
1974
			/**
1975
			 * @since 1.9
1976
			 */
1977 1
			if ( ! empty( $this->entry ) ) {
1978 1
				$error .= ' ' . gravityview_get_link( '#', _x('Go back.', 'Link shown when invalid Edit Entry link is clicked', 'gravityview' ), array( 'onclick' => "window.history.go(-1); return false;" ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
Coding Style Comprehensibility introduced by
The string literal window.history.go(-1); return false; does not require double quotes, as per coding-style, please use single quotes.

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

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

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

<?php

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

print $doubleQuoted;

will print an indented: Single is Value

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

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

Loading history...
1979
			}
1980
1981 1
			echo GVCommon::generate_notice( wpautop( $error ), 'gv-error error');
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1982
		}
1983
1984 1
		do_action('gravityview_log_error', 'GravityView_Edit_Entry[user_can_edit_entry]' . $error );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
1985
1986 1
		return false;
1987
	}
1988
1989
1990
	/**
1991
	 * Check whether a field is editable by the current user, and optionally display an error message
1992
	 * @uses  GravityView_Edit_Entry->check_user_cap_edit_field() Check user capabilities
1993
	 * @param  array  $field Field or field settings array
1994
	 * @param  boolean $echo  Whether to show error message telling user they aren't allowed
1995
	 * @return boolean		 True: user can edit the current field; False: nope, they can't.
1996
	 */
1997
	private function user_can_edit_field( $field, $echo = false ) {
1998
1999
		$error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
2000
2001
		if( ! $this->check_user_cap_edit_field( $field ) ) {
2002
			$error = __( 'You do not have permission to edit this field.', 'gravityview');
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
2003
		}
2004
2005
		// No errors; everything's fine here!
2006
		if( empty( $error ) ) {
2007
			return true;
2008
		}
2009
2010
		if( $echo ) {
2011
			echo GVCommon::generate_notice( wpautop( esc_html( $error ) ), 'gv-error error');
0 ignored issues
show
introduced by
Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'GVCommon'
Loading history...
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
2012
		}
2013
2014
		do_action('gravityview_log_error', 'GravityView_Edit_Entry[user_can_edit_field]' . $error );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 0 found
Loading history...
2015
2016
		return false;
2017
2018
	}
2019
2020
2021
	/**
2022
	 * checks if user has permissions to edit a specific field
2023
	 *
2024
	 * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_field for maximum security!!
2025
	 *
2026
	 * @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...
2027
	 * @return bool
2028
	 */
2029
	private function check_user_cap_edit_field( $field ) {
2030
2031
		// If they can edit any entries (as defined in Gravity Forms), we're good.
2032
		if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ) ) ) {
2033
			return true;
2034
		}
2035
2036
		$field_cap = isset( $field['allow_edit_cap'] ) ? $field['allow_edit_cap'] : false;
2037
2038
		// If the field has custom editing capaibilities set, check those
2039
		if( $field_cap ) {
2040
			return GVCommon::has_cap( $field['allow_edit_cap'] );
2041
		}
2042
2043
		return false;
2044
	}
2045
2046
2047
	/**
2048
	 * Is the current nonce valid for editing the entry?
2049
	 * @return boolean
2050
	 */
2051 3
	public function verify_nonce() {
2052
2053
		// Verify form submitted for editing single
2054 3
		if( $this->is_edit_entry_submission() ) {
2055
			$valid = wp_verify_nonce( $_POST[ self::$nonce_field ], self::$nonce_field );
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-validated input variable: $_POST
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_POST
Loading history...
2056
		}
2057
2058
		// Verify
2059 3
		else if( ! $this->is_edit_entry() ) {
2060
			$valid = false;
2061
		}
2062
2063
		else {
2064 3
			$valid = wp_verify_nonce( $_GET['edit'], self::$nonce_key );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
introduced by
Detected usage of a non-validated input variable: $_GET
Loading history...
introduced by
Detected usage of a non-sanitized input variable: $_GET
Loading history...
2065
		}
2066
2067
		/**
2068
		 * @filter `gravityview/edit_entry/verify_nonce` Override Edit Entry nonce validation. Return true to declare nonce valid.
2069
		 * @since 1.13
2070
		 * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
2071
		 * @param string $nonce_field Key used when validating submissions. Default: is_gv_edit_entry
2072
		 */
2073 3
		$valid = apply_filters( 'gravityview/edit_entry/verify_nonce', $valid, self::$nonce_field );
2074
2075 3
		return $valid;
2076
	}
2077
2078
2079
	/**
2080
	 * Multiselect in GF 2.2 became a json_encoded value. Fix it.
2081
	 *
2082
	 * As a hack for now we'll implode it back.
2083
	 */
2084
	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...
2085
		if ( empty ( $field->storageType ) || $field->storageType != 'json' ) {
0 ignored issues
show
introduced by
Found "!= '". Use Yoda Condition checks, you must
Loading history...
Coding Style introduced by
Space before opening parenthesis of function call prohibited
Loading history...
2086
			return $field_value;
2087
		}
2088
2089
		$maybe_json = @json_decode( $field_value, true );
0 ignored issues
show
Coding Style introduced by
Silencing errors is discouraged
Loading history...
2090
2091
		if ( $maybe_json ) {
2092
			return implode( ',', $maybe_json );
2093
		}
2094
2095
		return $field_value;
2096
	}
2097
2098
2099
2100
} //end class
2101