Completed
Push — branch-6.1-built ( 92c2f0...470bbc )
by
unknown
32:15 queued 22:07
created

Grunion_Contact_Form_Plugin::ajax_request()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 19
Code Lines 15

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
eloc 15
nc 3
nop 0
dl 0
loc 19
rs 9.4285
c 0
b 0
f 0
1
<?php
2
3
/*
4
Plugin Name: Grunion Contact Form
5
Description: Add a contact form to any post, page or text widget.  Emails will be sent to the post's author by default, or any email address you choose.  As seen on WordPress.com.
6
Plugin URI: http://automattic.com/#
7
AUthor: Automattic, Inc.
8
Author URI: http://automattic.com/
9
Version: 2.4
10
License: GPLv2 or later
11
*/
12
13
define( 'GRUNION_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
14
define( 'GRUNION_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
15
16
if ( is_admin() ) {
17
	require_once GRUNION_PLUGIN_DIR . 'admin.php';
18
}
19
20
add_action( 'rest_api_init', 'grunion_contact_form_require_endpoint' );
21
function grunion_contact_form_require_endpoint() {
22
	require_once GRUNION_PLUGIN_DIR . 'class-grunion-contact-form-endpoint.php';
23
}
24
25
/**
26
 * Sets up various actions, filters, post types, post statuses, shortcodes.
27
 */
28
class Grunion_Contact_Form_Plugin {
29
30
	/**
31
	 * @var string The Widget ID of the widget currently being processed.  Used to build the unique contact-form ID for forms embedded in widgets.
32
	 */
33
	public $current_widget_id;
34
35
	static $using_contact_form_field = false;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $using_contact_form_field.

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...
36
37
	static function init() {
38
		static $instance = false;
39
40
		if ( ! $instance ) {
41
			$instance = new Grunion_Contact_Form_Plugin;
42
43
			// Schedule our daily cleanup
44
			add_action( 'wp_scheduled_delete', array( $instance, 'daily_akismet_meta_cleanup' ) );
45
		}
46
47
		return $instance;
48
	}
49
50
	/**
51
	 * Runs daily to clean up spam detection metadata after 15 days.  Keeps your DB squeaky clean.
52
	 */
53
	public function daily_akismet_meta_cleanup() {
54
		global $wpdb;
55
56
		$feedback_ids = $wpdb->get_col( "SELECT p.ID FROM {$wpdb->posts} as p INNER JOIN {$wpdb->postmeta} as m on m.post_id = p.ID WHERE p.post_type = 'feedback' AND m.meta_key = '_feedback_akismet_values' AND DATE_SUB(NOW(), INTERVAL 15 DAY) > p.post_date_gmt LIMIT 10000" );
57
58
		if ( empty( $feedback_ids ) ) {
59
			return;
60
		}
61
62
		/**
63
		 * Fires right before deleting the _feedback_akismet_values post meta on $feedback_ids
64
		 *
65
		 * @module contact-form
66
		 *
67
		 * @since 6.1.0
68
		 *
69
		 * @param array $feedback_ids list of feedback post ID
70
		 */
71
		do_action( 'jetpack_daily_akismet_meta_cleanup_before', $feedback_ids );
72
		foreach ( $feedback_ids as $feedback_id ) {
73
			delete_post_meta( $feedback_id, '_feedback_akismet_values' );
74
		}
75
76
		/**
77
		 * Fires right after deleting the _feedback_akismet_values post meta on $feedback_ids
78
		 *
79
		 * @module contact-form
80
		 *
81
		 * @since 6.1.0
82
		 *
83
		 * @param array $feedback_ids list of feedback post ID
84
		 */
85
		do_action( 'jetpack_daily_akismet_meta_cleanup_after', $feedback_ids );
86
	}
87
88
	/**
89
	 * Strips HTML tags from input.  Output is NOT HTML safe.
90
	 *
91
	 * @param mixed $data_with_tags
92
	 * @return mixed
93
	 */
94
	public static function strip_tags( $data_with_tags ) {
95
		if ( is_array( $data_with_tags ) ) {
96
			foreach ( $data_with_tags as $index => $value ) {
97
				$index = sanitize_text_field( strval( $index ) );
98
				$value = wp_kses( strval( $value ), array() );
99
				$value = str_replace( '&amp;', '&', $value ); // undo damage done by wp_kses_normalize_entities()
100
101
				$data_without_tags[ $index ] = $value;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$data_without_tags was never initialized. Although not strictly required by PHP, it is generally a good practice to add $data_without_tags = 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...
102
			}
103
		} else {
104
			$data_without_tags = wp_kses( $data_with_tags, array() );
105
			$data_without_tags = str_replace( '&amp;', '&', $data_without_tags ); // undo damage done by wp_kses_normalize_entities()
106
		}
107
108
		return $data_without_tags;
0 ignored issues
show
Bug introduced by
The variable $data_without_tags does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
109
	}
110
111
	function __construct() {
112
		$this->add_shortcode();
113
114
		// While generating the output of a text widget with a contact-form shortcode, we need to know its widget ID.
115
		add_action( 'dynamic_sidebar', array( $this, 'track_current_widget' ) );
116
117
		// Add a "widget" shortcode attribute to all contact-form shortcodes embedded in widgets
118
		add_filter( 'widget_text', array( $this, 'widget_atts' ), 0 );
119
120
		// If Text Widgets don't get shortcode processed, hack ours into place.
121
		if (
122
			version_compare( get_bloginfo( 'version' ), '4.9-z', '<=' )
123
			&& ! has_filter( 'widget_text', 'do_shortcode' )
124
		) {
125
			add_filter( 'widget_text', array( $this, 'widget_shortcode_hack' ), 5 );
126
		}
127
128
		// Akismet to the rescue
129
		if ( defined( 'AKISMET_VERSION' ) || function_exists( 'akismet_http_post' ) ) {
130
			add_filter( 'jetpack_contact_form_is_spam', array( $this, 'is_spam_akismet' ), 10, 2 );
131
			add_action( 'contact_form_akismet', array( $this, 'akismet_submit' ), 10, 2 );
132
		}
133
134
		add_action( 'loop_start', array( 'Grunion_Contact_Form', '_style_on' ) );
135
136
		add_action( 'wp_ajax_grunion-contact-form', array( $this, 'ajax_request' ) );
137
		add_action( 'wp_ajax_nopriv_grunion-contact-form', array( $this, 'ajax_request' ) );
138
139
		// GDPR: personal data exporter & eraser.
140
		add_filter( 'wp_privacy_personal_data_exporters', array( $this, 'register_personal_data_exporter' ) );
141
		add_filter( 'wp_privacy_personal_data_erasers', array( $this, 'register_personal_data_eraser' ) );
142
143
		// Export to CSV feature
144
		if ( is_admin() ) {
145
			add_action( 'admin_init',            array( $this, 'download_feedback_as_csv' ) );
146
			add_action( 'admin_footer-edit.php', array( $this, 'export_form' ) );
147
			add_action( 'admin_menu',            array( $this, 'admin_menu' ) );
148
			add_action( 'current_screen',        array( $this, 'unread_count' ) );
149
		}
150
151
		// custom post type we'll use to keep copies of the feedback items
152
		register_post_type( 'feedback', array(
153
			'labels'            => array(
154
				'name'               => __( 'Feedback', 'jetpack' ),
155
				'singular_name'      => __( 'Feedback', 'jetpack' ),
156
				'search_items'       => __( 'Search Feedback', 'jetpack' ),
157
				'not_found'          => __( 'No feedback found', 'jetpack' ),
158
				'not_found_in_trash' => __( 'No feedback found', 'jetpack' ),
159
			),
160
			'menu_icon'         	=> 'dashicons-feedback',
161
			'show_ui'           	=> TRUE,
162
			'show_in_admin_bar' 	=> FALSE,
163
			'public'            	=> FALSE,
164
			'rewrite'           	=> FALSE,
165
			'query_var'         	=> FALSE,
166
			'capability_type'   	=> 'page',
167
			'show_in_rest'      	=> true,
168
			'rest_controller_class' => 'Grunion_Contact_Form_Endpoint',
169
			'capabilities'			=> array(
170
				'create_posts'        => false,
171
				'publish_posts'       => 'publish_pages',
172
				'edit_posts'          => 'edit_pages',
173
				'edit_others_posts'   => 'edit_others_pages',
174
				'delete_posts'        => 'delete_pages',
175
				'delete_others_posts' => 'delete_others_pages',
176
				'read_private_posts'  => 'read_private_pages',
177
				'edit_post'           => 'edit_page',
178
				'delete_post'         => 'delete_page',
179
				'read_post'           => 'read_page',
180
			),
181
			'map_meta_cap'			=> true,
182
		) );
183
184
		// Add to REST API post type whitelist
185
		add_filter( 'rest_api_allowed_post_types', array( $this, 'allow_feedback_rest_api_type' ) );
186
187
		// Add "spam" as a post status
188
		register_post_status( 'spam', array(
189
			'label'                  => 'Spam',
190
			'public'                 => false,
191
			'exclude_from_search'    => true,
192
			'show_in_admin_all_list' => false,
193
			'label_count'            => _n_noop( 'Spam <span class="count">(%s)</span>', 'Spam <span class="count">(%s)</span>', 'jetpack' ),
194
			'protected'              => true,
195
			'_builtin'               => false,
196
		) );
197
198
		// POST handler
199
		if (
200
			isset( $_SERVER['REQUEST_METHOD'] ) && 'POST' == strtoupper( $_SERVER['REQUEST_METHOD'] )
201
		&&
202
			isset( $_POST['action'] ) && 'grunion-contact-form' == $_POST['action']
203
		&&
204
			isset( $_POST['contact-form-id'] )
205
		) {
206
			add_action( 'template_redirect', array( $this, 'process_form_submission' ) );
207
		}
208
209
		/*
210
		 Can be dequeued by placing the following in wp-content/themes/yourtheme/functions.php
211
		 *
212
		 * 	function remove_grunion_style() {
213
		 *		wp_deregister_style('grunion.css');
214
		 *	}
215
		 *	add_action('wp_print_styles', 'remove_grunion_style');
216
		 */
217
		wp_register_style( 'grunion.css', GRUNION_PLUGIN_URL . 'css/grunion.css', array(), JETPACK__VERSION );
218
		wp_style_add_data( 'grunion.css', 'rtl', 'replace' );
219
	}
220
221
	/**
222
	 * Add the 'Export' menu item as a submenu of Feedback.
223
	 */
224
	public function admin_menu() {
225
		add_submenu_page(
226
			'edit.php?post_type=feedback',
227
			__( 'Export feedback as CSV', 'jetpack' ),
228
			__( 'Export CSV', 'jetpack' ),
229
			'export',
230
			'feedback-export',
231
			array( $this, 'export_form' )
232
		);
233
	}
234
235
	/**
236
	 * Add to REST API post type whitelist
237
	 */
238
	function allow_feedback_rest_api_type( $post_types ) {
239
		$post_types[] = 'feedback';
240
		return $post_types;
241
	}
242
243
	/**
244
	 * Display the count of new feedback entries received. It's reset when user visits the Feedback screen.
245
	 *
246
	 * @since 4.1.0
247
	 *
248
	 * @param object $screen Information about the current screen.
249
	 */
250
	function unread_count( $screen ) {
251
		if ( isset( $screen->post_type ) && 'feedback' == $screen->post_type ) {
252
			update_option( 'feedback_unread_count', 0 );
253
		} else {
254
			global $menu;
255
			if ( isset( $menu ) && is_array( $menu ) && ! empty( $menu ) ) {
256
				foreach ( $menu as $index => $menu_item ) {
257
					if ( 'edit.php?post_type=feedback' == $menu_item[2] ) {
258
						$unread = get_option( 'feedback_unread_count', 0 );
259
						if ( $unread > 0 ) {
260
							$unread_count = current_user_can( 'publish_pages' ) ? " <span class='feedback-unread count-{$unread} awaiting-mod'><span class='feedback-unread-count'>" . number_format_i18n( $unread ) . '</span></span>' : '';
261
							$menu[ $index ][0] .= $unread_count;
262
						}
263
						break;
264
					}
265
				}
266
			}
267
		}
268
	}
269
270
	/**
271
	 * Handles all contact-form POST submissions
272
	 *
273
	 * Conditionally attached to `template_redirect`
274
	 */
275
	function process_form_submission() {
276
		// Add a filter to replace tokens in the subject field with sanitized field values
277
		add_filter( 'contact_form_subject', array( $this, 'replace_tokens_with_input' ), 10, 2 );
278
279
		$id = stripslashes( $_POST['contact-form-id'] );
280
		$hash = isset( $_POST['contact-form-hash'] ) ? $_POST['contact-form-hash'] : null;
281
		$hash = preg_replace( '/[^\da-f]/i', '', $hash );
282
283
		if ( is_user_logged_in() ) {
284
			check_admin_referer( "contact-form_{$id}" );
285
		}
286
287
		$is_widget = 0 === strpos( $id, 'widget-' );
288
289
		$form = false;
0 ignored issues
show
Unused Code introduced by
$form is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
290
291
		if ( $is_widget ) {
292
			// It's a form embedded in a text widget
293
			$this->current_widget_id = substr( $id, 7 ); // remove "widget-"
294
			$widget_type = implode( '-', array_slice( explode( '-', $this->current_widget_id ), 0, -1 ) ); // Remove trailing -#
295
296
			// Is the widget active?
297
			$sidebar = is_active_widget( false, $this->current_widget_id, $widget_type );
298
299
			// This is lame - no core API for getting a widget by ID
300
			$widget = isset( $GLOBALS['wp_registered_widgets'][ $this->current_widget_id ] ) ? $GLOBALS['wp_registered_widgets'][ $this->current_widget_id ] : false;
301
302
			if ( $sidebar && $widget && isset( $widget['callback'] ) ) {
303
				// prevent PHP notices by populating widget args
304
				$widget_args = array(
305
					'before_widget' => '',
306
					'after_widget' => '',
307
					'before_title' => '',
308
					'after_title' => '',
309
				);
310
				// This is lamer - no API for outputting a given widget by ID
311
				ob_start();
312
				// Process the widget to populate Grunion_Contact_Form::$last
313
				call_user_func( $widget['callback'], $widget_args, $widget['params'][0] );
314
				ob_end_clean();
315
			}
316
		} else {
317
			// It's a form embedded in a post
318
			$post = get_post( $id );
319
320
			// Process the content to populate Grunion_Contact_Form::$last
321
			/** This filter is already documented in core. wp-includes/post-template.php */
322
			apply_filters( 'the_content', $post->post_content );
323
		}
324
325
		$form = isset( Grunion_Contact_Form::$forms[ $hash ] ) ? Grunion_Contact_Form::$forms[ $hash ] : null;
0 ignored issues
show
Bug introduced by
The property forms cannot be accessed from this context as it is declared private in class Grunion_Contact_Form.

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...
326
327
		// No form may mean user is using do_shortcode, grab the form using the stored post meta
328
		if ( ! $form ) {
329
330
			// Get shortcode from post meta
331
			$shortcode = get_post_meta( $_POST['contact-form-id'], "_g_feedback_shortcode_{$hash}", true );
332
333
			// Format it
334
			if ( $shortcode != '' ) {
335
336
				// Get attributes from post meta.
337
				$parameters = '';
338
				$attributes = get_post_meta( $_POST['contact-form-id'], "_g_feedback_shortcode_atts_{$hash}", true );
339
				if ( ! empty( $attributes ) && is_array( $attributes ) ) {
340
					foreach( array_filter( $attributes ) as $param => $value  ) {
341
						$parameters .= " $param=\"$value\"";
342
					}
343
				}
344
345
				$shortcode = '[contact-form' . $parameters . ']' . $shortcode . '[/contact-form]';
346
				do_shortcode( $shortcode );
347
348
				// Recreate form
349
				$form = Grunion_Contact_Form::$last;
0 ignored issues
show
Bug introduced by
The property last cannot be accessed from this context as it is declared private in class Grunion_Contact_Form.

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...
350
			}
351
352
			if ( ! $form ) {
353
				return false;
354
			}
355
		}
356
357
		if ( is_wp_error( $form->errors ) && $form->errors->get_error_codes() ) {
358
			return $form->errors;
359
		}
360
361
		// Process the form
362
		return $form->process_submission();
363
	}
364
365
	function ajax_request() {
366
		$submission_result = self::process_form_submission();
367
368
		if ( ! $submission_result ) {
369
			header( 'HTTP/1.1 500 Server Error', 500, true );
370
			echo '<div class="form-error"><ul class="form-errors"><li class="form-error-message">';
371
			esc_html_e( 'An error occurred. Please try again later.', 'jetpack' );
372
			echo '</li></ul></div>';
373
		} elseif ( is_wp_error( $submission_result ) ) {
374
			header( 'HTTP/1.1 400 Bad Request', 403, true );
375
			echo '<div class="form-error"><ul class="form-errors"><li class="form-error-message">';
376
			echo esc_html( $submission_result->get_error_message() );
377
			echo '</li></ul></div>';
378
		} else {
379
			echo '<h3>' . esc_html__( 'Message Sent', 'jetpack' ) . '</h3>' . $submission_result;
380
		}
381
382
		die;
0 ignored issues
show
Coding Style Compatibility introduced by
The method ajax_request() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
383
	}
384
385
	/**
386
	 * Ensure the post author is always zero for contact-form feedbacks
387
	 * Attached to `wp_insert_post_data`
388
	 *
389
	 * @see Grunion_Contact_Form::process_submission()
390
	 *
391
	 * @param array $data the data to insert
392
	 * @param array $postarr the data sent to wp_insert_post()
393
	 * @return array The filtered $data to insert
394
	 */
395
	function insert_feedback_filter( $data, $postarr ) {
396
		if ( $data['post_type'] == 'feedback' && $postarr['post_type'] == 'feedback' ) {
397
			$data['post_author'] = 0;
398
		}
399
400
		return $data;
401
	}
402
	/*
403
	 * Adds our contact-form shortcode
404
	 * The "child" contact-field shortcode is enabled as needed by the contact-form shortcode handler
405
	 */
406
	function add_shortcode() {
407
		add_shortcode( 'contact-form',         array( 'Grunion_Contact_Form', 'parse' ) );
408
		add_shortcode( 'contact-field',        array( 'Grunion_Contact_Form', 'parse_contact_field' ) );
409
	}
410
411
	static function tokenize_label( $label ) {
412
		return '{' . trim( preg_replace( '#^\d+_#', '', $label ) ) . '}';
413
	}
414
415
	static function sanitize_value( $value ) {
416
		return preg_replace( '=((<CR>|<LF>|0x0A/%0A|0x0D/%0D|\\n|\\r)\S).*=i', null, $value );
417
	}
418
419
	/**
420
	 * Replaces tokens like {city} or {City} (case insensitive) with the value
421
	 * of an input field of that name
422
	 *
423
	 * @param string $subject
424
	 * @param array  $field_values Array with field label => field value associations
425
	 *
426
	 * @return string The filtered $subject with the tokens replaced
427
	 */
428
	function replace_tokens_with_input( $subject, $field_values ) {
429
		// Wrap labels into tokens (inside {})
430
		$wrapped_labels = array_map( array( 'Grunion_Contact_Form_Plugin', 'tokenize_label' ), array_keys( $field_values ) );
431
		// Sanitize all values
432
		$sanitized_values = array_map( array( 'Grunion_Contact_Form_Plugin', 'sanitize_value' ), array_values( $field_values ) );
433
434
		foreach ( $sanitized_values as $k => $sanitized_value ) {
435
			if ( is_array( $sanitized_value ) ) {
436
				$sanitized_values[ $k ] = implode( ', ', $sanitized_value );
437
			}
438
		}
439
440
		// Search for all valid tokens (based on existing fields) and replace with the field's value
441
		$subject = str_ireplace( $wrapped_labels, $sanitized_values, $subject );
442
		return $subject;
443
	}
444
445
	/**
446
	 * Tracks the widget currently being processed.
447
	 * Attached to `dynamic_sidebar`
448
	 *
449
	 * @see $current_widget_id
450
	 *
451
	 * @param array $widget The widget data
452
	 */
453
	function track_current_widget( $widget ) {
454
		$this->current_widget_id = $widget['id'];
455
	}
456
457
	/**
458
	 * Adds a "widget" attribute to every contact-form embedded in a text widget.
459
	 * Used to tell the difference between post-embedded contact-forms and widget-embedded contact-forms
460
	 * Attached to `widget_text`
461
	 *
462
	 * @param string $text The widget text
463
	 * @return string The filtered widget text
464
	 */
465
	function widget_atts( $text ) {
466
		Grunion_Contact_Form::style( true );
467
468
		return preg_replace( '/\[contact-form([^a-zA-Z_-])/', '[contact-form widget="' . $this->current_widget_id . '"\\1', $text );
469
	}
470
471
	/**
472
	 * For sites where text widgets are not processed for shortcodes, we add this hack to process just our shortcode
473
	 * Attached to `widget_text`
474
	 *
475
	 * @param string $text The widget text
476
	 * @return string The contact-form filtered widget text
477
	 */
478
	function widget_shortcode_hack( $text ) {
479
		if ( ! preg_match( '/\[contact-form([^a-zA-Z_-])/', $text ) ) {
480
			return $text;
481
		}
482
483
		$old = $GLOBALS['shortcode_tags'];
484
		remove_all_shortcodes();
485
		Grunion_Contact_Form_Plugin::$using_contact_form_field = true;
486
		$this->add_shortcode();
487
488
		$text = do_shortcode( $text );
489
490
		Grunion_Contact_Form_Plugin::$using_contact_form_field = false;
491
		$GLOBALS['shortcode_tags'] = $old;
492
493
		return $text;
494
	}
495
496
	/**
497
	 * Populate an array with all values necessary to submit a NEW contact-form feedback to Akismet.
498
	 * Note that this includes the current user_ip etc, so this should only be called when accepting a new item via $_POST
499
	 *
500
	 * @param array $form Contact form feedback array
501
	 * @return array feedback array with additional data ready for submission to Akismet
502
	 */
503
	function prepare_for_akismet( $form ) {
504
		$form['comment_type'] = 'contact_form';
505
		$form['user_ip']      = $_SERVER['REMOTE_ADDR'];
506
		$form['user_agent']   = $_SERVER['HTTP_USER_AGENT'];
507
		$form['referrer']     = $_SERVER['HTTP_REFERER'];
508
		$form['blog']         = get_option( 'home' );
509
510
		foreach ( $_SERVER as $key => $value ) {
511
			if ( ! is_string( $value ) ) {
512
				continue;
513
			}
514
			if ( in_array( $key, array( 'HTTP_COOKIE', 'HTTP_COOKIE2', 'HTTP_USER_AGENT', 'HTTP_REFERER' ) ) ) {
515
				// We don't care about cookies, and the UA and Referrer were caught above.
516
				continue;
517
			} elseif ( in_array( $key, array( 'REMOTE_ADDR', 'REQUEST_URI', 'DOCUMENT_URI' ) ) ) {
518
				// All three of these are relevant indicators and should be passed along.
519
				$form[ $key ] = $value;
520
			} elseif ( wp_startswith( $key, 'HTTP_' ) ) {
521
				// Any other HTTP header indicators.
522
				// `wp_startswith()` is a wpcom helper function and is included in Jetpack via `functions.compat.php`
523
				$form[ $key ] = $value;
524
			}
525
		}
526
527
		return $form;
528
	}
529
530
	/**
531
	 * Submit contact-form data to Akismet to check for spam.
532
	 * If you're accepting a new item via $_POST, run it Grunion_Contact_Form_Plugin::prepare_for_akismet() first
533
	 * Attached to `jetpack_contact_form_is_spam`
534
	 *
535
	 * @param bool  $is_spam
536
	 * @param array $form
537
	 * @return bool|WP_Error TRUE => spam, FALSE => not spam, WP_Error => stop processing entirely
538
	 */
539
	function is_spam_akismet( $is_spam, $form = array() ) {
540
		global $akismet_api_host, $akismet_api_port;
541
542
		// The signature of this function changed from accepting just $form.
543
		// If something only sends an array, assume it's still using the old
544
		// signature and work around it.
545
		if ( empty( $form ) && is_array( $is_spam ) ) {
546
			$form = $is_spam;
547
			$is_spam = false;
548
		}
549
550
		// If a previous filter has alrady marked this as spam, trust that and move on.
551
		if ( $is_spam ) {
552
			return $is_spam;
553
		}
554
555
		if ( ! function_exists( 'akismet_http_post' ) && ! defined( 'AKISMET_VERSION' ) ) {
556
			return false;
557
		}
558
559
		$query_string = http_build_query( $form );
560
561
		if ( method_exists( 'Akismet', 'http_post' ) ) {
562
			$response = Akismet::http_post( $query_string, 'comment-check' );
563
		} else {
564
			$response = akismet_http_post( $query_string, $akismet_api_host, '/1.1/comment-check', $akismet_api_port );
565
		}
566
567
		$result = false;
568
569
		if ( isset( $response[0]['x-akismet-pro-tip'] ) && 'discard' === trim( $response[0]['x-akismet-pro-tip'] ) && get_option( 'akismet_strictness' ) === '1' ) {
570
			$result = new WP_Error( 'feedback-discarded', __( 'Feedback discarded.', 'jetpack' ) );
571
		} elseif ( isset( $response[1] ) && 'true' == trim( $response[1] ) ) { // 'true' is spam
572
			$result = true;
573
		}
574
575
		/**
576
		 * Filter the results returned by Akismet for each submitted contact form.
577
		 *
578
		 * @module contact-form
579
		 *
580
		 * @since 1.3.1
581
		 *
582
		 * @param WP_Error|bool $result Is the submitted feedback spam.
583
		 * @param array|bool $form Submitted feedback.
584
		 */
585
		return apply_filters( 'contact_form_is_spam_akismet', $result, $form );
586
	}
587
588
	/**
589
	 * Submit a feedback as either spam or ham
590
	 *
591
	 * @param string $as Either 'spam' or 'ham'.
592
	 * @param array  $form the contact-form data
593
	 */
594
	function akismet_submit( $as, $form ) {
595
		global $akismet_api_host, $akismet_api_port;
596
597
		if ( ! in_array( $as, array( 'ham', 'spam' ) ) ) {
598
			return false;
599
		}
600
601
		$query_string = '';
602
		if ( is_array( $form ) ) {
603
			$query_string = http_build_query( $form );
604
		}
605
		if ( method_exists( 'Akismet', 'http_post' ) ) {
606
			$response = Akismet::http_post( $query_string, "submit-{$as}" );
607
		} else {
608
			$response = akismet_http_post( $query_string, $akismet_api_host, "/1.1/submit-{$as}", $akismet_api_port );
609
		}
610
611
		return trim( $response[1] );
612
	}
613
614
	/**
615
	 * Prints the menu
616
	 */
617
	function export_form() {
618
		$current_screen = get_current_screen();
619
		if ( ! in_array( $current_screen->id, array( 'edit-feedback', 'feedback_page_feedback-export' ) ) ) {
620
			return;
621
		}
622
623
		if ( ! current_user_can( 'export' ) ) {
624
			return;
625
		}
626
627
		// if there aren't any feedbacks, bail out
628
		if ( ! (int) wp_count_posts( 'feedback' )->publish ) {
629
			return;
630
		}
631
		?>
632
633
		<div id="feedback-export" style="display:none">
634
			<h2><?php _e( 'Export feedback as CSV', 'jetpack' ) ?></h2>
635
			<div class="clear"></div>
636
			<form action="<?php echo admin_url( 'admin-post.php' ); ?>" method="post" class="form">
637
				<?php wp_nonce_field( 'feedback_export','feedback_export_nonce' ); ?>
638
639
				<input name="action" value="feedback_export" type="hidden">
640
				<label for="post"><?php _e( 'Select feedback to download', 'jetpack' ) ?></label>
641
				<select name="post">
642
					<option value="all"><?php esc_html_e( 'All posts', 'jetpack' ) ?></option>
643
					<?php echo $this->get_feedbacks_as_options() ?>
644
				</select>
645
646
				<br><br>
647
				<input type="submit" name="submit" id="submit" class="button button-primary" value="<?php esc_html_e( 'Download', 'jetpack' ); ?>">
648
			</form>
649
		</div>
650
651
		<?php
652
		// There aren't any usable actions in core to output the "export feedback" form in the correct place,
653
		// so this inline JS moves it from the top of the page to the bottom.
654
		?>
655
		<script type='text/javascript'>
656
		var menu = document.getElementById( 'feedback-export' ),
657
		wrapper = document.getElementsByClassName( 'wrap' )[0];
658
		<?php if ( 'edit-feedback' === $current_screen->id ) : ?>
659
		wrapper.appendChild(menu);
660
		<?php endif; ?>
661
		menu.style.display = 'block';
662
		</script>
663
		<?php
664
	}
665
666
	/**
667
	 * Fetch post content for a post and extract just the comment.
668
	 *
669
	 * @param int $post_id The post id to fetch the content for.
670
	 *
671
	 * @return string Trimmed post comment.
672
	 *
673
	 * @codeCoverageIgnore
674
	 */
675
	public function get_post_content_for_csv_export( $post_id ) {
676
		$post_content = get_post_field( 'post_content', $post_id );
677
		$content      = explode( '<!--more-->', $post_content );
678
679
		return trim( $content[0] );
680
	}
681
682
	/**
683
	 * Get `_feedback_extra_fields` field from post meta data.
684
	 *
685
	 * @param int $post_id Id of the post to fetch meta data for.
686
	 *
687
	 * @return mixed
688
	 *
689
	 * @codeCoverageIgnore - No need to be covered.
690
	 */
691
	public function get_post_meta_for_csv_export( $post_id ) {
692
		return get_post_meta( $post_id, '_feedback_extra_fields', true );
693
	}
694
695
	/**
696
	 * Get parsed feedback post fields.
697
	 *
698
	 * @param int $post_id Id of the post to fetch parsed contents for.
699
	 *
700
	 * @return array
701
	 *
702
	 * @codeCoverageIgnore - No need to be covered.
703
	 */
704
	public function get_parsed_field_contents_of_post( $post_id ) {
705
		return self::parse_fields_from_content( $post_id );
706
	}
707
708
	/**
709
	 * Properly maps fields that are missing from the post meta data
710
	 * to names, that are similar to those of the post meta.
711
	 *
712
	 * @param array $parsed_post_content Parsed post content
713
	 *
714
	 * @see parse_fields_from_content for how the input data is generated.
715
	 *
716
	 * @return array Mapped fields.
717
	 */
718
	public function map_parsed_field_contents_of_post_to_field_names( $parsed_post_content ) {
719
720
		$mapped_fields = array();
721
722
		$field_mapping = array(
723
			'_feedback_subject'      => __( 'Contact Form', 'jetpack' ),
724
			'_feedback_author'       => '1_Name',
725
			'_feedback_author_email' => '2_Email',
726
			'_feedback_author_url'   => '3_Website',
727
			'_feedback_main_comment' => '4_Comment',
728
		);
729
730
		foreach ( $field_mapping as $parsed_field_name => $field_name ) {
731
			if (
732
				isset( $parsed_post_content[ $parsed_field_name ] )
733
				&& ! empty( $parsed_post_content[ $parsed_field_name ] )
734
			) {
735
				$mapped_fields[ $field_name ] = $parsed_post_content[ $parsed_field_name ];
736
			}
737
		}
738
739
		return $mapped_fields;
740
	}
741
742
	/**
743
	 * Registers the personal data exporter.
744
	 *
745
	 * @since 6.1.1
746
	 *
747
	 * @param  array $exporters An array of personal data exporters.
748
	 *
749
	 * @return array $exporters An array of personal data exporters.
750
	 */
751
	public function register_personal_data_exporter( $exporters ) {
752
		$exporters[] = array(
753
			'exporter_friendly_name' => __( 'Feedback', 'jetpack' ),
754
			'callback'               => array( $this, 'personal_data_exporter' ),
755
		);
756
757
		return $exporters;
758
	}
759
760
	/**
761
	 * Registers the personal data eraser.
762
	 *
763
	 * @since 6.1.1
764
	 *
765
	 * @param  array $erasers An array of personal data erasers.
766
	 *
767
	 * @return array $erasers An array of personal data erasers.
768
	 */
769
	public function register_personal_data_eraser( $erasers ) {
770
		$erasers[] = array(
771
			'eraser_friendly_name' => __( 'Feedback', 'jetpack' ),
772
			'callback'             => array( $this, 'personal_data_eraser' ),
773
		);
774
775
		return $erasers;
776
	}
777
778
	/**
779
	 * Exports personal data.
780
	 *
781
	 * @since 6.1.1
782
	 *
783
	 * @param  string $email  Email address.
784
	 * @param  int    $page   Page to export.
785
	 *
786
	 * @return array  $return Associative array with keys expected by core.
787
	 */
788
	public function personal_data_exporter( $email, $page = 1 ) {
789
		$per_page    = 250;
790
		$export_data = array();
791
		$post_ids    = $this->personal_data_post_ids_by_email( $email, $per_page, $page );
792
793
		foreach ( $post_ids as $post_id ) {
794
			$post_fields = $this->get_parsed_field_contents_of_post( $post_id );
795
796
			if ( ! is_array( $post_fields ) || empty( $post_fields['_feedback_subject'] ) ) {
797
				continue; // Corrupt data.
798
			}
799
800
			$post_fields['_feedback_main_comment'] = $this->get_post_content_for_csv_export( $post_id );
801
			$post_fields                           = $this->map_parsed_field_contents_of_post_to_field_names( $post_fields );
802
803
			if ( ! is_array( $post_fields ) || empty( $post_fields ) ) {
804
				continue; // No fields to export.
805
			}
806
807
			$post_meta   = $this->get_post_meta_for_csv_export( $post_id );
808
			$post_meta   = is_array( $post_meta ) ? $post_meta : array();
809
810
			$post_export_data = array();
811
			$post_data        = array_merge( $post_fields, $post_meta );
812
			ksort( $post_data );
813
814
			foreach ( $post_data as $post_data_key => $post_data_value ) {
815
				$post_export_data[] = array(
816
					'name'  => preg_replace( '/^[0-9]+_/', '', $post_data_key ),
817
					'value' => $post_data_value,
818
				);
819
			}
820
821
			$export_data[] = array(
822
				'group_id'    => 'feedback',
823
				'group_label' => __( 'Feedback', 'jetpack' ),
824
				'item_id'     => 'feedback-' . $post_id,
825
				'data'        => $post_export_data,
826
			);
827
		}
828
829
		return array(
830
			'data' => $export_data,
831
			'done' => count( $post_ids ) < $per_page,
832
		);
833
	}
834
835
	/**
836
	 * Erases personal data.
837
	 *
838
	 * @since 6.1.1
839
	 *
840
	 * @param  string $email Email address.
841
	 * @param  int    $page  Page to erase.
842
	 *
843
	 * @return array         Associative array with keys expected by core.
844
	 */
845
	public function personal_data_eraser( $email, $page = 1 ) {
846
		$per_page = 250;
847
		$removed  = 0;
848
		$retained = 0;
849
		$messages = array();
850
		$post_ids = $this->personal_data_post_ids_by_email( $email, $per_page, $page );
851
852
		foreach ( $post_ids as $post_id ) {
853
			if ( wp_delete_post( $post_id, true ) ) {
854
				$removed++;
855
			} else {
856
				$retained++;
857
				$messages[] = sprintf(
858
					// translators: %d: Post ID.
859
					__( 'Feedback ID %d could not be removed at this time.', 'jetpack' ),
860
					$post_id
861
				);
862
			}
863
		}
864
865
		return array(
866
			'items_removed'  => $removed,
867
			'items_retained' => $retained,
868
			'messages'       => $messages,
869
			'done'           => count( $post_ids ) < $per_page,
870
		);
871
	}
872
873
	/**
874
	 * Queries personal data by email address.
875
	 *
876
	 * @since 6.1.1
877
	 *
878
	 * @param  string $email    Email address.
879
	 * @param  int    $per_page Post IDs per page. Default is `250`.
880
	 * @param  int    $page     Page to query. Default is `1`.
881
	 *
882
	 * @return array            An array of post IDs.
883
	 */
884
	public function personal_data_post_ids_by_email( $email, $per_page = 250, $page = 1 ) {
885
		add_filter( 'posts_search', array( $this, 'personal_data_search_filter' ) );
886
887
		$post_ids = get_posts( array(
888
			'post_type'        => 'feedback',
889
			'post_status'      => 'publish',
890
			's'                => 'AUTHOR EMAIL: ' . $email,
891
			'sentence'         => true,
892
			'order'            => 'ASC',
893
			'fields'           => 'ids',
894
			'posts_per_page'   => $per_page,
895
			'paged'            => $page,
896
			'suppress_filters' => false,
897
		) );
898
899
		remove_filter( 'posts_search', array( $this, 'personal_data_search_filter' ) );
900
901
		return $post_ids;
902
	}
903
904
	/**
905
	 * Filters searches by email address.
906
	 *
907
	 * @since 6.1.1
908
	 *
909
	 * @param  string $search SQL where clause.
910
	 *
911
	 * @return array          Filtered SQL where clause.
912
	 */
913
	public function personal_data_search_filter( $search ) {
914
		global $wpdb;
915
916
		/*
917
		 * Limits search to `post_content` only, and we only match the
918
		 * author's email address whenever it's on a line by itself.
919
		 * `CHAR(13)` = `\r`, `CHAR(10)` = `\n`
920
		 */
921
		if ( preg_match( '/AUTHOR EMAIL\: ([^{\s]+)/', $search, $m ) ) {
922
			$esc_like_email = esc_sql( $wpdb->esc_like( 'AUTHOR EMAIL: ' . $m[1] ) );
923
			$search         = " AND (
924
				{$wpdb->posts}.post_content LIKE CONCAT('%', CHAR(13), '{$esc_like_email}', CHAR(13), '%')
925
				OR {$wpdb->posts}.post_content LIKE CONCAT('%', CHAR(10), '{$esc_like_email}', CHAR(10), '%')
926
			)";
927
		}
928
929
		return $search;
930
	}
931
932
	/**
933
	 * Prepares feedback post data for CSV export.
934
	 *
935
	 * @param array $post_ids Post IDs to fetch the data for. These need to be Feedback posts.
936
	 *
937
	 * @return array
938
	 */
939
	public function get_export_data_for_posts( $post_ids ) {
940
941
		$posts_data  = array();
942
		$field_names = array();
943
		$result      = array();
944
945
		/**
946
		 * Fetch posts and get the possible field names for later use
947
		 */
948
		foreach ( $post_ids as $post_id ) {
949
950
			/**
951
			 * Fetch post main data, because we need the subject and author data for the feedback form.
952
			 */
953
			$post_real_data = $this->get_parsed_field_contents_of_post( $post_id );
954
955
			/**
956
			 * If `$post_real_data` is not an array or there is no `_feedback_subject` set,
957
			 * then something must be wrong with the feedback post. Skip it.
958
			 */
959
			if ( ! is_array( $post_real_data ) || ! isset( $post_real_data['_feedback_subject'] ) ) {
960
				continue;
961
			}
962
963
			/**
964
			 * Fetch main post comment. This is from the default textarea fields.
965
			 * If it is non-empty, then we add it to data, otherwise skip it.
966
			 */
967
			$post_comment_content = $this->get_post_content_for_csv_export( $post_id );
968
			if ( ! empty( $post_comment_content ) ) {
969
				$post_real_data['_feedback_main_comment'] = $post_comment_content;
970
			}
971
972
			/**
973
			 * Map parsed fields to proper field names
974
			 */
975
			$mapped_fields = $this->map_parsed_field_contents_of_post_to_field_names( $post_real_data );
976
977
			/**
978
			 * Fetch post meta data.
979
			 */
980
			$post_meta_data = $this->get_post_meta_for_csv_export( $post_id );
981
982
			/**
983
			 * If `$post_meta_data` is not an array or if it is empty, then there is no
984
			 * extra feedback to work with. Create an empty array.
985
			 */
986
			if ( ! is_array( $post_meta_data ) || empty( $post_meta_data ) ) {
987
				$post_meta_data = array();
988
			}
989
990
			/**
991
			 * Prepend the feedback subject to the list of fields.
992
			 */
993
			$post_meta_data = array_merge(
994
				$mapped_fields,
995
				$post_meta_data
996
			);
997
998
			/**
999
			 * Save post metadata for later usage.
1000
			 */
1001
			$posts_data[ $post_id ] = $post_meta_data;
1002
1003
			/**
1004
			 * Save field names, so we can use them as header fields later in the CSV.
1005
			 */
1006
			$field_names = array_merge( $field_names, array_keys( $post_meta_data ) );
1007
		}
1008
1009
		/**
1010
		 * Make sure the field names are unique, because we don't want duplicate data.
1011
		 */
1012
		$field_names = array_unique( $field_names );
1013
1014
		/**
1015
		 * Sort the field names by the field id number
1016
		 */
1017
		sort( $field_names, SORT_NUMERIC );
1018
1019
		/**
1020
		 * Loop through every post, which is essentially CSV row.
1021
		 */
1022
		foreach ( $posts_data as $post_id => $single_post_data ) {
1023
1024
			/**
1025
			 * Go through all the possible fields and check if the field is available
1026
			 * in the current post.
1027
			 *
1028
			 * If it is - add the data as a value.
1029
			 * If it is not - add an empty string, which is just a placeholder in the CSV.
1030
			 */
1031
			foreach ( $field_names as $single_field_name ) {
1032
				if (
1033
					isset( $single_post_data[ $single_field_name ] )
1034
					&& ! empty( $single_post_data[ $single_field_name ] )
1035
				) {
1036
					$result[ $single_field_name ][] = trim( $single_post_data[ $single_field_name ] );
1037
				} else {
1038
					$result[ $single_field_name ][] = '';
1039
				}
1040
			}
1041
		}
1042
1043
		return $result;
1044
	}
1045
1046
	/**
1047
	 * download as a csv a contact form or all of them in a csv file
1048
	 */
1049
	function download_feedback_as_csv() {
1050
		if ( empty( $_POST['feedback_export_nonce'] ) ) {
1051
			return;
1052
		}
1053
1054
		check_admin_referer( 'feedback_export', 'feedback_export_nonce' );
1055
1056
		if ( ! current_user_can( 'export' ) ) {
1057
			return;
1058
		}
1059
1060
		$args = array(
1061
			'posts_per_page'   => -1,
1062
			'post_type'        => 'feedback',
1063
			'post_status'      => 'publish',
1064
			'order'            => 'ASC',
1065
			'fields'           => 'ids',
1066
			'suppress_filters' => false,
1067
		);
1068
1069
		$filename = date( 'Y-m-d' ) . '-feedback-export.csv';
1070
1071
		// Check if we want to download all the feedbacks or just a certain contact form
1072
		if ( ! empty( $_POST['post'] ) && $_POST['post'] !== 'all' ) {
1073
			$args['post_parent'] = (int) $_POST['post'];
1074
			$filename            = date( 'Y-m-d' ) . '-' . str_replace( '&nbsp;', '-', get_the_title( (int) $_POST['post'] ) ) . '.csv';
1075
		}
1076
1077
		$feedbacks = get_posts( $args );
1078
1079
		if ( empty( $feedbacks ) ) {
1080
			return;
1081
		}
1082
1083
		$filename  = sanitize_file_name( $filename );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 2 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
1084
1085
		/**
1086
		 * Prepare data for export.
1087
		 */
1088
		$data = $this->get_export_data_for_posts( $feedbacks );
1089
1090
		/**
1091
		 * If `$data` is empty, there's nothing we can do below.
1092
		 */
1093
		if ( ! is_array( $data ) || empty( $data ) ) {
1094
			return;
1095
		}
1096
1097
		/**
1098
		 * Extract field names from `$data` for later use.
1099
		 */
1100
		$fields = array_keys( $data );
1101
1102
		/**
1103
		 * Count how many rows will be exported.
1104
		 */
1105
		$row_count = count( reset( $data ) );
1106
1107
		// Forces the download of the CSV instead of echoing
1108
		header( 'Content-Disposition: attachment; filename=' . $filename );
1109
		header( 'Pragma: no-cache' );
1110
		header( 'Expires: 0' );
1111
		header( 'Content-Type: text/csv; charset=utf-8' );
1112
1113
		$output = fopen( 'php://output', 'w' );
1114
1115
		/**
1116
		 * Print CSV headers
1117
		 */
1118
		fputcsv( $output, $fields );
1119
1120
		/**
1121
		 * Print rows to the output.
1122
		 */
1123
		for ( $i = 0; $i < $row_count; $i ++ ) {
1124
1125
			$current_row = array();
1126
1127
			/**
1128
			 * Put all the fields in `$current_row` array.
1129
			 */
1130
			foreach ( $fields as $single_field_name ) {
1131
				$current_row[] = $this->esc_csv( $data[ $single_field_name ][ $i ] );
1132
			}
1133
1134
			/**
1135
			 * Output the complete CSV row
1136
			 */
1137
			fputcsv( $output, $current_row );
1138
		}
1139
1140
		fclose( $output );
1141
	}
1142
1143
	/**
1144
	 * Escape a string to be used in a CSV context
1145
	 *
1146
	 * Malicious input can inject formulas into CSV files, opening up the possibility for phishing attacks and
1147
	 * disclosure of sensitive information.
1148
	 *
1149
	 * Additionally, Excel exposes the ability to launch arbitrary commands through the DDE protocol.
1150
	 *
1151
	 * @see http://www.contextis.com/resources/blog/comma-separated-vulnerabilities/
1152
	 *
1153
	 * @param string $field
1154
	 *
1155
	 * @return string
1156
	 */
1157
	public function esc_csv( $field ) {
1158
		$active_content_triggers = array( '=', '+', '-', '@' );
1159
1160
		if ( in_array( mb_substr( $field, 0, 1 ), $active_content_triggers, true ) ) {
1161
			$field = "'" . $field;
1162
		}
1163
1164
		return $field;
1165
	}
1166
1167
	/**
1168
	 * Returns a string of HTML <option> items from an array of posts
1169
	 *
1170
	 * @return string a string of HTML <option> items
1171
	 */
1172
	protected function get_feedbacks_as_options() {
1173
		$options = '';
1174
1175
		// Get the feedbacks' parents' post IDs
1176
		$feedbacks = get_posts( array(
1177
			'fields'           => 'id=>parent',
1178
			'posts_per_page'   => 100000,
1179
			'post_type'        => 'feedback',
1180
			'post_status'      => 'publish',
1181
			'suppress_filters' => false,
1182
		) );
1183
		$parents = array_unique( array_values( $feedbacks ) );
1184
1185
		$posts = get_posts( array(
1186
			'orderby'          => 'ID',
1187
			'posts_per_page'   => 1000,
1188
			'post_type'        => 'any',
1189
			'post__in'         => array_values( $parents ),
1190
			'suppress_filters' => false,
1191
		) );
1192
1193
		// creates the string of <option> elements
1194
		foreach ( $posts as $post ) {
1195
			$options .= sprintf( '<option value="%s">%s</option>', esc_attr( $post->ID ), esc_html( $post->post_title ) );
1196
		}
1197
1198
		return $options;
1199
	}
1200
1201
	/**
1202
	 * Get the names of all the form's fields
1203
	 *
1204
	 * @param  array|int $posts the post we want the fields of
1205
	 *
1206
	 * @return array     the array of fields
1207
	 *
1208
	 * @deprecated As this is no longer necessary as of the CSV export rewrite. - 2015-12-29
1209
	 */
1210
	protected function get_field_names( $posts ) {
1211
		$posts = (array) $posts;
1212
		$all_fields = array();
1213
1214
		foreach ( $posts as $post ) {
1215
			$fields = self::parse_fields_from_content( $post );
1216
1217
			if ( isset( $fields['_feedback_all_fields'] ) ) {
1218
				$extra_fields = array_keys( $fields['_feedback_all_fields'] );
1219
				$all_fields = array_merge( $all_fields, $extra_fields );
1220
			}
1221
		}
1222
1223
		$all_fields = array_unique( $all_fields );
1224
		return $all_fields;
1225
	}
1226
1227
	public static function parse_fields_from_content( $post_id ) {
1228
		static $post_fields;
1229
1230
		if ( ! is_array( $post_fields ) ) {
1231
			$post_fields = array();
1232
		}
1233
1234
		if ( isset( $post_fields[ $post_id ] ) ) {
1235
			return $post_fields[ $post_id ];
1236
		}
1237
1238
		$all_values   = array();
1239
		$post_content = get_post_field( 'post_content', $post_id );
1240
		$content      = explode( '<!--more-->', $post_content );
1241
		$lines        = array();
1242
1243
		if ( count( $content ) > 1 ) {
1244
			$content  = str_ireplace( array( '<br />', ')</p>' ), '', $content[1] );
1245
			$one_line = preg_replace( '/\s+/', ' ', $content );
1246
			$one_line = preg_replace( '/.*Array \( (.*)\)/', '$1', $one_line );
1247
1248
			preg_match_all( '/\[([^\]]+)\] =\&gt\; ([^\[]+)/', $one_line, $matches );
1249
1250
			if ( count( $matches ) > 1 ) {
1251
				$all_values = array_combine( array_map( 'trim', $matches[1] ), array_map( 'trim', $matches[2] ) );
1252
			}
1253
1254
			$lines = array_filter( explode( "\n", $content ) );
1255
		}
1256
1257
		$var_map = array(
1258
			'AUTHOR'       => '_feedback_author',
1259
			'AUTHOR EMAIL' => '_feedback_author_email',
1260
			'AUTHOR URL'   => '_feedback_author_url',
1261
			'SUBJECT'      => '_feedback_subject',
1262
			'IP'           => '_feedback_ip',
1263
		);
1264
1265
		$fields = array();
1266
1267
		foreach ( $lines as $line ) {
1268
			$vars = explode( ': ', $line, 2 );
1269
			if ( ! empty( $vars ) ) {
1270
				if ( isset( $var_map[ $vars[0] ] ) ) {
1271
					$fields[ $var_map[ $vars[0] ] ] = self::strip_tags( trim( $vars[1] ) );
1272
				}
1273
			}
1274
		}
1275
1276
		$fields['_feedback_all_fields'] = $all_values;
1277
1278
		$post_fields[ $post_id ] = $fields;
1279
1280
		return $fields;
1281
	}
1282
1283
	/**
1284
	 * Creates a valid csv row from a post id
1285
	 *
1286
	 * @param  int   $post_id The id of the post
1287
	 * @param  array $fields  An array containing the names of all the fields of the csv
1288
	 * @return String The csv row
1289
	 *
1290
	 * @deprecated This is no longer needed, as of the CSV export rewrite.
1291
	 */
1292
	protected static function make_csv_row_from_feedback( $post_id, $fields ) {
1293
		$content_fields = self::parse_fields_from_content( $post_id );
1294
		$all_fields     = array();
1295
1296
		if ( isset( $content_fields['_feedback_all_fields'] ) ) {
1297
			$all_fields = $content_fields['_feedback_all_fields'];
1298
		}
1299
1300
		// Overwrite the parsed content with the content we stored in post_meta in a better format.
1301
		$extra_fields   = get_post_meta( $post_id, '_feedback_extra_fields', true );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 3 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
1302
		foreach ( $extra_fields as $extra_field => $extra_value ) {
1303
			$all_fields[ $extra_field ] = $extra_value;
1304
		}
1305
1306
		// The first element in all of the exports will be the subject
1307
		$row_items[] = $content_fields['_feedback_subject'];
0 ignored issues
show
Coding Style Comprehensibility introduced by
$row_items was never initialized. Although not strictly required by PHP, it is generally a good practice to add $row_items = 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...
1308
1309
		// Loop the fields array in order to fill the $row_items array correctly
1310
		foreach ( $fields as $field ) {
1311
			if ( $field === __( 'Contact Form', 'jetpack' ) ) { // the first field will ever be the contact form, so we can continue
1312
				continue;
1313
			} elseif ( array_key_exists( $field, $all_fields ) ) {
1314
				$row_items[] = $all_fields[ $field ];
1315
			} else { $row_items[] = '';
1316
			}
1317
		}
1318
1319
		return $row_items;
1320
	}
1321
1322
	public static function get_ip_address() {
1323
		return isset( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : null;
1324
	}
1325
}
1326
1327
/**
1328
 * Generic shortcode class.
1329
 * Does nothing other than store structured data and output the shortcode as a string
1330
 *
1331
 * Not very general - specific to Grunion.
1332
 */
1333
class Crunion_Contact_Form_Shortcode {
0 ignored issues
show
Coding Style Compatibility introduced by
PSR1 recommends that each class should be in its own file to aid autoloaders.

Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule.

Loading history...
1334
	/**
1335
	 * @var string the name of the shortcode: [$shortcode_name /]
1336
	 */
1337
	public $shortcode_name;
1338
1339
	/**
1340
	 * @var array key => value pairs for the shortcode's attributes: [$shortcode_name key="value" ... /]
1341
	 */
1342
	public $attributes;
1343
1344
	/**
1345
	 * @var array key => value pair for attribute defaults
1346
	 */
1347
	public $defaults = array();
1348
1349
	/**
1350
	 * @var null|string Null for selfclosing shortcodes.  Hhe inner content of otherwise: [$shortcode_name]$content[/$shortcode_name]
1351
	 */
1352
	public $content;
1353
1354
	/**
1355
	 * @var array Associative array of inner "child" shortcodes equivalent to the $content: [$shortcode_name][child 1/][child 2/][/$shortcode_name]
1356
	 */
1357
	public $fields;
1358
1359
	/**
1360
	 * @var null|string The HTML of the parsed inner "child" shortcodes".  Null for selfclosing shortcodes.
1361
	 */
1362
	public $body;
1363
1364
	/**
1365
	 * @param array       $attributes An associative array of shortcode attributes.  @see shortcode_atts()
1366
	 * @param null|string $content Null for selfclosing shortcodes.  The inner content otherwise.
1367
	 */
1368
	function __construct( $attributes, $content = null ) {
1369
		$this->attributes = $this->unesc_attr( $attributes );
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->unesc_attr($attributes) of type * is incompatible with the declared type array of property $attributes.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1370
		if ( is_array( $content ) ) {
1371
			$string_content = '';
1372
			foreach ( $content as $field ) {
1373
				$string_content .= (string) $field;
1374
			}
1375
1376
			$this->content = $string_content;
1377
		} else {
1378
			$this->content = $content;
1379
		}
1380
1381
		$this->parse_content( $this->content );
1382
	}
1383
1384
	/**
1385
	 * Processes the shortcode's inner content for "child" shortcodes
1386
	 *
1387
	 * @param string $content The shortcode's inner content: [shortcode]$content[/shortcode]
1388
	 */
1389
	function parse_content( $content ) {
1390
		if ( is_null( $content ) ) {
1391
			$this->body = null;
1392
		}
1393
1394
		$this->body = do_shortcode( $content );
1395
	}
1396
1397
	/**
1398
	 * Returns the value of the requested attribute.
1399
	 *
1400
	 * @param string $key The attribute to retrieve
1401
	 * @return mixed
1402
	 */
1403
	function get_attribute( $key ) {
1404
		return isset( $this->attributes[ $key ] ) ? $this->attributes[ $key ] : null;
1405
	}
1406
1407
	function esc_attr( $value ) {
1408
		if ( is_array( $value ) ) {
1409
			return array_map( array( $this, 'esc_attr' ), $value );
1410
		}
1411
1412
		$value = Grunion_Contact_Form_Plugin::strip_tags( $value );
1413
		$value = _wp_specialchars( $value, ENT_QUOTES, false, true );
1414
1415
		// Shortcode attributes can't contain "]"
1416
		$value = str_replace( ']', '', $value );
1417
		$value = str_replace( ',', '&#x002c;', $value ); // store commas encoded
1418
		$value = strtr( $value, array( '%' => '%25', '&' => '%26' ) );
1419
1420
		// shortcode_parse_atts() does stripcslashes()
1421
		$value = addslashes( $value );
1422
		return $value;
1423
	}
1424
1425
	function unesc_attr( $value ) {
1426
		if ( is_array( $value ) ) {
1427
			return array_map( array( $this, 'unesc_attr' ), $value );
1428
		}
1429
1430
		// For back-compat with old Grunion encoding
1431
		// Also, unencode commas
1432
		$value = strtr( $value, array( '%26' => '&', '%25' => '%' ) );
1433
		$value = preg_replace( array( '/&#x0*22;/i', '/&#x0*27;/i', '/&#x0*26;/i', '/&#x0*2c;/i' ), array( '"', "'", '&', ',' ), $value );
1434
		$value = htmlspecialchars_decode( $value, ENT_QUOTES );
1435
		$value = Grunion_Contact_Form_Plugin::strip_tags( $value );
1436
1437
		return $value;
1438
	}
1439
1440
	/**
1441
	 * Generates the shortcode
1442
	 */
1443
	function __toString() {
1444
		$r = "[{$this->shortcode_name} ";
1445
1446
		foreach ( $this->attributes as $key => $value ) {
1447
			if ( ! $value ) {
1448
				continue;
1449
			}
1450
1451
			if ( isset( $this->defaults[ $key ] ) && $this->defaults[ $key ] == $value ) {
1452
				continue;
1453
			}
1454
1455
			if ( 'id' == $key ) {
1456
				continue;
1457
			}
1458
1459
			$value = $this->esc_attr( $value );
1460
1461
			if ( is_array( $value ) ) {
1462
				$value = join( ',', $value );
1463
			}
1464
1465
			if ( false === strpos( $value, "'" ) ) {
1466
				$value = "'$value'";
1467
			} elseif ( false === strpos( $value, '"' ) ) {
1468
				$value = '"' . $value . '"';
1469
			} else {
1470
				// Shortcodes can't contain both '"' and "'".  Strip one.
1471
				$value = str_replace( "'", '', $value );
1472
				$value = "'$value'";
1473
			}
1474
1475
			$r .= "{$key}={$value} ";
1476
		}
1477
1478
		$r = rtrim( $r );
1479
1480
		if ( $this->fields ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->fields 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...
1481
			$r .= ']';
1482
1483
			foreach ( $this->fields as $field ) {
1484
				$r .= (string) $field;
1485
			}
1486
1487
			$r .= "[/{$this->shortcode_name}]";
1488
		} else {
1489
			$r .= '/]';
1490
		}
1491
1492
		return $r;
1493
	}
1494
}
1495
1496
/**
1497
 * Class for the contact-form shortcode.
1498
 * Parses shortcode to output the contact form as HTML
1499
 * Sends email and stores the contact form response (a.k.a. "feedback")
1500
 */
1501
class Grunion_Contact_Form extends Crunion_Contact_Form_Shortcode {
0 ignored issues
show
Coding Style Compatibility introduced by
PSR1 recommends that each class should be in its own file to aid autoloaders.

Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule.

Loading history...
1502
	public $shortcode_name = 'contact-form';
1503
1504
	/**
1505
	 * @var WP_Error stores form submission errors
1506
	 */
1507
	public $errors;
1508
1509
	/**
1510
	 * @var string The SHA1 hash of the attributes that comprise the form.
1511
	 */
1512
	public $hash;
1513
1514
	/**
1515
	 * @var Grunion_Contact_Form The most recent (inclusive) contact-form shortcode processed
1516
	 */
1517
	static $last;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $last.

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...
1518
1519
	/**
1520
	 * @var Whatever form we are currently looking at. If processed, will become $last
1521
	 */
1522
	static $current_form;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $current_form.

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...
1523
1524
	/**
1525
	 * @var array All found forms, indexed by hash.
1526
	 */
1527
	static $forms = array();
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $forms.

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...
1528
1529
	/**
1530
	 * @var bool Whether to print the grunion.css style when processing the contact-form shortcode
1531
	 */
1532
	static $style = false;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $style.

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...
1533
1534
	function __construct( $attributes, $content = null ) {
1535
		global $post;
1536
1537
		$this->hash = sha1( json_encode( $attributes ) . $content );
1538
		self::$forms[ $this->hash ] = $this;
1539
1540
		// Set up the default subject and recipient for this form
1541
		$default_to = '';
1542
		$default_subject = '[' . get_option( 'blogname' ) . ']';
1543
1544
		if ( ! isset( $attributes ) || ! is_array( $attributes ) ) {
1545
			$attributes = array();
1546
		}
1547
1548
		if ( ! empty( $attributes['widget'] ) && $attributes['widget'] ) {
1549
			$default_to .= get_option( 'admin_email' );
1550
			$attributes['id'] = 'widget-' . $attributes['widget'];
1551
			$default_subject = sprintf( _x( '%1$s Sidebar', '%1$s = blog name', 'jetpack' ), $default_subject );
1552
		} elseif ( $post ) {
1553
			$attributes['id'] = $post->ID;
1554
			$default_subject = sprintf( _x( '%1$s %2$s', '%1$s = blog name, %2$s = post title', 'jetpack' ), $default_subject, Grunion_Contact_Form_Plugin::strip_tags( $post->post_title ) );
1555
			$post_author = get_userdata( $post->post_author );
1556
			$default_to .= $post_author->user_email;
1557
		}
1558
1559
		// Keep reference to $this for parsing form fields
1560
		self::$current_form = $this;
0 ignored issues
show
Documentation Bug introduced by
It seems like $this of type this<Grunion_Contact_Form> is incompatible with the declared type object<Whatever> of property $current_form.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1561
1562
		$this->defaults = array(
1563
			'to'                 => $default_to,
1564
			'subject'            => $default_subject,
1565
			'show_subject'       => 'no', // only used in back-compat mode
1566
			'widget'             => 0,    // Not exposed to the user. Works with Grunion_Contact_Form_Plugin::widget_atts()
1567
			'id'                 => null, // Not exposed to the user. Set above.
1568
			'submit_button_text' => __( 'Submit &#187;', 'jetpack' ),
1569
		);
1570
1571
		$attributes = shortcode_atts( $this->defaults, $attributes, 'contact-form' );
1572
1573
		// We only enable the contact-field shortcode temporarily while processing the contact-form shortcode
1574
		Grunion_Contact_Form_Plugin::$using_contact_form_field = true;
0 ignored issues
show
Bug introduced by
The property using_contact_form_field cannot be accessed from this context as it is declared private in class Grunion_Contact_Form_Plugin.

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...
1575
1576
		parent::__construct( $attributes, $content );
1577
1578
		// There were no fields in the contact form. The form was probably just [contact-form /]. Build a default form.
1579
		if ( empty( $this->fields ) ) {
1580
			// same as the original Grunion v1 form
1581
			$default_form = '
1582
				[contact-field label="' . __( 'Name', 'jetpack' ) . '" type="name"  required="true" /]
1583
				[contact-field label="' . __( 'Email', 'jetpack' ) . '" type="email" required="true" /]
1584
				[contact-field label="' . __( 'Website', 'jetpack' ) . '" type="url" /]';
1585
1586
			if ( 'yes' == strtolower( $this->get_attribute( 'show_subject' ) ) ) {
1587
				$default_form .= '
1588
					[contact-field label="' . __( 'Subject', 'jetpack' ) . '" type="subject" /]';
1589
			}
1590
1591
			$default_form .= '
1592
				[contact-field label="' . __( 'Message', 'jetpack' ) . '" type="textarea" /]';
1593
1594
			$this->parse_content( $default_form );
1595
1596
			// Store the shortcode
1597
			$this->store_shortcode( $default_form, $attributes, $this->hash );
1598
		} else {
1599
			// Store the shortcode
1600
			$this->store_shortcode( $content, $attributes, $this->hash );
1601
		}
1602
1603
		// $this->body and $this->fields have been setup.  We no longer need the contact-field shortcode.
1604
		Grunion_Contact_Form_Plugin::$using_contact_form_field = false;
0 ignored issues
show
Bug introduced by
The property using_contact_form_field cannot be accessed from this context as it is declared private in class Grunion_Contact_Form_Plugin.

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...
1605
	}
1606
1607
	/**
1608
	 * Store shortcode content for recall later
1609
	 *	- used to receate shortcode when user uses do_shortcode
1610
	 *
1611
	 * @param string $content
0 ignored issues
show
Documentation introduced by
Should the type for parameter $content not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
1612
	 * @param array $attributes
0 ignored issues
show
Documentation introduced by
Should the type for parameter $attributes not be array|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
1613
	 * @param string $hash
0 ignored issues
show
Documentation introduced by
Should the type for parameter $hash not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
1614
	 */
1615
	static function store_shortcode( $content = null, $attributes = null, $hash = null ) {
1616
1617
		if ( $content != null and isset( $attributes['id'] ) ) {
0 ignored issues
show
Bug introduced by
It seems like you are loosely comparing $content of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison !== instead.
Loading history...
Comprehensibility Best Practice introduced by
Using logical operators such as and instead of && is generally not recommended.

PHP has two types of connecting operators (logical operators, and boolean operators):

  Logical Operators Boolean Operator
AND - meaning and &&
OR - meaning or ||

The difference between these is the order in which they are executed. In most cases, you would want to use a boolean operator like &&, or ||.

Let’s take a look at a few examples:

// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);

Logical Operators are used for Control-Flow

One case where you explicitly want to use logical operators is for control-flow such as this:

$x === 5
    or die('$x must be 5.');

// Instead of
if ($x !== 5) {
    die('$x must be 5.');
}

Since die introduces problems of its own, f.e. it makes our code hardly testable, and prevents any kind of more sophisticated error handling; you probably do not want to use this in real-world code. Unfortunately, logical operators cannot be combined with throw at this point:

// The following is currently a parse error.
$x === 5
    or throw new RuntimeException('$x must be 5.');

These limitations lead to logical operators rarely being of use in current PHP code.

Loading history...
1618
1619
			if ( empty( $hash ) ) {
1620
				$hash = sha1( json_encode( $attributes ) . $content );
1621
			}
1622
1623
			$shortcode_meta = get_post_meta( $attributes['id'], "_g_feedback_shortcode_{$hash}", true );
1624
1625
			if ( $shortcode_meta != '' or $shortcode_meta != $content ) {
0 ignored issues
show
Comprehensibility Best Practice introduced by
Using logical operators such as or instead of || is generally not recommended.

PHP has two types of connecting operators (logical operators, and boolean operators):

  Logical Operators Boolean Operator
AND - meaning and &&
OR - meaning or ||

The difference between these is the order in which they are executed. In most cases, you would want to use a boolean operator like &&, or ||.

Let’s take a look at a few examples:

// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);

Logical Operators are used for Control-Flow

One case where you explicitly want to use logical operators is for control-flow such as this:

$x === 5
    or die('$x must be 5.');

// Instead of
if ($x !== 5) {
    die('$x must be 5.');
}

Since die introduces problems of its own, f.e. it makes our code hardly testable, and prevents any kind of more sophisticated error handling; you probably do not want to use this in real-world code. Unfortunately, logical operators cannot be combined with throw at this point:

// The following is currently a parse error.
$x === 5
    or throw new RuntimeException('$x must be 5.');

These limitations lead to logical operators rarely being of use in current PHP code.

Loading history...
1626
				update_post_meta( $attributes['id'], "_g_feedback_shortcode_{$hash}", $content );
1627
1628
				// Save attributes to post_meta for later use. They're not available later in do_shortcode situations.
1629
				update_post_meta( $attributes['id'], "_g_feedback_shortcode_atts_{$hash}", $attributes );
1630
			}
1631
		}
1632
	}
1633
1634
	/**
1635
	 * Toggle for printing the grunion.css stylesheet
1636
	 *
1637
	 * @param bool $style
1638
	 */
1639
	static function style( $style ) {
1640
		$previous_style = self::$style;
1641
		self::$style = (bool) $style;
1642
		return $previous_style;
1643
	}
1644
1645
	/**
1646
	 * Turn on printing of grunion.css stylesheet
1647
	 *
1648
	 * @see ::style()
1649
	 * @internal
1650
	 * @param bool $style
0 ignored issues
show
Bug introduced by
There is no parameter named $style. 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...
1651
	 */
1652
	static function _style_on() {
1653
		return self::style( true );
1654
	}
1655
1656
	/**
1657
	 * The contact-form shortcode processor
1658
	 *
1659
	 * @param array       $attributes Key => Value pairs as parsed by shortcode_parse_atts()
1660
	 * @param string|null $content The shortcode's inner content: [contact-form]$content[/contact-form]
1661
	 * @return string HTML for the concat form.
1662
	 */
1663
	static function parse( $attributes, $content ) {
1664
		require_once JETPACK__PLUGIN_DIR . '/sync/class.jetpack-sync-settings.php';
1665
		if ( Jetpack_Sync_Settings::is_syncing() ) {
1666
			return '';
1667
		}
1668
		// Create a new Grunion_Contact_Form object (this class)
1669
		$form = new Grunion_Contact_Form( $attributes, $content );
1670
1671
		$id = $form->get_attribute( 'id' );
1672
1673
		if ( ! $id ) { // something terrible has happened
1674
			return '[contact-form]';
1675
		}
1676
1677
		if ( is_feed() ) {
1678
			return '[contact-form]';
1679
		}
1680
1681
		self::$last = $form;
1682
1683
		// Enqueue the grunion.css stylesheet if self::$style allows it
1684
		if ( self::$style && ( empty( $_REQUEST['action'] ) || $_REQUEST['action'] != 'grunion_shortcode_to_json' ) ) {
1685
			// Enqueue the style here instead of printing it, because if some other plugin has run the_post()+rewind_posts(),
1686
			// (like VideoPress does), the style tag gets "printed" the first time and discarded, leaving the contact form unstyled.
1687
			// when WordPress does the real loop.
1688
			wp_enqueue_style( 'grunion.css' );
1689
		}
1690
1691
		$r = '';
1692
		$r .= "<div id='contact-form-$id'>\n";
1693
1694
		if ( is_wp_error( $form->errors ) && $form->errors->get_error_codes() ) {
1695
			// There are errors.  Display them
1696
			$r .= "<div class='form-error'>\n<h3>" . __( 'Error!', 'jetpack' ) . "</h3>\n<ul class='form-errors'>\n";
1697
			foreach ( $form->errors->get_error_messages() as $message ) {
1698
				$r .= "\t<li class='form-error-message'>" . esc_html( $message ) . "</li>\n";
1699
			}
1700
			$r .= "</ul>\n</div>\n\n";
1701
		}
1702
1703
		if ( isset( $_GET['contact-form-id'] )
1704
			&& $_GET['contact-form-id'] == self::$last->get_attribute( 'id' )
1705
			&& isset( $_GET['contact-form-sent'], $_GET['contact-form-hash'] )
1706
			&& hash_equals( $form->hash, $_GET['contact-form-hash'] ) ) {
1707
			// The contact form was submitted.  Show the success message/results
1708
			$feedback_id = (int) $_GET['contact-form-sent'];
1709
1710
			$back_url = remove_query_arg( array( 'contact-form-id', 'contact-form-sent', '_wpnonce' ) );
1711
1712
			$r_success_message =
1713
				'<h3>' . __( 'Message Sent', 'jetpack' ) .
1714
				' (<a href="' . esc_url( $back_url ) . '">' . esc_html__( 'go back', 'jetpack' ) . '</a>)' .
1715
				"</h3>\n\n";
1716
1717
			// Don't show the feedback details unless the nonce matches
1718
			if ( $feedback_id && wp_verify_nonce( stripslashes( $_GET['_wpnonce'] ), "contact-form-sent-{$feedback_id}" ) ) {
1719
				$r_success_message .= self::success_message( $feedback_id, $form );
1720
			}
1721
1722
			/**
1723
			 * Filter the message returned after a successful contact form submission.
1724
			 *
1725
			 * @module contact-form
1726
			 *
1727
			 * @since 1.3.1
1728
			 *
1729
			 * @param string $r_success_message Success message.
1730
			 */
1731
			$r .= apply_filters( 'grunion_contact_form_success_message', $r_success_message );
1732
		} else {
1733
			// Nothing special - show the normal contact form
1734
			if ( $form->get_attribute( 'widget' ) ) {
1735
				// Submit form to the current URL
1736
				$url = remove_query_arg( array( 'contact-form-id', 'contact-form-sent', 'action', '_wpnonce' ) );
1737
			} else {
1738
				// Submit form to the post permalink
1739
				$url = get_permalink();
1740
			}
1741
1742
			// For SSL/TLS page. See RFC 3986 Section 4.2
1743
			$url = set_url_scheme( $url );
1744
1745
			// May eventually want to send this to admin-post.php...
1746
			/**
1747
			 * Filter the contact form action URL.
1748
			 *
1749
			 * @module contact-form
1750
			 *
1751
			 * @since 1.3.1
1752
			 *
1753
			 * @param string $contact_form_id Contact form post URL.
1754
			 * @param $post $GLOBALS['post'] Post global variable.
0 ignored issues
show
Documentation introduced by
The doc-type $post could not be parsed: Unknown type name "$post" 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...
1755
			 * @param int $id Contact Form ID.
1756
			 */
1757
			$url = apply_filters( 'grunion_contact_form_form_action', "{$url}#contact-form-{$id}", $GLOBALS['post'], $id );
1758
1759
			$r .= "<form action='" . esc_url( $url ) . "' method='post' class='contact-form commentsblock'>\n";
1760
			$r .= $form->body;
1761
			$r .= "\t<p class='contact-submit'>\n";
1762
			$r .= "\t\t<input type='submit' value='" . esc_attr( $form->get_attribute( 'submit_button_text' ) ) . "' class='pushbutton-wide'/>\n";
1763
			if ( is_user_logged_in() ) {
1764
				$r .= "\t\t" . wp_nonce_field( 'contact-form_' . $id, '_wpnonce', true, false ) . "\n"; // nonce and referer
1765
			}
1766
			$r .= "\t\t<input type='hidden' name='contact-form-id' value='$id' />\n";
1767
			$r .= "\t\t<input type='hidden' name='action' value='grunion-contact-form' />\n";
1768
			$r .= "\t\t<input type='hidden' name='contact-form-hash' value='" . esc_attr( $form->hash ) . "' />\n";
1769
			$r .= "\t</p>\n";
1770
			$r .= "</form>\n";
1771
		}
1772
1773
		$r .= '</div>';
1774
1775
		return $r;
1776
	}
1777
1778
	/**
1779
	 * Returns a success message to be returned if the form is sent via AJAX.
1780
	 *
1781
	 * @param int                         $feedback_id
1782
	 * @param object Grunion_Contact_Form $form
1783
	 *
1784
	 * @return string $message
1785
	 */
1786
	static function success_message( $feedback_id, $form ) {
1787
		return wp_kses(
1788
			'<blockquote class="contact-form-submission">'
1789
			. '<p>' . join( self::get_compiled_form( $feedback_id, $form ), '</p><p>' ) . '</p>'
1790
			. '</blockquote>',
1791
			array( 'br' => array(), 'blockquote' => array( 'class' => array() ), 'p' => array() )
1792
		);
1793
	}
1794
1795
	/**
1796
	 * Returns a compiled form with labels and values in a form of  an array
1797
	 * of lines.
1798
	 *
1799
	 * @param int                         $feedback_id
1800
	 * @param object Grunion_Contact_Form $form
1801
	 *
1802
	 * @return array $lines
1803
	 */
1804
	static function get_compiled_form( $feedback_id, $form ) {
1805
		$feedback       = get_post( $feedback_id );
1806
		$field_ids      = $form->get_field_ids();
1807
		$content_fields = Grunion_Contact_Form_Plugin::parse_fields_from_content( $feedback_id );
1808
1809
		// Maps field_ids to post_meta keys
1810
		$field_value_map = array(
1811
			'name'     => 'author',
1812
			'email'    => 'author_email',
1813
			'url'      => 'author_url',
1814
			'subject'  => 'subject',
1815
			'textarea' => false, // not a post_meta key.  This is stored in post_content
1816
		);
1817
1818
		$compiled_form = array();
1819
1820
		// "Standard" field whitelist
1821
		foreach ( $field_value_map as $type => $meta_key ) {
1822
			if ( isset( $field_ids[ $type ] ) ) {
1823
				$field = $form->fields[ $field_ids[ $type ] ];
1824
1825
				if ( $meta_key ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $meta_key of type string|false is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

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

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
1826
					if ( isset( $content_fields[ "_feedback_{$meta_key}" ] ) ) {
1827
						$value = $content_fields[ "_feedback_{$meta_key}" ];
1828
					}
1829
				} else {
1830
					// The feedback content is stored as the first "half" of post_content
1831
					$value = $feedback->post_content;
1832
					list( $value ) = explode( '<!--more-->', $value );
1833
					$value = trim( $value );
1834
				}
1835
1836
				$field_index = array_search( $field_ids[ $type ], $field_ids['all'] );
1837
				$compiled_form[ $field_index ] = sprintf(
1838
					'<b>%1$s:</b> %2$s<br /><br />',
1839
					wp_kses( $field->get_attribute( 'label' ), array() ),
1840
					nl2br( wp_kses( $value, array() ) )
0 ignored issues
show
Bug introduced by
The variable $value does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1841
				);
1842
			}
1843
		}
1844
1845
		// "Non-standard" fields
1846
		if ( $field_ids['extra'] ) {
1847
			// array indexed by field label (not field id)
1848
			$extra_fields = get_post_meta( $feedback_id, '_feedback_extra_fields', true );
1849
1850
			/**
1851
			 * Only get data for the compiled form if `$extra_fields` is a valid and non-empty array.
1852
			 */
1853
			if ( is_array( $extra_fields ) && ! empty( $extra_fields ) ) {
1854
1855
				$extra_field_keys = array_keys( $extra_fields );
1856
1857
				$i = 0;
1858
				foreach ( $field_ids['extra'] as $field_id ) {
1859
					$field       = $form->fields[ $field_id ];
1860
					$field_index = array_search( $field_id, $field_ids['all'] );
1861
1862
					$label = $field->get_attribute( 'label' );
1863
1864
					$compiled_form[ $field_index ] = sprintf(
1865
						'<b>%1$s:</b> %2$s<br /><br />',
1866
						wp_kses( $label, array() ),
1867
						nl2br( wp_kses( $extra_fields[ $extra_field_keys[ $i ] ], array() ) )
1868
					);
1869
1870
					$i++;
1871
				}
1872
			}
1873
		}
1874
1875
		// Sorting lines by the field index
1876
		ksort( $compiled_form );
1877
1878
		return $compiled_form;
1879
	}
1880
1881
	/**
1882
	 * The contact-field shortcode processor
1883
	 * We use an object method here instead of a static Grunion_Contact_Form_Field class method to parse contact-field shortcodes so that we can tie them to the contact-form object.
1884
	 *
1885
	 * @param array       $attributes Key => Value pairs as parsed by shortcode_parse_atts()
1886
	 * @param string|null $content The shortcode's inner content: [contact-field]$content[/contact-field]
1887
	 * @return HTML for the contact form field
1888
	 */
1889
	static function parse_contact_field( $attributes, $content ) {
1890
		// Don't try to parse contact form fields if not inside a contact form
1891
		if ( ! Grunion_Contact_Form_Plugin::$using_contact_form_field ) {
0 ignored issues
show
Bug introduced by
The property using_contact_form_field cannot be accessed from this context as it is declared private in class Grunion_Contact_Form_Plugin.

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...
1892
			$att_strs = array();
1893
			foreach ( $attributes as $att => $val ) {
1894
				if ( is_numeric( $att ) ) { // Is a valueless attribute
1895
					$att_strs[] = esc_html( $val );
1896
				} elseif ( isset( $val ) ) { // A regular attr - value pair
1897
					$att_strs[] = esc_html( $att ) . '=\'' . esc_html( $val ) . '\'';
1898
				}
1899
			}
1900
1901
			$html = '[contact-field ' . implode( ' ', $att_strs );
1902
1903
			if ( isset( $content ) && ! empty( $content ) ) { // If there is content, let's add a closing tag
1904
				$html .= ']' . esc_html( $content ) . '[/contact-field]';
1905
			} else { // Otherwise let's add a closing slash in the first tag
1906
				$html .= '/]';
1907
			}
1908
1909
			return $html;
1910
		}
1911
1912
		$form = Grunion_Contact_Form::$current_form;
1913
1914
		$field = new Grunion_Contact_Form_Field( $attributes, $content, $form );
1915
1916
		$field_id = $field->get_attribute( 'id' );
1917
		if ( $field_id ) {
1918
			$form->fields[ $field_id ] = $field;
1919
		} else {
1920
			$form->fields[] = $field;
1921
		}
1922
1923
		if (
1924
			isset( $_POST['action'] ) && 'grunion-contact-form' === $_POST['action']
1925
		&&
1926
			isset( $_POST['contact-form-id'] ) && $form->get_attribute( 'id' ) == $_POST['contact-form-id']
1927
		&&
1928
			isset( $_POST['contact-form-hash'] ) && hash_equals( $form->hash, $_POST['contact-form-hash'] )
1929
		) {
1930
			// If we're processing a POST submission for this contact form, validate the field value so we can show errors as necessary.
1931
			$field->validate();
1932
		}
1933
1934
		// Output HTML
1935
		return $field->render();
1936
	}
1937
1938
	/**
1939
	 * Loops through $this->fields to generate a (structured) list of field IDs.
1940
	 *
1941
	 * Important: Currently the whitelisted fields are defined as follows:
1942
	 *  `name`, `email`, `url`, `subject`, `textarea`
1943
	 *
1944
	 * If you need to add new fields to the Contact Form, please don't add them
1945
	 * to the whitelisted fields and leave them as extra fields.
1946
	 *
1947
	 * The reasoning behind this is that both the admin Feedback view and the CSV
1948
	 * export will not include any fields that are added to the list of
1949
	 * whitelisted fields without taking proper care to add them to all the
1950
	 * other places where they accessed/used/saved.
1951
	 *
1952
	 * The safest way to add new fields is to add them to the dropdown and the
1953
	 * HTML list ( @see Grunion_Contact_Form_Field::render ) and don't add them
1954
	 * to the list of whitelisted fields. This way they will become a part of the
1955
	 * `extra fields` which are saved in the post meta and will be properly
1956
	 * handled by the admin Feedback view and the CSV Export without any extra
1957
	 * work.
1958
	 *
1959
	 * If there is need to add a field to the whitelisted fields, then please
1960
	 * take proper care to add logic to handle the field in the following places:
1961
	 *
1962
	 *  - Below in the switch statement - so the field is recognized as whitelisted.
1963
	 *
1964
	 *  - Grunion_Contact_Form::process_submission - validation and logic.
1965
	 *
1966
	 *  - Grunion_Contact_Form::process_submission - add the field as an additional
1967
	 *      field in the `post_content` when saving the feedback content.
1968
	 *
1969
	 *  - Grunion_Contact_Form_Plugin::parse_fields_from_content - add mapping
1970
	 *      for the field, defined in the above method.
1971
	 *
1972
	 *  - Grunion_Contact_Form_Plugin::map_parsed_field_contents_of_post_to_field_names -
1973
	 *      add mapping of the field for the CSV Export. Otherwise it will be missing
1974
	 *      from the exported data.
1975
	 *
1976
	 *  - admin.php / grunion_manage_post_columns - add the field to the render logic.
1977
	 *      Otherwise it will be missing from the admin Feedback view.
1978
	 *
1979
	 * @return array
1980
	 */
1981
	function get_field_ids() {
1982
		$field_ids = array(
1983
			'all'   => array(), // array of all field_ids
1984
			'extra' => array(), // array of all non-whitelisted field IDs
1985
1986
			// Whitelisted "standard" field IDs:
1987
			// 'email'    => field_id,
1988
			// 'name'     => field_id,
1989
			// 'url'      => field_id,
1990
			// 'subject'  => field_id,
1991
			// 'textarea' => field_id,
1992
		);
1993
1994
		foreach ( $this->fields as $id => $field ) {
1995
			$field_ids['all'][] = $id;
1996
1997
			$type = $field->get_attribute( 'type' );
1998
			if ( isset( $field_ids[ $type ] ) ) {
1999
				// This type of field is already present in our whitelist of "standard" fields for this form
2000
				// Put it in extra
2001
				$field_ids['extra'][] = $id;
2002
				continue;
2003
			}
2004
2005
			/**
2006
			 * See method description before modifying the switch cases.
2007
			 */
2008
			switch ( $type ) {
2009
				case 'email' :
2010
				case 'name' :
2011
				case 'url' :
2012
				case 'subject' :
2013
				case 'textarea' :
2014
					$field_ids[ $type ] = $id;
2015
					break;
2016
				default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
2017
					// Put everything else in extra
2018
					$field_ids['extra'][] = $id;
2019
			}
2020
		}
2021
2022
		return $field_ids;
2023
	}
2024
2025
	/**
2026
	 * Process the contact form's POST submission
2027
	 * Stores feedback.  Sends email.
2028
	 */
2029
	function process_submission() {
2030
		global $post;
2031
2032
		$plugin = Grunion_Contact_Form_Plugin::init();
2033
2034
		$id     = $this->get_attribute( 'id' );
2035
		$to     = $this->get_attribute( 'to' );
2036
		$widget = $this->get_attribute( 'widget' );
2037
2038
		$contact_form_subject = $this->get_attribute( 'subject' );
2039
2040
		$to = str_replace( ' ', '', $to );
2041
		$emails = explode( ',', $to );
2042
2043
		$valid_emails = array();
2044
2045
		foreach ( (array) $emails as $email ) {
2046
			if ( ! is_email( $email ) ) {
2047
				continue;
2048
			}
2049
2050
			if ( function_exists( 'is_email_address_unsafe' ) && is_email_address_unsafe( $email ) ) {
2051
				continue;
2052
			}
2053
2054
			$valid_emails[] = $email;
2055
		}
2056
2057
		// No one to send it to, which means none of the "to" attributes are valid emails.
2058
		// Use default email instead.
2059
		if ( ! $valid_emails ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $valid_emails 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...
2060
			$valid_emails = $this->defaults['to'];
2061
		}
2062
2063
		$to = $valid_emails;
2064
2065
		// Last ditch effort to set a recipient if somehow none have been set.
2066
		if ( empty( $to ) ) {
2067
			$to = get_option( 'admin_email' );
2068
		}
2069
2070
		// Make sure we're processing the form we think we're processing... probably a redundant check.
2071
		if ( $widget ) {
2072
			if ( 'widget-' . $widget != $_POST['contact-form-id'] ) {
2073
				return false;
2074
			}
2075
		} else {
2076
			if ( $post->ID != $_POST['contact-form-id'] ) {
2077
				return false;
2078
			}
2079
		}
2080
2081
		$field_ids = $this->get_field_ids();
2082
2083
		// Initialize all these "standard" fields to null
2084
		$comment_author_email = $comment_author_email_label = // v
2085
		$comment_author       = $comment_author_label       = // v
2086
		$comment_author_url   = $comment_author_url_label   = // v
2087
		$comment_content      = $comment_content_label      = null;
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 6 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
2088
2089
		// For each of the "standard" fields, grab their field label and value.
2090 View Code Duplication
		if ( isset( $field_ids['name'] ) ) {
2091
			$field = $this->fields[ $field_ids['name'] ];
2092
			$comment_author = Grunion_Contact_Form_Plugin::strip_tags(
2093
				stripslashes(
2094
					/** This filter is already documented in core/wp-includes/comment-functions.php */
2095
					apply_filters( 'pre_comment_author_name', addslashes( $field->value ) )
2096
				)
2097
			);
2098
			$comment_author_label = Grunion_Contact_Form_Plugin::strip_tags( $field->get_attribute( 'label' ) );
2099
		}
2100
2101 View Code Duplication
		if ( isset( $field_ids['email'] ) ) {
2102
			$field = $this->fields[ $field_ids['email'] ];
2103
			$comment_author_email = Grunion_Contact_Form_Plugin::strip_tags(
2104
				stripslashes(
2105
					/** This filter is already documented in core/wp-includes/comment-functions.php */
2106
					apply_filters( 'pre_comment_author_email', addslashes( $field->value ) )
2107
				)
2108
			);
2109
			$comment_author_email_label = Grunion_Contact_Form_Plugin::strip_tags( $field->get_attribute( 'label' ) );
2110
		}
2111
2112
		if ( isset( $field_ids['url'] ) ) {
2113
			$field = $this->fields[ $field_ids['url'] ];
2114
			$comment_author_url = Grunion_Contact_Form_Plugin::strip_tags(
2115
				stripslashes(
2116
					/** This filter is already documented in core/wp-includes/comment-functions.php */
2117
					apply_filters( 'pre_comment_author_url', addslashes( $field->value ) )
2118
				)
2119
			);
2120
			if ( 'http://' == $comment_author_url ) {
2121
				$comment_author_url = '';
2122
			}
2123
			$comment_author_url_label = Grunion_Contact_Form_Plugin::strip_tags( $field->get_attribute( 'label' ) );
2124
		}
2125
2126
		if ( isset( $field_ids['textarea'] ) ) {
2127
			$field = $this->fields[ $field_ids['textarea'] ];
2128
			$comment_content = trim( Grunion_Contact_Form_Plugin::strip_tags( $field->value ) );
2129
			$comment_content_label = Grunion_Contact_Form_Plugin::strip_tags( $field->get_attribute( 'label' ) );
2130
		}
2131
2132
		if ( isset( $field_ids['subject'] ) ) {
2133
			$field = $this->fields[ $field_ids['subject'] ];
2134
			if ( $field->value ) {
2135
				$contact_form_subject = Grunion_Contact_Form_Plugin::strip_tags( $field->value );
2136
			}
2137
		}
2138
2139
		$all_values = $extra_values = array();
2140
		$i = 1; // Prefix counter for stored metadata
2141
2142
		// For all fields, grab label and value
2143
		foreach ( $field_ids['all'] as $field_id ) {
2144
			$field = $this->fields[ $field_id ];
2145
			$label = $i . '_' . $field->get_attribute( 'label' );
2146
			$value = $field->value;
2147
2148
			$all_values[ $label ] = $value;
2149
			$i++; // Increment prefix counter for the next field
2150
		}
2151
2152
		// For the "non-standard" fields, grab label and value
2153
		// Extra fields have their prefix starting from count( $all_values ) + 1
2154
		foreach ( $field_ids['extra'] as $field_id ) {
2155
			$field = $this->fields[ $field_id ];
2156
			$label = $i . '_' . $field->get_attribute( 'label' );
2157
			$value = $field->value;
2158
2159
			if ( is_array( $value ) ) {
2160
				$value = implode( ', ', $value );
2161
			}
2162
2163
			$extra_values[ $label ] = $value;
2164
			$i++; // Increment prefix counter for the next extra field
2165
		}
2166
2167
		$contact_form_subject = trim( $contact_form_subject );
2168
2169
		$comment_author_IP = Grunion_Contact_Form_Plugin::get_ip_address();
2170
2171
		$vars = array( 'comment_author', 'comment_author_email', 'comment_author_url', 'contact_form_subject', 'comment_author_IP' );
2172
		foreach ( $vars as $var ) {
2173
			$$var = str_replace( array( "\n", "\r" ), '', $$var );
2174
		}
2175
2176
		// Ensure that Akismet gets all of the relevant information from the contact form,
2177
		// not just the textarea field and predetermined subject.
2178
		$akismet_vars = compact( $vars );
2179
		$akismet_vars['comment_content'] = $comment_content;
2180
2181
		foreach ( array_merge( $field_ids['all'], $field_ids['extra'] ) as $field_id ) {
2182
			$field = $this->fields[ $field_id ];
2183
2184
			// Skip any fields that are just a choice from a pre-defined list. They wouldn't have any value
2185
			// from a spam-filtering point of view.
2186
			if ( in_array( $field->get_attribute( 'type' ), array( 'select', 'checkbox', 'checkbox-multiple', 'radio' ) ) ) {
2187
				continue;
2188
			}
2189
2190
			// Normalize the label into a slug.
2191
			$field_slug = trim( // Strip all leading/trailing dashes.
2192
				preg_replace(   // Normalize everything to a-z0-9_-
2193
					'/[^a-z0-9_]+/',
2194
					'-',
2195
					strtolower( $field->get_attribute( 'label' ) ) // Lowercase
2196
				),
2197
				'-'
2198
			);
2199
2200
			$field_value = ( is_array( $field->value ) ) ? trim( implode( ', ', $field->value ) ) : trim( $field->value );
2201
2202
			// Skip any values that are already in the array we're sending.
2203
			if ( $field_value && in_array( $field_value, $akismet_vars ) ) {
2204
				continue;
2205
			}
2206
2207
			$akismet_vars[ 'contact_form_field_' . $field_slug ] = $field_value;
2208
		}
2209
2210
		$spam = '';
2211
		$akismet_values = $plugin->prepare_for_akismet( $akismet_vars );
2212
2213
		// Is it spam?
2214
		/** This filter is already documented in modules/contact-form/admin.php */
2215
		$is_spam = apply_filters( 'jetpack_contact_form_is_spam', false, $akismet_values );
2216
		if ( is_wp_error( $is_spam ) ) { // WP_Error to abort
2217
			return $is_spam; // abort
2218
		} elseif ( $is_spam === true ) {  // TRUE to flag a spam
2219
			$spam = '***SPAM*** ';
2220
		}
2221
2222
		if ( ! $comment_author ) {
2223
			$comment_author = $comment_author_email;
2224
		}
2225
2226
		/**
2227
		 * Filter the email where a submitted feedback is sent.
2228
		 *
2229
		 * @module contact-form
2230
		 *
2231
		 * @since 1.3.1
2232
		 *
2233
		 * @param string|array $to Array of valid email addresses, or single email address.
2234
		 */
2235
		$to = (array) apply_filters( 'contact_form_to', $to );
2236
		$reply_to_addr = $to[0]; // get just the address part before the name part is added
2237
2238
		foreach ( $to as $to_key => $to_value ) {
2239
			$to[ $to_key ] = Grunion_Contact_Form_Plugin::strip_tags( $to_value );
2240
			$to[ $to_key ] = self::add_name_to_address( $to_value );
2241
		}
2242
2243
		$blog_url = parse_url( site_url() );
2244
		$from_email_addr = 'wordpress@' . $blog_url['host'];
2245
2246
		if ( ! empty( $comment_author_email ) ) {
2247
			$reply_to_addr = $comment_author_email;
2248
		}
2249
2250
		$headers = 'From: "' . $comment_author . '" <' . $from_email_addr . ">\r\n" .
2251
					'Reply-To: "' . $comment_author . '" <' . $reply_to_addr . ">\r\n";
2252
2253
		// Build feedback reference
2254
		$feedback_time  = current_time( 'mysql' );
2255
		$feedback_title = "{$comment_author} - {$feedback_time}";
2256
		$feedback_id    = md5( $feedback_title );
2257
2258
		$all_values = array_merge( $all_values, array(
2259
			'entry_title'     => the_title_attribute( 'echo=0' ),
2260
			'entry_permalink' => esc_url( get_permalink( get_the_ID() ) ),
2261
			'feedback_id'     => $feedback_id,
2262
		) );
2263
2264
		/** This filter is already documented in modules/contact-form/admin.php */
2265
		$subject = apply_filters( 'contact_form_subject', $contact_form_subject, $all_values );
2266
		$url     = $widget ? home_url( '/' ) : get_permalink( $post->ID );
2267
2268
		$date_time_format = _x( '%1$s \a\t %2$s', '{$date_format} \a\t {$time_format}', 'jetpack' );
2269
		$date_time_format = sprintf( $date_time_format, get_option( 'date_format' ), get_option( 'time_format' ) );
2270
		$time = date_i18n( $date_time_format, current_time( 'timestamp' ) );
2271
2272
		// keep a copy of the feedback as a custom post type
2273
		$feedback_status = $is_spam === true ? 'spam' : 'publish';
2274
2275
		foreach ( (array) $akismet_values as $av_key => $av_value ) {
2276
			$akismet_values[ $av_key ] = Grunion_Contact_Form_Plugin::strip_tags( $av_value );
2277
		}
2278
2279
		foreach ( (array) $all_values as $all_key => $all_value ) {
2280
			$all_values[ $all_key ] = Grunion_Contact_Form_Plugin::strip_tags( $all_value );
2281
		}
2282
2283
		foreach ( (array) $extra_values as $ev_key => $ev_value ) {
2284
			$extra_values[ $ev_key ] = Grunion_Contact_Form_Plugin::strip_tags( $ev_value );
2285
		}
2286
2287
		/*
2288
		 We need to make sure that the post author is always zero for contact
2289
		 * form submissions.  This prevents export/import from trying to create
2290
		 * new users based on form submissions from people who were logged in
2291
		 * at the time.
2292
		 *
2293
		 * Unfortunately wp_insert_post() tries very hard to make sure the post
2294
		 * author gets the currently logged in user id.  That is how we ended up
2295
		 * with this work around. */
2296
		add_filter( 'wp_insert_post_data', array( $plugin, 'insert_feedback_filter' ), 10, 2 );
2297
2298
		$post_id = wp_insert_post( array(
2299
			'post_date'    => addslashes( $feedback_time ),
2300
			'post_type'    => 'feedback',
2301
			'post_status'  => addslashes( $feedback_status ),
2302
			'post_parent'  => (int) $post->ID,
2303
			'post_title'   => addslashes( wp_kses( $feedback_title, array() ) ),
2304
			'post_content' => addslashes( wp_kses( $comment_content . "\n<!--more-->\n" . "AUTHOR: {$comment_author}\nAUTHOR EMAIL: {$comment_author_email}\nAUTHOR URL: {$comment_author_url}\nSUBJECT: {$subject}\nIP: {$comment_author_IP}\n" . @print_r( $all_values, true ), array() ) ), // so that search will pick up this data
2305
			'post_name'    => $feedback_id,
2306
		) );
2307
2308
		// once insert has finished we don't need this filter any more
2309
		remove_filter( 'wp_insert_post_data', array( $plugin, 'insert_feedback_filter' ), 10 );
2310
2311
		update_post_meta( $post_id, '_feedback_extra_fields', $this->addslashes_deep( $extra_values ) );
2312
2313
		if ( 'publish' == $feedback_status ) {
2314
			// Increase count of unread feedback.
2315
			$unread = get_option( 'feedback_unread_count', 0 ) + 1;
2316
			update_option( 'feedback_unread_count', $unread );
2317
		}
2318
2319
		if ( defined( 'AKISMET_VERSION' ) ) {
2320
			update_post_meta( $post_id, '_feedback_akismet_values', $this->addslashes_deep( $akismet_values ) );
2321
		}
2322
2323
		$message = self::get_compiled_form( $post_id, $this );
2324
2325
		array_push(
2326
			$message,
2327
			"<br />",
2328
			'<hr />',
2329
			__( 'Time:', 'jetpack' ) . ' ' . $time . '<br />',
2330
			__( 'IP Address:', 'jetpack' ) . ' ' . $comment_author_IP . '<br />',
2331
			__( 'Contact Form URL:', 'jetpack' ) . ' ' . $url . '<br />'
2332
		);
2333
2334
		if ( is_user_logged_in() ) {
2335
			array_push(
2336
				$message,
2337
				sprintf(
2338
					'<p>' . __( 'Sent by a verified %s user.', 'jetpack' ) . '</p>',
2339
					isset( $GLOBALS['current_site']->site_name ) && $GLOBALS['current_site']->site_name ?
2340
						$GLOBALS['current_site']->site_name : '"' . get_option( 'blogname' ) . '"'
2341
				)
2342
			);
2343
		} else {
2344
			array_push( $message, '<p>' . __( 'Sent by an unverified visitor to your site.', 'jetpack' ) . '</p>' );
2345
		}
2346
2347
		$message = join( $message, '' );
2348
2349
		/**
2350
		 * Filters the message sent via email after a successful form submission.
2351
		 *
2352
		 * @module contact-form
2353
		 *
2354
		 * @since 1.3.1
2355
		 *
2356
		 * @param string $message Feedback email message.
2357
		 */
2358
		$message = apply_filters( 'contact_form_message', $message );
2359
2360
		// This is called after `contact_form_message`, in order to preserve back-compat
2361
		$message = self::wrap_message_in_html_tags( $message );
2362
2363
		update_post_meta( $post_id, '_feedback_email', $this->addslashes_deep( compact( 'to', 'message' ) ) );
2364
2365
		/**
2366
		 * Fires right before the contact form message is sent via email to
2367
		 * the recipient specified in the contact form.
2368
		 *
2369
		 * @module contact-form
2370
		 *
2371
		 * @since 1.3.1
2372
		 *
2373
		 * @param integer $post_id Post contact form lives on
2374
		 * @param array $all_values Contact form fields
2375
		 * @param array $extra_values Contact form fields not included in $all_values
2376
		 */
2377
		do_action( 'grunion_pre_message_sent', $post_id, $all_values, $extra_values );
2378
2379
		// schedule deletes of old spam feedbacks
2380
		if ( ! wp_next_scheduled( 'grunion_scheduled_delete' ) ) {
2381
			wp_schedule_event( time() + 250, 'daily', 'grunion_scheduled_delete' );
2382
		}
2383
2384
		if (
2385
			$is_spam !== true &&
2386
			/**
2387
			 * Filter to choose whether an email should be sent after each successful contact form submission.
2388
			 *
2389
			 * @module contact-form
2390
			 *
2391
			 * @since 2.6.0
2392
			 *
2393
			 * @param bool true Should an email be sent after a form submission. Default to true.
2394
			 * @param int $post_id Post ID.
2395
			 */
2396
			true === apply_filters( 'grunion_should_send_email', true, $post_id )
2397
		) {
2398
			self::wp_mail( $to, "{$spam}{$subject}", $message, $headers );
2399
		} elseif (
2400
			true === $is_spam &&
2401
			/**
2402
			 * Choose whether an email should be sent for each spam contact form submission.
2403
			 *
2404
			 * @module contact-form
2405
			 *
2406
			 * @since 1.3.1
2407
			 *
2408
			 * @param bool false Should an email be sent after a spam form submission. Default to false.
2409
			 */
2410
			apply_filters( 'grunion_still_email_spam', false ) == true
2411
		) { // don't send spam by default.  Filterable.
2412
			self::wp_mail( $to, "{$spam}{$subject}", $message, $headers );
2413
		}
2414
2415
		if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
2416
			return self::success_message( $post_id, $this );
2417
		}
2418
2419
		$redirect = wp_get_referer();
2420
		if ( ! $redirect ) { // wp_get_referer() returns false if the referer is the same as the current page
2421
			$redirect = $_SERVER['REQUEST_URI'];
2422
		}
2423
2424
		$redirect = add_query_arg( urlencode_deep( array(
2425
			'contact-form-id'   => $id,
2426
			'contact-form-sent' => $post_id,
2427
			'contact-form-hash' => $this->hash,
2428
			'_wpnonce'          => wp_create_nonce( "contact-form-sent-{$post_id}" ), // wp_nonce_url HTMLencodes :(
2429
		) ), $redirect );
2430
2431
		/**
2432
		 * Filter the URL where the reader is redirected after submitting a form.
2433
		 *
2434
		 * @module contact-form
2435
		 *
2436
		 * @since 1.9.0
2437
		 *
2438
		 * @param string $redirect Post submission URL.
2439
		 * @param int $id Contact Form ID.
2440
		 * @param int $post_id Post ID.
2441
		 */
2442
		$redirect = apply_filters( 'grunion_contact_form_redirect_url', $redirect, $id, $post_id );
2443
2444
		wp_safe_redirect( $redirect );
2445
		exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method process_submission() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2446
	}
2447
2448
	/**
2449
	 * Wrapper for wp_mail() that enables HTML messages with text alternatives
2450
	 *
2451
	 * @param string|array $to          Array or comma-separated list of email addresses to send message.
2452
	 * @param string       $subject     Email subject.
2453
	 * @param string       $message     Message contents.
2454
	 * @param string|array $headers     Optional. Additional headers.
2455
	 * @param string|array $attachments Optional. Files to attach.
2456
	 *
2457
	 * @return bool Whether the email contents were sent successfully.
2458
	 */
2459
	public static function wp_mail( $to, $subject, $message, $headers = '', $attachments = array() ) {
2460
		add_filter( 'wp_mail_content_type', __CLASS__ . '::get_mail_content_type' );
2461
		add_action( 'phpmailer_init',       __CLASS__ . '::add_plain_text_alternative' );
2462
2463
		$result = wp_mail( $to, $subject, $message, $headers, $attachments );
2464
2465
		remove_filter( 'wp_mail_content_type', __CLASS__ . '::get_mail_content_type' );
2466
		remove_action( 'phpmailer_init',       __CLASS__ . '::add_plain_text_alternative' );
2467
2468
		return $result;
2469
	}
2470
2471
	/**
2472
	 * Add a display name part to an email address
2473
	 *
2474
	 * SpamAssassin doesn't like addresses in HTML messages that are missing display names (e.g., `[email protected]`
2475
	 * instead of `"Foo Bar" <[email protected]>`.
2476
	 *
2477
	 * @param string $address
2478
	 *
2479
	 * @return string
2480
	 */
2481
	function add_name_to_address( $address ) {
2482
		// If it's just the address, without a display name
2483
		if ( is_email( $address ) ) {
2484
			$address_parts = explode( '@', $address );
2485
			$address = sprintf( '"%s" <%s>', $address_parts[0], $address );
2486
		}
2487
2488
		return $address;
2489
	}
2490
2491
	/**
2492
	 * Get the content type that should be assigned to outbound emails
2493
	 *
2494
	 * @return string
2495
	 */
2496
	static function get_mail_content_type() {
2497
		return 'text/html';
2498
	}
2499
2500
	/**
2501
	 * Wrap a message body with the appropriate in HTML tags
2502
	 *
2503
	 * This helps to ensure correct parsing by clients, and also helps avoid triggering spam filtering rules
2504
	 *
2505
	 * @param string $body
2506
	 *
2507
	 * @return string
2508
	 */
2509
	static function wrap_message_in_html_tags( $body ) {
2510
		// Don't do anything if the message was already wrapped in HTML tags
2511
		// That could have be done by a plugin via filters
2512
		if ( false !== strpos( $body, '<html' ) ) {
2513
			return $body;
2514
		}
2515
2516
		$html_message = sprintf(
2517
			// The tabs are just here so that the raw code is correctly formatted for developers
2518
			// They're removed so that they don't affect the final message sent to users
2519
			str_replace( "\t", '',
2520
				"<!doctype html>
2521
				<html xmlns=\"http://www.w3.org/1999/xhtml\">
2522
				<body>
2523
2524
				%s
2525
2526
				</body>
2527
				</html>"
2528
			),
2529
			$body
2530
		);
2531
2532
		return $html_message;
2533
	}
2534
2535
	/**
2536
	 * Add a plain-text alternative part to an outbound email
2537
	 *
2538
	 * This makes the message more accessible to mail clients that aren't HTML-aware, and decreases the likelihood
2539
	 * that the message will be flagged as spam.
2540
	 *
2541
	 * @param PHPMailer $phpmailer
2542
	 */
2543
	static function add_plain_text_alternative( $phpmailer ) {
2544
		// Add an extra break so that the extra space above the <p> is preserved after the <p> is stripped out
2545
		$alt_body = str_replace( '<p>', '<p><br />', $phpmailer->Body );
2546
2547
		// Convert <br> to \n breaks, to preserve the space between lines that we want to keep
2548
		$alt_body = str_replace( array( '<br>', '<br />' ), "\n", $alt_body );
2549
2550
		// Convert <hr> to an plain-text equivalent, to preserve the integrity of the message
2551
		$alt_body = str_replace( array( "<hr>", "<hr />" ), "----\n", $alt_body );
2552
2553
		// Trim the plain text message to remove the \n breaks that were after <doctype>, <html>, and <body>
2554
		$phpmailer->AltBody = trim( strip_tags( $alt_body ) );
2555
	}
2556
2557
	function addslashes_deep( $value ) {
2558
		if ( is_array( $value ) ) {
2559
			return array_map( array( $this, 'addslashes_deep' ), $value );
2560
		} elseif ( is_object( $value ) ) {
2561
			$vars = get_object_vars( $value );
2562
			foreach ( $vars as $key => $data ) {
2563
				$value->{$key} = $this->addslashes_deep( $data );
2564
			}
2565
			return $value;
2566
		}
2567
2568
		return addslashes( $value );
2569
	}
2570
}
2571
2572
/**
2573
 * Class for the contact-field shortcode.
2574
 * Parses shortcode to output the contact form field as HTML.
2575
 * Validates input.
2576
 */
2577
class Grunion_Contact_Form_Field extends Crunion_Contact_Form_Shortcode {
0 ignored issues
show
Coding Style Compatibility introduced by
PSR1 recommends that each class should be in its own file to aid autoloaders.

Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule.

Loading history...
2578
	public $shortcode_name = 'contact-field';
2579
2580
	/**
2581
	 * @var Grunion_Contact_Form parent form
2582
	 */
2583
	public $form;
2584
2585
	/**
2586
	 * @var string default or POSTed value
2587
	 */
2588
	public $value;
2589
2590
	/**
2591
	 * @var bool Is the input invalid?
2592
	 */
2593
	public $error = false;
2594
2595
	/**
2596
	 * @param array                $attributes An associative array of shortcode attributes.  @see shortcode_atts()
2597
	 * @param null|string          $content Null for selfclosing shortcodes.  The inner content otherwise.
2598
	 * @param Grunion_Contact_Form $form The parent form
0 ignored issues
show
Documentation introduced by
Should the type for parameter $form not be Grunion_Contact_Form|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
2599
	 */
2600
	function __construct( $attributes, $content = null, $form = null ) {
2601
		$attributes = shortcode_atts( array(
2602
					'label'       => null,
2603
					'type'        => 'text',
2604
					'required'    => false,
2605
					'options'     => array(),
2606
					'id'          => null,
2607
					'default'     => null,
2608
					'values'      => null,
2609
					'placeholder' => null,
2610
					'class'       => null,
2611
		), $attributes, 'contact-field' );
2612
2613
		// special default for subject field
2614
		if ( 'subject' == $attributes['type'] && is_null( $attributes['default'] ) && ! is_null( $form ) ) {
2615
			$attributes['default'] = $form->get_attribute( 'subject' );
2616
		}
2617
2618
		// allow required=1 or required=true
2619
		if ( '1' == $attributes['required'] || 'true' == strtolower( $attributes['required'] ) ) {
2620
			$attributes['required'] = true;
2621
		} else { $attributes['required'] = false;
2622
		}
2623
2624
		// parse out comma-separated options list (for selects, radios, and checkbox-multiples)
2625
		if ( ! empty( $attributes['options'] ) && is_string( $attributes['options'] ) ) {
2626
			$attributes['options'] = array_map( 'trim', explode( ',', $attributes['options'] ) );
2627
2628 View Code Duplication
			if ( ! empty( $attributes['values'] ) && is_string( $attributes['values'] ) ) {
2629
				$attributes['values'] = array_map( 'trim', explode( ',', $attributes['values'] ) );
2630
			}
2631
		}
2632
2633
		if ( $form ) {
2634
			// make a unique field ID based on the label, with an incrementing number if needed to avoid clashes
2635
			$form_id = $form->get_attribute( 'id' );
2636
			$id = isset( $attributes['id'] ) ? $attributes['id'] : false;
2637
2638
			$unescaped_label = $this->unesc_attr( $attributes['label'] );
2639
			$unescaped_label = str_replace( '%', '-', $unescaped_label ); // jQuery doesn't like % in IDs?
2640
			$unescaped_label = preg_replace( '/[^a-zA-Z0-9.-_:]/', '', $unescaped_label );
2641
2642
			if ( empty( $id ) ) {
2643
				$id = sanitize_title_with_dashes( 'g' . $form_id . '-' . $unescaped_label );
2644
				$i = 0;
2645
				$max_tries = 99;
2646
				while ( isset( $form->fields[ $id ] ) ) {
2647
					$i++;
2648
					$id = sanitize_title_with_dashes( 'g' . $form_id . '-' . $unescaped_label . '-' . $i );
2649
2650
					if ( $i > $max_tries ) {
2651
						break;
2652
					}
2653
				}
2654
			}
2655
2656
			$attributes['id'] = $id;
2657
		}
2658
2659
		parent::__construct( $attributes, $content );
2660
2661
		// Store parent form
2662
		$this->form = $form;
2663
	}
2664
2665
	/**
2666
	 * This field's input is invalid.  Flag as invalid and add an error to the parent form
2667
	 *
2668
	 * @param string $message The error message to display on the form.
2669
	 */
2670
	function add_error( $message ) {
2671
		$this->is_error = true;
0 ignored issues
show
Bug introduced by
The property is_error does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
2672
2673
		if ( ! is_wp_error( $this->form->errors ) ) {
2674
			$this->form->errors = new WP_Error;
2675
		}
2676
2677
		$this->form->errors->add( $this->get_attribute( 'id' ), $message );
2678
	}
2679
2680
	/**
2681
	 * Is the field input invalid?
2682
	 *
2683
	 * @see $error
2684
	 *
2685
	 * @return bool
2686
	 */
2687
	function is_error() {
2688
		return $this->error;
2689
	}
2690
2691
	/**
2692
	 * Validates the form input
2693
	 */
2694
	function validate() {
2695
		// If it's not required, there's nothing to validate
2696
		if ( ! $this->get_attribute( 'required' ) ) {
2697
			return;
2698
		}
2699
2700
		$field_id    = $this->get_attribute( 'id' );
2701
		$field_type  = $this->get_attribute( 'type' );
2702
		$field_label = $this->get_attribute( 'label' );
2703
2704
		if ( isset( $_POST[ $field_id ] ) ) {
2705
			if ( is_array( $_POST[ $field_id ] ) ) {
2706
				$field_value = array_map( 'stripslashes', $_POST[ $field_id ] );
2707
			} else {
2708
				$field_value = stripslashes( $_POST[ $field_id ] );
2709
			}
2710
		} else {
2711
			$field_value = '';
2712
		}
2713
2714
		switch ( $field_type ) {
2715
			case 'email' :
2716
				// Make sure the email address is valid
2717
				if ( ! is_email( $field_value ) ) {
2718
					/* translators: %s is the name of a form field */
2719
					$this->add_error( sprintf( __( '%s requires a valid email address', 'jetpack' ), $field_label ) );
2720
				}
2721
			break;
2722
			case 'checkbox-multiple' :
2723
				// Check that there is at least one option selected
2724
				if ( empty( $field_value ) ) {
2725
					/* translators: %s is the name of a form field */
2726
					$this->add_error( sprintf( __( '%s requires at least one selection', 'jetpack' ), $field_label ) );
2727
				}
2728
			break;
2729
			default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
2730
				// Just check for presence of any text
2731
				if ( ! strlen( trim( $field_value ) ) ) {
2732
					/* translators: %s is the name of a form field */
2733
					$this->add_error( sprintf( __( '%s is required', 'jetpack' ), $field_label ) );
2734
				}
2735
		}
2736
	}
2737
2738
2739
	/**
2740
	 * Check the default value for options field
2741
	 *
2742
	 * @param string value
2743
	 * @param int index
2744
	 * @param string default value
2745
	 *
2746
	 * @return string
2747
	 */
2748
	public function get_option_value( $value, $index, $options ) {
2749
		if ( empty( $value[ $index ] ) ) {
2750
			return $options;
2751
		}
2752
		return $value[ $index ];
2753
	}
2754
2755
	/**
2756
	 * Outputs the HTML for this form field
2757
	 *
2758
	 * @return string HTML
2759
	 */
2760
	function render() {
2761
		global $current_user, $user_identity;
2762
2763
		$r = '';
2764
2765
		$field_id          = $this->get_attribute( 'id' );
2766
		$field_type        = $this->get_attribute( 'type' );
2767
		$field_label       = $this->get_attribute( 'label' );
2768
		$field_required    = $this->get_attribute( 'required' );
2769
		$placeholder       = $this->get_attribute( 'placeholder' );
2770
		$class             = 'date' === $field_type ? 'jp-contact-form-date' : $this->get_attribute( 'class' );
2771
		$field_placeholder = ( ! empty( $placeholder ) ) ? "placeholder='" . esc_attr( $placeholder ) . "'" : '';
2772
		$field_class       = "class='" . trim( esc_attr( $field_type ) . ' ' . esc_attr( $class ) ) . "' ";
2773
2774
		if ( isset( $_POST[ $field_id ] ) ) {
2775
			if ( is_array( $_POST[ $field_id ] ) ) {
2776
				$this->value = array_map( 'stripslashes', $_POST[ $field_id ] );
0 ignored issues
show
Documentation Bug introduced by
It seems like array_map('stripslashes', $_POST[$field_id]) of type array is incompatible with the declared type string of property $value.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
2777
			} else {
2778
				$this->value = stripslashes( (string) $_POST[ $field_id ] );
2779
			}
2780
		} elseif ( isset( $_GET[ $field_id ] ) ) {
2781
			$this->value = stripslashes( (string) $_GET[ $field_id ] );
2782
		} elseif (
2783
			is_user_logged_in() &&
2784
			( ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ||
2785
			/**
2786
			 * Allow third-party tools to prefill the contact form with the user's details when they're logged in.
2787
			 *
2788
			 * @module contact-form
2789
			 *
2790
			 * @since 3.2.0
2791
			 *
2792
			 * @param bool false Should the Contact Form be prefilled with your details when you're logged in. Default to false.
2793
			 */
2794
			true === apply_filters( 'jetpack_auto_fill_logged_in_user', false )
2795
			)
2796
		) {
2797
			// Special defaults for logged-in users
2798
			switch ( $this->get_attribute( 'type' ) ) {
2799
				case 'email' :
2800
					$this->value = $current_user->data->user_email;
2801
				break;
2802
				case 'name' :
2803
					$this->value = $user_identity;
2804
				break;
2805
				case 'url' :
2806
					$this->value = $current_user->data->user_url;
2807
				break;
2808
				default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
2809
					$this->value = $this->get_attribute( 'default' );
2810
			}
2811
		} else {
2812
			$this->value = $this->get_attribute( 'default' );
2813
		}
2814
2815
		$field_value = Grunion_Contact_Form_Plugin::strip_tags( $this->value );
2816
		$field_label = Grunion_Contact_Form_Plugin::strip_tags( $field_label );
2817
2818
		/**
2819
		 * Filter the Contact Form required field text
2820
		 *
2821
		 * @module contact-form
2822
		 *
2823
		 * @since 3.8.0
2824
		 *
2825
		 * @param string $var Required field text. Default is "(required)".
2826
		 */
2827
		$required_field_text = esc_html( apply_filters( 'jetpack_required_field_text', __( '(required)', 'jetpack' ) ) );
2828
2829
		switch ( $field_type ) {
2830 View Code Duplication
			case 'email' :
2831
				$r .= "\n<div>\n";
2832
				$r .= "\t\t<label for='" . esc_attr( $field_id ) . "' class='grunion-field-label email" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . $required_field_text . '</span>' : '' ) . "</label>\n";
2833
				$r .= "\t\t<input type='email' name='" . esc_attr( $field_id ) . "' id='" . esc_attr( $field_id ) . "' value='" . esc_attr( $field_value ) . "' " . $field_class . $field_placeholder . ' ' . ( $field_required ? "required aria-required='true'" : '' ) . "/>\n";
2834
				$r .= "\t</div>\n";
2835
			break;
2836
			case 'telephone' :
2837
				$r .= "\n<div>\n";
2838
				$r .= "\t\t<label for='" . esc_attr( $field_id ) . "' class='grunion-field-label telephone" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . $required_field_text . '</span>' : '' ) . "</label>\n";
2839
				$r .= "\t\t<input type='tel' name='" . esc_attr( $field_id ) . "' id='" . esc_attr( $field_id ) . "' value='" . esc_attr( $field_value ) . "' " . $field_class . $field_placeholder . "/>\n";
2840
			break;
2841
			case 'url' :
2842
				$r .= "\n<div>\n";
2843
				$r .= "\t\t<label for='" . esc_attr( $field_id ) . "' class='grunion-field-label url" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . $required_field_text . '</span>' : '' ) . "</label>\n";
2844
				$r .= "\t\t<input type='url' name='" . esc_attr( $field_id ) . "' id='" . esc_attr( $field_id ) . "' value='" . esc_attr( $field_value ) . "' " . $field_class . $field_placeholder . ' ' . ( $field_required ? "required aria-required='true'" : '' ) . "/>\n";
2845
				$r .= "\t</div>\n";
2846
			break;
2847 View Code Duplication
			case 'textarea' :
2848
				$r .= "\n<div>\n";
2849
				$r .= "\t\t<label for='contact-form-comment-" . esc_attr( $field_id ) . "' class='grunion-field-label textarea" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . $required_field_text . '</span>' : '' ) . "</label>\n";
