Completed
Push — develop ( e9495e...98d972 )
by Zack
17:18 queued 11s
created

GravityView_Duplicate_Entry::verify_nonce()   A

Complexity

Conditions 3
Paths 2

Size

Total Lines 22

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 6
CRAP Score 3.0261

Importance

Changes 0
Metric Value
cc 3
nc 2
nop 0
dl 0
loc 22
ccs 6
cts 7
cp 0.8571
crap 3.0261
rs 9.568
c 0
b 0
f 0
1
<?php
2
/**
3
 * The GravityView Duplicate Entry Extension
4
 *
5
 * Duplicate entries in GravityView.
6
 *
7
 * @since     2.5
8
 * @package   GravityView
9
 * @license   GPL2+
10
 * @author    Katz Web Services, Inc.
11
 * @link      http://gravityview.co
12
 * @copyright Copyright 2014, Katz Web Services, Inc.
13
 */
14
15
if ( ! defined( 'WPINC' ) ) {
16
	die;
17
}
18
19
/**
20
 * @since 2.5
21
 */
22
final class GravityView_Duplicate_Entry {
23
24
	/**
25
	 * @var string The location of this file.
26
	 */
27
	static $file;
28
29
	/**
30
	 * @var GravityView_Duplicate_Entry This instance.
31
	 */
32
	static $instance;
33
34
	var $view_id;
35
36
	function __construct() {
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...
37
38
		self::$file = plugin_dir_path( __FILE__ );
39
		$this->add_hooks();
40
	}
41 1
42
	/**
43 1
	 * @since 2.5
44 1
	 */
45 1
	private function add_hooks() {
46
47
		add_action( 'wp', array( $this, 'process_duplicate' ), 10000 );
48
49
		add_filter( 'gravityview_entry_default_fields', array( $this, 'add_default_field' ), 10, 3 );
50 1
51
		add_action( 'gravityview_before', array( $this, 'display_message' ) );
52 1
53
		// For the Duplicate Entry Link, you don't want visible to all users.
54 1
		add_filter( 'gravityview_field_visibility_caps', array( $this, 'modify_visibility_caps' ), 10, 5 );
55
56 1
		// Modify the field options based on the name of the field type
57
		add_filter( 'gravityview_template_duplicate_link_options', array( $this, 'duplicate_link_field_options' ), 10, 5 );
58
59 1
		// add template path to check for field
60
		add_filter( 'gravityview_template_paths', array( $this, 'add_template_path' ) );
61
62 1
		// Entry duplication in the backend
63
		add_action( 'gform_entries_first_column_actions', array( $this, 'make_duplicate_link_row' ), 10, 5 );
64
65 1
		// Handle duplicate action in the backend
66 1
		add_action( 'gform_pre_entry_list', array( $this, 'maybe_duplicate_list' ) );
67
	}
68
69
	/**
70
	 * Return the instantiated class object
71
	 *
72
	 * @since  2.5
73
	 * @return GravityView_Duplicate_Entry
74 2
	 */
75
	static public function getInstance() {
76 2
77 1
		if ( empty( self::$instance ) ) {
78
			self::$instance = new self;
79
		}
80 2
81
		return self::$instance;
82
	}
83
84
	/**
85
	 * Include this extension templates path
86
	 *
87
	 * @since  2.5
88
	 *
89
	 * @param array $file_paths List of template paths ordered
90
	 *
91
	 * @return array File paths, with duplicate field path added at index 117
92 2
	 */
93
	public function add_template_path( $file_paths ) {
94
95
		// Index 100 is the default GravityView template path.
96 2
		// Index 110 is Edit Entry link
97
		$file_paths[ 117 ] = self::$file;
98 2
99
		return $file_paths;
100
	}
101
102
	/**
103
	 * Add "Duplicate Link Text" setting to the edit_link field settings
104
	 *
105
	 * @since  2.5
106
	 *
107
	 * @param  array  $field_options [description]
108
	 * @param  [type] $template_id   [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...
109
	 * @param  [type] $field_id      [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...
110
	 * @param  [type] $context       [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...
111
	 * @param  [type] $input_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...
112
	 *
113
	 * @return array                [description]
114
	 */
115
	public function duplicate_link_field_options( $field_options, $template_id, $field_id, $context, $input_type ) {
116
117
		// Always a link, never a filter, always same window
118
		unset( $field_options['show_as_link'], $field_options['search_filter'], $field_options['new_window'] );
119
120
		// Duplicate Entry link should only appear to visitors capable of editing entries
121
		unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] );
