Completed
Push — develop ( d5d4b9...69e663 )
by Zack
16:25
created

maybe_print_message()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 32

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 6.4624

Importance

Changes 0
Metric Value
cc 3
nc 3
nop 0
dl 0
loc 32
ccs 3
cts 11
cp 0.2727
crap 6.4624
rs 9.408
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
	 * ID of the current post. May also be ID of the current View.
97
     *
98
     * @since 2.0.13
99
     * 
100
     * @var int
101
	 */
102
	public $post_id;
103
104
	/**
105
	 * Updated entry is valid (GF Validation object)
106
	 *
107
	 * @var array
108
	 */
109
	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...
110
111 4
	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...
112 4
		$this->loader = $loader;
113 4
	}
114
115 4
	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...
116
117
		/** @define "GRAVITYVIEW_DIR" "../../../" */
118 4
		include_once( GRAVITYVIEW_DIR .'includes/class-admin-approve-entries.php' );
119
120
		// Don't display an embedded form when editing an entry
121 4
		add_action( 'wp_head', array( $this, 'prevent_render_form' ) );
122 4
		add_action( 'wp_footer', array( $this, 'prevent_render_form' ) );
123
124
		// Stop Gravity Forms processing what is ours!
125 4
		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...
126
127 4
		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...
128
129 4
		add_action( 'gravityview_edit_entry', array( $this, 'init' ) );
130
131
		// Disable conditional logic if needed (since 1.9)
132 4
		add_filter( 'gform_has_conditional_logic', array( $this, 'manage_conditional_logic' ), 10, 2 );
133
134
		// Make sure GF doesn't validate max files (since 1.9)
135 4
		add_filter( 'gform_plupload_settings', array( $this, 'modify_fileupload_settings' ), 10, 3 );
136
137
		// Add fields expected by GFFormDisplay::validate()
138 4
		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...
139
140
		// Fix multiselect value for GF 2.2
141 4
		add_filter( 'gravityview/edit_entry/field_value_multiselect', array( $this, 'fix_multiselect_value_serialization' ), 10, 3 );
142 4
	}
143
144
	/**
145
	 * Don't show any forms embedded on a page when GravityView is in Edit Entry mode
146
	 *
147
	 * Adds a `__return_empty_string` filter on the Gravity Forms shortcode on the `wp_head` action
148
	 * And then removes it on the `wp_footer` action
149
	 *
150
	 * @since 1.16.1
151
	 *
152
	 * @return void
153
	 */
154 1
	public function prevent_render_form() {
155 1
		if( $this->is_edit_entry() ) {
156 1
			if( 'wp_head' === current_filter() ) {
157 1
				add_filter( 'gform_shortcode_form', '__return_empty_string' );
158
			} else {
159 1
				remove_filter( 'gform_shortcode_form', '__return_empty_string' );
160
			}
161
		}
162 1
	}
163
164
	/**
165
	 * Because we're mimicking being a front-end Gravity Forms form while using a Gravity Forms
166
	 * backend form, we need to prevent them from saving twice.
167
	 * @return void
168
	 */
169 1
	public function prevent_maybe_process_form() {
170
171 1
		if( ! empty( $_POST ) ) {
0 ignored issues
show
introduced by
Detected access of super global var $_POST, probably need manual inspection.
Loading history...
172
	        gravityview()->log->debug( 'GravityView_Edit_Entry[prevent_maybe_process_form] $_POSTed data (sanitized): ', array( 'data' => 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...
173
		}
174
175 1
		if( $this->is_edit_entry_submission() ) {
176
			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...
177
	        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...
178
		}
179 1
	}
180
181
	/**
182
	 * Is the current page an Edit Entry page?
183
	 * @return boolean
184
	 */
185 9
	public function is_edit_entry() {
186
187 9
		$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...
188
189 9
		return ( $is_edit_entry || $this->is_edit_entry_submission() );
190
	}
191
192
	/**
193
	 * Is the current page an Edit Entry page?
194
	 * @since 1.9
195
	 * @return boolean
196
	 */
197 9
	public function is_edit_entry_submission() {
198 9
		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...
199
	}
200
201
	/**
202
	 * When Edit entry view is requested setup the vars
203
	 */
204 4
	private function setup_vars() {
205 4
        global $post;
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...
206
207 4
		$gravityview_view = GravityView_View::getInstance();
208
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
209
210 4
		$entries = $gravityview_view->getEntries();
211 4
	    self::$original_entry = $entries[0];
212 4
	    $this->entry = $entries[0];
213
214 4
		self::$original_form = $gravityview_view->getForm();
215 4
		$this->form = $gravityview_view->getForm();
216 4
		$this->form_id = $gravityview_view->getFormId();
217 4
		$this->view_id = $gravityview_view->getViewId();
218 4
		$this->post_id = \GV\Utils::get( $post, 'ID', null );
219
220 4
		self::$nonce_key = GravityView_Edit_Entry::get_nonce_key( $this->view_id, $this->form_id, $this->entry['id'] );
221 4
	}
222
223
224
	/**
225
	 * Load required files and trigger edit flow
226
	 *
227
	 * Run when the is_edit_entry returns true.
228
	 *
229
	 * @param \GravityView_View_Data $gv_data GravityView Data object
230
	 * @return void
231
	 */
232 5
	public function init( $gv_data = null ) {
233
234 5
		require_once( GFCommon::get_base_path() . '/form_display.php' );
235 5
		require_once( GFCommon::get_base_path() . '/entry_detail.php' );
236
237 5
		$this->setup_vars();
238
239 5
		if ( ! $gv_data ) {
240
			$gv_data = GravityView_View_Data::getInstance();
241
		}
242
243
		// Multiple Views embedded, don't proceed if nonce fails
244 5
		if ( $gv_data->has_multiple_views() && ! $this->verify_nonce() ) {
0 ignored issues
show
Deprecated Code introduced by
The method GravityView_View_Data::has_multiple_views() has been deprecated.

This method has been deprecated.

Loading history...
245
			gravityview()->log->error( 'Nonce validation failed for the Edit Entry request; returning' );
246
			return;
247
		}
248
249
		// Sorry, you're not allowed here.
250 5
		if ( false === $this->user_can_edit_entry( true ) ) {
251 1
			gravityview()->log->error( 'User is not allowed to edit this entry; returning', array( 'data' => $this->entry ) );
252 1
			return;
253
		}
254
255 5
		$this->print_scripts();
256
257 5
		$this->process_save( $gv_data );
258
259 5
		$this->edit_entry_form();
260
261 5
	}
262
263
264
	/**
265
	 * Force Gravity Forms to output scripts as if it were in the admin
266
	 * @return void
267
	 */
268 4
	private function print_scripts() {
269 4
		$gravityview_view = GravityView_View::getInstance();
270
271 4
		wp_register_script( 'gform_gravityforms', GFCommon::get_base_url().'/js/gravityforms.js', array( 'jquery', 'gform_json', 'gform_placeholder', 'sack', 'plupload-all', 'gravityview-fe-view' ) );
272
273 4
		GFFormDisplay::enqueue_form_scripts( $gravityview_view->getForm(), false);
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
274
275 4
		wp_localize_script( 'gravityview-fe-view', 'gvGlobals', array( 'cookiepath' => COOKIEPATH ) );
276
277
		// Sack is required for images
278 4
		wp_print_scripts( array( 'sack', 'gform_gravityforms', 'gravityview-fe-view' ) );
279 4
	}
280
281
282
	/**
283
	 * Process edit entry form save
284
	 *
285
	 * @param array $gv_data The View data.
286
	 */
287 5
	private function process_save( $gv_data ) {
288
289 5
		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...
290 5
			return;
291
		}
292
293
		// Make sure the entry, view, and form IDs are all correct
294 4
		$valid = $this->verify_nonce();
295
296 4
		if ( !$valid ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
297
			gravityview()->log->error( 'Nonce validation failed.' );
298
			return;
299
		}
300
301 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...
302
			gravityview()->log->error( 'Entry ID did not match posted entry ID.' );
303
			return;
304
		}
305
306 4
		gravityview()->log->debug( '$_POSTed data (sanitized): ', array( 'data' => 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...
307
308 4
		$this->process_save_process_files( $this->form_id );
309
310 4
		$this->validate();
311
312 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...
313
314 4
			gravityview()->log->debug( 'Submission is valid.' );
315
316
			/**
317
			 * @hack This step is needed to unset the adminOnly from form fields, to add the calculation fields
318
			 */
319 4
			$form = $this->form_prepare_for_save();
320
321
			/**
322
			 * @hack to avoid the capability validation of the method save_lead for GF 1.9+
323
			 */
324 4
			unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
325
326 4
			$date_created = $this->entry['date_created'];
327
328
			/**
329
			 * @hack to force Gravity Forms to use $read_value_from_post in GFFormsModel::save_lead()
330
			 * @since 1.17.2
331
			 */
332 4
			unset( $this->entry['date_created'] );
333
334 4
			GFFormsModel::save_lead( $form, $this->entry );
335
336
	        // Delete the values for hidden inputs
337 4
	        $this->unset_hidden_field_values();
338
			
339 4
			$this->entry['date_created'] = $date_created;
340
341
			// Process calculation fields
342 4
			$this->update_calculation_fields();
343
344
			// Perform actions normally performed after updating a lead
345 4
			$this->after_update();
346
347
	        /**
348
			 * Must be AFTER after_update()!
349
			 * @see https://github.com/gravityview/GravityView/issues/764
350
			 */
351 4
			$this->maybe_update_post_fields( $form );
352
353
			/**
354
			 * @action `gravityview/edit_entry/after_update` Perform an action after the entry has been updated using Edit Entry
355
             * @since 2.1 Added $gv_data parameter
356
			 * @param array $form Gravity Forms form array
357
			 * @param string $entry_id Numeric ID of the entry that was updated
358
			 * @param GravityView_Edit_Entry_Render $this This object
359
			 * @param GravityView_View_Data $gv_data The View data
360
			 */
361 4
			do_action( 'gravityview/edit_entry/after_update', $this->form, $this->entry['id'], $this, $gv_data );
362
363
		} else {
364
			gravityview()->log->error( 'Submission is NOT valid.', array( 'entry' => $this->entry ) );
365
		}
366
367 4
	} // process_save
368
369
	/**
370
	 * Delete the value of fields hidden by conditional logic when the entry is edited
371
	 *
372
	 * @uses GFFormsModel::update_lead_field_value()
373
	 *
374
	 * @since 1.17.4
375
	 *
376
	 * @return void
377
	 */
378 3
	private function unset_hidden_field_values() {
379 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...
380
381
		/**
382
		 * @filter `gravityview/edit_entry/unset_hidden_field_values` Whether to delete values of fields hidden by conditional logic
383
		 * @since 1.22.2
384
		 * @param bool $unset_hidden_field_values Default: true
385
		 * @param GravityView_Edit_Entry_Render $this This object
386
		 */
387 3
		$unset_hidden_field_values = apply_filters( 'gravityview/edit_entry/unset_hidden_field_values', true, $this );
388
389 3
		if( ! $unset_hidden_field_values ) {
390
			return;
391
		}
392
393 3
		if ( version_compare( GravityView_GFFormsModel::get_database_version(), '2.3-dev-1', '>=' ) && method_exists( 'GFFormsModel', 'get_entry_meta_table_name' ) ) {
394 3
			$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
395 3
			$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...
396
		} else {
397
			$lead_detail_table = GFFormsModel::get_lead_details_table_name();
398
			$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...
399
		}
400
401 3
	    foreach ( $this->entry as $input_id => $field_value ) {
402
403 3
		    $field = RGFormsModel::get_field( $this->form, $input_id );
404
405
		    // Reset fields that are hidden
406
		    // Don't pass $entry as fourth parameter; force using $_POST values to calculate conditional logic
407 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...
408
409
		        // List fields are stored as empty arrays when empty
410
			    $empty_value = $this->is_field_json_encoded( $field ) ? '[]' : '';
411
412
			    $lead_detail_id = GFFormsModel::get_lead_detail_id( $current_fields, $input_id );
413
414
			    GFFormsModel::update_lead_field_value( $this->form, $this->entry, $field, $lead_detail_id, $input_id, $empty_value );
415
416
			    // Prevent the $_POST values of hidden fields from being used as default values when rendering the form
417
				// after submission
418
			    $post_input_id = 'input_' . str_replace( '.', '_', $input_id );
419 3
			    $_POST[ $post_input_id ] = '';
420
		    }
421
	    }
422 3
	}