2850
				$r .= "\t\t<textarea name='" . esc_attr( $field_id ) . "' id='contact-form-comment-" . esc_attr( $field_id ) . "' rows='20' " . $field_class . $field_placeholder . ' ' . ( $field_required ? "required aria-required='true'" : '' ) . '>' . esc_textarea( $field_value ) . "</textarea>\n";
2851
				$r .= "\t</div>\n";
2852
			break;
2853
			case 'radio' :
2854
				$r .= "\t<div><label class='grunion-field-label" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . $required_field_text . '</span>' : '' ) . "</label>\n";
2855
				foreach ( $this->get_attribute( 'options' ) as $optionIndex => $option ) {
2856
					$option = Grunion_Contact_Form_Plugin::strip_tags( $option );
2857
					$r .= "\t\t<label class='grunion-radio-label radio" . ( $this->is_error() ? ' form-error' : '' ) . "'>";
2858
					$r .= "<input type='radio' name='" . esc_attr( $field_id ) . "' value='" . esc_attr( $this->get_option_value( $this->get_attribute( 'values' ), $optionIndex, $option ) ) . "' " . $field_class . checked( $option, $field_value, false ) . ' ' . ( $field_required ? "required aria-required='true'" : '' ) . '/> ';
2859
					$r .= esc_html( $option ) . "</label>\n";
2860
					$r .= "\t\t<div class='clear-form'></div>\n";
2861
				}