122
123
		$add_option['duplicate_link'] = array(
0 ignored issues
show
Coding Style Comprehensibility introduced by
$add_option was never initialized. Although not strictly required by PHP, it is generally a good practice to add $add_option = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
124
			'type' => 'text',
125
			'label' => __( 'Duplicate Link Text', 'gravityview' ),
126
			'desc' => NULL,
127
			'value' => __( 'Duplicate Entry', 'gravityview' ),
128
			'merge_tags' => true,
129
		);
130
131
		$field_options['allow_duplicate_cap'] = array(
132
			'type' => 'select',
133
			'label' => __( 'Allow the following users to duplicate the entry:', 'gravityview' ),
134
			'choices' => GravityView_Render_Settings::get_cap_choices( $template_id, $field_id, $context, $input_type ),
135
			'tooltip' => 'allow_duplicate_cap',
136
			'class' => 'widefat',
137
			'value' => 'read', // Default: entry creator
138
		);
139
140
		return array_merge( $add_option, $field_options );
141
	}
142
143
144
	/**
145
	 * Add Edit Link as a default field, outside those set in the Gravity Form form
146
	 *
147
	 * @since 2.5
148
	 *
149
	 * @param array $entry_default_fields Existing fields
150
	 * @param  string|array $form form_ID or form object
151
	 * @param  string $zone   Either 'single', 'directory', 'edit', 'header', 'footer'
152
	 *
153
	 * @return array $entry_default_fields, with `duplicate_link` added. Won't be added if in Edit Entry context.
154
	 */
155
	public function add_default_field( $entry_default_fields, $form = array(), $zone = '' ) {
156
157
		if ( 'edit' !== $zone ) {
158
			$entry_default_fields['duplicate_link'] = array(
159
				'label' => __( 'Duplicate Entry', 'gravityview' ),
160
				'type'  => 'duplicate_link',
161
				'desc'  => __( 'A link to duplicate the entry. Respects the Duplicate Entry permissions.', 'gravityview' ),
162
			);
163
		}
164
165
		return $entry_default_fields;
166
	}
167
168
	/**
169
	 * Add Duplicate Entry Link to the Add Field dialog
170
	 *
171
	 * @since 2.5
172
	 *
173
	 * @param array $available_fields
174
	 *
175
	 * @return array Fields with `duplicate_link` added
176
	 */
177
	public function add_available_field( $available_fields = array() ) {
178
179
		$available_fields['duplicate_link'] = array(
180
			'label_text' => __( 'Duplicate Entry', 'gravityview' ),
181
			'field_id' => 'duplicate_link',
182
			'label_type' => 'field',
183
			'input_type' => 'duplicate_link',
184
			'field_options' => NULL
185
		);
186
187
		return $available_fields;
188
	}
189
190
	/**
191
	 * Change wording for the Edit context to read Entry Creator
192
	 *
193
	 * @since 2.5
194
	 *
195
	 * @param  array 	    $visibility_caps        Array of capabilities to display in field dropdown.
196
	 * @param  string       $field_type  Type of field options to render (`field` or `widget`)
0 ignored issues
show
Bug introduced by
There is no parameter named $field_type. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
197
	 * @param  string       $template_id Table slug
198
	 * @param  float|string $field_id    GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by`
199
	 * @param  string       $context     What context are we in? Example: `single` or `directory`
200
	 * @param  string       $input_type  (textarea, list, select, etc.)
201
	 *
202
	 * @return array                   Array of field options with `label`, `value`, `type`, `default` keys
203
	 */
