EgoServ/outline.rst

WIP Outline of Commands and Functionality
=========================================

The permissions are inherited in descending order. Tier 1 inherits Tier 2 ... 

+-----------+-------------+------------+-------------+----------+
|Commands   |Description  | Tier       | Channel     | Status   |
|           |             |            | Restrictions|          |
+===========+=============+============+=============+==========+
| DEFCON    |             | Admins/Ops | column 3    | DONE     |
+-----------+-------------+------------+-------------+----------+
| SAJOIN    |             | Admins/Ops |             | DONE     |
+-----------+-------------+------------+-------------+----------+
| SANICK    |             | Admins/Ops | column 3    | column 4 |
+-----------+-------------+------------+-------------+----------+
| KILL      |             | Admins/Ops |             |          |
+-----------+-------------+------------+-------------+----------+
| UBAN      |             | Moderators | column 3    | column 4 |
+-----------+-------------+------------+-------------+----------+
| NBAN      |             | Moderators |             |          |
+-----------+-------------+------------+-------------+----------+
| KBAN      |             | Moderators | column 3    | column 4 |
+-----------+-------------+------------+-------------+----------+
| SUSTATUS  |             | Moderators |             |          |
+-----------+-------------+------------+-------------+----------+
| WARN      |             | Tripsitters| column 3    | column 4 |
+-----------+-------------+------------+-------------+----------+
| ADDNOTE   |             | Tripsitters|             |          |
+-----------+-------------+------------+-------------+----------+
| STATUS    |             | Tripsitters| column 3    | column 4 |
+-----------+-------------+------------+-------------+----------+
| QUIET     |             | Tripsitters|             |          |
+-----------+-------------+------------+-------------+----------+
| NOTES     |             | Tripsitters|             |          |
+-----------+-------------+------------+-------------+----------+


Tier 1 : Administrator/Operator only
------------------------------------
1. DEFCON
2. SANICK
3. SAJOIN
4. KILL
5. UBAN - Variations. This can be considered akin to a KLINE in tripbot.


Tier 2 : Moderators
-------------------
1. NBAN - this will behave as current ``nban`` minus the kline aspect
2. KBAN - Single channel bans (exists)
3. WARN
4. SUSTATUS


Tier 3 : Tripsitters
--------------------
1. QUIET - should allow for --all flag to quiet accross channels similar to NBAN
   1. This will require the use of the mute extban ``MODE +b #channel m:nick!user@host``
   2. Refer to ``@kban`` and ``@iban`` code in the ``Channel`` plugin
2. STATUS
3. ADDNOTE
4. NOTES


---

- All commands targetting a user (infractions) should be logged in a database. sqlite3 for now.
  - decide upon the schema for these tables.
- Besides the user permissions, there should be channel restrictions for certain commands.
- Ensure that the bot itself cannot be targetted and is immune