2862
				$r .= "\t\t</div>\n";
2863
			break;
2864
			case 'checkbox' :
2865
				$r .= "\t<div>\n";
2866
				$r .= "\t\t<label class='grunion-field-label checkbox" . ( $this->is_error() ? ' form-error' : '' ) . "'>\n";
2867
				$r .= "\t\t<input type='checkbox' name='" . esc_attr( $field_id ) . "' value='" . esc_attr__( 'Yes', 'jetpack' ) . "' " . $field_class . checked( (bool) $field_value, true, false ) . ' ' . ( $field_required ? "required aria-required='true'" : '' ) . "/> \n";
2868
				$r .= "\t\t" . esc_html( $field_label ) . ( $field_required ? '<span>' . $required_field_text . '</span>' : '' ) . "</label>\n";
2869
				$r .= "\t\t<div class='clear-form'></div>\n";
2870
				$r .= "\t</div>\n";
2871
			break;
2872
			case 'checkbox-multiple' :
2873
				$r .= "\t<div><label class='grunion-field-label" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . $required_field_text . '</span>' : '' ) . "</label>\n";
2874
				foreach ( $this->get_attribute( 'options' ) as $optionIndex => $option ) {
2875
					$option = Grunion_Contact_Form_Plugin::strip_tags( $option );
2876
					$r .= "\t\t<label class='grunion-checkbox-multiple-label checkbox-multiple" . ( $this->is_error() ? ' form-error' : '' ) . "'>";
2877
					$r .= "<input type='checkbox' name='" . esc_attr( $field_id ) . "[]' value='" . esc_attr( $this->get_option_value( $this->get_attribute( 'values' ), $optionIndex, $option ) ) . "' " . $field_class . checked( in_array( $option, (array) $field_value ), true, false ) . ' /> ';
2878
					$r .= esc_html( $option ) . "</label>\n";
2879
					$r .= "\t\t<div class='clear-form'></div>\n";
2880
				}
