register_routes(); $this->model = $this->get_model(); $this->service = wd_di()->get( User_Agent_Service::class ); add_action( 'defender_enqueue_assets', array( $this, 'enqueue_assets' ) ); } /** * Returns an instance of the User_Agent_Lockout model class. * * @return User_Agent_Lockout The User_Agent_Lockout model class. */ private function get_model() { if ( is_object( $this->model ) ) { return $this->model; } return new User_Agent_Lockout(); } /** * Enqueues scripts and styles for this page. * Only enqueues assets if the page is active. */ public function enqueue_assets() { if ( ! $this->is_page_active() ) { return; } } /** * Save settings. * * @param Request $request The request object containing new settings data. * * @return Response * @defender_route * @throws Exception If the table is not defined. */ public function save_settings( Request $request ) { $data = $request->get_data_by_model( $this->model ); $old_enabled = $this->model->enabled; $old_malicious_bot_enabled = $this->model->malicious_bot_enabled; $old_fake_bots_enabled = $this->model->fake_bots_enabled; $prev_data = $this->model->export(); $this->model->import( $data ); if ( $this->model->validate() ) { $arr_blocklist = $this->model->get_lockout_list( 'blocklist' ); if ( is_array( $arr_blocklist ) && array() !== $arr_blocklist ) { // Update 'Custom User Agents' if 'Blocklist Presets' is enabled. if ( $data['blocklist_presets'] && is_array( $data['blocklist_preset_values'] ) && array() !== $data['blocklist_preset_values'] ) { // Check and remove duplicates. $common_result = array_intersect( $arr_blocklist, $data['blocklist_preset_values'] ); if ( array() !== $common_result ) { $arr_blocklist = User_Agent_Service::check_and_remove_duplicates( $arr_blocklist, $common_result ); $this->model->blacklist = implode( PHP_EOL, $arr_blocklist ); } } // Update 'Custom User Agents' if 'Scripts Presets' is enabled. if ( $data['script_presets'] && is_array( $data['script_preset_values'] ) && array() !== $data['script_preset_values'] ) { // Check and remove duplicates. $common_result = array_intersect( $arr_blocklist, $data['script_preset_values'] ); if ( array() !== $common_result ) { $arr_blocklist = User_Agent_Service::check_and_remove_duplicates( $arr_blocklist, $common_result ); $this->model->blacklist = implode( PHP_EOL, $arr_blocklist ); } } } $this->model->save(); Config_Hub_Helper::set_clear_active_flag(); // Attention: next actions after saving model changes. if ( ( ! $this->model->enabled && $old_enabled ) || ( ! $this->model->malicious_bot_enabled && $old_malicious_bot_enabled ) ) { wd_di()->get( Malicious_Bot::class )->remove_data(); } elseif ( ( $this->model->enabled && ! $old_enabled && $this->model->malicious_bot_enabled ) || ( $this->model->malicious_bot_enabled && ! $old_malicious_bot_enabled && $this->model->enabled ) ) { wd_di()->get( Malicious_Bot::class )->rotate_hash(); } if ( ( ! $this->model->enabled && $old_enabled ) || ( ! $this->model->fake_bots_enabled && $old_fake_bots_enabled ) ) { wd_di()->get( Fake_Bot_Detection::class )->remove_data(); } // Maybe track. if ( ! defender_is_wp_cli() ) { // Track if UA Module is activated/deactivated OR there is a change in State on Add/Remove Custom User Agents (Allowlist/Blocklist). if ( ( $old_enabled !== $data['enabled'] ) || ( $this->is_feature_state_changed( $prev_data['blacklist'], $data['blacklist'] ) ) || ( $this->is_feature_state_changed( $prev_data['whitelist'], $data['whitelist'] ) ) ) { $track_data = array( 'Action' => $data['enabled'] ? 'Enabled' : 'Disabled', 'No of Bots in the Whitelist' => count( $this->model->get_lockout_list( 'allowlist', false ) ), 'No of Bots in the Blocklist' => count( $this->model->get_lockout_list( 'blocklist', false ) ), ); $this->track_feature( 'def_user_agent_banning', $track_data ); } // New one for 'Blocklist Presets'. if ( ( $prev_data['blocklist_presets'] !== $data['blocklist_presets'] ) || ( count( $prev_data['blocklist_preset_values'] ) !== count( array_intersect( $prev_data['blocklist_preset_values'], $data['blocklist_preset_values'] ) ) ) ) { $track_data = array( 'Action' => $data['blocklist_presets'] ? 'Enabled' : 'Disabled', 'List of Activated Bots' => implode( ', ', $data['blocklist_preset_values'] ), ); $this->track_feature( 'def_ua_blocklist_preset', $track_data ); } // New one for 'Script Presets'. if ( ( $prev_data['script_presets'] !== $data['script_presets'] ) || ( count( $prev_data['script_preset_values'] ) !== count( array_intersect( $prev_data['script_preset_values'], $data['script_preset_values'] ) ) ) ) { $track_data = array( 'Action' => $data['script_presets'] ? 'Enabled' : 'Disabled', 'List of Activated Scripts' => implode( ', ', $data['script_preset_values'] ), ); $this->track_feature( 'def_ua_scripts_preset', $track_data ); } // Track "Fake Bots Detection". if ( $prev_data['fake_bots_enabled'] !== $data['fake_bots_enabled'] || $prev_data['fake_bots_lockout_type'] !== $data['fake_bots_lockout_type'] ) { $data = array( 'Action' => $data['fake_bots_enabled'] ? 'Enabled' : 'Disabled', 'Blocking type' => 'temporary' === $data['fake_bots_lockout_type'] ? 'Temporary' : 'Permanent', ); $this->track_feature( 'def_fake_crawler', $data ); } } return new Response( true, array_merge( array( 'message' => $this->get_update_message( $data, $old_enabled, User_Agent_Lockout::get_module_name() ), 'auto_close' => true, ), $this->data_frontend() ) ); } return new Response( false, array( 'message' => $this->model->get_formatted_errors() ) ); } /** * Removes settings for all submodules. */ public function remove_settings() { } /** * Delete all the data & the cache. */ public function remove_data() { } /** * Converts the current object state to an array. * * @return array The array representation of the object. */ public function to_array(): array { return array(); } /** * Provides data for the frontend. * * @return array An array of data for the frontend. */ public function data_frontend(): array { $arr_model = $this->model->export(); // Check for empty Disallow line only if Bot Trap is enabled. $has_empty_disallow = false; if ( $this->model->enabled && $this->model->malicious_bot_enabled ) { $malicious_bot_service = wd_di()->get( \WP_Defender\Component\Malicious_Bot::class ); $has_empty_disallow = $malicious_bot_service->has_empty_disallow_line(); } $misc = array( 'no_ua' => '' === $arr_model['blacklist'] && '' === $arr_model['whitelist'], 'module_name' => User_Agent_Lockout::get_module_name(), 'blocklist_presets' => User_Agent_Service::get_blocklist_presets(), 'script_presets' => User_Agent_Service::get_script_presets(), 'has_empty_disallow_line' => $has_empty_disallow, 'lockouts_last_24_hours' => Lockout_Log::count_ua_lockouts_in_24_hours(), ); return array_merge( array( 'model' => $arr_model, 'misc' => $misc, ), $this->dump_routes_and_nonces() ); } /** * Adapt the given data array by adding additional fields if necessary. * * @param array $data The data array to adapt. * * @return array The adapted data array. */ private function adapt_data( array $data ): array { $adapted_data = array(); if ( isset( $data['ua_banning_enabled'] ) ) { $adapted_data['enabled'] = (bool) $data['ua_banning_enabled']; } if ( isset( $data['ua_banning_message'] ) ) { $adapted_data['message'] = $data['ua_banning_message']; } if ( isset( $data['ua_banning_blacklist'] ) ) { $adapted_data['blacklist'] = $data['ua_banning_blacklist']; } if ( isset( $data['ua_banning_whitelist'] ) ) { $adapted_data['whitelist'] = $data['ua_banning_whitelist']; } if ( isset( $data['ua_banning_empty_headers'] ) ) { $adapted_data['empty_headers'] = (bool) $data['ua_banning_empty_headers']; } return array_merge( $data, $adapted_data ); } /** * Imports data into the model. * * @param array $data Data to be imported into the model. * * @throws Exception If table is not defined. */ public function import_data( array $data ): void { $model = $this->get_model(); if ( array() !== $data ) { $data = $this->adapt_data( $data ); $model->import( $data ); if ( $model->validate() ) { $model->save(); } } else { $default_ua_values = $model->get_default_values(); $model->enabled = false; $model->message = $default_ua_values['message']; $model->blacklist = $default_ua_values['blacklist']; $model->whitelist = $default_ua_values['whitelist']; $model->empty_headers = false; $model->save(); } } /** * Exports User Agents to a CSV file. * * @return void * @defender_route * @since 2.6.0 */ public function export_ua(): void { try { Csv::to_browser( 'ua', $this->get_export_rows() ); } catch ( \RuntimeException $e ) { $this->log( $e->getMessage(), 'ua-lockout' ); } } /** * Generates User Agent export rows. * * @return Generator */ private function get_export_rows(): Generator { foreach ( $this->model->get_lockout_list( 'allowlist', false ) as $ua ) { yield array( 'ua' => $ua, 'type' => 'allowlist', ); } foreach ( $this->model->get_all_selected_blocklist_ua( false ) as $ua ) { yield array( 'ua' => $ua, 'type' => 'blocklist', ); } } /** * Importing UAs from exporter. * * @param Request $request The request object. * * @defender_route * @return Response */ public function import_ua( Request $request ) { $data = $request->get_data( array( 'id' => array( 'type' => 'int', ), ) ); $file = ''; $attached_id = $data['id'] ?? 0; if ( 0 < $attached_id ) { if ( ! is_object( get_post( $attached_id ) ) ) { return new Response( false, array( 'message' => esc_html__( 'Your file is invalid!', 'defender-security' ) ) ); } $file = get_attached_file( $attached_id ); } else { $file_data = defender_get_data_from_request( 'file', 'f' ); if ( is_array( $file_data ) && isset( $file_data['tmp_name'] ) && is_uploaded_file( $file_data['tmp_name'] ) ) { $file = $file_data['tmp_name']; } } if ( ! is_string( $file ) || '' === $file || ! is_file( $file ) ) { return new Response( false, array( 'message' => esc_html__( 'Your file is invalid!', 'defender-security' ) ) ); } $data = $this->service->verify_import_file( $file ); if ( ! $data ) { return new Response( false, array( 'message' => esc_html__( 'Your file content is invalid! Please use a CSV file format and try again.', 'defender-security' ), ) ); } // All good, start to import. foreach ( $data as $line ) { $this->model->add_to_list( $line[0], $line[1] ); } return new Response( true, array_merge( array( 'message' => esc_html__( 'Your blocklist and allowlist have been successfully imported.', 'defender-security' ), 'auto_close' => true, ), $this->data_frontend() ) ); } /** * Exports strings. * * @return array An array of strings. */ public function export_strings(): array { return array(); } }