423
424
	/**
425
	 * Have GF handle file uploads
426
	 *
427
	 * Copy of code from GFFormDisplay::process_form()
428
	 *
429
	 * @param int $form_id
430
	 */
431 3
	private function process_save_process_files( $form_id ) {
432
433
		//Loading files that have been uploaded to temp folder
434 3
		$files = GFCommon::json_decode( stripslashes( RGForms::post( 'gform_uploaded_files' ) ) );
435 3
		if ( ! is_array( $files ) ) {
436 2
			$files = array();
437
		}
438
439
		/**
440
		 * Make sure the fileuploads are not overwritten if no such request was done.
441
		 * @since 1.20.1
442
		 */
443 3
		add_filter( "gform_save_field_value_$form_id", array( $this, 'save_field_value' ), 99, 5 );
444
445 3
		RGFormsModel::$uploaded_files[ $form_id ] = $files;
446 3
	}
447
448
	/**
449
	 * Make sure the fileuploads are not overwritten if no such request was done.
450
	 *
451
	 * TO ONLY BE USED INTERNALLY; DO NOT DEVELOP ON; MAY BE REMOVED AT ANY TIME.
452
	 *
453
	 * @since 1.20.1
454
	 *
455
	 * @param string $value Field value
456
	 * @param array $entry GF entry array
457
	 * @param GF_Field_FileUpload $field
458
	 * @param array $form GF form array
459
	 * @param string $input_id ID of the input being saved
460
	 *
461
	 * @return string
462
	 */
463 3
	public function save_field_value( $value = '', $entry = array(), $field = null, $form = array(), $input_id = '' ) {
464
465 3
		if ( ! $field || $field->type != 'fileupload' ) {
0 ignored issues
show
introduced by
Found "!= '". Use Yoda Condition checks, you must
Loading history...
466 3
			return $value;
467
		}
468
469 1
		$input_name = 'input_' . str_replace( '.', '_', $input_id );
470
471 1
		if ( $field->multipleFiles ) {
472
			if ( empty( $value ) ) {
473
				return json_decode( $entry[ $input_id ], true );
474
			}
475
			return $value;
476
		}
477
478
		/** No file is being uploaded. */
479 1
		if ( empty( $_FILES[ $input_name ]['name'] ) ) {
480
			/** So return the original upload */
481 1
			return $entry[ $input_id ];
482
		}
483
484 1
		return $value;
485
	}
486
487
	/**
488
	 * Remove max_files validation (done on gravityforms.js) to avoid conflicts with GravityView
489
	 * Late validation done on self::custom_validation
490
	 *
491
	 * @param $plupload_init array Plupload settings
492
	 * @param $form_id
493
	 * @param $instance
494
	 * @return mixed
495
	 */
496 2
	public function modify_fileupload_settings( $plupload_init, $form_id, $instance ) {
0 ignored issues
show
Unused Code introduced by
The parameter $form_id is not used and could be removed.

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

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

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

Loading history...
497 2
		if( ! $this->is_edit_entry() ) {
498
			return $plupload_init;
499
		}
500
501 2
		$plupload_init['gf_vars']['max_files'] = 0;
502
503 2
		return $plupload_init;
504
	}
505
506
507
	/**
508
	 * Set visibility to visible and convert field input key to string
509
	 * @return array $form
510
	 */
511 3
	private function form_prepare_for_save() {
512
513 3
		$form = $this->form;
514
515
	    /** @var GF_Field $field */
516 3
		foreach( $form['fields'] as $k => &$field ) {
517
518
			/**
519
			 * Remove the fields with calculation formulas before save to avoid conflicts with GF logic
520
			 * @since 1.16.3
521
			 * @var GF_Field $field
522
			 */
523 3
			if( $field->has_calculation() ) {
524
				unset( $form['fields'][ $k ] );
525
			}
526
527 3
			$field->adminOnly = false;
528
529 3
			if( isset( $field->inputs ) && is_array( $field->inputs ) ) {
530
				foreach( $field->inputs as $key => $input ) {
531 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...
532
				}
533
			}
534
		}
535
536 3
		return $form;
537
	}