2881
				$r .= "\t\t</div>\n";
2882
			break;
2883
			case 'select' :
2884
				$r .= "\n<div>\n";
2885
				$r .= "\t\t<label for='" . esc_attr( $field_id ) . "' class='grunion-field-label select" . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . $required_field_text . '</span>' : '' ) . "</label>\n";
2886
				$r .= "\t<select name='" . esc_attr( $field_id ) . "' id='" . esc_attr( $field_id ) . "' " . $field_class . ( $field_required ? "required aria-required='true'" : '' ) . ">\n";
2887
				foreach ( $this->get_attribute( 'options' ) as $optionIndex => $option ) {
2888
					$option = Grunion_Contact_Form_Plugin::strip_tags( $option );
2889
					$r .= "\t\t<option" . selected( $option, $field_value, false ) . " value='" . esc_attr( $this->get_option_value( $this->get_attribute( 'values' ), $optionIndex, $option ) ) . "'>" . esc_html( $option ) . "</option>\n";
2890
				}
2891
				$r .= "\t</select>\n";
2892
				$r .= "\t</div>\n";
2893
			break;
2894
			case 'date' :
2895
				$r .= "\n<div>\n";
2896
				$r .= "\t\t<label for='" . esc_attr( $field_id ) . "' class='grunion-field-label " . esc_attr( $field_type ) . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . $required_field_text . '</span>' : '' ) . "</label>\n";
