cubrr / boson Goto Github PK

Implement spell checking for commands. The Levenshtein algo from the old plugin could be used.

jCuber: !halp
[Q - BOSON] Did you mean: !help?

Should we consider making the plugin fully modular? Note to self: don't use Assembly.LoadFile.

Todo: EXPLORE APPDOMAINS MORE IN THE PLUGIN CONTEXT

Options for on the fly updates

Pros:

• Decoupling
• Easier to test

Cons:

• Even.more.abstraction.

With the new plugin persistence feature in the upcoming Tekno 2.7.4.0, this feature is a must.

• Basic PM functionality, silEnT mod/shrubbot style (or was it MC?); shows you the message you just sent
• Possibility to leave messages to offline players, fetched when player joins (or spawns on) the server

Prerequisite: #6

We want to be able to unit test this shit

Need to be able to blacklist following entity properties:

• Name
• HWID
• IP
  • Explicit address
  • Subnet?
• Callsign title
  • String representation
  • Explicit bytes
• Callsign clantag
  • String representation
  • Explicit bytes

Long plugin responses to clients should be paginated with manual page turning.

• Determine maximum length for a readable message
  • Maximum length is:
• Create PaginatedMessage class with IList<string> containing the pages and a CurrentPage property.
• Manual pagination by commands
  • Connect the class to BosonClient and let the command check if the client has any paginated messages pending?
  • Or create a pagination manager which maintains client states?

Lift log message literals to XML files or resources in satellite assemblies.

Need the following models:

• Account
  • Username
  • Password & hash
  • Whichever UID we go for (#8)
  • Command exceptions: forbidden commands and explicitly allowed commands (e.g. give a random lvl 100 !ban or something)
• Rank
  • Numeric level
  • VIP status
• Commands
  • Need to figure out some relational design for connecting the commands to the ranks!
• Logging errors and other info (#9)

Commands should...

• Implement an interface which includes
  • Invoking the command
  • Invoking the command's help text
  • Getting its name and aliases

• Investigate thread related crashes

Need to create logger outputs for SQLite, text files and dedicated server window.

Plausible specification

1. Ranks

A rank shall contain an integer level, a string description and a list of commands.
The level shall be an unique integer where the lowest number represents a rank with the least rights and the highest number represents a rank with the most rights. The description string shall be used to provide context to other users about the rank. The list of commands contains the base commands for the rank.

interface IRank
{
    IEnumerable<ICommand> Commands { get; }
    string Description { get; }
    int Level { get; }
}

2. Accounts

An account shall consist of a rank, unique username, password and VIP status flag.

If the account is the guest account used for unregistered clients, the username shall be "Guest", the password null and vip status false.

interface IUserAccount
{
    string Username { get; }
    string Password { get; }
    IRank Rank { get; }
    bool Vip { get; }
}

abstract class IGuestAccount : IUserAccount
{
    public virtual string Username { get { return "Guest"; } }
    public virtual string Password { get { return null; } }
    public abstract IRank Rank { get; protected set; }
    public virtual bool Vip { get { return false; } }
}

3. Account manager

The account manager shall handle client registrations, logins, password changes.

interface IAccountManager
{
    HashSet<IUserAccount> AuthenticatedUsers { get; }
    /* Return type undefined for now */ void Authenticate(IUserAccount userAccount, string password);
    /* Return type undefined for now */ void SignOut(IUserAccount userAccount);
    /* Return type undefined for now */ void Register(IUserAccount userAccount, string password);
    /* Return type undefined for now */ void UpdatePassword(IUserAccount userAccount, string currentPassword, string newPassword);
}

4. Future plans

• Make the account system fully autonomous, allowing for lost password resets without administrator notice.