<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Helper logging and debug functions.

[2] Fix | Delete

*

[3] Fix | Delete

* @since 1.8.0

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

use WPForms\Logger\Log;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Check whether the plugin works in a debug mode.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 1.2.3

[12] Fix | Delete

*

[13] Fix | Delete

* @return bool

[14] Fix | Delete

*/

[15] Fix | Delete

function wpforms_debug(): bool {

[16] Fix | Delete

[17] Fix | Delete

$debug = false;

[18] Fix | Delete

[19] Fix | Delete

if ( ( defined( 'WPFORMS_DEBUG' ) && true === WPFORMS_DEBUG ) && is_super_admin() ) {

[20] Fix | Delete

$debug = true;

[21] Fix | Delete

}

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Filters wpforms_debug status.

[25] Fix | Delete

*

[26] Fix | Delete

* @since 1.2.3

[27] Fix | Delete

*

[28] Fix | Delete

* @param bool $debug WPForms debug status.

[29] Fix | Delete

*/

[30] Fix | Delete

return (bool) apply_filters( 'wpforms_debug', $debug );

[31] Fix | Delete

}

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Helper function to display debug data.

[35] Fix | Delete

*

[36] Fix | Delete

* @since 1.0.0

[37] Fix | Delete

*

[38] Fix | Delete

* @param mixed $data What to dump - can be any type.

[39] Fix | Delete

* @param bool $do_echo Whether to print or return. The default is to print.

[40] Fix | Delete

*

[41] Fix | Delete

* @return string|void

[42] Fix | Delete

*/

[43] Fix | Delete