204
	public function modify_visibility_caps( $visibility_caps = array(), $template_id = '', $field_id = '', $context = '', $input_type = '' ) {
0 ignored issues
show
Unused Code introduced by
The parameter $context 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 $input_type 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...
205
206
		$caps = $visibility_caps;
207
208
		// If we're configuring fields in the edit context, we want a limited selection
209
		if ( 'duplicate_link' === $field_id ) {
210
211
			// Remove other built-in caps.
212
			unset( $caps['publish_posts'], $caps['gravityforms_view_entries'], $caps['duplicate_others_posts'] );
213
214
			$caps['read'] = _x( 'Entry Creator', 'User capability', 'gravityview' );
215
		}
216
217
		return $caps;
218
	}
219
220
	/**
221
	 * Generate a consistent nonce key based on the Entry ID
222
	 *
223
	 * @since 2.5
224
	 *
225
	 * @param  int $entry_id Entry ID
226
	 *
227
	 * @return string           Key used to validate request
228
	 */
229
	public static function get_nonce_key( $entry_id ) {
230
		return sprintf( 'duplicate_%s', $entry_id );
231
	}
232
233
234
	/**
235
	 * Generate a nonce link with the base URL of the current View embed
236
	 *
237
	 * We don't want to link to the single entry, because when duplicated, there would be nothing to return to.
238
	 *
239
	 * @since 2.5
240
	 *
241
	 * @param  array       $entry Gravity Forms entry array
242 2
	 * @param  int         $view_id The View id. Not optional since 2.0
243 2
	 * @param  int         $post_id ID of the current post/page being embedded on, if any
244
	 *
245
	 * @return string|null If directory link is valid, the URL to process the duplicate request. Otherwise, `NULL`.
246
	 */
247
	public static function get_duplicate_link( $entry, $view_id, $post_id = null ) {
248
249
        $base = GravityView_API::directory_link( $post_id ? : $view_id, true );
250
251
		if ( empty( $base ) ) {
252
			gravityview()->log->error( 'Post ID does not exist: {post_id}', array( 'post_id' => $post_id ) );
253
			return NULL;
254
		}
255
256
		$actionurl = add_query_arg( array(
257
			'action'	=> 'duplicate',
258
			'entry_id'	=> $entry['id'],
259
			'gvid' => $view_id,
260 2
            'view_id' => $view_id,
261 2
		), $base );
262
263 2
		return add_query_arg( 'duplicate', wp_create_nonce( self::get_nonce_key( $entry['id'] ) ), $actionurl );
264
	}
265 2
266
	/**
267
	 * Handle the duplication request, if $_GET['action'] is set to "duplicate"
268
	 *
269
	 * 1. Check referrer validity
270 2
	 * 2. Make sure there's an entry with the slug of $_GET['entry_id']
271 2
	 * 3. If so, attempt to duplicate the entry. If not, set the error status
272 2
	 * 4. Remove `action=duplicate` from the URL
273 2
	 * 5. Redirect to the page using `wp_safe_redirect()`
274 2
	 *
275 2
	 * @since 2.5
276
	 *
277 2
	 * @uses wp_safe_redirect()
278
	 *
279
	 * @return void|string $url URL during tests instead of redirect.
280
	 */
