Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

require_once path_join( __DIR__, 'form.php' );

[2] Fix | Delete

require_once path_join( __DIR__, 'mail.php' );

[3] Fix | Delete

require_once path_join( __DIR__, 'messages.php' );

[4] Fix | Delete

require_once path_join( __DIR__, 'additional-settings.php' );

[5] Fix | Delete

require_once path_join( __DIR__, 'actions.php' );

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Configuration validator.

[10] Fix | Delete

[11] Fix | Delete

* @link https://contactform7.com/configuration-errors/

[12] Fix | Delete

[13] Fix | Delete

class WPCF7_ConfigValidator {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* The plugin version in which important updates happened last time.

[17] Fix | Delete

[18] Fix | Delete

const last_important_update = '5.8.1';

[19] Fix | Delete

[20] Fix | Delete

const error_codes = array(

[21] Fix | Delete

'maybe_empty',

[22] Fix | Delete

'invalid_mailbox_syntax',

[23] Fix | Delete

'email_not_in_site_domain',

[24] Fix | Delete

'html_in_message',

[25] Fix | Delete

'multiple_controls_in_label',

[26] Fix | Delete

'file_not_found',

[27] Fix | Delete

'unavailable_names',

[28] Fix | Delete

'invalid_mail_header',

[29] Fix | Delete

'deprecated_settings',

[30] Fix | Delete

'file_not_in_content_dir',

[31] Fix | Delete

'unavailable_html_elements',

[32] Fix | Delete

'attachments_overweight',

[33] Fix | Delete

'dots_in_names',

[34] Fix | Delete

'colons_in_names',

[35] Fix | Delete

'upload_filesize_overlimit',

[36] Fix | Delete

'unsafe_email_without_protection',

[37] Fix | Delete

);

[38] Fix | Delete

[39] Fix | Delete

use WPCF7_ConfigValidator_Form;

[40] Fix | Delete

use WPCF7_ConfigValidator_Mail;

[41] Fix | Delete

use WPCF7_ConfigValidator_Messages;

[42] Fix | Delete

use WPCF7_ConfigValidator_AdditionalSettings;

[43] Fix | Delete

[44] Fix | Delete

private $contact_form;

[45] Fix | Delete

private $errors = array();

[46] Fix | Delete

private $include;

[47] Fix | Delete

private $exclude;

[48] Fix | Delete

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Returns a URL linking to the documentation page for the error type.

[52] Fix | Delete

[53] Fix | Delete

public static function get_doc_link( $child_page = '' ) {

[54] Fix | Delete

$url = __( 'https://contactform7.com/configuration-errors/',

[55] Fix | Delete

'contact-form-7'

[56] Fix | Delete

);

[57] Fix | Delete

[58] Fix | Delete

if ( '' !== $child_page ) {

[59] Fix | Delete

$child_page = strtr( $child_page, '_', '-' );

[60] Fix | Delete

[61] Fix | Delete

$url = sprintf( '%s/%s', untrailingslashit( $url ), $child_page );

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

return esc_url( $url );

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Constructor.

[70] Fix | Delete

[71] Fix | Delete

public function __construct( WPCF7_ContactForm $contact_form, $options = '' ) {

[72] Fix | Delete

$options = wp_parse_args( $options, array(

[73] Fix | Delete

'include' => null,

[74] Fix | Delete

'exclude' => null,

[75] Fix | Delete

) );

[76] Fix | Delete

[77] Fix | Delete

$this->contact_form = $contact_form;

[78] Fix | Delete

[79] Fix | Delete

if ( isset( $options['include'] ) ) {

[80] Fix | Delete

$this->include = (array) $options['include'];

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

if ( isset( $options['exclude'] ) ) {

[84] Fix | Delete

$this->exclude = (array) $options['exclude'];

[85] Fix | Delete

}

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Returns the contact form object that is tied to this validator.

[91] Fix | Delete

[92] Fix | Delete

public function contact_form() {

[93] Fix | Delete

return $this->contact_form;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Returns true if no error has been detected.

[99] Fix | Delete

[100] Fix | Delete

public function is_valid() {

[101] Fix | Delete

return ! $this->count_errors();

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Returns true if the given error code is supported by this instance.

[107] Fix | Delete

[108] Fix | Delete

public function supports( $error_code ) {

[109] Fix | Delete

if ( isset( $this->include ) ) {

[110] Fix | Delete

$supported_codes = array_intersect( self::error_codes, $this->include );

[111] Fix | Delete

} else {

[112] Fix | Delete

$supported_codes = self::error_codes;

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

if ( isset( $this->exclude ) ) {

[116] Fix | Delete

$supported_codes = array_diff( $supported_codes, $this->exclude );

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

return in_array( $error_code, $supported_codes, true );

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Counts detected errors.

[125] Fix | Delete

[126] Fix | Delete

public function count_errors( $options = '' ) {

[127] Fix | Delete

$options = wp_parse_args( $options, array(

[128] Fix | Delete

'section' => '',

[129] Fix | Delete

'code' => '',

[130] Fix | Delete

) );

[131] Fix | Delete

[132] Fix | Delete

$count = 0;

[133] Fix | Delete

[134] Fix | Delete

foreach ( $this->errors as $key => $errors ) {

[135] Fix | Delete

if ( preg_match( '/^mail_[0-9]+\.(.*)$/', $key, $matches ) ) {

[136] Fix | Delete

$key = sprintf( 'mail.%s', $matches[1] );

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

if ( $options['section']

[140] Fix | Delete

and $key !== $options['section']

[141] Fix | Delete

and preg_replace( '/\..*$/', '', $key, 1 ) !== $options['section'] ) {

[142] Fix | Delete

continue;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

foreach ( $errors as $error ) {

[146] Fix | Delete

if ( empty( $error ) ) {

[147] Fix | Delete

continue;

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

if ( $options['code'] and $error['code'] !== $options['code'] ) {

[151] Fix | Delete

continue;

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

$count += 1;

[155] Fix | Delete

}

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

return $count;

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

[162] Fix | Delete

/**

[163] Fix | Delete

* Collects messages for detected errors.

[164] Fix | Delete

[165] Fix | Delete

public function collect_error_messages() {

[166] Fix | Delete

$error_messages = array();

[167] Fix | Delete

[168] Fix | Delete

foreach ( $this->errors as $section => $errors ) {

[169] Fix | Delete

$error_messages[$section] = array();

[170] Fix | Delete

[171] Fix | Delete

foreach ( $errors as $error ) {

[172] Fix | Delete

if ( empty( $error['args']['message'] ) ) {

[173] Fix | Delete

$message = $this->get_default_message( $error['code'] );

[174] Fix | Delete

} elseif ( empty( $error['args']['params'] ) ) {

[175] Fix | Delete

$message = $error['args']['message'];

[176] Fix | Delete

} else {

[177] Fix | Delete

$message = $this->build_message(

[178] Fix | Delete

$error['args']['message'],

[179] Fix | Delete

$error['args']['params']

[180] Fix | Delete

);

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

$link = '';

[184] Fix | Delete

[185] Fix | Delete

if ( ! empty( $error['args']['link'] ) ) {

[186] Fix | Delete

$link = $error['args']['link'];

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

$error_messages[$section][] = array(

[190] Fix | Delete

'message' => $message,

[191] Fix | Delete

'link' => esc_url( $link ),

[192] Fix | Delete

);

[193] Fix | Delete

}

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

return $error_messages;

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

[200] Fix | Delete

/**

[201] Fix | Delete

* Builds an error message by replacing placeholders.

[202] Fix | Delete

[203] Fix | Delete

public function build_message( $message, $params = '' ) {

[204] Fix | Delete

$params = wp_parse_args( $params, array() );

[205] Fix | Delete

[206] Fix | Delete

foreach ( $params as $key => $val ) {

[207] Fix | Delete

if ( ! preg_match( '/^[0-9A-Za-z_]+$/', $key ) ) { // invalid key

[208] Fix | Delete

continue;

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

$placeholder = '%' . $key . '%';

[212] Fix | Delete

[213] Fix | Delete

if ( false !== stripos( $message, $placeholder ) ) {

[214] Fix | Delete

$message = str_ireplace( $placeholder, $val, $message );

[215] Fix | Delete

}

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

return $message;

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

[222] Fix | Delete

/**

[223] Fix | Delete

* Returns a default message that is used when the message for the error

[224] Fix | Delete

* is not specified.

[225] Fix | Delete

[226] Fix | Delete

public function get_default_message( $code = '' ) {

[227] Fix | Delete

return __( "Configuration error is detected.", 'contact-form-7' );

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

[231] Fix | Delete

/**

[232] Fix | Delete

* Returns true if the specified section has the specified error.

[233] Fix | Delete

[234] Fix | Delete

* @param string $section The section where the error detected.

[235] Fix | Delete

* @param string $code The unique code of the error.

[236] Fix | Delete

[237] Fix | Delete

public function has_error( $section, $code ) {

[238] Fix | Delete

if ( empty( $this->errors[$section] ) ) {

[239] Fix | Delete

return false;

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

foreach ( (array) $this->errors[$section] as $error ) {

[243] Fix | Delete

if ( isset( $error['code'] ) and $error['code'] === $code ) {

[244] Fix | Delete

return true;

[245] Fix | Delete

}

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

return false;

[249] Fix | Delete

}

[250] Fix | Delete

[251] Fix | Delete

[252] Fix | Delete

/**

[253] Fix | Delete

* Adds a validation error.

[254] Fix | Delete

[255] Fix | Delete

* @param string $section The section where the error detected.

[256] Fix | Delete

* @param string $code The unique code of the error.

[257] Fix | Delete

* @param string|array $args Optional options for the error.

[258] Fix | Delete

[259] Fix | Delete

public function add_error( $section, $code, $args = '' ) {

[260] Fix | Delete

$args = wp_parse_args( $args, array(

[261] Fix | Delete

'message' => '',

[262] Fix | Delete

'params' => array(),

[263] Fix | Delete

) );

[264] Fix | Delete

[265] Fix | Delete

$available_error_codes = (array) apply_filters(

[266] Fix | Delete

'wpcf7_config_validator_available_error_codes',

[267] Fix | Delete

self::error_codes,

[268] Fix | Delete

$this->contact_form

[269] Fix | Delete

);

[270] Fix | Delete

[271] Fix | Delete

if ( ! in_array( $code, $available_error_codes, true ) ) {

[272] Fix | Delete

return false;

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

if ( ! isset( $args['link'] ) ) {

[276] Fix | Delete

$args['link'] = self::get_doc_link( $code );

[277] Fix | Delete

}

[278] Fix | Delete

[279] Fix | Delete

if ( ! isset( $this->errors[$section] ) ) {

[280] Fix | Delete

$this->errors[$section] = array();

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

$this->errors[$section][] = array(

[284] Fix | Delete

'code' => $code,

[285] Fix | Delete

'args' => $args,

[286] Fix | Delete

);

[287] Fix | Delete

[288] Fix | Delete

return true;

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

[292] Fix | Delete

/**

[293] Fix | Delete

* Removes an error.

[294] Fix | Delete

[295] Fix | Delete

* @param string $section The section where the error detected.

[296] Fix | Delete

* @param string $code The unique code of the error.

[297] Fix | Delete

[298] Fix | Delete

public function remove_error( $section, $code ) {

[299] Fix | Delete

if ( empty( $this->errors[$section] ) ) {

[300] Fix | Delete

return;

[301] Fix | Delete

}

[302] Fix | Delete

[303] Fix | Delete

foreach ( (array) $this->errors[$section] as $key => $error ) {

[304] Fix | Delete

if ( isset( $error['code'] ) and $error['code'] === $code ) {

[305] Fix | Delete

unset( $this->errors[$section][$key] );

[306] Fix | Delete

}

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

if ( empty( $this->errors[$section] ) ) {

[310] Fix | Delete

unset( $this->errors[$section] );

[311] Fix | Delete

}

[312] Fix | Delete

}

[313] Fix | Delete

[314] Fix | Delete

[315] Fix | Delete

/**

[316] Fix | Delete

* The main validation runner.

[317] Fix | Delete

[318] Fix | Delete

* @return bool True if there is no error detected.

[319] Fix | Delete

[320] Fix | Delete

public function validate() {

[321] Fix | Delete

$this->validate_form();

[322] Fix | Delete

$this->validate_mail( 'mail' );

[323] Fix | Delete

$this->validate_mail( 'mail_2' );

[324] Fix | Delete

$this->validate_messages();

[325] Fix | Delete

$this->validate_additional_settings();

[326] Fix | Delete

[327] Fix | Delete

do_action( 'wpcf7_config_validator_validate', $this );

[328] Fix | Delete

[329] Fix | Delete

return $this->is_valid();

[330] Fix | Delete

}

[331] Fix | Delete

[332] Fix | Delete

[333] Fix | Delete

/**

[334] Fix | Delete

* Saves detected errors as a post meta data.

[335] Fix | Delete

[336] Fix | Delete

public function save() {

[337] Fix | Delete

if ( $this->contact_form->initial() ) {

[338] Fix | Delete

return;

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete

delete_post_meta( $this->contact_form->id(), '_config_validation' );

[342] Fix | Delete

[343] Fix | Delete

if ( $this->errors ) {

[344] Fix | Delete

update_post_meta(

[345] Fix | Delete

$this->contact_form->id(), '_config_validation', $this->errors

[346] Fix | Delete

);

[347] Fix | Delete

}

[348] Fix | Delete

}

[349] Fix | Delete

[350] Fix | Delete

[351] Fix | Delete

/**

[352] Fix | Delete

* Restore errors from the database.

[353] Fix | Delete

[354] Fix | Delete

public function restore() {

[355] Fix | Delete

$config_errors = get_post_meta(

[356] Fix | Delete

$this->contact_form->id(), '_config_validation', true

[357] Fix | Delete

);

[358] Fix | Delete

[359] Fix | Delete

foreach ( (array) $config_errors as $section => $errors ) {

[360] Fix | Delete

if ( empty( $errors ) ) {

[361] Fix | Delete

continue;

[362] Fix | Delete

}

[363] Fix | Delete

[364] Fix | Delete

foreach ( (array) $errors as $error ) {

[365] Fix | Delete

if ( ! empty( $error['code'] ) ) {

[366] Fix | Delete

$code = $error['code'];

[367] Fix | Delete

$args = isset( $error['args'] ) ? $error['args'] : '';

[368] Fix | Delete

$this->add_error( $section, $code, $args );

[369] Fix | Delete

}

[370] Fix | Delete

}

[371] Fix | Delete

}

[372] Fix | Delete

}

[373] Fix | Delete

[374] Fix | Delete

}

[375] Fix | Delete

[376] Fix | Delete