538
539 3
	private function update_calculation_fields() {
540
541 3
		$form = self::$original_form;
542 3
		$update = false;
543
544
		// get the most up to date entry values
545 3
		$entry = GFAPI::get_entry( $this->entry['id'] );
546
547 3
		if( !empty( $this->fields_with_calculation ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
548
			$update = true;
549
			foreach ( $this->fields_with_calculation as $calc_field ) {
550
				$inputs = $calc_field->get_entry_inputs();
551
				if ( is_array( $inputs ) ) {
552
				    foreach ( $inputs as $input ) {
553
				        $input_name = 'input_' . str_replace( '.', '_', $input['id'] );
554
				        $entry[ strval( $input['id'] ) ] = RGFormsModel::prepare_value( $form, $calc_field, '', $input_name, $entry['id'], $entry );
555
				    }
556
				} else {
557
				    $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...
558
				    $entry[ strval( $calc_field->id ) ] = RGFormsModel::prepare_value( $form, $calc_field, '', $input_name, $entry['id'], $entry );
559
				}
560
			}
561
562
		}
563
564 3
		if( $update ) {
565
566
			$return_entry = GFAPI::update_entry( $entry );
567
568
			if( is_wp_error( $return_entry ) ) {
569
				gravityview()->log->error( 'Updating the entry calculation fields failed', array( 'data' => $return_entry ) );
570
			} else {
571
				gravityview()->log->debug( 'Updating the entry calculation fields succeeded' );
572
			}
573
		}
574 3
	}
575
576
	/**
577
	 * Handle updating the Post Image field
578
	 *
579
	 * Sets a new Featured Image if configured in Gravity Forms; otherwise uploads/updates media
580
	 *
581
	 * @since 1.17
582
	 *
583
	 * @uses GFFormsModel::media_handle_upload
584
	 * @uses set_post_thumbnail
585
	 * 
586
	 * @param array $form GF Form array
587
	 * @param GF_Field $field GF Field
588
	 * @param string $field_id Numeric ID of the field
589
	 * @param string $value
590
	 * @param array $entry GF Entry currently being edited
591
	 * @param int $post_id ID of the Post being edited
592
	 *
593
	 * @return mixed|string
594
	 */
595 1
	private function update_post_image( $form, $field, $field_id, $value, $entry, $post_id ) {
596
597 1
		$input_name = 'input_' . $field_id;
598
599 1
		if ( !empty( $_FILES[ $input_name ]['name'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
600
601
			// We have a new image
602
603
			$value = RGFormsModel::prepare_value( $form, $field, $value, $input_name, $entry['id'] );
604
605
			$ary = ! empty( $value ) ? explode( '|:|', $value ) : array();
606
	        $ary = stripslashes_deep( $ary );
607
			$img_url = \GV\Utils::get( $ary, 0 );
608
609
			$img_title       = count( $ary ) > 1 ? $ary[1] : '';
610
			$img_caption     = count( $ary ) > 2 ? $ary[2] : '';
611
			$img_description = count( $ary ) > 3 ? $ary[3] : '';
612
613
			$image_meta = array(
614
				'post_excerpt' => $img_caption,
615
				'post_content' => $img_description,
616
			);
617
618
			//adding title only if it is not empty. It will default to the file name if it is not in the array
619
			if ( ! empty( $img_title ) ) {
620
				$image_meta['post_title'] = $img_title;
621
			}
622
623
			/**
624
			 * 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.
625
			 * Note: the method became public in GF 1.9.17.7, but we don't require that version yet.
626
			 */
627
			require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
628
			$media_id = GravityView_GFFormsModel::media_handle_upload( $img_url, $post_id, $image_meta );
629
630
			// is this field set as featured image?
631
			if ( $media_id && $field->postFeaturedImage ) {
632
				set_post_thumbnail( $post_id, $media_id );
633
			}
634
635 1
		} elseif ( ! empty( $_POST[ $input_name ] ) && is_array( $value ) ) {
636
637 1
			$img_url         = stripslashes_deep( $_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...
638 1
			$img_title       = stripslashes_deep( \GV\Utils::_POST( $input_name . '_1' ) );
639 1
			$img_caption     = stripslashes_deep( \GV\Utils::_POST( $input_name . '_4' ) );
640 1
			$img_description = stripslashes_deep( \GV\Utils::_POST( $input_name . '_7' ) );
641
642 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...
643
644 1
			if ( $field->postFeaturedImage ) {
645
646
				$image_meta = array(
647 1
					'ID' => get_post_thumbnail_id( $post_id ),
648 1
					'post_title' => $img_title,
649 1
					'post_excerpt' => $img_caption,
650 1
					'post_content' => $img_description,
651
				);
652
653
				// update image title, caption or description
654 1
				wp_update_post( $image_meta );
655
			}
656
		} else {
657
658
			// if we get here, image was removed or not set.
659
			$value = '';
660
661
			if ( $field->postFeaturedImage ) {
662
				delete_post_thumbnail( $post_id );
663
			}
664
		}
665
666 1
		return $value;
667
	}
668
669
	/**
670
	 * Loop through the fields being edited and if they include Post fields, update the Entry's post object
671
	 *
672
	 * @param array $form Gravity Forms form
673
	 *
674
	 * @return void
675
	 */
676 3
	private function maybe_update_post_fields( $form ) {
677
678 3
		if( empty( $this->entry['post_id'] ) ) {
679 2
	        gravityview()->log->debug( 'This entry has no post fields. Continuing...' );
680 2
			return;
681
		}
682
683 1
		$post_id = $this->entry['post_id'];
684
685
		// Security check
686 1
		if( false === GVCommon::has_cap( 'edit_post', $post_id ) ) {
687
			gravityview()->log->error( 'The current user does not have the ability to edit Post #{post_id}', array( 'post_id' => $post_id ) );
688
			return;
689
		}
690
691 1
		$update_entry = false;
692
693 1
		$updated_post = $original_post = get_post( $post_id );
694
695 1
		foreach ( $this->entry as $field_id => $value ) {
696
697 1
			$field = RGFormsModel::get_field( $form, $field_id );
698
699 1
			if( ! $field ) {
700 1
				continue;
701
			}
702
703 1
			if( GFCommon::is_post_field( $field ) && 'post_category' !== $field->type ) {
704
705
				// Get the value of the field, including $_POSTed value
706 1
				$value = RGFormsModel::get_field_value( $field );
707
708
				// Use temporary entry variable, to make values available to fill_post_template() and update_post_image()
709 1
				$entry_tmp = $this->entry;
710 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...
711
712 1
				switch( $field->type ) {
713
714 1
				    case 'post_title':
715
				        $post_title = $value;
716
				        if ( \GV\Utils::get( $form, 'postTitleTemplateEnabled' ) ) {
717
				            $post_title = $this->fill_post_template( $form['postTitleTemplate'], $form, $entry_tmp );
718
				        }
719
				        $updated_post->post_title = $post_title;
720
				        $updated_post->post_name  = $post_title;
721
				        unset( $post_title );
722
				        break;
723
724 1
				    case 'post_content':
725
				        $post_content = $value;
726
				        if ( \GV\Utils::get( $form, 'postContentTemplateEnabled' ) ) {
727
				            $post_content = $this->fill_post_template( $form['postContentTemplate'], $form, $entry_tmp, true );
728
				        }
729
				        $updated_post->post_content = $post_content;
730
				        unset( $post_content );
731
				        break;
732 1
				    case 'post_excerpt':
733
				        $updated_post->post_excerpt = $value;
734
				        break;
735 1
				    case 'post_tags':
736
				        wp_set_post_tags( $post_id, $value, false );
737
				        break;
738 1
				    case 'post_category':
739
				        break;
740 1
				    case 'post_custom_field':
741
						if ( is_array( $value ) && ( floatval( $field_id ) !== floatval( $field->id ) ) ) {
742
							$value = $value[ $field_id ];
743
						}
744
745
				        if( ! empty( $field->customFieldTemplateEnabled ) ) {
746
				            $value = $this->fill_post_template( $field->customFieldTemplate, $form, $entry_tmp, true );
747
				        }
748
749
	                    if ( $this->is_field_json_encoded( $field ) && ! is_string( $value ) ) {
750
		                    $value = wp_json_encode( $value );
751
	                    }
752
753
				        update_post_meta( $post_id, $field->postCustomFieldName, $value );
754
				        break;
755
756 1
				    case 'post_image':
757 1
				        $value = $this->update_post_image( $form, $field, $field_id, $value, $this->entry, $post_id );
758 1
				        break;
759
760
				}
761
762
				// update entry after
763 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...
764
765 1
				$update_entry = true;
766
767 1
				unset( $entry_tmp );
768
			}
769
770
		}
771
772 1
		if( $update_entry ) {
773
774 1
			$return_entry = GFAPI::update_entry( $this->entry );
775
776 1
			if( is_wp_error( $return_entry ) ) {
777
				gravityview()->log->error( 'Updating the entry post fields failed', array( 'data' => array( '$this->entry' => $this->entry, '$return_entry' => $return_entry ) ) );
778
			} else {
779 1
				gravityview()->log->debug( 'Updating the entry post fields for post #{post_id} succeeded', array( 'post_id' => $post_id ) );
780
			}
781
782
		}
783
784 1
		$return_post = wp_update_post( $updated_post, true );
785
786 1
		if( is_wp_error( $return_post ) ) {
787
			$return_post->add_data( $updated_post, '$updated_post' );
788
			gravityview()->log->error( 'Updating the post content failed', array( 'data' => compact( 'updated_post', 'return_post' ) ) );
789
		} else {
790 1
			gravityview()->log->debug( 'Updating the post content for post #{post_id} succeeded', array( 'post_id' => $post_id, 'data' => $updated_post ) );
791
		}
792 1
	}
793
794
	/**
795
	 * Is the field stored in a JSON-encoded manner?
796
	 *
797
	 * @param GF_Field $field
798
	 *
799
	 * @return bool True: stored in DB json_encode()'d; False: not encoded
800
	 */
801
	private function is_field_json_encoded( $field ) {
802
803
	    $json_encoded = false;
804
805
		$input_type = RGFormsModel::get_input_type( $field );
806
807
	    // Only certain custom field types are supported
808
	    switch( $input_type ) {
809
		    case 'fileupload':
810
		    case 'list':
811
		    case 'multiselect':
812
			    $json_encoded = true;
813
			    break;
814
	    }
815
816
	    return $json_encoded;
817
	}
818
819
	/**
820
	 * Convert a field content template into prepared output
821
	 *
822
	 * @uses GravityView_GFFormsModel::get_post_field_images()
823
	 *
824
	 * @since 1.17
825
	 *
826
	 * @param string $template The content template for the field
827
	 * @param array $form Gravity Forms form
828
	 * @param bool $do_shortcode Whether to process shortcode inside content. In GF, only run on Custom Field and Post Content fields
829
	 *
830
	 * @return string
831
	 */
832
	private function fill_post_template( $template, $form, $entry, $do_shortcode = false ) {
833
834
		require_once GRAVITYVIEW_DIR . 'includes/class-gravityview-gfformsmodel.php';
835
836
		$post_images = GravityView_GFFormsModel::get_post_field_images( $form, $entry );
837
838
		//replacing post image variables
839
		$output = GFCommon::replace_variables_post_image( $template, $post_images, $entry );
840
841
		//replacing all other variables
842
		$output = GFCommon::replace_variables( $output, $form, $entry, false, false, false );
843
844
		// replace conditional shortcodes
845
		if( $do_shortcode ) {
846
			$output = do_shortcode( $output );
847
		}
848
849
		return $output;
850
	}
851
852
853
	/**
854
	 * Perform actions normally performed after updating a lead
855
	 *
856
	 * @since 1.8
857
	 *
858
	 * @see GFEntryDetail::lead_detail_page()
859
	 *
860
	 * @return void
861
	 */
862 3
	private function after_update() {
863
864 3
		do_action( 'gform_after_update_entry', $this->form, $this->entry['id'], self::$original_entry );
865 3
		do_action( "gform_after_update_entry_{$this->form['id']}", $this->form, $this->entry['id'], self::$original_entry );
866
867
		// Re-define the entry now that we've updated it.
868 3
		$entry = RGFormsModel::get_lead( $this->entry['id'] );
869
870 3
		$entry = GFFormsModel::set_entry_meta( $entry, $this->form );
871
872 3
		if ( version_compare( GFFormsModel::get_database_version(), '2.3-dev-1', '<' ) ) {
873
			// We need to clear the cache because Gravity Forms caches the field values, which
874
			// we have just updated.
875
			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...
876
				GFFormsModel::refresh_lead_field_value( $entry['id'], $field->id );
877
			}
878
		}
879
880 3
		$this->entry = $entry;
881 3
	}
882
883
884
	/**
885
	 * Display the Edit Entry form
886
	 *
887
	 * @return void
888
	 */
889 4
	public function edit_entry_form() {
890
891
		?>
892
893
		<div class="gv-edit-entry-wrapper"><?php
894
895 4
			$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...
896
897
			/**
898
			 * Fixes weird wpautop() issue
899
			 * @see https://github.com/katzwebservices/GravityView/issues/451
900
			 */
901 4
			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...
902
903
			?><h2 class="gv-edit-entry-title">
904
				<span><?php
905
906
				    /**
907
				     * @filter `gravityview_edit_entry_title` Modify the edit entry title
908
				     * @param string $edit_entry_title Modify the "Edit Entry" title
909
				     * @param GravityView_Edit_Entry_Render $this This object
910
				     */
911 4
				    $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...
912
913 4
				    echo esc_attr( $edit_entry_title );
914
			?></span>
915
			</h2>
916
917
			<?php $this->maybe_print_message(); ?>
918
919
			<?php // The ID of the form needs to be `gform_{form_id}` for the pluploader ?>
920
921
			<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...
922
923
				<?php
924
925 4
				wp_nonce_field( self::$nonce_key, self::$nonce_key );
926
927 4
				wp_nonce_field( self::$nonce_field, self::$nonce_field, false );
928
929
				// Print the actual form HTML
930 4
				$this->render_edit_form();
931
932
				?>
933 4
			</form>
934
935
			<script>
936
				gform.addFilter('gform_reset_pre_conditional_logic_field_action', function ( reset, formId, targetId, defaultValues, isInit ) {
937
				    return false;
938
				});
939
			</script>
940
941
		</div>
942
943
	<?php
944 4
	}
945
946
	/**
947
	 * Display success or error message if the form has been submitted
948
	 *
949
	 * @uses GVCommon::generate_notice
950
	 *
951
	 * @since 1.16.2.2
952
	 *
953
	 * @return void
954
	 */
955 4
	private function maybe_print_message() {
956
957 4
		if ( \GV\Utils::_POST( 'action' ) === 'update' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
958
959
			$back_link = esc_url( remove_query_arg( array( 'page', 'view', 'edit' ) ) );
960
961
			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...
962
963
				// Keeping this compatible with Gravity Forms.
964
				$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...
965
				$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...
966
967
				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...
968
969
			} else {
970
				$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...
971
972
				/**
973
				 * @filter `gravityview/edit_entry/success` Modify the edit entry success message (including the anchor link)
974
				 * @since 1.5.4
975
				 * @param string $entry_updated_message Existing message
976
				 * @param int $view_id View ID
977
				 * @param array $entry Gravity Forms entry array
978
				 * @param string $back_link URL to return to the original entry. @since 1.6
979
				 */
980
				$message = apply_filters( 'gravityview/edit_entry/success', $entry_updated_message , $this->view_id, $this->entry, $back_link );
981
982
				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...
983
			}
984
985
		}
986 4
	}
987
988
	/**
989
	 * Display the Edit Entry form in the original Gravity Forms format
990
	 *
991
	 * @since 1.9
992
	 *
993
	 * @return void
994
	 */
995 4
	private function render_edit_form() {
996
997
		/**
998
		 * @action `gravityview/edit-entry/render/before` Before rendering the Edit Entry form
999
		 * @since 1.17
1000
		 * @param GravityView_Edit_Entry_Render $this
1001
		 */
1002 4
		do_action( 'gravityview/edit-entry/render/before', $this );
1003
1004 4
		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...
1005 4
		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...
1006 4
		add_filter( 'gform_disable_view_counter', '__return_true' );
1007
1008 4
		add_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5, 5 );
1009 4
		add_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10, 5 );
1010
1011
		// We need to remove the fake $_GET['page'] arg to avoid rendering form as if in admin.
1012 4
		unset( $_GET['page'] );
0 ignored issues
show
introduced by
Detected access of super global var $_GET, probably need manual inspection.
Loading history...
1013
1014
		// TODO: Verify multiple-page forms
1015
1016 4
		ob_start(); // Prevent PHP warnings possibly caused by prefilling list fields for conditional logic
1017
1018 4
		$html = GFFormDisplay::get_form( $this->form['id'], false, false, true, $this->entry );
1019
1020 4
		ob_get_clean();
1021
1022 4
	    remove_filter( 'gform_pre_render', array( $this, 'filter_modify_form_fields' ), 5000 );
1023 4
		remove_filter( 'gform_submit_button', array( $this, 'render_form_buttons' ) );
1024 4
		remove_filter( 'gform_disable_view_counter', '__return_true' );
1025 4
		remove_filter( 'gform_field_input', array( $this, 'verify_user_can_edit_post' ), 5 );
1026 4
		remove_filter( 'gform_field_input', array( $this, 'modify_edit_field_input' ), 10 );
1027
1028 4
		echo $html;
0 ignored issues
show
introduced by
Expected next thing to be a escaping function, not '$html'
Loading history...
1029
1030
		/**
1031
		 * @action `gravityview/edit-entry/render/after` After rendering the Edit Entry form
1032
		 * @since 1.17
1033
		 * @param GravityView_Edit_Entry_Render $this
1034
		 */
1035 4
		do_action( 'gravityview/edit-entry/render/after', $this );
1036 4
	}
