# defender-security/3.0.1/src/controller/scan.php
Defender Security – Malware Scanner, Login Security & Firewall, version 3.0.1. 750 lines.
- Page: https://pluginprobe.com/plugins/defender-security/3.0.1/code/src/controller/scan.php
- Raw: https://pluginprobe.com/plugins/defender-security/3.0.1/raw/src/controller/scan.php
- Modified: 2022-06-16T08:36:34+00:00
Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/defender-security/3.0.1/code/src/controller/scan.php#L10-L20`.
```php
register_page(
esc_html__( 'Malware Scanning', 'wpdef' ),
$this->slug,
array(
&$this,
'main_view',
),
$this->parent_slug
);
$this->model = new \WP_Defender\Model\Setting\Scan();
$this->service = new \WP_Defender\Component\Scan();
$this->register_routes();
add_action( 'defender_enqueue_assets', array( &$this, 'enqueue_assets' ) );
add_action( 'wp_ajax_defender_process_scan', array( &$this, 'process' ) );
add_action( 'wp_ajax_nopriv_defender_process_scan', array( &$this, 'process' ) );
add_action( 'defender/async_scan', array( &$this, 'process' ) );
// Clean up data after successful core update.
add_action( '_core_updated_successfully', array( &$this, 'clean_up_data' ) );
global $pagenow;
// @since 2.6.2
if (
is_admin() &&
'plugins.php' === $pagenow &&
apply_filters( 'wd_display_vulnerability_warnings', true )
) {
$this->service->display_vulnerability_warnings();
}
// Schedule a time to clear completed action scheduler logs.
if ( ! wp_next_scheduled( 'wpdef_clear_scan_logs' ) ) {
wp_schedule_event( time(), 'weekly', 'wpdef_clear_scan_logs' );
}
add_action( 'wpdef_clear_scan_logs', array( $this, 'clear_scan_logs' ) );
}
/**
* Clean up data after core updating.
*/
public function clean_up_data() {
$this->service->clean_up();
}
/**
* Start a scan.
*
* @param Request $request
*
* @return Response
* @throws \Exception
* @defender_route
*/
public function start( Request $request ) {
$model = Model_Scan::create();
if ( is_object( $model ) && ! is_wp_error( $model ) ) {
$this->log( 'Initial ping self', 'scan.log' );
$this->do_async_scan( 'scan' );
return new Response(
true,
array(
'status' => $model->status,
'status_text' => $model->get_status_text(),
'percent' => 0,
)
);
}
return new Response(
false,
array(
'message' => __( 'A scan is already in progress', 'wpdef' ),
)
);
}
/**
* Use this for self ping, so it can both run in background and active mode with good performance.
*
* @return mixed
* @throws \ReflectionException
* @defender_route
* @is_public
*/
public function process() {
if ( $this->service->has_lock() ) {
$this->log( 'Fallback as already a process is running', 'scan.log' );
return;
}
// This creates file lock, for make sure only 1 process run as a time.
$this->service->create_lock();
// Check if the ping is from self or not.
$ret = $this->service->process();
$this->log( 'process done, queue for next', 'scan.log' );
if ( false === $ret ) {
// Ping self.
$this->log( 'Scan not done, pinging', 'scan.log' );
$this->service->remove_lock();
$this->process();
} else {
$this->service->remove_lock();
}
}
/**
* Query status.
*
* @return Response
* @defender_route
*/
public function status() {
$idle_scan = wd_di()->get( Model_Scan::class )->get_idle();
if ( is_object( $idle_scan ) ) {
$this->service->update_idle_scan_status();
return new Response( false, $idle_scan->to_array() );
}
$scan = Model_Scan::get_active();
if ( is_object( $scan ) ) {
return new Response( false, $scan->to_array() );
}
$scan = Model_Scan::get_last();
if ( is_object( $scan ) && ! is_wp_error( $scan ) ) {
return new Response( true, $scan->to_array() );
}
return new Response(
false,
array(
'message' => __( 'Error during scanning', 'wpdef' ),
)
);
}
/**
* Cancel current scan.
*
* @return Response
* @defender_route
*/
public function cancel() {
$component = new \WP_Defender\Component\Scan();
$component->cancel_a_scan();
$last = Model_Scan::get_last();
if ( is_object( $last ) && ! is_wp_error( $last ) ) {
$last = $last->to_array();
}
return new Response(
true,
array(
'scan' => $last,
)
);
}
/**
* A central controller to pass any request from frontend to scan item.
*
* @param Request $request
*
* @return Response
* @defender_route
*/
public function item_hub( Request $request ) {
$data = $request->get_data(
array(
'id' => array(
'type' => 'int',
'sanitize' => 'sanitize_text_field',
),
'intention' => array(
'type' => 'string',
'sanitize' => 'sanitize_text_field',
),
)
);
$id = $data['id'] ?? false;
$intention = $data['intention'] ?? false;
if ( false === $id || false === $intention || ! in_array(
$intention,
array(
'pull_src',
'resolve',
'ignore',
'delete',
'unignore',
)
) ) {
wp_die();
}
$scan = Model_Scan::get_last();
$item = $scan->get_issue( $id );
if ( is_object( $item ) && $item->has_method( $intention ) ) {
$result = $item->$intention();
if ( is_wp_error( $result ) ) {
return new Response(
false,
array(
'message' => $result->get_error_message(),
)
);
} elseif ( isset( $result['type_notice'] ) ) {
return new Response(
true,
$result
);
}
// Refresh scan instance.
$scan = Model_Scan::get_last();
$result['scan'] = $scan->to_array();
return new Response( true, $result );
}
return new Response( false, array() );
}
/**
* Process for bulk action.
* There is no Update-intention because it is a lengthy process. There may not be enough execution time.
*
* @param Request $request
*
* @defender_route
* @return Response
*/
public function bulk_hub( Request $request ) {
$data = $request->get_data(
array(
'items' => array(
'type' => 'array',
'sanitize' => 'sanitize_text_field',
),
'bulk' => array(
'type' => 'string',
'sanitize' => 'sanitize_text_field',
),
)
);
$items = $data['items'] ?? array();
$intention = $data['bulk'] ?? false;
if (
empty( $items )
|| ! is_array( $items )
|| false === $intention
|| ! in_array( $intention, array( 'ignore', 'unignore', 'delete' ), true )
) {
return new Response( false, array() );
}
$scan = Model_Scan::get_last();
if ( ! is_object( $scan ) ) {
return new Response( false, array() );
}
foreach ( $items as $id ) {
if ( 'ignore' === $intention ) {
$scan->ignore_issue( (int) $id );
} elseif ( 'unignore' === $intention ) {
$scan->unignore_issue( (int) $id );
} elseif ( 'delete' === $intention ) {
$item = $scan->get_issue( (int) $id );
if ( is_object( $item ) ) {
$item->delete();
}
}
}
return new Response(
true,
array(
'scan' => $scan->to_array(),
)
);
}
/**
* Endpoint for saving data.
* @since 2.7.0 Add Scheduled Scanning to Malware settings and hide it on Malware Scanning - Reporting.
* Also, the backward compatibility of settings for Scan and Malware_Report models.
*
* @param Request $request
*
* @defender_route
* @return Response
*/
public function save_settings( Request $request ) {
$data = $request->get_data_by_model( $this->model );
// Case#1: enable all child options, if parent and all child options are disabled, so that there is no notice when saving.
if (
! $data['integrity_check']
&& ! $data['check_core']
&& ! $data['check_plugins']
) {
$data['check_core'] = true;
$data['check_plugins'] = true;
}
// Case#2: Suspicious code is activated BUT File change detection is deactivated then show the notice.
if ( $data['scan_malware'] && ! $data['integrity_check'] ){
$response = array(
'type_notice' => 'info',
'message' => __( "To reduce false-positive results, we recommend enabling" .
" File change detection options for all scan types while the" .
" Suspicious code option is enabled.", 'wpdef' ),
);
} else {
// Prepare response message for usual successful case.
$response = array(
'message' => __( 'Your settings have been updated.', 'wpdef' ),
);
}
// Additional cases are in the Scan model.
$report_change = false;
// If 'Scheduled Scanning' is checked then need to change Malware_Report.
if ( true === $data['scheduled_scanning'] ) {
$report = new Malware_Report();
$report_change = true;
$report->frequency = $data['frequency'];
$report->day = $data['day'];
$report->day_n = $data['day_n'];
$report->time = $data['time'];
// Disable 'Scheduled Scanning'.
} elseif ( true === $this->model->scheduled_scanning && false === $data['scheduled_scanning'] ) {
$report = new Malware_Report();
$report_change = true;
$report->status = \WP_Defender\Model\Notification::STATUS_DISABLED;
}
$this->model->import( $data );
if ( $this->model->validate() ) {
// Todo: need to disable Malware_Notification & Malware_Report if all scan settings are deactivated?
$this->model->save();
// Save Report's changes.
if ( $report_change ) {
$report->save();
}
Config_Hub_Helper::set_clear_active_flag();
return new Response(
true,
array_merge( $response, $this->data_frontend() )
);
} else {
return new Response(
false,
array_merge(
array(
'message' => $this->model->get_formatted_errors(),
),
$this->data_frontend()
)
);
}
}
/**
* Get the issues mainly for pagination request.
*
* @param Request $request
*
* @return Response
* @defender_route
*/
public function get_issues( Request $request ) {
$data = $request->get_data(
array(
'scenario' => array(
'type' => 'string',
'sanitize' => 'sanitize_text_field',
),
'type' => array(
'type' => 'string',
'sanitize' => 'sanitize_text_field',
),
'per_page' => array(
'type' => 'string',
'sanitize' => 'sanitize_text_field',
),
'paged' => array(
'type' => 'int',
'sanitize' => 'sanitize_text_field',
),
)
);
// Validate the request.
$v = new Validator( $data, array() );
$v->rule( 'required', array( 'scenario', 'type', 'per_page', 'paged' ) );
if ( ! $v->validate() ) {
return new Response(
false,
array(
'message' => '',
)
);
}
$scan = Model_Scan::get_last();
$issues = $scan->to_array( $data['per_page'], $data['paged'], $data['type'] );
return new Response(
true,
array(
'issue' => $issues['issues_items'],
'ignored' => $issues['ignored_items'],
'paging' => $issues['paging'],
'count' => $issues['count'],
)
);
}
/**
* Render main page.
*/
public function main_view() {
$this->render( 'main' );
}
/**
* Enqueue assets.
*/
public function enqueue_assets() {
if ( ! $this->is_page_active() ) {
return;
}
wp_localize_script( 'def-scan', 'scan', $this->data_frontend() );
wp_enqueue_script( 'def-scan' );
wp_enqueue_script( 'clipboard' );
$this->enqueue_main_assets();
wp_enqueue_script( 'def-codemirror', defender_asset_url( '/assets/js/vendor/codemirror/codemirror.js' ) );
wp_enqueue_script( 'def-codemirror-xml', defender_asset_url( '/assets/js/vendor/codemirror/xml/xml.js' ) );
wp_enqueue_script(
'def-codemirror-clike',
defender_asset_url( '/assets/js/vendor/codemirror/clike/clike.js' )
);
wp_enqueue_script( 'def-codemirror-css', defender_asset_url( '/assets/js/vendor/codemirror/css/css.js' ) );
wp_enqueue_script(
'def-codemirror-javascript',
defender_asset_url( '/assets/js/vendor/codemirror/javascript/javascript.js' )
);
wp_enqueue_script(
'def-codemirror-htmlmixed',
defender_asset_url( '/assets/js/vendor/codemirror/htmlmixed/htmlmixed.js' )
);
wp_enqueue_script( 'def-codemirror-php', defender_asset_url( '/assets/js/vendor/codemirror/php/php.js' ) );
wp_enqueue_script(
'def-codemirror-merge',
defender_asset_url( '/assets/js/vendor/codemirror/merge/merge.js' )
);
wp_enqueue_script( 'def-diff-match-patch', defender_asset_url( '/assets/js/vendor/diff-match-patch.js' ) );
wp_enqueue_script(
'def-codemirror-annotatescrollbar',
defender_asset_url( '/assets/js/vendor/codemirror/scroll/annotatescrollbar.js' )
);
wp_enqueue_script(
'def-codemirror-simplescrollbars',
defender_asset_url( '/assets/js/vendor/codemirror/scroll/simplescrollbars.js' )
);
wp_enqueue_script(
'def-codemirror-searchcursor',
defender_asset_url( '/assets/js/vendor/codemirror/search/searchcursor.js' )
);
wp_enqueue_script(
'def-codemirror-matchonscrollbars',
defender_asset_url( '/assets/js/vendor/codemirror/search/matchesonscrollbar.js' )
);
wp_enqueue_style( 'def-codemirror', defender_asset_url( '/assets/js/vendor/codemirror/codemirror.css' ) );
wp_enqueue_style( 'def-codemirror-dracula', defender_asset_url( '/assets/js/vendor/codemirror/dracula.css' ) );
wp_enqueue_style(
'def-codemirror-merge',
defender_asset_url( '/assets/js/vendor/codemirror/merge/merge.css' )
);
wp_enqueue_style(
'def-codemirror-matchonscrollbars',
defender_asset_url( '/assets/js/vendor/codemirror/search/matchesonscrollbar.css' )
);
wp_enqueue_style(
'def-codemirror-simplescrollbars',
defender_asset_url( '/assets/js/vendor/codemirror/scroll/simplescrollbars.css' )
);
}
/**
* @return array[]
*/
public function to_array() {
$scan = Model_Scan::get_active();
$last = Model_Scan::get_last();
if ( ! is_object( $scan ) && ! is_object( $last ) ) {
$scan = null;
} else {
$scan = is_object( $scan ) ? $scan->to_array() : $last->to_array();
}
return array_merge(
array(
'scan' => $scan,
'report' => array(
'enabled' => true,
'frequency' => 'weekly',
),
),
$this->dump_routes_and_nonces()
);
}
public function remove_settings() {
( new \WP_Defender\Model\Setting\Scan() )->delete();
}
public function remove_data() {
delete_site_option( Model_Scan::IGNORE_INDEXER );
}
/**
* This should set up optimizing configurations for this module.
* Todo: need?
*/
public function optimize_configs() {
$settings = new \WP_Defender\Model\Setting\Scan();
$settings->save();
// Schedule it.
$report = new Malware_Report();
$report->save();
}
/**
* @return array
*/
public function data_frontend() {
$scan = Model_Scan::get_active();
$last = Model_Scan::get_last();
$per_page = 10;
$paged = 1;
if ( ! is_object( $scan ) && ! is_object( $last ) ) {
$scan = null;
} else {
$scan = is_object( $scan ) ? $scan->to_array( $per_page, $paged ) : $last->to_array( $per_page, $paged );
}
$settings = new \WP_Defender\Model\Setting\Scan();
$report = wd_di()->get( Malware_Report::class );
$report_text = __( 'Automatic scans are disabled', 'wpdef' );
if ( $settings->scheduled_scanning && isset( $settings->frequency ) ) {
$report_text = sprintf( __( 'Automatic scans are
running %s', 'wpdef' ), $settings->frequency );
}
$misc = ( new \WP_Defender\Behavior\WPMUDEV() )->is_pro()
? array(
'days_of_week' => $this->get_days_of_week(),
'times_of_day' => $this->get_times(),
'timezone_text' => sprintf(
/* translators: %s - timezone, %s - time */
__(
'Your timezone is set to %1$s, so your current time is %2$s.',
'wpdef'
),
wp_timezone_string(),
date( 'H:i', current_time( 'timestamp' ) )// phpcs:ignore
),
'show_notice' => ! $settings->scheduled_scanning
&& isset( $_GET['enable'] ) && 'scheduled_scanning' === $_GET['enable'],
)
: array();
// Todo: add logic for deactivated scan settings. Maybe display some notice.
$data = array(
'scan' => $scan,
'settings' => $settings->export(),
'report' => $report_text,
'active_tools' => array(
'integrity_check' => $settings->integrity_check,
'check_known_vuln' => $settings->check_known_vuln,
'scan_malware' => $settings->scan_malware,
'scheduled_scanning' => $settings->scheduled_scanning,
),
'notification' => $report->to_string(),
'next_run' => $report->get_next_run_as_string(),
'misc' => $misc,
);
return array_merge( $data, $this->dump_routes_and_nonces() );
}
public function import_data( $data ) {
$model = $this->model;
$model->import( $data );
if ( $model->validate() ) {
$model->save();
}
}
/**
* @param bool $is_pro
*
* @return bool
*/
private function is_any_active( $is_pro ) {
$settings = new \WP_Defender\Model\Setting\Scan();
$integrity_check = $settings->is_any_filetypes_checked();
if ( ! $integrity_check && ! $is_pro ) {
return false;
} elseif (
( ! $integrity_check && ! $settings->check_known_vuln && ! $settings->scan_malware )
&& ! $is_pro
) {
return false;
}
return true;
}
/**
* @return array
*/
public function export_strings() {
$strings = array();
$is_pro = ( new \WP_Defender\Behavior\WPMUDEV() )->is_pro();
if ( $this->is_any_active( $is_pro ) ) {
$strings[] = __( 'Active', 'wpdef' );
} else {
$strings[] = __( 'Inactive', 'wpdef' );
}
$scan_report = new Malware_Report();
$scan_notification = new \WP_Defender\Model\Notification\Malware_Notification();
if ( 'enabled' === $scan_notification->status ) {
$strings[] = __( 'Email notifications active', 'wpdef' );
}
if ( $is_pro && 'enabled' === $scan_report->status ) {
$strings[] = sprintf(
__( 'Email reports sending %s', 'wpdef' ),
$scan_report->frequency
);
} elseif ( ! $is_pro ) {
$strings[] = sprintf(
__( 'Email report inactive %s', 'wpdef' ),
'Pro'
);
}
return $strings;
}
/**
* @param array $config
* @param bool $is_pro
*
* @return array
*/
public function config_strings( $config, $is_pro ) {
$strings = [];
$strings[] = $this->service->is_any_scan_active( $config, $is_pro )
? __( 'Active', 'wpdef' )
: __( 'Inactive', 'wpdef' );
if ( 'enabled' === $config['notification'] ) {
$strings[] = __( 'Email notifications active', 'wpdef' );
}
if ( $is_pro && 'enabled' === $config['report'] ) {
$strings[] = sprintf(
/* translators: ... */
__( 'Email reports sending %s', 'wpdef' ),
$config['frequency']
);
} elseif ( ! $is_pro ) {
$strings[] = sprintf(
/* translators: ... */
__( 'Email report inactive %s', 'wpdef' ),
'Pro'
);
}
return $strings;
}
/**
* Triggers the asynchronous scan.
*
* @param string $type Denotes type of the scan from the following four possible values scan, install, hub or report.
*/
public function do_async_scan( $type ) {
wd_di()->get( Model_Scan::class )->delete_idle();
as_enqueue_async_action(
'defender/async_scan',
array(
'type' => $type
),
'defender'
);
}
/**
* Clear completed action scheduler logs.
*
* @since 2.6.5
*/
public function clear_scan_logs() {
$result = \WP_Defender\Component\Scan::clear_logs();
if ( isset( $result['error'] ) ) {
$this->log( 'WP CRON Error : ' . $result['error'], 'scan.log' );
}
}
}
```