281
	public function process_duplicate() {
282
283
		// If the form is submitted
284
		if ( ! isset( $_GET['action'] ) || 'duplicate' !== $_GET['action'] || ! isset( $_GET['entry_id'] ) ) {
285
			return;
286
		}
287
288
		// Make sure it's a GravityView request
289
		$valid_nonce_key = wp_verify_nonce( \GV\Utils::_GET( 'duplicate' ), self::get_nonce_key( $_GET['entry_id'] ) );
290
291
		if ( ! $valid_nonce_key ) {
292
			gravityview()->log->debug( 'Duplicate entry not processed: nonce validation failed.' );
293
			return;
294
		}
295 3
296
		// Get the entry slug
297
		$entry_slug = esc_attr( $_GET['entry_id'] );
298 3
299 3
		// See if there's an entry there
300
		$entry = gravityview_get_entry( $entry_slug, true, false );
301
302
		if ( $entry ) {
303 1
304
			$has_permission = $this->user_can_duplicate_entry( $entry );
305 1
306 1
			if ( is_wp_error( $has_permission ) ) {
307 1
308
				$messages = array(
309
					'message' => urlencode( $has_permission->get_error_message() ),
310
					'status' => 'error',
311 1
				);
312
313
			} else {
314 1
315
				// Duplicate the entry
316 1
				$duplicate_response = $this->duplicate_entry( $entry );
317
318 1
				if ( is_wp_error( $duplicate_response ) ) {
319
320 1
					$messages = array(
321
						'message' => urlencode( $duplicate_response->get_error_message() ),
322
						'status' => 'error',
323 1
					);
324 1
325
					gravityview()->log->error( 'Entry {entry_slug} cannot be duplicated: {error_code} {error_message}', array(
326
						'entry_slug'    => $entry_slug,
327
						'error_code'    => $duplicate_response->get_error_code(),
328
						'error_message' => $duplicate_response->get_error_message(),
329
					) );
330 1
331
				} else {
332 1
333
					$messages = array(
334
						'status' => $duplicate_response,
335 1
					);
336 1
337
				}
338
339 1
			}
340 1
341 1
		} else {
342 1
343
			gravityview()->log->error( 'Duplicate entry failed: there was no entry with the entry slug {entry_slug}', array( 'entry_slug' => $entry_slug ) );
344
345
			$messages = array(
346
				'message' => urlencode( __( 'The entry does not exist.', 'gravityview' ) ),
347
				'status' => 'error',
348 1
			);
349
		}
350
351
		$redirect_to_base = esc_url_raw( remove_query_arg( array( 'action', 'gvid' ) ) );
352
		$redirect_to = add_query_arg( $messages, $redirect_to_base );
353
354
		if ( defined( 'DOING_GRAVITYVIEW_TESTS' ) ) {
355
			return $redirect_to;
356
		}
357 1
358
		wp_safe_redirect( $redirect_to );
359
360 1
		exit();
361 1
	}
362
363
	/**
364
	 * Duplicate the entry.
365 1
	 *
366 1
	 * Done after all the checks in self::process_duplicate.
367
	 *
368 1
	 * @since 2.5
369 1
	 *
370
	 * @param array $entry The entry to be duplicated
371
	 *
372
	 * @return WP_Error|boolean
373
	 */