2897
				$r .= "\t\t<input type='text' name='" . esc_attr( $field_id ) . "' id='" . esc_attr( $field_id ) . "' value='" . esc_attr( $field_value ) . "' " . $field_class . ( $field_required ? "required aria-required='true'" : '' ) . "/>\n";
2898
				$r .= "\t</div>\n";
2899
2900
				wp_enqueue_script(
2901
					'grunion-frontend',
2902
					Jetpack::get_file_url_for_environment(
2903
						'_inc/build/contact-form/js/grunion-frontend.min.js',
2904
						'modules/contact-form/js/grunion-frontend.js'
2905
					),
2906
					array( 'jquery', 'jquery-ui-datepicker' )
2907
				);
2908
				wp_enqueue_style( 'jp-jquery-ui-datepicker', plugins_url( 'css/jquery-ui-datepicker.css', __FILE__ ), array( 'dashicons' ), '1.0' );
2909
2910
				// Using Core's built-in datepicker localization routine
2911
				wp_localize_jquery_ui_datepicker();
2912
			break;
2913 View Code Duplication
			default : // text field
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
2914
				// note that any unknown types will produce a text input, so we can use arbitrary type names to handle
2915
				// input fields like name, email, url that require special validation or handling at POST
2916
				$r .= "\n<div>\n";
