PBH-BTN / PeerBanHelper

自动封禁不受欢迎、吸血和异常的 BT 客户端,并支持自定义规则。PeerId黑名单/UserAgent黑名单/IP CIDR/假进度/超量下载/进度回退/多播追猎/连锁封禁/伪装检测 支持 qBittorrent/Transmission/Deluge/BiglyBT
GNU General Public License v3.0
539 stars 15 forks source link

使用简单状态机托管Peer状态 #163

Open PluieM opened 1 week ago

PluieM commented 1 week ago

使用简单状态机托管Peer状态切换 peer状态切换 drawio 在一次轮询中每个Peer最多只会被Ban一次

RuleBlocker为状态机的接口定义

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The updates encompass significant enhancements focused on peer banning based on configurable rules, utilizing state machines for more robust ban management. New modules and refactors streamline the configuration and execution of these rules. Key additions include a disconnect timeout feature, an updated and centralized rule system, and expanded capabilities for handling peer interactions through new classes and methods.

Changes

File(s) Summary
pom.xml Added cola-component-statemachine dependency.
PeerBanHelperServer.java Added disconnectTimeout, overhauled peer banning with state machine logic, enhanced banning logic and modular registration.
ProfileUpdateScript.java Added subModuleUpdate() method for module rule configurations. Adjusted existing methods for configuration updates.
DatabaseHelper.java, RuleSubLog.java Renamed IPBanRuleUpdateType to RuleUpdateType, affecting method and record parameters.
AbstractRuleBlocker.java, MatchEvents.java, ... Introduced foundational classes and enums (RuleBlocker interface, AbstractRuleBlocker class, new enums) for rule-based blocking.
PeerIdBlocker.java, RuleSubBlocker.java, ... Implemented rule-based peer blocking mechanisms (PeerIdBlocker, RuleSubBlocker). Refactored methods for rule matching logic.
RuleSubController.java Adjusted method signatures and logic to incorporate renamed entities and new rule types.
Lang.java Renamed constants related to rule actions, added new constants for subscription rule handling.
RuleMatcher.java, PrefixMatcher.java, ... Introduced abstract and specific matcher classes (RuleMatcher, PrefixMatcher, SubStrMatcher), handling rule-based evaluations.

Sequence Diagram(s)

sequenceDiagram
    participant Peer as Peer
    participant Server as PeerBanHelperServer
    participant Matcher as RuleMatcher
    participant State as StateMachine<PeerState, MatchEvents, PeerMatchContext>

    Peer ->> Server: Connect
    Server ->> Matcher: Evaluate Peer
    alt Rule Match
        Matcher ->> State: Trigger HIT Event
        State ->> Server: Update Peer Status (Ban/Active)
    else No Match
        Matcher ->> State: Trigger PASS Event
    end
    Note over Server, Peer: Peer Status Updated based on State

    activate Server
    loop Periodically
        Server ->> Peer: Check Connection Status
        alt Timeout
            Server ->> State: Trigger TIMEOUT Event
            State ->> Server: Disconnect Peer
        else Active
            Server ->> State: Trigger ACTIVE Event
            State ->> Server: Maintain Connection
        end
    end
    deactivate Server

Poem

🐇✨ In the code where peer flags toss, New rules and states cross, Disconnects timed, bans refine,

Peers in line, a stricter sign, Matchers check, state machines bind, Configuration perfect, intertwined.

From fortress code the rabbits cheer, Rules are clear, no peer shall veer! With carrots shared, and code so fair. 🌟💻


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.