374
	private function duplicate_entry( $entry ) {
375
376
		if ( ! $entry_id = \GV\Utils::get( $entry, 'id' ) ) {
377
			return new WP_Error( 'gravityview-duplicate-entry-missing', __( 'The entry does not exist.', 'gravityview' ) );
378
		}
379
380
		gravityview()->log->debug( 'Starting duplicate entry: {entry_id}', array( 'entry_id' => $entry_id ) );
381
382
		global $wpdb;
383
384
		$entry_table = GFFormsModel::get_entry_table_name();
385
		$entry_meta_table = GFFormsModel::get_entry_meta_table_name();
386
387
		if ( ! $row = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $entry_table WHERE ID = %d", $entry_id ), ARRAY_A ) ) {
388 1
			return new WP_Error( 'gravityview-duplicate-entry-missing', __( 'The entry does not exist.', 'gravityview' ) );
389
		}
390 1
391
		$row['id'] = null;
392
		$row['date_created'] = date( 'Y-m-d H:i:s', time() );
393
		$row['date_updated'] = $row['date_created'];
394 1
		$row['is_starred'] = false;
395
		$row['is_read'] = false;
396 1
		$row['ip'] = GFFormsModel::get_ip();
397
		$row['source_url'] = esc_url_raw( remove_query_arg( array( 'action', 'gvid' ) ) );
398 1
		$row['user_agent'] = \GV\Utils::_SERVER( 'HTTP_USER_AGENT' );
399 1
		$row['created_by'] = wp_get_current_user()->ID;
400
401 1
		/**
402
		 * @filter `gravityview/entry/duplicate/details` Modify the new entry details before it's created.
403
		 * @since 2.5
404
		 * @param[in,out] array $row The entry details
405 1
		 * @param array $entry The original entry
406 1
		 */
407 1
		$row = apply_filters( 'gravityview/entry/duplicate/details', $row, $entry );
408 1
409 1
		if ( ! $wpdb->insert( $entry_table, $row ) ) {
410 1
			return new WP_Error( 'gravityview-duplicate-entry-db-details', __( 'There was an error duplicating the entry.', 'gravityview' ) );
411 1
		}
412 1
413 1
		$duplicated_id = $wpdb->insert_id;
414
415
		$meta = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $entry_meta_table WHERE entry_id = %d", $entry_id ), ARRAY_A );
416
417
		$duplicate_meta = new WP_List_Util( $meta );
418
419
		// Keys that should be reset by default
420
		$reset_meta = array( 'is_approved', 'gravityview_unique_id', 'workflow_current_status_timestamp' );
421 1
		foreach ( $reset_meta as $meta_key ) {
422
			$duplicate_meta->filter( array( 'meta_key' => $meta_key ), 'NOT' );
423 1
		}
424 1
425
		$save_this_meta = array();
426
		foreach ( $duplicate_meta->get_output() as $m ) {
427 1
			$save_this_meta[] = array(
428
				'meta_key' => $m['meta_key'],
429 1
				'meta_value' => $m['meta_value'],
430
				'item_index' => $m['item_index'],
431 1
			);
432
		}
433
434 1
		// Update the row ID for later usage
435 1
		$row['id'] = $duplicated_id;
436 1
437
		/**
438
		 * @filter `gravityview/entry/duplicate/meta` Modify the new entry meta details.
439 1
		 * @param[in,out] array $save_this_meta The duplicate meta. Use/add meta_key, meta_value, item_index.
440 1
		 * @param array $row The duplicated entry
441 1
		 * @param array $entry The original entry
442 1
		 */
443 1
		$save_this_meta = apply_filters( 'gravityview/entry/duplicate/meta', $save_this_meta, $row, $entry );
444 1
445
		foreach ( $save_this_meta as $data ) {
446
			$data['form_id'] = $entry['form_id'];
447
			$data['entry_id'] = $duplicated_id;
448
449 1
			if ( ! $wpdb->insert( $entry_meta_table, $data ) ) {
450
				return new WP_Error( 'gravityview-duplicate-entry-db-meta', __( 'There was an error duplicating the entry.', 'gravityview' ) );
451
			}
452
		}
453
454
		$duplicated_entry = \GFAPI::get_entry( $duplicated_id );
455
456
		$duplicate_response = 'duplicated';
457 1
458
		/**
459 1
		 * @action `gravityview/duplicate-entry/duplicated` Triggered when an entry is duplicated
460 1
		 * @since 2.5
461 1
		 * @param  array $duplicated_entry The duplicated entry
462
		 * @param  array $entry The original entry
463 1
		*/
464
		do_action( 'gravityview/duplicate-entry/duplicated', $duplicated_entry, $entry );
465
466
		gravityview()->log->debug( 'Duplicate response: {duplicate_response}', array( 'duplicate_response' => $duplicate_response ) );
467
468 1
		return $duplicate_response;
469
	}
470 1
471
	/**
472
	 * Is the current nonce valid for editing the entry?
473
	 *
474
	 * @since 2.5
475
	 *
476
	 * @return boolean
477
	 */
478 1
	public function verify_nonce() {
479
480 1
		// No duplicate entry request was made
481
		if ( empty( $_GET['entry_id'] ) || empty( $_GET['duplicate'] ) ) {
482 1
			return false;
483
		}
484
485
		$nonce_key = self::get_nonce_key( $_GET['entry_id'] );
486
487
		$valid = wp_verify_nonce( $_GET['duplicate'], $nonce_key );
488
489
		/**
490
		 * @filter `gravityview/duplicate-entry/verify_nonce` Override Duplicate Entry nonce validation. Return true to declare nonce valid.
491
		 * @since 2.5
492 1
		 * @see wp_verify_nonce()
493
		 * @param int|boolean $valid False if invalid; 1 or 2 when nonce was generated
494
		 * @param string $nonce_key Name of nonce action used in wp_verify_nonce. $_GET['duplicate'] holds the nonce value itself. Default: `duplicate_{entry_id}`
495 1
		 */
496
		$valid = apply_filters( 'gravityview/duplicate-entry/verify_nonce', $valid, $nonce_key );
497
498
		return $valid;
499 1
	}
