ip = $ip; $user_agent = defender_get_data_from_request( 'HTTP_USER_AGENT', 's' ); $model->user_agent = '' !== $user_agent ? User_Agent::fast_cleaning( $user_agent ) : ''; $model->date = time(); $model->tried = $tried ?? $model->user_agent; $model->blog_id = get_current_blog_id(); $ip_to_country = $model->ip_to_country( $ip ); if ( isset( $ip_to_country['iso'] ) ) { $model->country_iso_code = $ip_to_country['iso']; } return $model; } /** * Query the logs based on the provided filters and pagination settings. * * @param array $filters An array of filters to apply to the query. Default is an empty array. * The following filters are supported: * - from: The start date for the date range filter. * - to: The end date for the date range filter. * - ip: The IP address to filter by. * - type: The type of log to filter by. * - ban_status: The ban status to filter by. * @param int $paged The page number of the results to retrieve. Default is 1. * @param string $order_by The field to order the results by. Default is 'id'. * @param string $order The order direction of the results. Default is 'desc'. * @param int $page_size The number of results to retrieve per page. Default is 50. * Set to -1 to retrieve all results. * * @return array An array of Lockout_Log objects representing the queried logs. */ public static function query_logs( $filters = array(), $paged = 1, $order_by = 'id', $order = 'desc', $page_size = 50 ): array { $orm = self::get_orm(); $orm->get_repository( self::class ) ->where( 'date', 'between', array( $filters['from'], $filters['to'], ) ); if ( isset( $filters['ip'] ) && '' !== $filters['ip'] ) { $orm->where( 'ip', 'like', '%' . $filters['ip'] . '%' ); } if ( isset( $filters['user_agent'] ) && '' !== $filters['user_agent'] ) { $orm->where( 'user_agent', 'like', '%' . $filters['user_agent'] . '%' ); } if ( isset( $filters['type'] ) && '' !== $filters['type'] ) { $orm->where( 'type', $filters['type'] ); } if ( isset( $filters['ban_status'] ) && '' !== $filters['ban_status'] ) { self::apply_ban_status_filter( $orm, $filters ); } if ( '' !== $order_by && '' !== $order ) { $orm->order_by( $order_by, $order ); } if ( $page_size > 0 ) { $offset = ( $paged - 1 ) * $page_size; $orm->limit( $page_size, $offset ); } return $orm->get(); } /** * Count the number of records in the database table based on the provided filters. * * @param mixed $date_from The start date for the date range filter. * @param mixed $date_to The end date for the date range filter. * @param mixed $type The type of log to filter by. * @param string $ip The IP address to filter by. Default is an empty string. * @param array $filters An array of additional filters to apply to the query. Default is an empty array. * The following filters are supported: * - ban_status: The ban status to filter by. * * @return string|null The number of records matching the provided filters, or null if an error occurred. */ public static function count( $date_from, $date_to, $type, $ip = '', $filters = array() ): ?string { $orm = self::get_orm(); $orm->get_repository( self::class ) ->where( 'date', 'between', array( $date_from, $date_to, ) ); if ( is_array( $type ) && array() !== $type ) { $orm->where( 'type', 'in', $type ); } elseif ( is_string( $type ) && '' !== trim( $type ) ) { $orm->where( 'type', $type ); } if ( is_string( $ip ) && '' !== trim( $ip ) ) { $orm->where( 'ip', 'like', "%$ip%" ); } if ( isset( $filters['user_agent'] ) && '' !== trim( $filters['user_agent'] ) ) { $orm->where( 'user_agent', 'like', '%' . $filters['user_agent'] . '%' ); } if ( isset( $filters['ban_status'] ) && '' !== trim( $filters['ban_status'] ) ) { self::apply_ban_status_filter( $orm, array_merge( $filters, array( 'type' => $type ) ) ); } return $orm->count(); } /** * Get 404 lockout types. */ public static function get_404_lockout_types(): array { return array( self::LOCKOUT_404, self::LOCKOUT_404_XSS, self::LOCKOUT_404_NON_EXISTENT_PLUGIN, self::LOCKOUT_404_NON_EXISTENT_THEME, ); } /** * Get all lockout types. */ public static function get_all_lockout_types(): array { return array_merge( self::get_404_lockout_types(), array( self::AUTH_LOCK ), self::get_ua_lockout_types() ); } /** * Count login lockout in the last 7 days. * * @return string|null */ public static function count_login_lockout_last_7_days(): ?string { $start = strtotime( '-7 days' ); $end = time(); return self::count( $start, $end, self::AUTH_LOCK ); } /** * Count 404 lockout in the last 7 days. * * @return string|null */ public static function count_404_lockout_last_7_days(): ?string { $start = strtotime( '-7 days' ); $end = time(); return self::count( $start, $end, self::get_404_lockout_types() ); } /** * Count all UA lockouts in the last 7 days. * * @return string|null */ public static function count_ua_lockout_last_7_days(): ?string { $start = strtotime( '-7 days' ); $end = time(); return self::count( $start, $end, self::get_ua_lockout_types() ); } /** * Count all UA lockouts in the last 24 hours. * * @return string|null */ public static function count_ua_lockouts_in_24_hours(): ?string { $start = strtotime( '-24 hours' ); $end = time(); return self::count( $start, $end, self::get_ua_lockout_types() ); } /** * A shortcut for quickly count ALL lockouts in last 24 hours. * * @return string|null */ public static function count_lockout_in_24_hours(): ?string { $start = strtotime( '-24 hours' ); $end = time(); return self::count( $start, $end, self::get_all_lockout_types() ); } /** * A shortcut for quickly count lockout in last 7 days. * * @return string|null */ public static function count_lockout_in_7_days(): ?string { $start = strtotime( '-7 days' ); $end = time(); return self::count( $start, $end, self::get_all_lockout_types() ); } /** * A shortcut for count lockout in 30 days. * * @return string|null */ public static function count_lockout_in_30_days(): ?string { $start = strtotime( '-30 days' ); $end = time(); return self::count( $start, $end, // LOCKOUT_IP_CUSTOM is not taken into account. self::get_all_lockout_types() ); } /** * Retrieves the date of the last lockout that occurred within the last 30 days. * * @param bool $for_hub (optional) Whether to format the date for the persistent hub. Default is false. * * @return string The formatted date of the last lockout, or 'n/a' if no lockouts were found. */ public static function get_last_lockout_date( $for_hub = false ) { $data = self::query_logs( array( 'from' => strtotime( '-30 days' ), 'to' => time(), ), 1, 'id', 'desc', 1 ); $last = array_shift( $data ); if ( ! is_object( $last ) ) { return 'n/a'; } return $for_hub ? $last->persistent_hub_datetime_format( $last->date ) : $last->format_date_time( $last->date ); } /** * Remove all data. * * @return bool|int */ public static function truncate() { $orm = self::get_orm(); return $orm->get_repository( self::class ) ->truncate(); } /** * Get log types that are attempts/errors (not lockout events). * * @return array */ public static function get_attempt_types(): array { return array( self::AUTH_FAIL, self::ERROR_404, self::ERROR_404_IGNORE, self::ERROR_404_XSS, self::ERROR_404_NON_EXISTENT_PLUGIN, self::ERROR_404_NON_EXISTENT_THEME, ); } /** * Delete only lockout-type log records, preserving attempt/error entries. * * @return int|false Number of rows deleted or false on failure. */ public static function delete_lockout_records() { $orm = self::get_orm(); return $orm->get_repository( self::class ) ->where( 'type', 'not in', self::get_attempt_types() ) ->delete_all(); } /** * Remove logs based on timestamp and limit. * * @param int $timestamp The timestamp to filter logs by. * @param int $limit The maximum number of logs to delete. * * @return void */ public static function remove_logs( $timestamp, $limit ) { $orm = self::get_orm(); $orm->get_repository( self::class ) ->where( 'date', '<=', $timestamp ) ->order_by( 'id' ) ->limit( $limit ) ->delete_by_limit(); } /** * Get log summary. * * @return array */ public static function get_summary(): array { // Time. $current_time = time(); $today_midnight = strtotime( '-24 hours', $current_time ); $first_this_week = strtotime( '-7 days', $current_time ); $first_this_month = strtotime( '-30 days', $current_time ); $ua_types_sql = "'" . implode( "', '", self::get_ua_lockout_types() ) . "'"; $types_404_sql = "'" . implode( "', '", self::get_404_lockout_types() ) . "'"; // Prepare columns. $select = array( 'MAX(date) as lockout_last', 'COUNT(*) as lockout_this_month', // 24 hours "COUNT(IF(date > {$today_midnight}, 1, NULL)) as lockout_today", "COUNT(IF(date > {$today_midnight} AND type IN ({$types_404_sql}), 1, NULL)) as lockout_404_today", "COUNT(IF(date > {$today_midnight} AND type = '" . self::AUTH_LOCK . "', 1, NULL)) as lockout_login_today", "COUNT(IF(date > {$today_midnight} AND type IN ({$ua_types_sql}), 1, NULL)) as lockout_ua_today", // 7 days "COUNT(IF(date > {$first_this_week} AND type IN ({$types_404_sql}), 1, NULL)) as lockout_404_this_week", "COUNT(IF(date > {$first_this_week} AND type = '" . self::AUTH_LOCK . "', 1, NULL)) as lockout_login_this_week", "COUNT(IF(date > {$first_this_week} AND type IN ({$ua_types_sql}), 1, NULL)) as lockout_ua_this_week", // 30 days "COUNT(IF(date > {$first_this_month} AND type IN ({$types_404_sql}), 1, NULL)) as lockout_404_this_month", "COUNT(IF(date > {$first_this_month} AND type = '" . self::AUTH_LOCK . "', 1, NULL)) as lockout_login_this_month", "COUNT(IF(date > {$first_this_month} AND type IN ({$ua_types_sql}), 1, NULL)) as lockout_ua_this_month", ); $select = implode( ',', $select ); $orm = self::get_orm(); $result = $orm->get_repository( self::class ) ->select( $select ) // LOCKOUT_IP_CUSTOM is not taken into account. ->where( 'type', 'in', self::get_all_lockout_types() ) ->where( 'date', '>=', strtotime( '-30 days', $current_time ) ) ->get_results(); return $result[0] ?? array(); } /** * Returns the log tag based on the given type. * * @param string $type The type of the log. * * @return string The log tag. */ protected static function get_log_tag( $type ): string { switch ( $type ) { case self::LOCKOUT_404: case self::LOCKOUT_404_XSS: case self::LOCKOUT_404_NON_EXISTENT_THEME: case self::LOCKOUT_404_NON_EXISTENT_PLUGIN: case self::ERROR_404: case self::ERROR_404_IGNORE: case self::ERROR_404_XSS: case self::ERROR_404_NON_EXISTENT_THEME: case self::ERROR_404_NON_EXISTENT_PLUGIN: $tag = '404'; break; case self::AUTH_FAIL: case self::AUTH_LOCK: $tag = 'login'; break; case self::LOCKOUT_IP_CUSTOM: $tag = 'Custom'; break; case self::IP_UNLOCK: $tag = 'Unlock'; break; case self::LOCKOUT_UA: case self::LOCKOUT_MALICIOUS_BOT: case self::LOCKOUT_FAKE_BOT: default: $tag = 'bots'; break; } return $tag; } /** * Returns the CSS class for the log container based on the given type. * * @param string $type The type of the log. * * @return string The CSS class for the log container. */ protected static function get_log_container_class( $type ): string { switch ( $type ) { case self::AUTH_LOCK: case self::LOCKOUT_404: case self::LOCKOUT_404_XSS: case self::LOCKOUT_404_NON_EXISTENT_THEME: case self::LOCKOUT_404_NON_EXISTENT_PLUGIN: case self::LOCKOUT_UA: case self::LOCKOUT_MALICIOUS_BOT: case self::LOCKOUT_FAKE_BOT: $class = 'sui-error'; break; case self::AUTH_FAIL: case self::ERROR_404: case self::ERROR_404_IGNORE: case self::ERROR_404_XSS: case self::ERROR_404_NON_EXISTENT_THEME: case self::ERROR_404_NON_EXISTENT_PLUGIN: default: $class = 'sui-warning'; break; } return $class; } /** * Retrieves logs from the database and formats them for display on the frontend. * * @param array $filters An array of filters to apply to the query. Default is an empty array. * The following filters are supported: * - from: The start date for the date range filter. * - to: The end date for the date range filter. * - ip: The IP address to filter by. * - type: The type of log to filter by. * - ban_status: The ban status to filter by. * @param int $paged The page number of the results to retrieve. Default is 1. * @param string $order_by The field to order the results by. Default is 'id'. * @param string $order The order direction of the results. Default is 'desc'. * @param int $page_size The number of results to retrieve per page. Default is 50. * Set to -1 to retrieve all results. * * @return array An array of formatted log entries. */ public static function get_logs_and_format( $filters = array(), $paged = 1, $order_by = 'id', $order = 'desc', $page_size = 50 ): array { $logs = self::query_logs( $filters, $paged, $order_by, $order, $page_size ); return self::format_logs( $logs ); } /** * Get the first log by ID. * * @param int $id The ID of the log. * * @return null|Model */ public static function find_by_id( $id ): ?Model { $orm = self::get_orm(); return $orm->get_repository( self::class ) ->where( 'id', $id ) ->first(); } /** * Get logs by an array of IDs. * * @param int[] $ids Array of log IDs. * * @return array */ public static function find_by_ids( array $ids ): array { if ( array() === $ids ) { return array(); } $orm = self::get_orm(); return $orm->get_repository( self::class ) ->where( 'id', 'in', $ids ) ->get(); } /** * Delete current log. */ public function delete() { $orm = self::get_orm(); $orm->get_repository( self::class )->delete( array( 'id' => $this->id, ) ); } /** * Apply ban status filtering based on lockout type. * * @param object $orm The ORM query builder. * @param array $filters The filters array. */ private static function apply_ban_status_filter( $orm, $filters ) { $ban_status = $filters['ban_status']; $type = $filters['type'] ?? ''; $ua_types = self::get_ua_lockout_types(); $where = self::ban_status_where( $ban_status ); if ( 3 === count( $where ) ) { if ( in_array( $type, $ua_types, true ) ) { $orm->where( ...$where ); } elseif ( '' === $type ) { $orm->where( 'type', 'in', $ua_types ); $orm->where( ...$where ); } return; } $table_lockout = wd_di()->get( Table_Lockout::class ); $bl_model = wd_di()->get( Blacklist_Lockout::class ); if ( $table_lockout::STATUS_BAN === $ban_status ) { $list = $bl_model->get_list( 'blocklist' ); // Empty blocklist means no IPs are banned — force zero results. $orm->where( 'ip', 'in', array() === $list ? array( '' ) : $list ); } elseif ( $table_lockout::STATUS_NOT_BAN === $ban_status ) { $list = $bl_model->get_list( 'blocklist' ); // Empty blocklist means all IPs are "not banned" — no filter needed. if ( array() !== $list ) { $orm->where( 'ip', 'not in', $list ); } } elseif ( $table_lockout::STATUS_ALLOWLIST === $ban_status ) { $list = $bl_model->get_list( 'allowlist' ); // Empty allowlist means no IPs are allowlisted — force zero results. $orm->where( 'ip', 'in', array() === $list ? array( '' ) : $list ); } } /** * Prepare user-agent where condition based on the ban status variant. * * @param string $ban_status_type Ban status type. * * @return array Where condition arguments or empty array. */ private static function ban_status_where( $ban_status_type ): array { $table_lockout = wd_di()->get( Table_Lockout::class ); $ua_model = wd_di()->get( User_Agent_Lockout::class ); if ( $table_lockout::STATUS_NOT_BAN === $ban_status_type ) { $blocklist = $ua_model->get_all_selected_blocklist_ua(); if ( array() === $blocklist ) { return array(); } $escaped = array_map( 'preg_quote', $blocklist, array_fill( 0, count( $blocklist ), '' ) ); return array( 'user_agent', 'not regexp', '(?i)' . implode( '|', $escaped ) ); } elseif ( $table_lockout::STATUS_BAN === $ban_status_type ) { $blocklist = $ua_model->get_all_selected_blocklist_ua(); if ( array() === $blocklist ) { return array(); } $escaped = array_map( 'preg_quote', $blocklist, array_fill( 0, count( $blocklist ), '' ) ); return array( 'user_agent', 'regexp', '(?i)' . implode( '|', $escaped ) ); } elseif ( $table_lockout::STATUS_ALLOWLIST === $ban_status_type ) { $allowlist = $ua_model->get_lockout_list( 'allowlist' ); if ( array() === $allowlist ) { return array(); } $escaped = array_map( 'preg_quote', $allowlist, array_fill( 0, count( $allowlist ), '' ) ); return array( 'user_agent', 'regexp', '(?i)' . implode( '|', $escaped ) ); } return array(); } /** * Format logs for ready to use on frontend. * * @param array $logs An array of log entries. * * @return array * @since 3.11.0 */ public static function format_logs( array $logs ): array { $data = array(); foreach ( $logs as $item ) { // Escape object properties received from end user. $item->log = sanitize_textarea_field( $item->log ); $item->tried = sanitize_textarea_field( $item->tried ); $log = $item->export(); // Escape array keys received from end user. $log['log'] = sanitize_textarea_field( $log['log'] ); $log['tried'] = sanitize_textarea_field( $log['tried'] ); $log['date'] = $item->format_date_time( $item->date ); $log['format_date'] = $item->get_date( $item->date ); $log['tag'] = self::get_log_tag( $item->type ); $log['container_class'] = self::get_log_container_class( $item->type ); if ( self::LOCKOUT_UA !== $item->type ) { $log['description'] = sanitize_textarea_field( $item->log ); } $data[] = $log; } return $data; } /** * Determine if the IP should be added to the database based on the timeframe. * * @return bool True if the IP should be added to the database, false otherwise. */ public function has_recent_ip_log(): bool { // Ensure IP is set before proceeding. if ( ! is_string( $this->ip ) || '' === trim( $this->ip ) ) { return false; } $orm = self::get_orm(); // Query the latest log for the current IP. $latest_log = $orm->get_repository( self::class ) ->select( 'date' ) ->where( 'ip', $this->ip ) ->order_by( 'date', 'desc' ) ->first(); if ( null !== $latest_log ) { // Return true if the log is within the 5-minute timeframe. return ( time() - $latest_log->date ) <= 300; } return false; } /** * Get UA lockout types. * * @return array */ public static function get_ua_lockout_types(): array { return array( self::LOCKOUT_UA, self::LOCKOUT_MALICIOUS_BOT, self::LOCKOUT_FAKE_BOT, ); } }