1037
1038
	/**
1039
	 * Display the Update/Cancel/Delete buttons for the Edit Entry form
1040
	 * @since 1.8
1041
	 * @return string
1042
	 */
1043 4
	public function render_form_buttons() {
1044 4
		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...
1045
	}
1046
1047
1048
	/**
1049
	 * Modify the form fields that are shown when using GFFormDisplay::get_form()
1050
	 *
1051
	 * By default, all fields will be shown. We only want the Edit Tab configured fields to be shown.
1052
	 *
1053
	 * @param array $form
1054
	 * @param boolean $ajax Whether in AJAX mode
1055
	 * @param array|string $field_values Passed parameters to the form
1056
	 *
1057
	 * @since 1.9
1058
	 *
1059
	 * @return array Modified form array
1060
	 */
1061 4
	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...
1062
1063
		// In case we have validated the form, use it to inject the validation results into the form render
1064 4
		if( isset( $this->form_after_validation ) ) {
1065 3
			$form = $this->form_after_validation;
1066
		} else {
1067 4
			$form['fields'] = $this->get_configured_edit_fields( $form, $this->view_id );
1068
		}
1069
1070 4
		$form = $this->filter_conditional_logic( $form );
1071
1072 4
		$form = $this->prefill_conditional_logic( $form );
1073
1074
		// for now we don't support Save and Continue feature.
1075 4
		if( ! self::$supports_save_and_continue ) {
1076 4
	        unset( $form['save'] );
1077
		}
1078
1079 4
		$form = $this->unselect_default_values( $form );
1080
1081 4
		return $form;
1082
	}
1083
1084
	/**
1085
	 * 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.
1086
	 *
1087
	 * @since 1.16.2.2
1088
	 *
1089
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1090
	 * @param GF_Field $field
1091
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1092
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1093
	 * @param int $form_id Form ID
1094
	 *
1095
	 * @return string If error, the error message. If no error, blank string (modify_edit_field_input() runs next)
1096
	 */
1097 4
	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...