2917
				$r .= "\t\t<label for='" . esc_attr( $field_id ) . "' class='grunion-field-label " . esc_attr( $field_type ) . ( $this->is_error() ? ' form-error' : '' ) . "'>" . esc_html( $field_label ) . ( $field_required ? '<span>' . $required_field_text . '</span>' : '' ) . "</label>\n";
2918
				$r .= "\t\t<input type='text' name='" . esc_attr( $field_id ) . "' id='" . esc_attr( $field_id ) . "' value='" . esc_attr( $field_value ) . "' " . $field_class . $field_placeholder . ' ' . ( $field_required ? "required aria-required='true'" : '' ) . "/>\n";
2919
				$r .= "\t</div>\n";
2920
		}
2921
2922
		/**
2923
		 * Filter the HTML of the Contact Form.
2924
		 *
2925
		 * @module contact-form
2926
		 *
2927
		 * @since 2.6.0
2928
		 *
2929
		 * @param string $r Contact Form HTML output.
2930
		 * @param string $field_label Field label.
2931
		 * @param int|null $id Post ID.
2932
		 */
2933
		return apply_filters( 'grunion_contact_form_field_html', $r, $field_label, ( in_the_loop() ? get_the_ID() : null ) );
2934
	}
2935
}
2936
2937
add_action( 'init', array( 'Grunion_Contact_Form_Plugin', 'init' ) );
2938
2939
add_action( 'grunion_scheduled_delete', 'grunion_delete_old_spam' );
2940
2941
/**
2942
 * Deletes old spam feedbacks to keep the posts table size under control
2943
 */