500
501 1
	/**
502
	 * Get the onclick attribute for the confirm dialogs that warns users before they duplicate an entry
503
	 *
504
	 * @since 2.5
505
	 *
506
	 * @return string HTML `onclick` attribute
507
	 */
508
	public static function get_confirm_dialog() {
509
510 1
		$confirm = __( 'Are you sure you want to duplicate this entry?', 'gravityview' );
511
512 1
		/**
513
		 * @filter `gravityview/duplicate-entry/confirm-text` Modify the Duplicate Entry Javascript confirmation text (will be sanitized when output)
514
		 *
515
		 * @param string $confirm Default: "Are you sure you want to duplicate this entry?". If empty, disable confirmation dialog.
516
		 */
517
		$confirm = apply_filters( 'gravityview/duplicate-entry/confirm-text', $confirm );
518
519
		if ( empty( $confirm ) ) {
520
			return '';
521
		}
522 1
523
		return 'return window.confirm(\''. esc_js( $confirm ) .'\');';
524 1
	}
525
526
	/**
527
	 * Check if the user can edit the entry
528
	 *
529
	 * - Is the nonce valid?
530
	 * - Does the user have the right caps for the entry
531 1
	 * - Is the entry in the trash?
532
	 *
533 1
	 * @since 2.5
534 1
	 *
535
	 * @param  array $entry Gravity Forms entry array
536
	 * @param  int   $view_id ID of the View being rendered
537 1
	 *
538
	 * @return boolean|WP_Error        True: can edit form. WP_Error: nope.
539
	 */
540
	private function user_can_duplicate_entry( $entry = array(), $view_id = null ) {
541
542
		$error = NULL;
543
544
		if ( ! $this->verify_nonce() ) {
545
			$error = __( 'The link to duplicate this entry is not valid; it may have expired.', 'gravityview' );
546
		}
547
548
		if ( ! self::check_user_cap_duplicate_entry( $entry, array(), $view_id ) ) {
549
			$error = __( 'You do not have permission to duplicate this entry.', 'gravityview' );
550
		}
551
552
		// No errors; everything's fine here!
553
		if ( empty( $error ) ) {
554 1
			return true;
555
		}
556 1
557
		gravityview()->log->error( '{error}', array( 'erorr' => $error ) );
558 1
559
		return new WP_Error( 'gravityview-duplicate-entry-permissions', $error );
560
	}
561
562 1
563 1
	/**
564
	 * checks if user has permissions to view the link or duplicate a specific entry
565
	 *
566
	 * @since 2.5
567 1
	 *
568 1
	 * @param  array $entry Gravity Forms entry array
569
	 * @param array $field Field settings (optional)
570
	 * @param int $view_id Pass a View ID to check caps against. If not set, check against current View
571 1
	 *
572
	 * @return bool
573 1
	 */