function wpforms_debug_data( $data, bool $do_echo = true ) {

[44] Fix | Delete

[45] Fix | Delete

if ( ! wpforms_debug() ) {

[46] Fix | Delete

return;

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

if ( is_array( $data ) || is_object( $data ) ) {

[50] Fix | Delete

// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r

[51] Fix | Delete

$data = print_r( $data, true );

[52] Fix | Delete

}

[53] Fix | Delete

[54] Fix | Delete

$output = sprintf(

[55] Fix | Delete

'<style>

[56] Fix | Delete

.wpforms-debug {

[57] Fix | Delete

line-height: 0;

[58] Fix | Delete

}

[59] Fix | Delete

.wpforms-debug textarea {

[60] Fix | Delete

background: #f6f7f7 !important;

[61] Fix | Delete

margin: 20px 0 0 0;

[62] Fix | Delete

width: 100%%;

[63] Fix | Delete

height: 500px;

[64] Fix | Delete

font-size: 12px;

[65] Fix | Delete

font-family: Consolas, Menlo, Monaco, monospace;

[66] Fix | Delete

direction: ltr;

[67] Fix | Delete

unicode-bidi: embed;

[68] Fix | Delete

line-height: 1.4;

[69] Fix | Delete

padding: 10px;

[70] Fix | Delete

border-radius: 0;

[71] Fix | Delete

border-color: #c3c4c7;

[72] Fix | Delete

box-sizing: border-box;

[73] Fix | Delete

}

[74] Fix | Delete

.postbox .wpforms-debug {

[75] Fix | Delete

padding: 6px;

[76] Fix | Delete

}

[77] Fix | Delete

.postbox .wpforms-debug:not(:first-of-type) {

[78] Fix | Delete

padding-top: 0;

[79] Fix | Delete

}

[80] Fix | Delete

.postbox .wpforms-debug textarea {

[81] Fix | Delete

margin-top: 0 !important;

[82] Fix | Delete

}

[83] Fix | Delete

</style>

[84] Fix | Delete

<div class="wpforms-debug">

[85] Fix | Delete

<textarea readonly>=================== WPFORMS DEBUG ===================%s</textarea>

[86] Fix | Delete

</div>',

[87] Fix | Delete

"\n\n" . esc_html( $data )

[88] Fix | Delete

);

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Allow developers to determine whether the debug data should be displayed.

[92] Fix | Delete

* Works only in debug mode (`WPFORMS_DEBUG` constant is `true`).

[93] Fix | Delete

*

[94] Fix | Delete

* @since 1.6.8

[95] Fix | Delete

*

[96] Fix | Delete

* @param bool $allow_display True by default.

[97] Fix | Delete

*/

[98] Fix | Delete

$allow_display = apply_filters( 'wpforms_debug_data_allow_display', true );

[99] Fix | Delete

[100] Fix | Delete

if ( $do_echo && $allow_display ) {

[101] Fix | Delete

// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[102] Fix | Delete

echo $output;

[103] Fix | Delete

} else {

[104] Fix | Delete

return $output;

[105] Fix | Delete

}

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Log helper.

[110] Fix | Delete

*

[111] Fix | Delete

* @since 1.0.0

[112] Fix | Delete

*

[113] Fix | Delete

* @param string $title Title of a log message.

[114] Fix | Delete

* @param mixed $message Content of a log message.

[115] Fix | Delete

* @param array $args Expected keys: type, form_id, meta, parent, force.

[116] Fix | Delete

*/

[117] Fix | Delete

function wpforms_log( $title = '', $message = '', $args = [] ) { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.TooHigh

[118] Fix | Delete

[119] Fix | Delete

// Skip if logs disabled in Tools -> Logs.

[120] Fix | Delete

if ( empty( $args['force'] ) && ! wpforms_setting( 'logs-enable' ) ) {

[121] Fix | Delete

return;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

// Require log title.

[125] Fix | Delete

if ( empty( $title ) ) {

[126] Fix | Delete

return;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Compare error levels to determine if we should log.

[131] Fix | Delete

* Current supported levels:

[132] Fix | Delete

* - Conditional Logic (conditional_logic)

[133] Fix | Delete

* - Entries (entry)

[134] Fix | Delete

* - Errors (error)

[135] Fix | Delete

* - Payments (payment)

[136] Fix | Delete

* - Providers (provider)

[137] Fix | Delete

* - Security (security)

[138] Fix | Delete

* - Spam (spam)

[139] Fix | Delete

* - Log (log)

[140] Fix | Delete

*/

[141] Fix | Delete

$types = ! empty( $args['type'] ) ? (array) $args['type'] : [ 'error' ];

[142] Fix | Delete

[143] Fix | Delete

// Skip invalid logs types.

[144] Fix | Delete

$log_types = Log::get_log_types();

[145] Fix | Delete

[146] Fix | Delete

foreach ( $types as $key => $type ) {

[147] Fix | Delete

if ( ! isset( $log_types[ $type ] ) ) {

[148] Fix | Delete

unset( $types[ $key ] );

[149] Fix | Delete

}

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

if ( empty( $types ) ) {

[153] Fix | Delete

return;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

/**

[157] Fix | Delete

* Filter log message.

[158] Fix | Delete

*

[159] Fix | Delete

* @since 1.8.2

[160] Fix | Delete

*

[161] Fix | Delete

* @param mixed $message Log message.

[162] Fix | Delete

* @param string $title Log title.

[163] Fix | Delete

* @param array $args Log arguments.

[164] Fix | Delete

*/

[165] Fix | Delete

$message = apply_filters( 'wpforms_log_message', $message, $title, $args );

[166] Fix | Delete

[167] Fix | Delete

// Make arrays and objects look nice.

[168] Fix | Delete

if ( is_array( $message ) || is_object( $message ) ) {

[169] Fix | Delete

$message = '<pre>' . esc_html( print_r( $message, true ) ) . '</pre>'; // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

// Filter logs types from Tools -> Logs page.

[173] Fix | Delete

$logs_types = wpforms_setting( 'logs-types' );

[174] Fix | Delete

[175] Fix | Delete

if ( $logs_types && empty( array_intersect( $logs_types, $types ) ) ) {

[176] Fix | Delete

return;

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

// Filter user roles from Tools -> Logs page.

[180] Fix | Delete

$current_user = function_exists( 'wp_get_current_user' ) ? wp_get_current_user() : null;

[181] Fix | Delete

$current_user_id = $current_user->ID ?? 0;

[182] Fix | Delete

$current_user_roles = $current_user->roles ?? [];

[183] Fix | Delete

$logs_user_roles = wpforms_setting( 'logs-user-roles' );

[184] Fix | Delete

[185] Fix | Delete

if ( $logs_user_roles && empty( array_intersect( $logs_user_roles, $current_user_roles ) ) ) {

[186] Fix | Delete

return;

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

// Filter logs users from Tools -> Logs page.

[190] Fix | Delete

$logs_users = wpforms_setting( 'logs-users' );

[191] Fix | Delete

[192] Fix | Delete

if ( $logs_users && ! in_array( $current_user_id, $logs_users, true ) ) {

[193] Fix | Delete

return;

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

$log = wpforms()->obj( 'log' );

[197] Fix | Delete

[198] Fix | Delete

if ( ! $log || ! method_exists( $log, 'add' ) ) {

[199] Fix | Delete

return;

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

// Create log entry.

[203] Fix | Delete

$log->add(

[204] Fix | Delete

$title,

[205] Fix | Delete

$message,

[206] Fix | Delete

$types,

[207] Fix | Delete

isset( $args['form_id'] ) ? absint( $args['form_id'] ) : 0,

[208] Fix | Delete

isset( $args['parent'] ) ? absint( $args['parent'] ) : 0,

[209] Fix | Delete

$current_user_id

[210] Fix | Delete

);

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* Wrapper for set_time_limit to see if it is enabled.

[215] Fix | Delete

*

[216] Fix | Delete

* @since 1.6.4

[217] Fix | Delete

*

[218] Fix | Delete

* @param int $limit Time limit.

[219] Fix | Delete

*/

[220] Fix | Delete

function wpforms_set_time_limit( $limit = 0 ) {

[221] Fix | Delete

[222] Fix | Delete

if ( function_exists( 'set_time_limit' ) && false === strpos( ini_get( 'disable_functions' ), 'set_time_limit' ) ) {

[223] Fix | Delete

@set_time_limit( $limit ); // @codingStandardsIgnoreLine

[224] Fix | Delete

}

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete