PluginProbe ʕ •ᴥ•ʔ
Conditional Fields for Contact Form 7 / 2.5.7
Conditional Fields for Contact Form 7 v2.5.7
2.7.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 0.2.4 0.2.5 0.2.6 0.2.7 0.2.8 0.2.9 1.0 1.1 1.2 1.2.1 1.2.2 1.2.3 1.3 1.3.1 1.3.2 1.3.3 1.3.4 1.4 1.4.1 1.4.2 1.4.3 1.5 1.5.1 1.5.2 1.5.3 1.5.4 1.5.5 1.6.1 1.6.2 1.6.3 1.6.5 1.7 1.7.1 1.7.2 1.7.3 1.7.4 1.7.5 1.7.6 1.7.8 1.7.9 1.8 1.8.1 1.8.2 1.8.3 1.8.5 1.8.6 1.8.7 1.9 1.9.1 1.9.10 1.9.11 1.9.12 1.9.13 1.9.14 1.9.15 1.9.16 1.9.2 1.9.3 1.9.4 1.9.5 1.9.6 1.9.7 1.9.8 1.9.9 2.0 2.0.1 2.0.2 2.0.3 2.0.4 2.0.5 2.0.6 2.0.7 2.0.8 2.0.9 2.1 2.1.1 2.1.2 2.1.3 2.1.4 2.1.5 2.1.6 2.2 2.2.1 2.2.10 2.2.11 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7 2.2.8 2.2.9 2.3 2.3.1 2.3.10 2.3.11 2.3.12 2.3.2 2.3.3 2.3.4 2.3.5 2.3.6 2.3.7 2.3.8 2.3.9 2.4 2.4.1 2.4.10 2.4.11 2.4.12 2.4.13 2.4.14 2.4.15 2.4.2 2.4.3 2.4.4 2.4.5 2.4.6 2.4.7 2.4.8 2.4.9 2.5 2.5.1 2.5.10 2.5.11 2.5.12 2.5.13 2.5.14 2.5.2 2.5.3 2.5.4 2.5.5 2.5.6 2.5.7 2.5.8 2.5.9 2.6 2.6.1 2.6.2 2.6.3 2.6.4 2.6.5 2.6.6 2.6.7 2.6.8 2.7 2.7.1 trunk 0.1 0.1.1 0.1.2 0.1.3 0.1.4 0.1.5 0.1.6 0.1.7 0.2 0.2.1 0.2.2 0.2.3
cf7-conditional-fields / cf7cf.php
cf7-conditional-fields Last commit date
js 1 year ago jsdoc-out 1 year ago Wpcf7cfMailParser.php 4 years ago admin-style.css 2 years ago admin-style.css.map 2 years ago admin-style.scss 4 years ago admin.php 2 years ago cf7cf.php 1 year ago conditional-fields.php 1 year ago init.php 1 year ago readme.txt 1 year ago style.css 3 years ago tg_pane_group.php 1 year ago wpcf7cf-options.php 1 year ago
cf7cf.php
494 lines
1 <?php
2
3 class CF7CF {
4 private $hidden_fields = array();
5 private $visible_groups = array();
6 private $hidden_groups = array();
7 private $repeaters = array();
8 private $steps = array();
9
10 function __construct() {
11
12 // compatibility with CF7 multi-step forms by Webhead LLC.
13 add_filter( 'wpcf7_posted_data', array($this,'cf7msm_merge_post_with_cookie'), 8, 1 );
14
15 // compatibility with CF7 Multi Step by NinjaTeam https://wordpress.org/plugins/cf7-multi-step/
16 add_action('wp_ajax_cf7mls_validation', array($this,'cf7mls_validation_callback'),9);
17 add_action('wp_ajax_nopriv_cf7mls_validation', array($this,'cf7mls_validation_callback'),9);
18
19 add_filter( 'wpcf7_validate', array($this, 'skip_validation_for_hidden_fields'), 2, 2 );
20
21 add_filter( 'wpcf7_validate_file*', array($this, 'skip_validation_for_hidden_file_field'), 30, 3);
22 add_filter( 'wpcf7_validate_multifile*', array($this, 'skip_validation_for_hidden_file_field'), 30, 3);
23
24 // If acceptance_as_validation is on, then Acceptance fields inside hidden groups should not trigger an error
25 add_filter( 'wpcf7_acceptance', function($accepted, $submission) {
26 $acceptance_as_validation = $submission->get_contact_form()->additional_setting('acceptance_as_validation');
27 return $accepted || (is_array($acceptance_as_validation) && in_array('on', $acceptance_as_validation));
28 }, 20, 2 );
29
30 // validation messages
31 add_action('wpcf7_config_validator_validate', array($this,'wpcf7cf_config_validator_validate'));
32
33 add_action("wpcf7_before_send_mail", [$this, 'hide_hidden_mail_fields'], 10, 3);
34
35 register_activation_hook(__FILE__, array($this, 'activate'));
36
37 if (is_admin()) {
38 require_once dirname(__FILE__) . '/admin.php';
39 }
40 }
41
42
43
44 /**
45 * Suppress invalid mailbox syntax errors on fields that contain existing conditional
46 */
47 function wpcf7cf_config_validator_validate(WPCF7_ConfigValidator $wpcf7_config_validator) {
48
49 // TODO: For now we kill every syntax error once a [groupname] tag is detected.
50 // Ideally, this function should check each string inside the group for invalid syntax.
51 // TODO 2: ajax validation not working yet, because $cf->scan_form_tags() does not seem to contain group tags if it's an ajax request. Need to investigate.
52
53 $cf = $wpcf7_config_validator->contact_form();
54 $all_group_tags = $cf->scan_form_tags();
55
56 foreach ($wpcf7_config_validator->collect_error_messages() as $err_type => $err) {
57
58 // print_r($err_type);
59
60 $parts = explode('.',$err_type);
61
62 $property = $parts[0];
63
64 if ($property == 'form') continue; // the 'form' field can be safely validated by CF7. No need to suppress it.
65
66 $sub_prop = $parts[1];
67 $prop_val = $cf->prop($property)[$sub_prop];
68
69
70 // TODO 2: Dirty hack. Because of TODO 2 we are just going to kill the error message if we detect the string '[/'
71 // Start removing here.
72 if (strpos($prop_val, '[/') !== false) {
73 if ( defined( 'WPCF7_ConfigValidator::error_invalid_mailbox_syntax' ) ) {
74 // Pre CF7 v5.8
75 $wpcf7_config_validator->remove_error($err_type, WPCF7_ConfigValidator::error_invalid_mailbox_syntax);
76 } else {
77 // CF7 v5.8+
78 $wpcf7_config_validator->remove_error($err_type, 'invalid_mail_header');
79 }
80 continue;
81 }
82 }
83
84 return new WPCF7_ConfigValidator($wpcf7_config_validator->contact_form());
85 }
86
87 function activate() {
88 //add options with add_option and stuff
89 }
90
91 /**
92 * Remove validation requirements for fields that are hidden at the time of form submission.
93 * Required/invalid fields should never trigger validation errors if they are inside a hidden group during submission.
94 * Called using add_filter( 'wpcf7_validate', array($this, 'skip_validation_for_hidden_fields'), 2, 2 );
95 * where the priority of 2 causes this to kill any validations with a priority higher than 2
96 *
97 * NOTE: CF7 is weirdly designed when it comes to validating a form with files.
98 * Only the non-file fields are considered during the wpcf7_validate filter.
99 * When validation passes for all fields (except the file fields), the files fields are validated individually.
100 * ( see skip_validation_for_hidden_file_field )
101 *
102 * @param $result
103 * @param $tag
104 *
105 * @return mixed
106 */
107 function skip_validation_for_hidden_fields($result, $tags, $args = []) {
108
109 if(isset($_POST)) {
110 $this->set_hidden_fields_arrays($_POST);
111 }
112
113 $invalid_fields = $result->get_invalid_fields();
114 $return_result = new WPCF7_Validation();
115
116 if (count($this->hidden_fields) == 0 || !is_array($invalid_fields) || count($invalid_fields) == 0) {
117 $return_result = $result;
118 } else {
119 foreach ($invalid_fields as $invalid_field_key => $invalid_field_data) {
120 if (!in_array($invalid_field_key, $this->hidden_fields)) {
121 foreach ($tags as $tag) {
122 if ($tag['name'] === $invalid_field_key) {
123 $return_result->invalidate($tag, $invalid_field_data['reason']);
124 }
125 }
126 }
127 }
128 }
129
130 return apply_filters('wpcf7cf_validate', $return_result, $tags);
131
132 }
133
134 /**
135 * Does the same thing as skip_validation_for_hidden_fields, but CF7 will check files again later
136 * via the wpcf7_unship_uploaded_files function
137 * so we need to skip validation a second time for individual file fields
138 */
139 function skip_validation_for_hidden_file_field($result, $tag, $args=[]) {
140
141 if (!count($result->get_invalid_fields())) {
142 return $result;
143 }
144 if(isset($_POST)) {
145 $this->set_hidden_fields_arrays($_POST);
146 }
147
148 $invalid_field_keys = array_keys($result->get_invalid_fields());
149
150 // if the current file is the only invalid tag in the result AND if the file is hidden: return a valid (blank) object
151 if (isset($this->hidden_fields) && is_array($this->hidden_fields) && in_array($tag->name, $this->hidden_fields) && count($invalid_field_keys) == 1) {
152 return new WPCF7_Validation();
153 }
154
155 // if the current file is not hidden, we'll just return the result (keep it invalid).
156 // (Note that this might also return the hidden files as invalid, but that shouldn't matter because the form is invalid, and the notification will be inside a hidden group)
157 return $result;
158 }
159
160 function cf7msm_merge_post_with_cookie($posted_data) {
161
162 if (!function_exists('cf7msm_get') || !key_exists('cf7msm_posted_data',$_COOKIE)) return $posted_data;
163
164 if (!$posted_data) {
165 $posted_data = WPCF7_Submission::get_instance()->get_posted_data();
166 }
167
168 // this will temporarily set the hidden fields data to the posted_data.
169 // later this function will be called again with the updated posted_data
170 $this->set_hidden_fields_arrays($_POST);
171
172 // get cookie data
173 $cookie_data = cf7msm_get('cf7msm_posted_data');
174 $cookie_data_hidden_group_fields = json_decode(stripslashes($cookie_data['_wpcf7cf_hidden_group_fields']));
175 $cookie_data_hidden_groups = json_decode(stripslashes($cookie_data['_wpcf7cf_hidden_groups']));
176 $cookie_data_visible_groups = json_decode(stripslashes($cookie_data['_wpcf7cf_visible_groups']));
177
178 // remove all the currently posted data from the cookie data (we don't wanna add it twice)
179 $cookie_data_hidden_group_fields = array_diff($cookie_data_hidden_group_fields, array_keys($posted_data));
180 $cookie_data_hidden_groups = array_diff((array) $cookie_data_hidden_groups, $this->hidden_groups, $this->visible_groups);
181 $cookie_data_visible_groups = array_diff((array) $cookie_data_visible_groups, $this->hidden_groups, $this->visible_groups);
182
183 // update current post data with cookie data
184 $posted_data['_wpcf7cf_hidden_group_fields'] = addslashes(json_encode(array_merge((array) $cookie_data_hidden_group_fields, $this->hidden_fields)));
185 $posted_data['_wpcf7cf_hidden_groups'] = addslashes(json_encode(array_merge((array) $cookie_data_hidden_groups, $this->hidden_groups)));
186 $posted_data['_wpcf7cf_visible_groups'] = addslashes(json_encode(array_merge((array) $cookie_data_visible_groups, $this->visible_groups)));
187
188 return $posted_data;
189 }
190
191 // compatibility with CF7 Multi Step by NinjaTeam https://wordpress.org/plugins/cf7-multi-step/
192 function cf7mls_validation_callback() {
193 $this->set_hidden_fields_arrays($_POST);
194 }
195
196 /**
197 * Finds the currently submitted form and set the hidden_fields variables accoringly
198 *
199 * @param bool|array $posted_data
200 */
201 function set_hidden_fields_arrays($posted_data = false) {
202
203 if (!$posted_data) $posted_data = $_POST;
204
205 $hidden_fields = json_decode(stripslashes($posted_data['_wpcf7cf_hidden_group_fields']));
206 if (is_array($hidden_fields) && count($hidden_fields) > 0) {
207 foreach ($hidden_fields as $field) {
208 $this->hidden_fields[] = $field;
209 if (wpcf7cf_endswith($field, '[]')) {
210 $this->hidden_fields[] = substr($field,0,strlen($field)-2);
211 }
212 }
213 }
214 $this->hidden_groups = json_decode(stripslashes($posted_data['_wpcf7cf_hidden_groups']));
215 $this->visible_groups = json_decode(stripslashes($posted_data['_wpcf7cf_visible_groups']));
216 $this->repeaters = json_decode(stripslashes($posted_data['_wpcf7cf_repeaters']));
217 $this->steps = json_decode(stripslashes($posted_data['_wpcf7cf_steps']));
218 }
219
220 function hide_hidden_mail_fields($form,$abort,$submission) {
221 $props = $form->get_properties();
222 $mails = ['mail','mail_2','messages'];
223 foreach ($mails as $mail) {
224 if (!is_array($props[$mail])) { continue; }
225 foreach ($props[$mail] as $key=>$val) {
226
227 // remove unwanted whitespace between closing and opening groups from email
228 $count = 1;
229 while ($count) {
230 $val = preg_replace(WPCF7CF_REGEX_MAIL_UNWANTED_WHITESPACE, '$1$2', $val, -1, $count);
231 }
232
233 // remove hiddden groups from email
234 $parser = new Wpcf7cfMailParser($val, $this->visible_groups, $this->hidden_groups, $this->repeaters, $_POST);
235 $props[$mail][$key] = $parser->getParsedMail();
236 }
237 }
238
239
240 //$props['mail']['body'] = 'xxx';
241 $form->set_properties($props);
242 }
243
244 function hide_hidden_mail_fields_regex_callback ( $matches ) {
245 $name = $matches[1];
246 $content = $matches[2];
247 if ( in_array( $name, $this->hidden_groups ) ) {
248 // The tag name represents a hidden group, so replace everything from [tagname] to [/tagname] with nothing
249 return '';
250 } elseif ( in_array( $name, $this->visible_groups ) ) {
251 // The tag name represents a visible group, so remove the tags themselves, but return everything else
252 // instead of just returning the $content, return the preg_replaced content :)
253 return preg_replace_callback(WPCF7CF_REGEX_MAIL_GROUP, array($this, 'hide_hidden_mail_fields_regex_callback'), $content );
254 } else {
255 // The tag name doesn't represent a group that was used in the form. Leave it alone (return the entire match).
256 return $matches[0];
257 }
258 }
259
260 public static function parse_conditions($string, $format='array') {
261 // Parse stuff like "show [g1] if [field] equals 2" to Array
262
263 preg_match_all(WPCF7CF_REGEX_CONDITIONS, $string, $matches);
264
265 $conditions = [];
266
267 $prev_then_field = '';
268 foreach ($matches[0] as $i=>$line) {
269 $then_field = $matches[1][$i];
270 $if_field = $matches[2][$i];
271 $operator = $matches[3][$i];
272 $if_value = $matches[4][$i];
273
274 $index = count($conditions);
275
276 if ($then_field == '') {
277 $index = $index -1;
278 $then_field = $prev_then_field;
279 } else {
280 $conditions[$index]['then_field'] = $then_field;
281 }
282
283 $conditions[$index]['and_rules'][] = [
284 'if_field' => $if_field,
285 'operator' => $operator,
286 'if_value' => $if_value,
287 ];
288
289 $prev_then_field = $then_field;
290
291 }
292
293 $conditions = array_values($conditions);
294
295 if ($format == 'array') {
296 return $conditions;
297 } else if ($format == 'json') {
298 return json_encode($conditions);
299 }
300 }
301
302 /**
303 * load the conditions from the form's post_meta
304 *
305 * @param string $form_id
306 * @return array
307 */
308 public static function getConditions($form_id) {
309 // make sure conditions are an array.
310 $options = get_post_meta($form_id,'wpcf7cf_options',true);
311 return is_array($options) ? $options : array(); // the meta key 'wpcf7cf_options' is a bit misleading at this point, because it only holds the form's conditions, no other options/settings
312 }
313
314 /**
315 * load the conditions from the form's post_meta as plain text
316 *
317 * @param string $form_id
318 * @return void
319 */
320 public static function getConditionsPlainText($form_id) {
321 return CF7CF::serializeConditions(CF7CF::getConditions($form_id));
322 }
323
324 public static function serializeConditions($array) {
325
326 $lines = [];
327
328 foreach ($array as $entry) {
329 $then_field = $entry['then_field'];
330 $and_rules = $entry['and_rules'];
331 $indent = strlen($then_field) + 4;
332 foreach ($and_rules as $i => $rule) {
333 $if_field = $rule['if_field'];
334 $operator = $rule['operator'];
335 $if_value = $rule['if_value'];
336
337 if ($i == 0) {
338 $lines[] = "show [$then_field] if [$if_field] $operator \"$if_value\"";
339 } else {
340 $lines[] = str_repeat(' ',$indent)."and if [$if_field] $operator \"$if_value\"";
341 }
342 }
343 }
344
345 return implode("\n", $lines);
346 }
347
348 /**
349 * save the conditions to the form's post_meta
350 *
351 * @param string $form_id
352 * @return void
353 */
354 public static function setConditions($form_id, $conditions) {
355 return update_post_meta($form_id,'wpcf7cf_options',$conditions); // the meta key 'wpcf7cf_options' is a bit misleading at this point, because it only holds the form's conditions, no other options/settings
356 }
357 }
358
359 new CF7CF;
360
361 add_filter( 'wpcf7_contact_form_properties', 'wpcf7cf_properties', 10, 2 );
362
363 function wpcf7cf_properties($properties, $wpcf7form) {
364 // Before CF7 5.5.3, this function was called each time we call get_properties() on a contact form. Since CF7 5.5.3 this function is called only once in the WPCF7_ContactForm
365 if (!is_admin() || (defined('DOING_AJAX') && DOING_AJAX)) { // TODO: kind of hacky. maybe find a better solution. Needed because otherwise the group tags will be replaced in the editor as well.
366 $form = $properties['form'];
367
368 $form_parts = preg_split('/(\[\/?group(?:\]|\s.*?\]))/',$form, -1,PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE);
369
370 ob_start();
371
372 $stack = array();
373
374 foreach ($form_parts as $form_part) {
375 if (substr($form_part,0,7) == '[group ') {
376 $tag_parts = explode(' ',rtrim($form_part,']'));
377
378 array_shift($tag_parts);
379
380 $tag_id = $tag_parts[0];
381 $tag_html_type = 'div';
382 $tag_html_data = array();
383
384 foreach ($tag_parts as $i => $tag_part) {
385 if ($i==0) continue;
386 $tag_part = explode(':',$tag_part);
387 if ($tag_part[0] == 'inline') $tag_html_type = 'span';
388 else if ($tag_part[0] == 'clear_on_hide') $tag_html_data[] = 'data-clear_on_hide';
389 else if ($tag_part[0] == 'disable_on_hide' && WPCF7CF_IS_PRO) $tag_html_data[] = 'data-disable_on_hide';
390 else if ($tag_part[0] == 'class') $tag_html_data[] = 'class="'.($tag_part[1]??'').'"';
391 }
392
393 array_push($stack,$tag_html_type);
394
395 echo '<'.$tag_html_type.' data-id="'.$tag_id.'" data-orig_data_id="'.$tag_id.'" '.implode(' ',$tag_html_data).' data-class="wpcf7cf_group">';
396 } else if ($form_part == '[/group]') {
397 echo '</'.array_pop($stack).'>';
398 } else {
399 echo $form_part;
400 }
401 }
402
403 $properties['form'] = ob_get_clean();
404 }
405 return $properties;
406 }
407
408 add_filter('wpcf7_form_hidden_fields', 'wpcf7cf_form_hidden_fields',10,1);
409
410 function wpcf7cf_form_hidden_fields($hidden_fields) {
411
412 $current_form = wpcf7_get_current_contact_form();
413 $current_form_id = $current_form->id();
414
415 $options = array(
416 'form_id' => $current_form_id,
417 'conditions' => CF7CF::getConditions($current_form_id),
418 'settings' => wpcf7cf_get_settings()
419 );
420
421 unset($options['settings']['license_key']); // don't show license key in the source code duh.
422
423 return array_merge($hidden_fields, array(
424 '_wpcf7cf_hidden_group_fields' => '[]',
425 '_wpcf7cf_hidden_groups' => '[]',
426 '_wpcf7cf_visible_groups' => '[]',
427 '_wpcf7cf_repeaters' => '[]',
428 '_wpcf7cf_steps' => '{}',
429 '_wpcf7cf_options' => ''.json_encode($options),
430 ));
431 }
432
433 function wpcf7cf_endswith($string, $test) {
434 $strlen = strlen($string);
435 $testlen = strlen($test);
436 if ($testlen > $strlen) return false;
437 return substr_compare($string, $test, $strlen - $testlen, $testlen) === 0;
438 }
439
440 add_filter( 'wpcf7_form_tag_data_option', 'wpcf7cf_form_tag_data_option', 10, 3 );
441
442 function wpcf7cf_form_tag_data_option($output, $args, $nog) {
443 $data = array();
444 return $data;
445 }
446
447 /* Scripts & Styles */
448
449 function wpcf7cf_load_js() {
450 return apply_filters( 'wpcf7cf_load_js', WPCF7CF_LOAD_JS );
451 }
452
453 function wpcf7cf_load_css() {
454 return apply_filters( 'wpcf7cf_load_css', WPCF7CF_LOAD_CSS );
455 }
456
457 add_action( 'wp_enqueue_scripts', 'wpcf7cf_do_enqueue_scripts', 20, 0 );
458
459 function wpcf7cf_do_enqueue_scripts() {
460 if ( wpcf7cf_load_js() ) {
461 wpcf7cf_enqueue_scripts();
462 }
463
464 if ( wpcf7cf_load_css() ) {
465 wpcf7cf_enqueue_styles();
466 }
467 }
468
469 function wpcf7cf_enqueue_scripts() {
470 if (is_admin()) return;
471 wp_enqueue_script('wpcf7cf-scripts', plugins_url('js/scripts.js', __FILE__), array('jquery', 'contact-form-7'), WPCF7CF_VERSION, true);
472 wp_localize_script('wpcf7cf-scripts', 'wpcf7cf_global_settings',
473 array(
474 'ajaxurl' => admin_url('admin-ajax.php'),
475 )
476 );
477
478 }
479
480 function wpcf7cf_enqueue_styles() {
481 if (is_admin()) return;
482 wp_enqueue_style('cf7cf-style', plugins_url('style.css', __FILE__), array(), WPCF7CF_VERSION);
483 }
484
485 // Make sure CF7 doesn't target any disabled fields for validation
486 // (HTML standard: "disabled fields don't get submitted", so no need to validate them)
487 add_filter( 'wpcf7_feedback_response', function($response, $result) {
488 foreach ($response['invalid_fields'] as $i => $inv) {
489 if (isset($response['invalid_fields'][$i]['into'])) {
490 $response['invalid_fields'][$i]['into'] .= ':not(.wpcf7cf-disabled)';
491 }
492 }
493 return $response;
494 }, 2, 10 );