574
	public static function check_user_cap_duplicate_entry( $entry, $field = array(), $view_id = 0 ) {
575
		$current_user = wp_get_current_user();
576
577
		$entry_id = isset( $entry['id'] ) ? $entry['id'] : null;
578
579
		// Or if they can duplicate any entries (as defined in Gravity Forms), we're good.
580
		if ( GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gform_full_access', 'gravityview_full_access' ), $entry_id ) ) {
581
582
			gravityview()->log->debug( 'Current user has `gravityforms_edit_entries` capability.' );
583
584
			return true;
585
		}
586
587
588 2
		// If field options are passed, check if current user can view the link
589 2
		if ( ! empty( $field ) ) {
590
591 2
			// If capability is not defined, something is not right!
592
			if ( empty( $field['allow_duplicate_cap'] ) ) {
593
594 2
				gravityview()->log->error( 'Cannot read duplicate entry field caps', array( 'data' => $field ) );
595
596 2
				return false;
597
			}
598 2
599
			if ( GVCommon::has_cap( $field['allow_duplicate_cap'] ) ) {
600
601
				// Do not return true if cap is read, as we need to check if the current user created the entry
602
				if ( 'read' !== $field['allow_duplicate_cap'] ) {
603 2
					return true;
604
				}
605
606
			} else {
607
608
				gravityview()->log->debug( 'User {user_id} is not authorized to view duplicate entry link ', array( 'user_id' => $current_user->ID ) );
609
610
				return false;
611
			}
612
613
		}
614
615
		if ( ! isset( $entry['created_by'] ) ) {
616
617
			gravityview()->log->error( 'Cannot duplicate entry; entry `created_by` doesn\'t exist.' );
618
619
			return false;
620
		}
621
622
		// Only checks user_duplicate view option if view is already set
623
		if ( $view_id ) {
624
625
			if ( ! $view = \GV\View::by_id( $view_id ) ) {
626
				return false;
627
			}
628
629 2
			$user_duplicate = $view->settings->get( 'user_duplicate', false );
630
631 1
			if ( empty( $user_duplicate ) ) {
632
633 1
				gravityview()->log->debug( 'User Duplicate is disabled. Returning false.' );
634
635
				return false;
636
			}
637 2
		}
638
639 1
		// If the logged-in user is the same as the user who created the entry, we're good.
640
		if ( is_user_logged_in() && intval( $current_user->ID ) === intval( $entry['created_by'] ) ) {
641
642
			gravityview()->log->debug( 'User {user_id} created the entry.', array( 'user_id' => $current_user->ID ) );
643 1
644
			return true;
645 1
		}
646
647 1
		return false;
648
	}
649 1
650
651
	/**
652
	 * After processing duplicate entry, the user will be redirected to the referring View or embedded post/page. Display a message on redirection.
653
	 *
654 2
	 * If success, there will be `status` URL parameters `status=>success`
655
	 * If an error, there will be `status` and `message` URL parameters `status=>error&message=example`
656 1
	 *
657
	 * @since 2.5
658 1
	 *
659
	 * @param int $current_view_id The ID of the View being rendered
660
	 *
661 2
	 * @return void
662
	 */
663
	public function display_message( $current_view_id = 0 ) {
664
665
		if ( empty( $_GET['status'] ) || ! self::verify_nonce() ) {
666
			return;
667
		}
668
669
		// Entry wasn't duplicated from current View
670
		if ( isset( $_GET['view_id'] ) && ( intval( $_GET['view_id'] ) !== intval( $current_view_id ) ) ) {
671
			return;
672
		}
673
674
		$status = esc_attr( $_GET['status'] );
675
		$message_from_url = \GV\Utils::_GET( 'message' );
676
		$message_from_url = rawurldecode( stripslashes_deep( $message_from_url ) );
677 37
		$class = '';
678
679 37
		switch ( $status ) {
680 37
			case 'error':
681
				$class = ' gv-error error';
682
				$error_message = __( 'There was an error duplicating the entry: %s', 'gravityview' );
683
				$message = sprintf( $error_message, $message_from_url );
684
				break;
685
			default:
686
				$message = __( 'The entry was successfully duplicated.', 'gravityview' );
687
				break;
688
		}
689
690
		/**
691
		 * @filter `gravityview/duplicate-entry/message` Modify the Duplicate Entry messages. Allows HTML; will not be further sanitized.
692
		 * @since 2.5
693
		 * @param string $message Message to be displayed, sanitized using esc_attr()
694
		 * @param string $status Message status (`error` or `success`)
695
		 * @param string $message_from_url The original error message, if any, without the "There was an error duplicating the entry:" prefix
696
		 */
697
		$message = apply_filters( 'gravityview/duplicate-entry/message', esc_attr( $message ), $status, $message_from_url );
698
699
		// DISPLAY ERROR/SUCCESS MESSAGE
700
		echo '<div class="gv-notice' . esc_attr( $class ) .'">'. $message .'</div>';
701
	}
702
703
	/**
704
	 * Add a Duplicate link to the row of actions on the entry list in the backend.
705
	 *
706
	 * @since 2.5.1
707
	 *
708
	 * @param int $form_id The form ID.
709
	 * @param int $field_id The field ID.
710
	 * @param string $value The value.
711
	 * @param array $entry The entryvalue The value.
712
	 * @param array $entry The entry.
713
	 * @param string $query_string The query.
714
	 *
715
	 * @return void
716
	 */
