3
0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-30 14:49:28 +01:00

Add can-manage-bot-channels protocol capability

This allows skipping part/join for service bots on platforms where this is not possible.
This commit is contained in:
James Lu 2019-11-02 13:55:49 -07:00
parent 4ceeb1630f
commit 7bf1a9e08d
3 changed files with 7 additions and 4 deletions

View File

@ -1,6 +1,6 @@
# PyLink Protocol Module Specification
***Last updated for 2.1-alpha2 (2019-10-10).***
***Last updated for 2.1-alpha2 (2019-11-02).***
Starting with PyLink 2.x, a *protocol module* is any module containing a class derived from `PyLinkNetworkCore` (e.g. `InspIRCdProtocol`), along with a global `Class` attribute set equal to it (e.g. `Class = InspIRCdProtocol`). These modules do everything from managing connections to providing plugins with an API to send and receive data. New protocol modules may be implemented based off any of the classes in the following inheritance tree, with each containing a different amount of abstraction.
@ -133,6 +133,7 @@ As of writing, the following protocol capabilities (case-sensitive) are implemen
### Supported protocol capabilities
- `can-host-relay` - whether servers using this protocol can host a relay channel (for sanity reasons, this should be off for anything that's not IRC S2S)
- `can-manage-bot-channels` - whether PyLink can manage which channels the bot itself is in. This is off for platforms such as Discord.
- `can-spawn-clients` - determines whether any spawned clients are real or virtual (mainly for `services_support`).
- `can-track-servers` - determines whether servers are accurately tracked (for `servermaps` and other statistics)
- `freeform-nicks` - if set, nicknames for PyLink's virtual clients are not subject to validity and nick collision checks. This implies the `slash-in-nicks` capability.
@ -262,6 +263,8 @@ In short, protocol modules have some very important jobs. If any of these aren't
7) Declare the correct set of protocol module capabilities to prevent confusing PyLink's plugins.
## Changes to this document
* 2019-11-02 (2.1-alpha2)
- Added protocol capability: `can-manage-bot-channels`
* 2019-10-10 (2.1-alpha2)
- Added protocol capability: `has-irc-modes`
* 2019-06-23 (2.1-alpha2)

View File

@ -61,7 +61,7 @@ class IRCCommonProtocol(IRCNetwork):
self._caps = {}
self._use_builtin_005_handling = False # Disabled by default for greater security
self.protocol_caps |= {'has-irc-modes'}
self.protocol_caps |= {'has-irc-modes', 'can-manage-bot-channels'}
def post_connect(self):
self._caps.clear()

View File

@ -399,7 +399,7 @@ class ServiceBot():
chanlist = namespace.setdefault(irc.name, structures.IRCCaseInsensitiveSet(irc))
chanlist.add(channel)
if try_join:
if try_join and irc.has_cap('can-manage-bot-channels'):
self.join(irc, [channel])
def remove_persistent_channel(self, irc, namespace, channel, try_part=True, part_reason=''):
@ -408,7 +408,7 @@ class ServiceBot():
"""
chanlist = self.dynamic_channels[namespace][irc.name].remove(channel)
if try_part and irc.connected.is_set():
if try_part and irc.connected.is_set() and irc.has_cap('can-manage-bot-channels'):
self.part(irc, [channel], reason=part_reason)
def get_persistent_channels(self, irc, namespace=None):