1098
1099 4
		if( ! GFCommon::is_post_field( $field ) ) {
1100 4
			return $field_content;
1101
		}
1102
1103 2
        $message = null;
1104
1105
        // First, make sure they have the capability to edit the post.
1106 2
        if( false === current_user_can( 'edit_post', $this->entry['post_id'] ) ) {
1107
1108
            /**
1109
             * @filter `gravityview/edit_entry/unsupported_post_field_text` Modify the message when someone isn't able to edit a post
1110
             * @param string $message The existing "You don't have permission..." text
1111
             */
1112 1
            $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...
1113
1114 1
        } elseif( null === get_post( $this->entry['post_id'] ) ) {
1115
            /**
1116
             * @filter `gravityview/edit_entry/no_post_text` Modify the message when someone is editing an entry attached to a post that no longer exists
1117
             * @param string $message The existing "This field is not editable; the post no longer exists." text
1118
             */
1119
            $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...
1120
        }
1121
1122 2
        if( $message ) {
1123 1
            $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...
1124
        }
1125
1126 2
        return $field_content;
1127
	}
1128
1129
	/**
1130
	 *
1131
	 * Fill-in the saved values into the form inputs
1132
	 *
1133
	 * @param string $field_content Always empty. Returning not-empty overrides the input.
1134
	 * @param GF_Field $field
1135
	 * @param string|array $value If array, it's a field with multiple inputs. If string, single input.
1136
	 * @param int $lead_id Lead ID. Always 0 for the `gform_field_input` filter.
1137
	 * @param int $form_id Form ID
1138
	 *
1139
	 * @return mixed
1140
	 */
1141 4
	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...
1142
1143 4
		$gv_field = GravityView_Fields::get_associated_field( $field );
1144
1145
		// If the form has been submitted, then we don't need to pre-fill the values,
1146
		// Except for fileupload type and when a field input is overridden- run always!!
1147
		if(
1148 4
			( $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...
1149 4
			&& false === ( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) )
1150
			&& ! GFCommon::is_product_field( $field->type )
1151 4
			|| ! empty( $field_content )
1152 4
			|| in_array( $field->type, array( 'honeypot' ) )
1153
		) {
1154 1
	        return $field_content;
1155
		}
1156
1157
		// SET SOME FIELD DEFAULTS TO PREVENT ISSUES
1158 4
		$field->adminOnly = false; /** @see GFFormDisplay::get_counter_init_script() need to prevent adminOnly */
1159
1160 4
		$field_value = $this->get_field_value( $field );
1161
1162
	    // Prevent any PHP warnings, like undefined index
1163 4
	    ob_start();
1164
1165 4
	    $return = null;
1166
1167
		/** @var GravityView_Field $gv_field */
1168 4
		if( $gv_field && is_callable( array( $gv_field, 'get_field_input' ) ) ) {
1169 3
			$return = $gv_field->get_field_input( $this->form, $field_value, $this->entry, $field );
1170
		} else {
1171 4
	        $return = $field->get_field_input( $this->form, $field_value, $this->entry );
1172
	    }
1173
1174
	    // If there was output, it's an error
1175 4
	    $warnings = ob_get_clean();
1176
1177 4
	    if( !empty( $warnings ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1178
		    gravityview()->log->error( '{warning}', array( 'warning' => $warnings, 'data' => $field_value ) );
1179
	    }
1180
1181 4
		return $return;
1182
	}
1183
1184
	/**
1185
	 * Modify the value for the current field input
1186
	 *
1187
	 * @param GF_Field $field
1188
	 *
1189
	 * @return array|mixed|string
1190
	 */
1191 4
	private function get_field_value( $field ) {
1192
1193
		/**
1194
		 * @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.
1195
		 * @param boolean True: override saved values; False: don't override (default)
1196
		 * @param $field GF_Field object Gravity Forms field object
1197
		 * @since 1.13
1198
		 */
1199 4
		$override_saved_value = apply_filters( 'gravityview/edit_entry/pre_populate/override', false, $field );
1200
1201
		// We're dealing with multiple inputs (e.g. checkbox) but not time or date (as it doesn't store data in input IDs)
1202 4
		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...
1203
1204 1
			$field_value = array();
1205
1206
			// only accept pre-populated values if the field doesn't have any choice selected.
1207 1
			$allow_pre_populated = $field->allowsPrepopulate;
1208
1209 1
			foreach ( (array)$field->inputs as $input ) {
0 ignored issues
show
introduced by
No space after closing casting parenthesis is prohibited
Loading history...
1210
1211 1
				$input_id = strval( $input['id'] );
1212
				
1213 1
				if ( isset( $this->entry[ $input_id ] ) && ! gv_empty( $this->entry[ $input_id ], false, false ) ) {
1214 1
				    $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...
1215 1
				    $allow_pre_populated = false;
1216
				}
1217
1218
			}
1219
1220 1
			$pre_value = $field->get_value_submission( array(), false );
1221
1222 1
			$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...
1223
1224
		} else {
1225
1226 4
			$id = intval( $field->id );
1227
1228
			// get pre-populated value if exists
1229 4
			$pre_value = $field->allowsPrepopulate ? GFFormsModel::get_parameter_value( $field->inputName, array(), $field ) : '';
1230
1231
			// saved field entry value (if empty, fallback to the pre-populated value, if exists)
1232
			// or pre-populated value if not empty and set to override saved value
1233 4
			$field_value = isset( $this->entry[ $id ] ) && ! gv_empty( $this->entry[ $id ], false, false ) && ! ( $override_saved_value && !gv_empty( $pre_value, false, false ) ) ? $this->entry[ $id ] : $pre_value;
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1234
1235
			// in case field is post_category but inputType is select, multi-select or radio, convert value into array of category IDs.
1236 4
			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...
1237
				$categories = array();
1238
				foreach ( explode( ',', $field_value ) as $cat_string ) {
1239
				    $categories[] = GFCommon::format_post_category( $cat_string, true );
1240
				}
1241
				$field_value = 'multiselect' === $field->get_input_type() ? $categories : implode( '', $categories );
1242
			}
1243
1244
		}
1245
1246
		// if value is empty get the default value if defined
1247 4
		$field_value = $field->get_value_default_if_empty( $field_value );
1248
1249
	    /**
1250
	     * @filter `gravityview/edit_entry/field_value` Change the value of an Edit Entry field, if needed
1251
	     * @since 1.11
1252
	     * @since 1.20 Added third param
1253
	     * @param mixed $field_value field value used to populate the input
1254
	     * @param object $field Gravity Forms field object ( Class GF_Field )
1255
	     * @param GravityView_Edit_Entry_Render $this Current object
1256
	     */
1257 4
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value', $field_value, $field, $this );
1258
1259
	    /**
1260
	     * @filter `gravityview/edit_entry/field_value_{field_type}` Change the value of an Edit Entry field for a specific field type
1261
	     * @since 1.17
1262
	     * @since 1.20 Added third param
1263
	     * @param mixed $field_value field value used to populate the input
1264
	     * @param GF_Field $field Gravity Forms field object
1265
	     * @param GravityView_Edit_Entry_Render $this Current object
1266
	     */
1267 4
	    $field_value = apply_filters( 'gravityview/edit_entry/field_value_' . $field->type , $field_value, $field, $this );
1268
1269 4
		return $field_value;
1270
	}
1271
1272
1273
	// ---- Entry validation
1274
1275
	/**
1276
	 * Add field keys that Gravity Forms expects.
1277
	 *
1278
	 * @see GFFormDisplay::validate()
1279
	 * @param  array $form GF Form
1280
	 * @return array       Modified GF Form
1281
	 */
1282 3
	public function gform_pre_validation( $form ) {
1283
1284 3
		if( ! $this->verify_nonce() ) {
1285
			return $form;
1286
		}
1287
1288
		// Fix PHP warning regarding undefined index.
1289 3
		foreach ( $form['fields'] as &$field) {
0 ignored issues
show
introduced by
No space before closing parenthesis is prohibited
Loading history...
1290
1291
			// This is because we're doing admin form pretending to be front-end, so Gravity Forms
1292
			// expects certain field array items to be set.
1293 3
			foreach ( array( 'noDuplicates', 'adminOnly', 'inputType', 'isRequired', 'enablePrice', 'inputs', 'allowedExtensions' ) as $key ) {
1294 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...
1295
			}
1296
1297 3
			switch( RGFormsModel::get_input_type( $field ) ) {
1298
1299
				/**
1300
				 * 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.
1301
				 *
1302
				 * 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.
1303
				 *
1304
				 * @hack
1305
				 */
1306 3
				case 'fileupload':
1307
1308
				    // Set the previous value
1309 1
				    $entry = $this->get_entry();
1310
1311 1
				    $input_name = 'input_'.$field->id;
1312 1
				    $form_id = $form['id'];
1313
1314 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...
1315
1316
				    // Use the previous entry value as the default.
1317 1
				    if( isset( $entry[ $field->id ] ) ) {
1318 1
				        $value = $entry[ $field->id ];
1319
				    }
1320
1321
				    // If this is a single upload file
1322 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...
1323 1
				        $file_path = GFFormsModel::get_file_upload_path( $form['id'], $_FILES[ $input_name ]['name'] );
1324 1
				        $value = $file_path['url'];
1325
1326
				    } else {
1327
1328
				        // Fix PHP warning on line 1498 of form_display.php for post_image fields
1329
				        // Fix PHP Notice:  Undefined index:  size in form_display.php on line 1511
1330 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...
1331
1332
				    }
1333
1334 1
				    if ( \GV\Utils::get( $field, "multipleFiles" ) ) {
0 ignored issues
show
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...
1335
1336
				        // If there are fresh uploads, process and merge them.
1337
				        // Otherwise, use the passed values, which should be json-encoded array of URLs
1338 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...
1339
				            $value = empty( $value ) ? '[]' : $value;
1340
				            $value = stripslashes_deep( $value );
1341 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...
1342
				        }
1343
1344
				    } else {
1345
1346
				        // A file already exists when editing an entry
1347
				        // We set this to solve issue when file upload fields are required.
1348 1
				        GFFormsModel::$uploaded_files[ $form_id ][ $input_name ] = $value;
1349
1350
				    }
1351
1352 1
				    $this->entry[ $input_name ] = $value;
1353 1
				    $_POST[ $input_name ] = $value;
1354
1355 1
				    break;
1356
1357 3
				case 'number':
1358
				    // Fix "undefined index" issue at line 1286 in form_display.php
1359 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...
1360
				        $_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...
1361
				    }