2944
function grunion_delete_old_spam() {
2945
	global $wpdb;
2946
2947
	$grunion_delete_limit = 100;
2948
2949
	$now_gmt = current_time( 'mysql', 1 );
2950
	$sql = $wpdb->prepare( "
2951
		SELECT `ID`
2952
		FROM $wpdb->posts
2953
		WHERE DATE_SUB( %s, INTERVAL 15 DAY ) > `post_date_gmt`
2954
			AND `post_type` = 'feedback'
2955
			AND `post_status` = 'spam'
2956
		LIMIT %d
2957
	", $now_gmt, $grunion_delete_limit );
2958
	$post_ids = $wpdb->get_col( $sql );
2959
2960
	foreach ( (array) $post_ids as $post_id ) {
2961
		// force a full delete, skip the trash
2962
		wp_delete_post( $post_id, true );
2963
	}
2964
2965
	// Arbitrary check points for running OPTIMIZE
2966
	// nothing special about 5000 or 11
2967
	// just trying to periodically recover deleted rows
2968
	$random_num = mt_rand( 1, 5000 );
2969
	if (
2970
		/**
2971
		 * Filter how often the module run OPTIMIZE TABLE on the core WP tables.
2972
		 *
2973
		 * @module contact-form
2974
		 *
2975
		 * @since 1.3.1
2976
		 *
2977
		 * @param int $random_num Random number.
2978
		 */
2979
		apply_filters( 'grunion_optimize_table', ( $random_num == 11 ) )
2980
	) {
2981
		$wpdb->query( "OPTIMIZE TABLE $wpdb->posts" );
2982
	}
2983
2984
	// if we hit the max then schedule another run
2985
	if ( count( $post_ids ) >= $grunion_delete_limit ) {
2986
		wp_schedule_single_event( time() + 700, 'grunion_scheduled_delete' );
2987
	}
2988
}
2989