File: //proc/self/cwd/wp-content/plugins/mainwp-child/class/class-mainwp-client-report-base.php
<?php
/**
* MainWP Client Reports Base
*
* MainWP Client Reprots Extension handler.
* Extension URL: https://mainwp.com/extension/client-reports/
*
* @package MainWP\Child
*/
namespace MainWP\Child;
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
//phpcs:disable WordPress.WP.AlternativeFunctions, Generic.Metrics.CyclomaticComplexity -- Current complexity is the only way to achieve desired results, pull request solutions appreciated.
/**
* Class MainWP_Client_Report_Base
*
* MainWP Client Reports extension handler, extened by the MainWP_Client_Report class.
*/
class MainWP_Client_Report_Base { //phpcs:ignore -- NOSONAR - multi methods.
/**
* Public static variable to hold the single instance of the class.
*
* @var mixed Default null
*/
public static $instance = null;
/**
* Static variable to hold date from.
*
* @var int $date_from.
*/
public static $date_from = null;
/**
* Static variable to hold date to.
*
* @var int $date_to.
*/
public static $date_to = null;
/**
* Static variable to hold cached records.
*
* @var array $records_cached.
*/
public static $records_cached = array();
/**
* Method get_class_name()
*
* Get class name.
*
* @return string __CLASS__ Class name.
*/
public static function get_class_name() {
return __CLASS__;
}
/**
* Public static variable to hold the single instance of the class.
*
* @var mixed Default null
*/
public static function instance() {
if ( null === static::$instance ) {
static::$instance = new self();
}
return static::$instance;
}
/**
* Convert context name of tokens to context name saved in child reports.
*
* @param string $context Context name to be converted.
*
* @return string $context Converted context name.
*/
public function get_compatible_context( $context ) {
// some context are not different.
$mapping_contexts = array(
'comment' => 'comments', // actual context values: post, page.
'plugin' => 'plugins',
'users' => 'profiles',
'user' => 'profiles',
'session' => 'sessions',
'setting' => 'settings',
'theme' => 'themes',
'posts' => 'post',
'pages' => 'page',
'widgets' => 'widgets',
'widget' => 'widgets',
'menu' => 'menus',
'backups' => 'backups',
'backup' => 'backups',
'sucuri' => 'sucuri_scan',
'maintenance' => 'mainwp_maintenance',
'wordfence' => 'wordfence_scan',
'media' => 'media',
'ithemes' => 'ithemes_scan',
);
$context = isset( $mapping_contexts[ $context ] ) ? $mapping_contexts[ $context ] : $context;
return strtolower( $context );
}
/**
* Get connector by compatible context.
*
* @param string $context Context name as reference.
*
* @return string $connector Required connector.
*/
public function get_connector_by_compatible_context( $context ) {
$connector = '';
$mapping_connectors = array(
'plugins' => 'installer',
'themes' => 'installer',
'wordpress' => 'installer', // phpcs:ignore -- wordpress -> WordPress.
'profiles' => 'users',
'comments' => 'comments',
'settings' => 'settings',
'post' => 'posts',
'page' => 'posts',
'widgets' => 'widgets',
'menus' => 'menus',
'backups' => 'mainwp_backups',
'sucuri_scan' => 'mainwp_sucuri',
'mainwp_maintenance' => 'mainwp_maintenance',
'wordfence_scan' => 'mainwp_wordfence',
'ithemes_scan' => 'mainwp_ithemes',
'media' => 'media',
);
if ( isset( $mapping_connectors[ $context ] ) ) {
$connector = $mapping_connectors[ $context ];
}
return $connector;
}
/**
* Get compatible action by context.
*
* @param string $action Action name as reference.
* @param string $context Context name as reference.
*
* @return string $action Compatible action.
*/
public function get_compatible_action( $action, $context = '' ) {
$mapping_actions = array(
'restored' => 'untrashed',
'spam' => 'spammed',
);
if ( isset( $mapping_actions[ $action ] ) ) {
return $mapping_actions[ $action ];
}
if ( 'mainwp_maintenance' === $context ) {
if ( 'process' === $action ) {
$action = 'maintenance';
}
} elseif ( 'sucuri_scan' === $context ) {
if ( 'checks' === $action ) {
$action = 'sucuri_scan';
}
} elseif ( 'wordfence_scan' === $context ) {
if ( 'scan' === $action ) {
$action = 'wordfence_scan';
}
} elseif ( 'ithemes_scan' === $context ) {
if ( 'scan' === $action ) {
$action = 'ithemes_scan';
}
}
return $action;
}
/**
* Get the Stream parameters.
*
* @param array $other_tokens An array containing other tokens.
* @param array $sections An array containing sections.
*
* @return array Arguments array.
*
* @uses \MainWP\Child\MainWP_Child_Branding::is_branding()
*/
public function get_stream_get_params( $other_tokens, $sections ) {
$allowed_params = array(
'connector',
'context',
'action',
'author',
'author_role',
'object_id',
'search',
'date',
'date_from',
'date_to',
'record__in',
'blog_id',
'ip',
);
$args = array();
foreach ( $allowed_params as $param ) {
$paramval = \wp_mainwp_stream_filter_input( INPUT_POST, $param );
if ( $paramval || '0' === $paramval ) {
$args[ $param ] = $paramval;
}
}
foreach ( $args as $arg => $val ) {
if ( ! in_array( $arg, $allowed_params ) ) {
unset( $args[ $arg ] );
}
}
static::$date_from = isset( $args['date_from'] ) ? $args['date_from'] : 0;
static::$date_to = isset( $args['date_to'] ) ? $args['date_to'] : 0;
$exclude_connector_posts = $this->get_stream_get_not_in_params( $sections, $other_tokens );
if ( $exclude_connector_posts ) {
$args['connector__not_in'] = array( 'posts' );
}
$args['action__not_in'] = array( 'login' );
$args['with-meta'] = 1;
if ( isset( $args['date_from'] ) ) {
$args['date_from'] = date( 'Y-m-d', $args['date_from'] ); // phpcs:ignore -- required to achieve desired results, pull request solutions appreciated.
}
if ( isset( $args['date_to'] ) ) {
$args['date_to'] = date( 'Y-m-d', $args['date_to'] ); // phpcs:ignore -- required to achieve desired results, pull request solutions appreciated.
}
if ( MainWP_Child_Branding::instance()->is_branding() ) {
$args['hide_child_reports'] = 1;
}
$args['records_per_page'] = 599999;
return $args;
}
/**
* Get the Stream excluded parameters.
*
* @param array $sections An array containing sections.
* @param array $other_tokens An array containing other tokens.
*
* @return bool true|false
*/
private function get_stream_get_not_in_params( $sections, $other_tokens ) { //phpcs:ignore -- NOSONAR - complex.
$exclude_connector_posts = true;
$parts = array( 'header', 'body', 'footer' );
foreach ( $parts as $part ) {
if ( isset( $sections[ $part ] ) && isset( $sections[ $part ]['section_token'] ) && is_array( $sections[ $part ]['section_token'] ) ) {
foreach ( $sections[ $part ]['section_token'] as $sec ) {
if ( false !== strpos( $sec, '[section.posts' ) || false !== strpos( $sec, '[section.pages' ) ) {
$exclude_connector_posts = false;
break;
}
}
}
if ( ! $exclude_connector_posts ) {
break;
}
}
if ( $exclude_connector_posts ) {
foreach ( $parts as $part ) {
if ( isset( $other_tokens[ $part ] ) && is_array( $other_tokens[ $part ] ) ) {
foreach ( $other_tokens[ $part ] as $sec ) {
if ( false !== strpos( $sec, '[post.' ) || false !== strpos( $sec, '[page.' ) ) {
$exclude_connector_posts = false;
break;
}
}
}
if ( ! $exclude_connector_posts ) {
break;
}
}
}
return $exclude_connector_posts;
}
/**
* Get the Stream other tokens.
*
* @param array $records An array containg actions records.
* @param array $other_tokens An array containing other tokens.
* @param array $skip_records An array containing skipped records.
*
* @return array Other tokens data.
*/
public function get_stream_others_tokens( $records, $other_tokens, $skip_records ) {
$other_tokens_data = array();
$parts = array( 'header', 'body', 'footer' );
foreach ( $parts as $part ) {
if ( isset( $other_tokens[ $part ] ) && is_array( $other_tokens[ $part ] ) ) {
$other_tokens_data[ $part ] = $this->get_other_tokens_data( $records, $other_tokens[ $part ], $skip_records );
}
}
return $other_tokens_data;
}
/**
* Get the Stream sections data.
*
* @param array $records An array containg actions records.
* @param array $sections An array containing sections.
* @param array $skip_records An array containing skipped records.
*
* @return array Sections data.
*/
public function get_stream_sections_data( $records, $sections, $skip_records ) {
$sections_data = array();
$parts = array( 'header', 'body', 'footer' );
foreach ( $parts as $part ) {
if ( isset( $sections[ $part ] ) && is_array( $sections[ $part ] ) && ! empty( $sections[ $part ] ) ) {
foreach ( $sections[ $part ]['section_token'] as $index => $sec ) {
$tokens = $sections[ $part ]['section_content_tokens'][ $index ];
$sections_data[ $part ][ $index ] = $this->get_section_loop_data( $records, $tokens, $sec, $skip_records );
}
}
}
return $sections_data;
}
/**
* Method parse_token_content().
*
* @param string $token The token
* @param string $type Token type
*
* @return mixed Parsed result.
*/
private function parse_token_content( $token, $type ) {
$content = str_replace( array( '[', ']' ), '', $token );
$parts = explode( '.', $content );
$results = array();
if ( 'section' === $type ) {
// pro reports section token formats: xxx.context or xxx.context.action.
if ( 2 === count( $parts ) ) {
$results = array(
'context' => $parts[1],
);
} elseif ( 3 === count( $parts ) ) {
$results = array(
'context' => $parts[1],
'action' => $parts[2],
);
}
} elseif ( 'other_token' === $type ) {
// pro reports section other token formats: context.data or context.action.data.
if ( 2 === count( $parts ) ) {
$results = array(
'context' => $parts[0],
'data' => $parts[1],
);
} elseif ( 3 === count( $parts ) ) {
$results = array(
'context' => $parts[0],
'action' => $parts[1],
'data' => $parts[2],
);
}
}
/**
*
* @since 5.4.0.8.
*
* To support custom token
*/
return apply_filters( 'mainwp_child_parse_reports_token_content', $results, $parts, $token, $type );
}
/**
* Get the other tokens data.
*
* @param array $records An array containg actions records.
* @param array $tokens An array containg the tokens list.
* @param array $skip_records An array containg records to skip.
*
* @return array An array containg the tokens values.
*/
public function get_other_tokens_data( $records, $tokens, &$skip_records ) { // phpcs:ignore -- NOSONAR - required to achieve desired results, pull request solutions appreciated.
$token_values = array();
if ( ! is_array( $tokens ) ) {
$tokens = array();
}
$backups_created_time_to_fix = array();
foreach ( $tokens as $token ) {
if ( isset( $token_values[ $token ] ) ) {
continue;
}
$token_parts = $this->parse_token_content( $token, 'other_token' );
if ( is_array( $token_parts ) ) {
$context = isset( $token_parts['context'] ) ? $token_parts['context'] : '';
$action = isset( $token_parts['action'] ) ? $token_parts['action'] : '';
$data = isset( $token_parts['data'] ) ? $token_parts['data'] : '';
$connector = isset( $token_parts['connector'] ) ? $token_parts['connector'] : ''; // to support hooked connector.
$context = $this->get_compatible_context( $context );
// to compatible with new version of child report.
// to check condition for grabbing report data.
if ( empty( $connector ) ) {
$connector = $this->get_connector_by_compatible_context( $context );
}
$action = $this->get_compatible_action( $action, $context );
// custom values.
if ( 'profiles' === $context && ( 'created' === $action || 'deleted' === $action ) ) {
$context = 'users';
}
if ( 'count' === $data ) {
if ( 'wordfence_scan' === $context ) { // wordfence.blocked.count.
if ( 'blocked' === $action ) {
$token_values[ $token ] = $this->wfc_getblockedcount();
} elseif ( 'issue' === $action ) {
$token_values[ $token ] = $this->wfc_getissuecount();
}
} elseif ( 'ithemes_scan' === $context ) {
if ( 'ithemes_scan' === $context ) {
if ( 'blocked' === $action ) { // ithemes.blocked.count.
$token_values[ $token ] = $this->ithemes_query_events_count( 'blocked' );
} elseif ( 'lockout' === $action ) { // ithemes.lockout.count.
$count = $this->ithemes_get_lockouts(
'all',
array(
'return' => 'count',
'after' => (int) static::$date_from,
'before' => (int) static::$date_to,
)
);
$token_values[ $token ] = $count;
}
}
}
if ( ! isset( $token_values[ $token ] ) ) {
$token_values[ $token ] = $this->get_other_tokens_count( $records, $connector, $context, $action, $skip_records, $backups_created_time_to_fix );
}
}
/**
* @since 5.4.0.8.
*/
$value = apply_filters( 'mainwp_child_get_other_tokens_data', null, $token, $data, $records, $context, $action, $skip_records, $connector );
if ( null !== $value ) {
$token_values[ $token ] = $value;
}
}
}
return $token_values;
}
/**
* Get the spammed comments IDs.
*
* @return array Spammed comments IDs.
*/
private function get_spammed_comments() {
global $wpdb;
if ( isset( static::$records_cached['comments']['spammed'] ) ) { // if the spammed records are not cached, cache them to skip when get other tokens count.
return static::$records_cached['comments']['spammed'];
}
$spam = $wpdb->get_col( //phpcs:ignore -- NOSONAR - required to achieve desired results, pull request solutions appreciated.
$wpdb->prepare(
"
SELECT comment_ID
FROM {$wpdb->comments}
WHERE comment_approved = 'spam'
AND comment_date BETWEEN %s AND %s
",
static::$date_from ? date( 'Y-m-d H:i:s', static::$date_from ) : '0000-00-00 00:00:00', // phpcs:ignore -- required to achieve desired results, pull request solutions appreciated.
static::$date_to ? date( 'Y-m-d H:i:s', static::$date_to ) : '9999-12-31 23:59:59' // phpcs:ignore -- required to achieve desired results, pull request solutions appreciated.
)
);
if ( ! is_array( $spam ) ) {
$spam = array();
}
static::$records_cached['comments']['spammed'] = $spam; // cache spammed records to skip when get other tokens count.
return $spam;
}
/**
* Get the other tokens count.
*
* @param object $records Object containng reports records.
* @param string $connector Record connector.
* @param string $context Record context.
* @param string $action Record action.
* @param array $skip_records Records to skip.
* @param array $backups_created_time_to_fix Backups created time.
*
* @return int The count number.
*/
private function get_other_tokens_count( $records, $connector, $context, $action, &$skip_records, &$backups_created_time_to_fix ) { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
$count = 0;
foreach ( $records as $record ) {
// check connector.
if ( 'editor' === $record->connector ) {
if ( ! in_array( $context, array( 'plugins', 'themes' ) ) || 'updated' !== $action ) {
continue;
}
} elseif ( $connector !== $record->connector ) {
continue;
}
$valid_context = false;
// check context.
if ( 'comments' === $context ) { // multi values.
if ( 'comments' !== $record->connector ) {
continue;
}
$excluded_comment_contexts = array( 'product' );
if ( in_array( $record->context, $excluded_comment_contexts ) ) {
continue;
}
// If it's comment created action of other token comment.created.count.
// Skip entries whose current status on the child is spam from [comment.created.count].
// It corresponds to the same token but with different action [section.comments.created], which is designed to skip spammed comments.
if ( 'created' === $action && in_array( $record->object_id, $this->get_spammed_comments() ) ) {
continue;
}
$valid_context = true;
} elseif ( 'post' === $context && 'created' === $action ) {
if ( in_array( $record->ID, $skip_records ) ) {
continue;
}
$valid_context = true;
} elseif ( 'menus' === $context ) {
$valid_context = true; // ok, pass, don't check context.
} elseif ( 'editor' === $record->connector ) {
$valid_context = true; // ok, pass, checked above.
} elseif ( 'media' === $connector && 'media' === $record->connector ) {
$valid_context = true; // ok, pass, do not check context.
} elseif ( 'widgets' === $connector && 'widgets' === $record->connector ) {
$valid_context = true; // ok, pass, don't check context.
}
$valid_context = ( $valid_context || strtolower( $record->context ) === $context ) ? true : false;
if ( ! $valid_context ) {
continue;
}
// custom action value.
if ( 'widgets' === $connector && 'deleted' === $action ) {
$action = 'removed'; // action saved in database.
}
// check action.
if ( 'backups' === $context ) {
if ( ! $this->is_backup_action( $record->action ) ) {
continue;
}
$created = strtotime( $record->created );
if ( in_array( $created, $backups_created_time_to_fix ) ) {
if ( ! in_array( $record->ID, $skip_records ) ) {
$skip_records[] = $record->ID;
}
continue;
} else {
$backups_created_time_to_fix[] = $created;
}
} else {
if ( $action !== $record->action ) {
continue;
}
if ( 'updated' === $action && ( 'post' === $context || 'page' === $context ) ) {
$new_status = $this->get_stream_meta_data( $record, 'new_status' );
if ( 'draft' === $new_status ) {
continue;
}
} elseif ( 'updated' === $action && ( 'themes' === $context || 'plugins' === $context ) ) {
$name = $this->get_stream_meta_data( $record, 'name' );
if ( empty( $name ) ) {
if ( ! in_array( $record->ID, $skip_records ) ) {
$skip_records[] = $record->ID;
}
continue;
} else {
$old_version = $this->get_stream_meta_data( $record, 'old_version' );
$version = $this->get_stream_meta_data( $record, 'version' );
if ( version_compare( $version, $old_version, '<=' ) ) {
if ( ! in_array( $record->ID, $skip_records ) ) {
$skip_records[] = $record->ID;
}
continue;
}
}
}
}
++$count;
}
return $count;
}
/**
* Get the section loop data.
*
* @param object $records Object containng reports records.
* @param array $tokens An array containing report tokens.
* @param string $section Section name.
* @param array $skip_records Records to skip.
*
* @return array Section loop records.
*/
public function get_section_loop_data( $records, $tokens, $section, $skip_records = array() ) {
$context = '';
$action = '';
$connector = '';
$token_parts = $this->parse_token_content( $section, 'section' );
if ( is_array( $token_parts ) ) {
$context = isset( $token_parts['context'] ) ? $token_parts['context'] : '';
$action = isset( $token_parts['action'] ) ? $token_parts['action'] : '';
$connector = isset( $token_parts['connector'] ) ? $token_parts['connector'] : ''; // to support hooked connector.
}
// get db $context value by mapping.
$context = $this->get_compatible_context( $context );
// to compatible with new version of child report.
// to check condition for grabbing report data.
if ( empty( $connector ) ) {
$connector = $this->get_connector_by_compatible_context( $context );
}
$action = $this->get_compatible_action( $action, $context );
if ( 'profiles' === $context && ( 'created' === $action || 'deleted' === $action ) ) {
$context = 'users';
}
return $this->get_section_loop_records( $records, $tokens, $connector, $context, $action, $skip_records, $section );
}
/**
* Get the section loop records.
*
* @param object $records Object containng reports records.
* @param array $tokens An array containing report tokens.
* @param string $connector Record connector.
* @param string $context Record context.
* @param string $action Record action.
* @param array $skip_records Records to skip.
* @param string $section Section tokens.
*
* @return array Loops.
*/
public function get_section_loop_records( $records, $tokens, $connector, $context, $action, $skip_records, $section = '' ) { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
// phpcs:disable WordPress.Security.NonceVerification
$loops = array();
$loop_count = 0;
$max_items_get = ( isset( $_POST['max_items_get'] ) && ! empty( $_POST['max_items_get'] ) ) ? intval( $_POST['max_items_get'] ) : 0;
$limit_connectors = ( isset( $_POST['limit_reports'] ) && ! empty( $_POST['limit_reports'] ) ) ? intval( $_POST['limit_reports'] ) : array();
// phpcs:enable
if ( ! is_array( $limit_connectors ) || empty( $limit_connectors ) ) {
$limit_connectors = array( 'mainwp_sucuri', 'mainwp_maintenance', 'mainwp_backups' );
}
foreach ( $records as $record ) {
if ( in_array( $record->ID, $skip_records ) ) {
continue;
}
if ( 'editor' === $record->connector ) {
if ( ! in_array( $context, array( 'plugins', 'themes' ) ) || 'updated' !== $action ) {
continue;
}
} elseif ( $connector !== $record->connector ) {
continue;
}
$valid_context = false;
if ( 'comments' === $context ) {
if ( 'comments' !== $record->connector ) {
continue;
}
$excluded_comment_contexts = array( 'product' );
if ( in_array( $record->context, $excluded_comment_contexts ) ) {
continue;
}
// If it's comment created action of section token section.comments.created.
// Skip entries whose current status on the child is spam from [section.comments.created].
if ( 'created' === $action && in_array( $record->object_id, $this->get_spammed_comments() ) ) {
continue;
}
$valid_context = true;
} elseif ( 'menus' === $context ) {
$valid_context = true; // ok, pass, don't check context.
} elseif ( 'editor' === $record->connector ) {
$valid_context = true; // ok, pass, checked above.
} elseif ( 'media' === $connector && 'media' === $record->connector ) {
$valid_context = true; // ok, pass, do not check context.
} elseif ( 'widgets' === $connector && 'widgets' === $record->connector ) {
$valid_context = true; // ok, pass, don't check context.
}
$valid_context = ( $valid_context || strtolower( $record->context ) === $context ) ? true : false;
if ( ! $valid_context ) {
continue;
}
// custom action value!
if ( 'widgets' === $connector && 'deleted' === $action ) {
$action = 'removed'; // action saved in database!
}
if ( 'backups' === $context ) {
if ( ! $this->is_backup_action( $record->action ) ) {
continue;
}
} elseif ( $action !== $record->action ) {
continue;
}
if ( 'updated' === $action && ( 'post' === $context || 'page' === $context ) ) {
$new_status = $this->get_stream_meta_data( $record, 'new_status' );
if ( 'draft' === $new_status ) { // avoid auto save post!
continue;
}
}
$token_values = $this->get_section_loop_token_values( $record, $context, $tokens, $section );
if ( ! empty( $token_values ) ) {
$loops[ $loop_count ] = $token_values;
++$loop_count;
}
if ( $max_items_get && ( $loop_count >= $max_items_get ) && in_array( $connector, $limit_connectors ) ) {
break;
}
}
return $loops;
}
/**
* Check if it's backup action.
*
* @param string $action Record action.
*
* @return bool If backup action, return trie, if not, false.
*/
public function is_backup_action( $action ) {
if ( in_array( $action, array( 'mainwp_backup', 'backupbuddy_backup', 'backupwordpress_backup', 'backwpup_backup', 'updraftplus_backup', 'wptimecapsule_backup', 'wpvivid_backup' ) ) ) {
return true;
}
return false;
}
/**
* Get the section loop token values.
*
* @param object $record Object containing the record data.
* @param string $context Record context.
* @param array $tokens An array containg the report tokens.
* @param string $section Section tokens.
*
* @return array Token values.
*
* @uses \MainWP\Child\MainWP_Helper::log_debug()
*/
private function get_section_loop_token_values( $record, $context, $tokens, $section = '' ) { //phpcs:ignore -- NOSONAR - ignore complex.
$token_values = array();
foreach ( $tokens as $token ) {
$data = '';
$token_name = str_replace( array( '[', ']' ), '', $token );
$array_tmp = explode( '.', $token_name );
if ( 'user.name' === $token_name ) {
$data = 'display_name';
} else {
if ( 1 === count( $array_tmp ) ) {
list( $data ) = $array_tmp;
} elseif ( 2 === count( $array_tmp ) ) {
list( $str1, $data ) = $array_tmp;
} elseif ( 3 === count( $array_tmp ) ) {
list( $str1, $str2, $data ) = $array_tmp;
}
if ( 'version' === $data ) {
if ( 'old' === $str2 ) {
$data = 'old_version';
} elseif ( 'current' === $str2 && 'wordpress' === $str1 ) { // phpcs:ignore -- wordpress -> WordPress.
$data = 'new_version';
}
}
}
if ( 'role' === $data ) {
$data = 'roles';
}
$tok_value = $this->get_section_token_value( $record, $data, $context, $token, $section );
$token_values[ $token ] = $tok_value;
if ( empty( $tok_value ) ) {
$msg = 'MainWP Child Report:: empty token value :: [token=' . $token . '] :: [record=' . print_r( $record, true ) . ']'; // phpcs:ignore -- required to achieve desired results, pull request solutions appreciated.
MainWP_Helper::log_debug( $msg );
}
}
return $token_values;
}
/**
* Get the section token value.
*
* @param object $record Object containing the record data.
* @param string $data Data to process.
* @param string $context Record context.
* @param string $token Requested token.
* @param string $section Section tokens.
*
* @return array Token value.
*
* @uses \MainWP\Child\MainWP_Helper::format_date()
* @uses \MainWP\Child\MainWP_Helper::format_time()
*/
public function get_section_token_value( $record, $data, $context, $token, $section = '' ) { // phpcs:ignore -- NOSONAR - Current complexity is the only way to achieve desired results, pull request solutions appreciated.
$tok_value = '';
switch ( $data ) {
case 'ID':
$tok_value = $record->ID;
break;
case 'date':
$tok_value = MainWP_Helper::format_date( MainWP_Helper::get_timestamp( strtotime( $record->created ) ) );
break;
case 'time':
$tok_value = MainWP_Helper::format_time( MainWP_Helper::get_timestamp( strtotime( $record->created ) ) );
break;
case 'utime':
$tok_value = $record->created;
break;
case 'slug':
$tok_value = $this->get_stream_meta_data( $record, $data );
break;
case 'area':
$data = 'sidebar_name';
$tok_value = $this->get_stream_meta_data( $record, $data );
break;
case 'name':
case 'version':
case 'old_version':
case 'new_version':
case 'display_name':
case 'roles':
case 'old_role':
case 'new_role':
if ( 'name' === $data && 'profiles' === $context ) {
$data = 'display_name';
}
$tok_value = $this->get_stream_meta_data( $record, $data );
if ( empty( $tok_value ) && 'roles' === $data ) {
$tok_value = $this->get_stream_meta_data( $record, 'new_role' ); // Get new role from record.
// Get old role from record.
if ( empty( $tok_value ) ) {
$tok_value = $this->get_stream_meta_data( $record, 'userroles' );
}
// Get current role from record.
if ( empty( $tok_value ) && isset( $record->user_role ) ) {
$tok_value = $record->user_role;
}
}
break;
case 'title':
if ( 'comments' === $context ) {
$tok_value = $record->summary;
} else {
if ( 'page' === $context || 'post' === $context ) {
$data = 'post_title';
} elseif ( 'menus' === $record->connector ) {
$data = 'name';
}
$tok_value = $this->get_stream_meta_data( $record, $data );
}
break;
case 'author':
$tok_value = $this->get_author_data_token_value( $record, $connector, $context, $data );
break;
case 'status':
case 'webtrust':
$value = '';
if ( 'sucuri_scan' === $context ) {
$value = $this->get_sucuri_scan_token_value( $record, $data );
}
$tok_value = $value;
break;
case 'details':
case 'result':
$tok_value = $this->get_result_data_token_value( $record, $context, $data );
break;
case 'type':
if ( 'backups' === $context ) {
$tok_value = $this->get_stream_meta_data( $record, $data );
} else {
$tok_value = $token;
}
break;
default:
$tok_value = 'N/A';
break;
}
/**
* @since 5.4.0.8 .
*/
return apply_filters( 'mainwp_child_get_reports_section_token_value', $tok_value, $record, $data, $context, $token, $section );
}
/**
* Get the Stream meta data for a certain record.
*
* @param object $record Object containing the record data.
* @param string $data Data to process.
*
* @return string Return the meta data value.
*/
public function get_stream_meta_data( $record, $data ) { //phpcs:ignore -- NOSONAR - complex.
if ( empty( $record ) ) {
return '';
}
$meta_key = $data;
$value = '';
if ( isset( $record->meta ) ) {
$meta = $record->meta;
if ( isset( $meta[ $meta_key ] ) ) {
$value = $meta[ $meta_key ];
$value = ( 'user_meta' === $meta_key && isset( $value[1] ) ) ? $value[1] : current( $value );
if ( 'author_meta' === $meta_key ) {
$value = maybe_unserialize( $value );
if ( is_array( $value ) ) {
$value = $value['display_name'];
// fix empty author value!
if ( empty( $value ) && isset( $value['agent'] ) && ! empty( $value['agent'] ) ) {
$value = $value['agent'];
}
}
if ( ! is_string( $value ) ) {
$value = '';
}
}
}
}
return $value;
}
/**
* Get the author data token value.
*
* @param object $record Object containing the record data.
* @param string $connector Record connector.
* @param string $context Record context.
*
* @return string Author data token value.
*/
private function get_author_data_token_value( $record, $connector, $context ) {
if ( 'comment' === $connector ) {
$data = 'user_name';
} else {
$data = 'user_meta';
}
$value = $this->get_stream_meta_data( $record, $data );
if ( empty( $value ) && 'comments' === $context ) {
$value = esc_html__( 'Guest', 'mainwp-child' );
}
// check compatibility with old meta data.
if ( empty( $value ) ) {
$value = $this->get_stream_meta_data( $record, 'author_meta' );
}
return $value;
}
/**
* Get the result data token value.
*
* @param object $record Object containing the record data.
* @param string $context Record context.
* @param string $data Data to process.
*
* @return string Result data token value.
*/
private function get_result_data_token_value( $record, $context, $data ) { //phpcs:ignore -- NOSONAR - ignore complex.
if ( 'mainwp_maintenance' === $context && 'details' === $data ) {
$tok_value = $this->get_mainwp_maintenance_token_value( $record, $data );
} elseif ( 'wordfence_scan' === $context || 'mainwp_maintenance' === $context ) {
$meta_value = $this->get_stream_meta_data( $record, $data );
if ( 'wordfence_scan' === $context ) {
if ( 'result' === $data ) {
$completed_log = esc_html__( 'Scan complete. Congratulations, no new problems found.', 'mainwp-child' );
$str_loc1 = MainWP_Child_Wordfence::instance()->get_substr( $completed_log, 2 ); // loc string.
$str_loc2 = MainWP_Child_Wordfence::instance()->get_substr( $completed_log, 3 ); // loc string.
$congra_str_loc = str_replace( $str_loc1, '', $str_loc2 );
$congra_str_loc = trim( $congra_str_loc, ' ,' );
// SUM_FINAL:Scan complete. You have xxx new issues to fix. See below.
// SUM_FINAL:Scan complete. Congratulations, no new problems found.
if ( stripos( $meta_value, 'Congratulations' ) || stripos( $meta_value, $congra_str_loc ) || $meta_value === $completed_log ) {
$meta_value = 'No issues detected';
} elseif ( stripos( $meta_value, 'You have' ) ) {
$meta_value = 'Issues Detected';
} else {
$meta_value = '';
}
} elseif ( 'details' === $data ) {
$meta_value = str_replace( 'SUM_FINAL:', '', $meta_value );
}
}
$tok_value = $meta_value;
} elseif ( 'ithemes_scan' === $context ) {
$meta_value = $this->get_stream_meta_data( $record, $data );
if ( 'result' === $data ) {
if ( empty( $meta_value ) ) {
$meta_value = 'No issues detected';
} else {
$meta_value = 'Issues Detected';
}
} elseif ( 'details' === $data ) {
if ( empty( $meta_value ) ) {
$meta_value = 'Scan complete. Congratulations, no new problems found.';
} else {
$meta_value = 'Scan complete. You have ' . intval( $meta_value ) . ' new issues to fix.';
}
}
$tok_value = $meta_value;
}
return $tok_value;
}
/**
* Get the Sucuri scan token value.
*
* @param object $record Object containing the record data.
* @param string $data Data to process.
*
* @return string Sucuri scan token value.
*/
private function get_sucuri_scan_token_value( $record, $data ) { //phpcs:ignore -- NOSONAR - ignore complex.
$tok_value = '';
$scan_data = $this->get_stream_meta_data( $record, 'scan_data' );
if ( ! empty( $scan_data ) ) {
$scan_data = json_decode( base64_decode( $scan_data ), true ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions -- base64_encode required for backwards compatibility.
if ( is_array( $scan_data ) ) {
$blacklisted = $scan_data['blacklisted'];
$malware_exists = $scan_data['malware_exists'];
$status = array();
if ( $blacklisted ) {
$status[] = esc_html__( 'Site Blacklisted', 'mainwp-child' );
}
if ( $malware_exists ) {
$status[] = esc_html__( 'Site With Warnings', 'mainwp-child' );
}
if ( 'status' === $data ) {
$tok_value = ! empty( $status ) ? implode( ', ', $status ) : esc_html__( 'Verified Clear', 'mainwp-child' );
} elseif ( 'webtrust' === $data ) {
$tok_value = $blacklisted ? esc_html__( 'Site Blacklisted', 'mainwp-child' ) : esc_html__( 'Trusted', 'mainwp-child' );
}
}
} else {
$tok_value = $this->get_stream_meta_data( $record, $data );
}
return $tok_value;
}
/**
* Get the Maintanence token value.
*
* @param object $record Object containing the record data.
* @param string $data Data to process.
*
* @return string Maintanence token value.
*/
private function get_mainwp_maintenance_token_value( $record, $data ) {
$maintenance_details = array(
'revisions' => esc_html__( 'Delete all post revisions', 'mainwp-child' ),
'revisions_max' => esc_html__( 'Delete all post revisions, except for the last:', 'mainwp-child' ),
'autodraft' => esc_html__( 'Delete all auto draft posts', 'mainwp-child' ),
'trashpost' => esc_html__( 'Delete trash posts', 'mainwp-child' ),
'spam' => esc_html__( 'Delete spam comments', 'mainwp-child' ),
'pending' => esc_html__( 'Delete pending comments', 'mainwp-child' ),
'trashcomment' => esc_html__( 'Delete trash comments', 'mainwp-child' ),
'tags' => esc_html__( 'Delete tags with 0 posts associated', 'mainwp-child' ),
'categories' => esc_html__( 'Delete categories with 0 posts associated', 'mainwp-child' ),
'optimize' => esc_html__( 'Optimize database tables', 'mainwp-child' ),
'transients_expired' => esc_html__( 'Delete expired transients', 'mainwp-child' ),
'transients_all' => esc_html__( 'Delete all transients', 'mainwp-child' ),
);
$meta_value = $this->get_stream_meta_data( $record, $data );
$meta_value = explode( ',', $meta_value );
$details = array();
if ( is_array( $meta_value ) ) {
foreach ( $meta_value as $mt ) {
if ( isset( $maintenance_details[ $mt ] ) ) {
if ( 'revisions_max' === $mt ) {
$max_revisions = $this->get_stream_meta_data( $record, 'revisions' );
$dtl = $maintenance_details['revisions_max'] . ' ' . $max_revisions;
} else {
$dtl = $maintenance_details[ $mt ];
}
$details[] = $dtl;
}
}
}
return implode( ', ', $details );
}
/**
* Method wfc_getblockedcount()
*
* Get the number of blocked attackes.
*
* @param string $grouping Contains the grouping blocked attacks to count blocked attacks.
*
* @return array Action result.
*/
public function wfc_getblockedcount( $grouping = null ) {
try {
MainWP_Helper::instance()->check_classes_exists( array( '\wfDB', '\wfConfig' ) );
MainWP_Helper::instance()->check_methods( '\wfDB', array( 'networkTable' ) );
MainWP_Helper::instance()->check_methods( '\wfConfig', array( 'get' ) );
} catch ( MainWP_Exception $e ) {
return 0;
}
$fromDays = (int) static::$date_from;
$toDays = (int) static::$date_to;
if ( $fromDays <= 0 ) {
$interval_fromDays = 'FLOOR(UNIX_TIMESTAMP(DATE_SUB(NOW(), interval 7 day)) / 86400)';
switch ( \wfConfig::get( 'email_summary_interval', 'weekly' ) ) {
case 'daily':
$interval_fromDays = 'FLOOR(UNIX_TIMESTAMP(DATE_SUB(NOW(), interval 1 day)) / 86400)';
break;
case 'monthly':
$interval_fromDays = 'FLOOR(UNIX_TIMESTAMP(DATE_SUB(NOW(), interval 1 month)) / 86400)';
break;
default:
break;
}
} else {
$interval_fromDays = floor( $fromDays / 86400 );
}
if ( $toDays <= 0 ) {
$interval_toDays = 'FLOOR(UNIX_TIMESTAMP(DATE_SUB(NOW(), interval 0 day)) / 86400)';
} else {
$interval_toDays = floor( $toDays / 86400 );
}
// Possible values for blockType: throttle, manual, brute, fakegoogle, badpost, country, advanced, blacklist, waf.
$groupingWHERE = '';
switch ( $grouping ) {
case MainWP_Child_Wordfence::BLOCK_TYPE_COMPLEX:
$groupingWHERE = ' AND blockType IN ("fakegoogle", "badpost", "country", "advanced", "waf")';
break;
case MainWP_Child_Wordfence::BLOCK_TYPE_BRUTE_FORCE:
$groupingWHERE = ' AND blockType IN ("throttle", "brute")';
break;
case MainWP_Child_Wordfence::BLOCK_TYPE_BLACKLIST:
$groupingWHERE = ' AND blockType IN ("blacklist", "manual")';
break;
default:
$groupingWHERE = ' AND blockType IN ("fakegoogle", "badpost", "country", "advanced", "waf", "throttle", "brute", "blacklist", "manual" )';
break;
}
global $wpdb;
$table_wfBlockedIPLog = \wfDB::networkTable( 'wfBlockedIPLog' );
$count_sql = 'SELECT SUM(blockCount) as blockCount'
. ' FROM ' . $table_wfBlockedIPLog
. ' WHERE unixday >= ' . $interval_fromDays
. ' AND unixday <= ' . $interval_toDays
. $groupingWHERE;
$count = $wpdb->get_var( $count_sql ); // phpcs:ignore -- unprepared SQL.
return intval( $count );
}
/**
* Method wfc_getissuecount()
*
* Get the issues found in most recent scan.
*
* @return array Action result.
*/
public function wfc_getissuecount() {
try {
MainWP_Helper::instance()->check_classes_exists( array( '\wfIssues' ) );
$wfIssues = new \wfIssues();
MainWP_Helper::instance()->check_methods( $wfIssues, array( 'getIssueCount' ) );
} catch ( MainWP_Exception $e ) {
return 0;
}
$issueCount = 0;
if ( $wfIssues ) {
$issueCount = $wfIssues->getIssueCount();
}
return $issueCount;
}
/**
* Method ithemes_getEventsCount()
*
* Get the number of Events.
*
* @param string $event event to count.
*
* @return array Action result.
*/
public function ithemes_query_events_count( $event = 'blocked' ) {
try {
MainWP_Helper::instance()->check_classes_exists( array( '\ITSEC_Dashboard_Util' ) );
MainWP_Helper::instance()->check_methods( '\ITSEC_Dashboard_Util', array( 'count_events' ) );
} catch ( MainWP_Exception $e ) {
return 0;
}
$period = array(
'start' => date( 'Y-m-d 00:00:00', static::$date_from ), // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
'end' => date( 'Y-m-d 23:59:59', static::$date_to ), // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
);
$count = 0;
if ( 'blocked' === $event ) {
$blocked = \ITSEC_Dashboard_Util::count_events(
array(
'blacklist-four_oh_four',
'blacklist-brute_force',
'blacklist-brute_force_admin_user',
'blacklist-recaptcha',
'lockout-user',
'lockout-username',
'lockout-host',
'fingerprint-login-blocked',
'recaptcha-empty',
'recaptcha-invalid',
'fingerprint-session-destroyed',
),
$period
);
$count = is_wp_error( $blocked ) ? 0 : array_sum( $blocked );
}
return $count;
}
/**
* Shows all lockouts currently in the database.
*
* @since 4.0
*
* @param string $type 'all', 'host', 'user' or 'username'.
* @param array $args Additional arguments.
*
* @return array all lockouts in the system
*/
public function ithemes_get_lockouts( $type = 'all', $args = array() ) { // phpcs:ignore -- NOSONAR - required to achieve desired results, pull request solutions appreciated.
try {
MainWP_Helper::instance()->check_classes_exists( array( '\ITSEC_Dashboard_Util' ) );
MainWP_Helper::instance()->check_methods( '\ITSEC_Dashboard_Util', array( 'count_events' ) );
} catch ( MainWP_Exception $e ) {
return 0;
}
global $wpdb;
$where = '';
$limit = '';
$order = '';
$wheres = array();
switch ( $type ) {
case 'host':
$wheres[] = "`lockout_host` IS NOT NULL AND `lockout_host` != ''";
break;
case 'user':
$wheres[] = '`lockout_user` != 0';
break;
case 'username':
$wheres[] = "`lockout_username` IS NOT NULL AND `lockout_username` != ''";
break;
default:
break;
}
if ( isset( $args['after'] ) ) {
$after = is_int( $args['after'] ) ? $args['after'] : strtotime( $args['after'] );
$after = date( 'Y-m-d H:i:s', $after ); // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
$wheres[] = "`lockout_start_gmt` > '{$after}'";
}
if ( isset( $args['before'] ) ) {
$before = is_int( $args['before'] ) ? $args['before'] : strtotime( $args['before'] );
$before = date( 'Y-m-d H:i:s', $before ); // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date
$wheres[] = "`lockout_start_gmt` < '{$before}'";
}
if ( $wheres ) {
$where = ' WHERE ' . implode( ' AND ', $wheres );
}
if ( ! empty( $args['orderby'] ) ) {
$columns = array( 'lockout_id', 'lockout_start', 'lockout_expire' );
$direction = isset( $args['order'] ) ? $args['order'] : 'DESC';
if ( ! in_array( $args['orderby'], $columns, true ) ) {
$args['orderby'] = 'lockout_id';
}
if ( ! in_array( $direction, array( 'ASC', 'DESC' ), true ) ) {
$direction = 'DESC';
}
$order = " ORDER BY `{$args['orderby']}` $direction";
}
if ( isset( $args['return'] ) && 'count' === $args['return'] ) {
$select = 'SELECT COUNT(1) as COUNT';
$is_count = true;
} else {
$select = "SELECT `{$wpdb->base_prefix}itsec_lockouts`.*";
$is_count = false;
}
$sql = "{$select} FROM `{$wpdb->base_prefix}itsec_lockouts` {$where}{$order}{$limit};";
$results = $wpdb->get_results( $sql, ARRAY_A ); // phpcs:ignore -- unprepared SQL.
if ( $is_count ) {
return $results ? $results[0]['COUNT'] : 0;
}
if ( $results ) {
foreach ( $results as $result ) {
wp_cache_add( $result['lockout_id'], $result, 'itsec-lockouts' );
}
}
return $results;
}
}