1362 3
				    break;
1363
			}
1364
1365
		}
1366
1367 3
		return $form;
1368
	}
1369
1370
1371
	/**
1372
	 * Process validation for a edit entry submission
1373
	 *
1374
	 * Sets the `is_valid` object var
1375
	 *
1376
	 * @return void
1377
	 */
1378 4
	private function validate() {
1379
1380
		/**
1381
		 * If using GF User Registration Add-on, remove the validation step, otherwise generates error when updating the entry
1382
		 * GF User Registration Add-on version > 3.x has a different class name
1383
		 * @since 1.16.2
1384
		 */
1385 4
		if ( class_exists( 'GF_User_Registration' ) ) {
1386 4
			remove_filter( 'gform_validation', array( GF_User_Registration::get_instance(), 'validate' ) );
1387
		} else  if ( class_exists( 'GFUser' ) ) {
1388
			remove_filter( 'gform_validation', array( 'GFUser', 'user_registration_validation' ) );
1389
		}
1390
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1391
1392
		/**
1393
		 * For some crazy reason, Gravity Forms doesn't validate Edit Entry form submissions.
1394
		 * You can enter whatever you want!
1395
		 * We try validating, and customize the results using `self::custom_validation()`
1396
		 */
1397 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...
1398
1399
		// Needed by the validate funtion
1400 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...
1401 4
		$field_values = RGForms::post( 'gform_field_values' );
1402
1403
		// Prevent entry limit from running when editing an entry, also
1404
		// prevent form scheduling from preventing editing
1405 4
		unset( $this->form['limitEntries'], $this->form['scheduleForm'] );
1406
1407
		// Hide fields depending on Edit Entry settings
1408 4
		$this->form['fields'] = $this->get_configured_edit_fields( $this->form, $this->view_id );
1409
1410 4
		$this->is_valid = GFFormDisplay::validate( $this->form, $field_values, 1, $failed_validation_page );
1411
1412 4
		remove_filter( 'gform_validation_'. $this->form_id, array( $this, 'custom_validation' ), 10 );
1413 4
	}
1414
1415
1416
	/**
1417
	 * Make validation work for Edit Entry
1418
	 *
1419
	 * Because we're calling the GFFormDisplay::validate() in an unusual way (as a front-end
1420
	 * form pretending to be a back-end form), validate() doesn't know we _can't_ edit post
1421
	 * fields. This goes through all the fields and if they're an invalid post field, we
1422
	 * set them as valid. If there are still issues, we'll return false.
1423
	 *
1424
	 * @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...
1425
	 * @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...
1426
	 */
1427 4
	public function custom_validation( $validation_results ) {
1428
1429 4
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results: ', array( 'data' => $validation_results ) );
1430
1431 4
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] $_POSTed data (sanitized): ', array( 'data' => 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...
1432
1433 4
		$gv_valid = true;
1434
1435 4
		foreach ( $validation_results['form']['fields'] as $key => &$field ) {
1436
1437 4
			$value = RGFormsModel::get_field_value( $field );
1438 4
			$field_type = RGFormsModel::get_input_type( $field );
1439
1440
			// Validate always
1441 4
			switch ( $field_type ) {
1442
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1443
1444 4
				case 'fileupload' :
1445 4
				case 'post_image':
1446
1447
				    // in case nothing is uploaded but there are already files saved
1448 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...
1449
				        $field->failed_validation = false;
1450
				        unset( $field->validation_message );
1451
				    }
1452
1453
				    // validate if multi file upload reached max number of files [maxFiles] => 2
1454 2
				    if( \GV\Utils::get( $field, 'maxFiles') && \GV\Utils::get( $field, 'multipleFiles') ) {
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces before closing bracket; 0 found
Loading history...
1455
1456
				        $input_name = 'input_' . $field->id;
1457
				        //uploaded
1458
				        $file_names = isset( GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] ) ? GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ][ $input_name ] : array();
1459
1460
				        //existent
1461
				        $entry = $this->get_entry();
1462
				        $value = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1463
				        if( isset( $entry[ $field->id ] ) ) {
1464
				            $value = json_decode( $entry[ $field->id ], true );
1465
				        }
1466
1467
				        // count uploaded files and existent entry files
1468
				        $count_files = count( $file_names ) + count( $value );
1469
1470
				        if( $count_files > $field->maxFiles ) {
1471
				            $field->validation_message = __( 'Maximum number of files reached', 'gravityview' );
1472
				            $field->failed_validation = 1;
1473
				            $gv_valid = false;
1474
1475
				            // in case of error make sure the newest upload files are removed from the upload input
1476
				            GFFormsModel::$uploaded_files[ $validation_results['form']['id'] ] = null;
1477
				        }
1478
1479
				    }
1480
0 ignored issues
show
Coding Style introduced by
Functions must not contain multiple empty lines in a row; found 2 empty lines
Loading history...
1481
1482 2
				    break;
1483
1484
			}
1485
1486
			// This field has failed validation.
1487 4
			if( !empty( $field->failed_validation ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1488
1489 1
				gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field is invalid.', array( 'data' => array( 'field' => $field, 'value' => $value ) ) );
1490
1491 1
				switch ( $field_type ) {
1492
1493
				    // Captchas don't need to be re-entered.
1494 1
				    case 'captcha':
1495
1496
				        // Post Image fields aren't editable, so we un-fail them.
1497 1
				    case 'post_image':
1498
				        $field->failed_validation = false;
1499
				        unset( $field->validation_message );
1500
				        break;
1501
1502
				}
1503
1504
				// You can't continue inside a switch, so we do it after.
1505 1
				if( empty( $field->failed_validation ) ) {
1506
				    continue;
1507
				}
1508
1509
				// checks if the No Duplicates option is not validating entry against itself, since
1510
				// we're editing a stored entry, it would also assume it's a duplicate.
1511 1
				if( !empty( $field->noDuplicates ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1512
1513
				    $entry = $this->get_entry();
1514
1515
				    // If the value of the entry is the same as the stored value
1516
				    // Then we can assume it's not a duplicate, it's the same.
1517
				    if( !empty( $entry ) && $value == $entry[ $field->id ] ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1518
				        //if value submitted was not changed, then don't validate
1519
				        $field->failed_validation = false;
1520
1521
				        unset( $field->validation_message );
1522
1523
				        gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Field not a duplicate; it is the same entry.', array( 'data' => $entry ) );
1524
1525
				        continue;
1526
				    }
1527
				}
1528
1529
				// if here then probably we are facing the validation 'At least one field must be filled out'
1530 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...
1531
				    unset( $field->validation_message );
1532
	                $field->validation_message = false;
1533
				    continue;
1534
				}
1535
1536 4
				$gv_valid = false;
1537
1538
			}
1539
1540
		}
1541
1542 4
		$validation_results['is_valid'] = $gv_valid;
1543
1544 4
		gravityview()->log->debug( 'GravityView_Edit_Entry[custom_validation] Validation results.', array( 'data' => $validation_results ) );
1545
1546
		// We'll need this result when rendering the form ( on GFFormDisplay::get_form )
1547 4
		$this->form_after_validation = $validation_results['form'];
1548
1549 4
		return $validation_results;
1550
	}
1551
1552
1553
	/**
1554
	 * TODO: This seems to be hacky... we should remove it. Entry is set when updating the form using setup_vars()!
1555
	 * Get the current entry and set it if it's not yet set.
1556
	 * @return array Gravity Forms entry array
1557
	 */
1558 2
	public function get_entry() {
1559
1560 2
		if( empty( $this->entry ) ) {
1561
			// Get the database value of the entry that's being edited
1562 1
			$this->entry = gravityview_get_entry( GravityView_frontend::is_single_entry() );
1563
		}
1564
1565 2
		return $this->entry;
1566
	}
1567
1568
1569
1570
	// --- Filters