717
	public function make_duplicate_link_row( $form_id, $field_id, $value, $entry, $query_string ) {
0 ignored issues
show
Unused Code introduced by
The parameter $query_string 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...
718
719
		/**
720
		 * @filter `gravityview/duplicate/backend/enable` Allows developers to disable the duplicate link on the backend.
721
		 * @param[in,out] boolean $enable True by default. Enabled.
722
		 * @param int $form_id The form ID.
723
		 */
724
		if ( ! apply_filters( 'gravityview/duplicate/backend/enable', true, $form_id ) ) {
725
			return;
726
		}
727
728
		?>
729
		<span class="duplicate">
730
			|
731
			<a href="<?php echo wp_nonce_url( add_query_arg( 'entry_id', $entry['id'] ), self::get_nonce_key( $entry['id'] ), 'duplicate' ); ?>"><?php esc_html_e( 'Duplicate', 'gravityview' ); ?></a>
732
		</span>
733
		<?php
734
	}
735
736
	/**
737
	 * Perhaps duplicate this entry if the action has been corrected.
738
	 *
739
	 * @since 2.5.1
740
	 *
741
	 * @param int $form_id The form ID.
742
	 *
743
	 * @return void
744
	 */
745
	public function maybe_duplicate_list( $form_id ) {
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...
746
747
		if ( ! is_admin() ) {
748
			return;
749
		}
750
751
		if ( 'success' === \GV\Utils::_GET( 'result' ) ) {
752
			add_filter( 'gform_admin_messages', function( $messages ) {
753
				$messages = (array) $messages;
754
755
				$messages[] = esc_html__( 'Entry duplicated.', 'gravityview' );
756
				return $messages;
757
			} );
758
		}
759
760
		if ( 'error' === \GV\Utils::_GET( 'result' ) ) {
761
762
			$is_logging_active = class_exists( 'GravityView_Logging' ) ? GravityView_Logging::is_logging_active() : true;
763
764
			$check_logs_message = '';
765
766
			if( $is_logging_active ) {
767
				$check_logs_message = sprintf( ' <a href="%s">%s</a>',
768
					esc_url( admin_url( 'admin.php?page=gf_settings&subview=gravityformslogging' ) ),
769
					esc_html_x( 'Check the GravityView logs for more information.', 'Error message links to logging page', 'gravityview' )
770
				);
771
			}
772
773
			add_filter( 'gform_admin_error_messages', function( $messages ) use ( $check_logs_message ) {
774
				$messages = (array) $messages;
775
776
				$messages[] = esc_html__( 'There was an error duplicating the entry.', 'gravityview' ) . $check_logs_message;
777
778
				return $messages;
779
			} );
780
		}
781
782
		if ( ! wp_verify_nonce( \GV\Utils::_GET( 'duplicate' ), self::get_nonce_key( $entry_id = \GV\Utils::_GET( 'entry_id' ) ) ) ) {
783
			return;
784
		}
785
786
		if ( ! GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gform_full_access', 'gravityview_full_access' ), $entry_id ) ) {
787
			return;
788
		}
789
790
		$entry = GFAPI::get_entry( $entry_id );
791
792
		if ( is_wp_error( $entry ) ) {
793
			$is_duplicated = $entry;
794
		} else {
795
			$is_duplicated = $this->duplicate_entry( $entry );
796
		}
797
798
		if ( is_wp_error( $is_duplicated ) ) {
799
			gravityview()->log->error( 'Error duplicating {id}: {error}', array( 'id' => $entry_id, 'error' => $is_duplicated->get_error_message() ) );
800
		}
801
802
		$return_url = remove_query_arg( 'duplicate' );
803
		$return_url = add_query_arg( 'result', is_wp_error( $is_duplicated ) ? 'error' : 'success', $return_url );
804
805
		echo '<script>window.location.href = ' . json_encode( $return_url ) . ';</script>';
806
807
		exit;
808
	}
809
810
811
} // end class
812
813
GravityView_Duplicate_Entry::getInstance();
814
815