1571
1572
	/**
1573
	 * Get the Edit Entry fields as configured in the View
1574
	 *
1575
	 * @since 1.8
1576
	 *
1577
	 * @param int $view_id
1578
	 *
1579
	 * @return array Array of fields that are configured in the Edit tab in the Admin
1580
	 */
1581 5
	private function get_configured_edit_fields( $form, $view_id ) {
1582
1583
		// Get all fields for form
1584 5
		if ( \GV\View::exists( $view_id ) ) {
1585 5
			$view = \GV\View::by_id( $view_id );
1586 5
			$properties = $view->fields ? $view->fields->as_configuration() : array();
1587
		} else {
1588
			$properties = null;
1589
		}
1590
1591
		// If edit tab not yet configured, show all fields
1592 5
		$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...
1593
1594
		// Hide fields depending on admin settings
1595 5
		$fields = $this->filter_fields( $form['fields'], $edit_fields );
1596
1597
	    // If Edit Entry fields are configured, remove adminOnly field settings. Otherwise, don't.
1598 5
	    $fields = $this->filter_admin_only_fields( $fields, $edit_fields, $form, $view_id );
1599
1600
		/**
1601
		 * @filter `gravityview/edit_entry/form_fields` Modify the fields displayed in Edit Entry form
1602
		 * @since 1.17
1603
		 * @param GF_Field[] $fields Gravity Forms form fields
1604
		 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1605
		 * @param array $form GF Form array (`fields` key modified to have only fields configured to show in Edit Entry)
1606
		 * @param int $view_id View ID
1607
		 */
1608 5
		$fields = apply_filters( 'gravityview/edit_entry/form_fields', $fields, $edit_fields, $form, $view_id );
1609
1610 5
		return $fields;
1611
	}
1612
1613
1614
	/**
1615
	 * Filter area fields based on specified conditions
1616
	 *  - This filter removes the fields that have calculation configured
1617
	 *
1618
	 * @uses GravityView_Edit_Entry::user_can_edit_field() Check caps
1619
	 * @access private
1620
	 * @param GF_Field[] $fields
1621
	 * @param array $configured_fields
1622
	 * @since  1.5
1623
	 * @return array $fields
1624
	 */
1625 4
	private function filter_fields( $fields, $configured_fields ) {
1626
1627 4
		if( empty( $fields ) || !is_array( $fields ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1628
			return $fields;
1629
		}
1630
1631 4
		$edit_fields = array();
1632
1633 4
		$field_type_blacklist = $this->loader->get_field_blacklist( $this->entry );
1634
1635
		// First, remove blacklist or calculation fields
1636 4
		foreach ( $fields as $key => $field ) {
1637
1638
			// Remove the fields that have calculation properties and keep them to be used later
1639
			// @since 1.16.2
1640 4
			if( $field->has_calculation() ) {
1641
				$this->fields_with_calculation[] = $field;
1642
				// don't remove the calculation fields on form render.
1643
			}
1644
1645 4
			if( in_array( $field->type, $field_type_blacklist ) ) {
1646 4
				unset( $fields[ $key ] );
1647
			}
1648
		}
1649
1650
		// The Edit tab has not been configured, so we return all fields by default.
1651 4
		if( empty( $configured_fields ) ) {
1652 4
			return $fields;
1653
		}
1654
1655
		// The edit tab has been configured, so we loop through to configured settings
1656
		foreach ( $configured_fields as $configured_field ) {
1657
1658
	        /** @var GF_Field $field */
1659
	        foreach ( $fields as $field ) {
1660
				if( intval( $configured_field['id'] ) === intval( $field->id ) && $this->user_can_edit_field( $configured_field, false ) ) {
1661
				    $edit_fields[] = $this->merge_field_properties( $field, $configured_field );
1662
				    break;
1663
				}
1664
1665
			}
1666
1667
		}
1668
1669
		return $edit_fields;
1670
1671
	}
1672
1673
	/**
1674
	 * Override GF Form field properties with the ones defined on the View
1675
	 * @param  GF_Field $field GF Form field object
1676
	 * @param  array $field_setting  GV field options
1677
	 * @since  1.5
1678
	 * @return array|GF_Field
1679
	 */
1680
	private function merge_field_properties( $field, $field_setting ) {
1681
1682
		$return_field = $field;
1683
1684
		if( empty( $field_setting['show_label'] ) ) {
1685
			$return_field->label = '';
1686
		} elseif ( !empty( $field_setting['custom_label'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1687
			$return_field->label = $field_setting['custom_label'];
1688
		}
1689
1690
		if( !empty( $field_setting['custom_class'] ) ) {
0 ignored issues
show
introduced by
Expected 1 space after "!"; 0 found
Loading history...
1691
			$return_field->cssClass .= ' '. gravityview_sanitize_html_class( $field_setting['custom_class'] );
1692
		}
1693
1694
		/**
1695
		 * Normalize page numbers - avoid conflicts with page validation
1696
		 * @since 1.6
1697
		 */
1698
		$return_field->pageNumber = 1;
1699
1700
		return $return_field;
1701
1702
	}
1703
1704
	/**
1705
	 * Remove fields that shouldn't be visible based on the Gravity Forms adminOnly field property
1706
	 *
1707
	 * @since 1.9.1
1708
	 *
1709
	 * @param array|GF_Field[] $fields Gravity Forms form fields
1710
	 * @param array|null $edit_fields Fields for the Edit Entry tab configured in the View Configuration
1711
	 * @param array $form GF Form array
1712
	 * @param int $view_id View ID
1713
	 *
1714
	 * @return array Possibly modified form array
1715
	 */
1716 4
	private function filter_admin_only_fields( $fields = array(), $edit_fields = null, $form = array(), $view_id = 0 ) {
1717
1718
	    /**
1719
		 * @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
1720
	     * If the Edit Entry tab is not configured, adminOnly fields will not be shown to non-administrators.
1721
	     * If the Edit Entry tab *is* configured, adminOnly fields will be shown to non-administrators, using the configured GV permissions
1722
	     * @since 1.9.1
1723
	     * @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.
1724
	     * @param array $form GF Form array
1725
	     * @param int $view_id View ID
1726
	     */
1727 4
	    $use_gf_adminonly_setting = apply_filters( 'gravityview/edit_entry/use_gf_admin_only_setting', empty( $edit_fields ), $form, $view_id );
1728
1729 4
	    if( $use_gf_adminonly_setting && false === GVCommon::has_cap( 'gravityforms_edit_entries', $this->entry['id'] ) ) {
1730
			foreach( $fields as $k => $field ) {
1731
				if( $field->adminOnly ) {
1732
				    unset( $fields[ $k ] );
1733
				}
1734
			}
1735
			return $fields;
1736
		}
1737
1738 4
	    foreach( $fields as &$field ) {
1739 4
		    $field->adminOnly = false;
1740
		}
1741
1742 4
		return $fields;
1743
	}
1744
1745
	/**
1746
	 * Checkboxes and other checkbox-based controls should not
1747
	 * display default checks in edit mode.
1748
	 *
1749
	 * https://github.com/gravityview/GravityView/1149
1750
	 *
1751
	 * @since 2.1
1752
	 *
1753
	 * @param array $form Gravity Forms array object
1754
	 *
1755
	 * @return array $form, modified to default checkboxes, radios from showing up.
1756
	 */
1757 4
	private function unselect_default_values( $form ) {
1758
1759 4
	    foreach ( $form['fields'] as &$field ) {
1760
1761 4
			if ( empty( $field->choices ) ) {
1762 4
                continue;
1763
			}
1764
1765 1
            foreach ( $field->choices as &$choice ) {
1766 1
				if ( \GV\Utils::get( $choice, 'isSelected' ) ) {
1767 1
					$choice['isSelected'] = false;
1768
				}
1769
			}
1770
		}
1771
1772 4
		return $form;
1773
	}
1774
1775
	// --- Conditional Logic
1776
1777
	/**
1778
	 * Conditional logic isn't designed to work with forms that already have content. When switching input values,
1779
	 * the dependent fields will be blank.
1780
	 *
1781
	 * Note: This is because GF populates a JavaScript variable with the input values. This is tough to filter at the input level;
1782
	 * via the `gform_field_value` filter; it requires lots of legwork. Doing it at the form level is easier.
1783
	 *
1784
	 * @since 1.17.4
1785
	 *
1786
	 * @param array $form Gravity Forms array object
1787
	 *
1788
	 * @return array $form, modified to fix conditional
1789
	 */
1790 4
	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...
1791
1792 4
		if( ! GFFormDisplay::has_conditional_logic( $form ) ) {
1793 4
			return $form;
1794
		}
1795
1796
		// Have Conditional Logic pre-fill fields as if the data were default values
1797
		/** @var GF_Field $field */
1798
		foreach ( $form['fields'] as &$field ) {
1799
1800
			if( 'checkbox' === $field->type ) {
1801
				foreach ( $field->get_entry_inputs() as $key => $input ) {
1802
				    $input_id = $input['id'];
1803
				    $choice = $field->choices[ $key ];
1804
				    $value = \GV\Utils::get( $this->entry, $input_id );
1805
				    $match = RGFormsModel::choice_value_match( $field, $choice, $value );
1806
				    if( $match ) {
1807
				        $field->choices[ $key ]['isSelected'] = true;
1808
				    }
1809
				}
1810
			} else {
1811
1812
				// We need to run through each field to set the default values
1813
				foreach ( $this->entry as $field_id => $field_value ) {
1814
1815
				    if( floatval( $field_id ) === floatval( $field->id ) ) {
1816
1817
				        if( 'list' === $field->type ) {
1818
				            $list_rows = maybe_unserialize( $field_value );
1819
1820
				            $list_field_value = array();
1821
				            foreach ( (array) $list_rows as $row ) {
1822
				                foreach ( (array) $row as $column ) {
1823
				                    $list_field_value[] = $column;
1824
				                }
1825
				            }
1826
1827
				            $field->defaultValue = serialize( $list_field_value );
1828
				        } else {
1829
				            $field->defaultValue = $field_value;
1830
				        }
1831
				    }
1832
				}
1833
			}
1834
		}
1835
1836
		return $form;
1837
	}
1838
1839
	/**
1840
	 * Remove the conditional logic rules from the form button and the form fields, if needed.
1841
	 *
1842
	 * @todo Merge with caller method
1843
	 * @since 1.9
1844
	 *
1845
	 * @param array $form Gravity Forms form
1846
	 * @return array Modified form, if not using Conditional Logic
1847
	 */
1848 4
	private function filter_conditional_logic( $form ) {
1849
1850
		/**
1851
		 * @filter `gravityview/edit_entry/conditional_logic` Should the Edit Entry form use Gravity Forms conditional logic showing/hiding of fields?
1852
		 * @since 1.9
1853
		 * @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
1854
		 * @param array $form Gravity Forms form
1855
		 */
1856 4
		$use_conditional_logic = apply_filters( 'gravityview/edit_entry/conditional_logic', true, $form );
1857
1858 4
		if( $use_conditional_logic ) {
1859 4
			return $form;
1860
		}
1861
1862
		foreach( $form['fields'] as &$field ) {
1863
			/* @var GF_Field $field */
1864
			$field->conditionalLogic = null;
1865
		}
1866
1867
		unset( $form['button']['conditionalLogic'] );
1868
1869
		return $form;
1870
1871
	}
1872
1873
	/**
1874
	 * Disable the Gravity Forms conditional logic script and features on the Edit Entry screen
1875
	 *
1876
	 * @since 1.9
1877
	 *
1878
	 * @param $has_conditional_logic
1879
	 * @param $form
1880
	 * @return mixed
1881
	 */
1882 4
	public function manage_conditional_logic( $has_conditional_logic, $form ) {
1883
1884 4
		if( ! $this->is_edit_entry() ) {
1885
			return $has_conditional_logic;
1886
		}
1887
1888
	    /** @see GravityView_Edit_Entry_Render::filter_conditional_logic for filter documentation */
1889 4
		return apply_filters( 'gravityview/edit_entry/conditional_logic', $has_conditional_logic, $form );
1890
	}
1891
1892
1893
	// --- User checks and nonces
1894
1895
	/**
1896
	 * Check if the user can edit the entry
1897
	 *
1898
	 * - Is the nonce valid?
1899
	 * - Does the user have the right caps for the entry
1900
	 * - Is the entry in the trash?
1901
	 *
1902
	 * @todo Move to GVCommon
1903
	 *
1904
	 * @param  boolean $echo Show error messages in the form?
1905
	 * @return boolean        True: can edit form. False: nope.
1906
	 */
1907 5
	private function user_can_edit_entry( $echo = false ) {
1908
1909 5
		$error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1910
1911
		/**
1912
		 *  1. Permalinks are turned off
1913
		 *  2. There are two entries embedded using oEmbed
1914
		 *  3. One of the entries has just been saved
1915
		 */
1916 5
		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...
1917
1918
			$error = true;
1919
1920
		}
1921
1922 5
		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...
1923
1924
			$error = true;
1925
1926 5
		} elseif( ! $this->verify_nonce() ) {
1927
1928
			/**
1929
			 * If the Entry is embedded, there may be two entries on the same page.
1930
			 * If that's the case, and one is being edited, the other should fail gracefully and not display an error.
1931
			 */
1932
			if( GravityView_oEmbed::getInstance()->get_entry_id() ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \GravityView_oEmbed::get...tance()->get_entry_id() of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

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

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

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

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
Deprecated Code introduced by
The method GravityView_oEmbed::getInstance() has been deprecated with message: Use \GV\oEmbed instead.

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

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

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

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

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

Loading history...
1933
				$error = true;
1934
			} else {
1935
				$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...
1936
			}
1937
1938
		}
1939
1940 5
		if( ! GravityView_Edit_Entry::check_user_cap_edit_entry( $this->entry ) ) {
1941 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...
1942
		}
1943
1944 5
		if( $this->entry['status'] === 'trash' ) {
0 ignored issues
show
introduced by
Found "=== '". Use Yoda Condition checks, you must
Loading history...
1945
			$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...
1946
		}
1947
1948
		// No errors; everything's fine here!
1949 5
		if( empty( $error ) ) {
1950 5
			return true;
1951
		}
1952
1953 1
		if( $echo && $error !== true ) {
0 ignored issues
show
introduced by
Found "!== true". Use Yoda Condition checks, you must
Loading history...
1954
1955 1
	        $error = esc_html( $error );
1956
1957
	        /**
1958
	         * @since 1.9
1959
	         */
1960 1
	        if ( ! empty( $this->entry ) ) {
1961 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...
1962
	        }
1963
1964 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...
1965
		}
1966
1967 1
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
1968
1969 1
		return false;
1970
	}
1971
1972
1973
	/**
1974
	 * Check whether a field is editable by the current user, and optionally display an error message
1975
	 * @uses  GravityView_Edit_Entry->check_user_cap_edit_field() Check user capabilities
1976
	 * @param  array  $field Field or field settings array
1977
	 * @param  boolean $echo  Whether to show error message telling user they aren't allowed
1978
	 * @return boolean         True: user can edit the current field; False: nope, they can't.
1979
	 */
1980
	private function user_can_edit_field( $field, $echo = false ) {
1981
1982
		$error = NULL;
0 ignored issues
show
Coding Style introduced by
TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.
Loading history...
1983
1984
		if( ! $this->check_user_cap_edit_field( $field ) ) {
1985
			$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...
1986
		}
1987
1988
		// No errors; everything's fine here!
1989
		if( empty( $error ) ) {
1990
			return true;
1991
		}
1992
1993
		if( $echo ) {
1994
			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...
1995
		}
1996
1997
		gravityview()->log->error( '{error}', array( 'error' => $error ) );
1998
1999
		return false;
2000
2001
	}
2002
2003
2004
	/**
2005
	 * checks if user has permissions to edit a specific field
2006
	 *
2007
	 * Needs to be used combined with GravityView_Edit_Entry::user_can_edit_field for maximum security!!
2008
	 *
2009
	 * @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...
2010
	 * @return bool
2011
	 */
2012
	private function check_user_cap_edit_field( $field ) {
2013
2014
		// If they can edit any entries (as defined in Gravity Forms), we're good.
2015
		if( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_others_entries' ) ) ) {
2016
			return true;
2017
		}
2018
2019
		$field_cap = isset( $field['allow_edit_cap'] ) ? $field['allow_edit_cap'] : false;
2020
2021
		if( $field_cap ) {
2022
			return GVCommon::has_cap( $field['allow_edit_cap'] );
2023
		}
2024
2025
		return false;
2026
	}
2027
2028
2029
	/**
2030
	 * Is the current nonce valid for editing the entry?
2031
	 * @return boolean
2032
	 */
2033 4
	public function verify_nonce() {
2034
2035
		// Verify form submitted for editing single
2036 4
		if( $this->is_edit_entry_submission() ) {
2037
			$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...
2038
		}
2039
2040
		// Verify
2041 4
		else if( ! $this->is_edit_entry() ) {
2042
			$valid = false;
2043
		}
2044
2045
		else {
2046 4
			$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...
2047
		}
2048
2049
		/**
2050
		 * @filter `gravityview/edit_entry/verify_nonce` Override Edit Entry nonce validation. Return true to declare nonce valid.
2051
		 * @since 1.13
2052
		 * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
2053
		 * @param string $nonce_field Key used when validating submissions. Default: is_gv_edit_entry
2054
		 */
2055 4
		$valid = apply_filters( 'gravityview/edit_entry/verify_nonce', $valid, self::$nonce_field );
2056
2057 4
		return $valid;
2058
	}
2059
2060
2061
	/**
2062
	 * Multiselect in GF 2.2 became a json_encoded value. Fix it.
2063
	 *
2064
	 * As a hack for now we'll implode it back.
2065
	 */
2066
	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...
2067
		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...
2068
			return $field_value;
2069
		}
2070
2071
		$maybe_json = @json_decode( $field_value, true );
0 ignored issues
show
Coding Style introduced by
Silencing errors is discouraged
Loading history...
2072
2073
		if ( $maybe_json ) {
2074
			return implode( ',', $maybe_json );
2075
		}
2076
2077
		return $field_value;
2078
	}
2079
2080
2081
2082
} //end class
2083