diff --git a/docs/technical/inspircd.html b/docs/technical/inspircd.html index 6bb13dc..6f25cc6 100644 --- a/docs/technical/inspircd.html +++ b/docs/technical/inspircd.html @@ -9,7 +9,7 @@  
inspircdindex
/home/gl/pylink/protocols/inspircd.py -

+

inspircd.py: InspIRCd 2.x protocol module for PyLink.

@@ -111,8 +111,13 @@ This is used to keep track of whether th internals - a server that fails to reply to our PINGs eventually
times out and is disconnected. +
handle_rsquit(self, numeric, command, args)
Handles the RSQUIT command, which is sent by opers to SQUIT remote
+servers.
+
handle_server(self, numeric, command, args)
Handles incoming SERVER commands (introduction of servers).
+
handle_svstopic = handle_ftopic(self, numeric, command, args)
+
handle_uid(self, numeric, command, args)
Handles incoming UID commands (user introduction).
inviteClient(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
@@ -151,10 +156,15 @@ Example uses:
Note: No nick collision / valid nickname checks are done here; it is
up to plugins to make sure they don't introduce anything invalid. -
spawnServer(self, name, sid=None, uplink=None, desc=None)
Spawns a server off a PyLink server. desc (server description)
+
spawnServer(self, name, sid=None, uplink=None, desc=None, endburst_delay=0)
Spawns a server off a PyLink server. desc (server description)
defaults to the one in the config. uplink defaults to the main PyLink
server, and sid (the server ID) is automatically generated if not
-given.
+given.
+ 
+If endburst_delay is set greater than zero, the sending of ENDBURST
+will be delayed by the amount given. This can be used to prevent
+pseudoserver bursts from triggering IRCd join-flood preventions,
+and prevent connections from filling up the snomasks too much.
squitServer(self, source, target, text='No reason given')
SQUITs a PyLink server.
@@ -213,6 +223,8 @@ be used for multi-word arguments that last un
removeClient(self, numeric)
Internal function to remove a client from our internal state.
+
updateTS(self, channel, their_ts)
+
Data descriptors inherited from classes.Protocol:
__dict__
@@ -290,8 +302,13 @@ This is used to keep track of whether th internals - a server that fails to reply to our PINGs eventually
times out and is disconnected.
+
handle_rsquit(self, numeric, command, args)
Handles the RSQUIT command, which is sent by opers to SQUIT remote
+servers.
+
handle_server(self, numeric, command, args)
Handles incoming SERVER commands (introduction of servers).
+
handle_svstopic = handle_ftopic(self, numeric, command, args)
+
handle_uid(self, numeric, command, args)
Handles incoming UID commands (user introduction).
inviteClient(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
@@ -330,10 +347,15 @@ Example uses:
Note: No nick collision / valid nickname checks are done here; it is
up to plugins to make sure they don't introduce anything invalid. -
spawnServer(self, name, sid=None, uplink=None, desc=None)
Spawns a server off a PyLink server. desc (server description)
+
spawnServer(self, name, sid=None, uplink=None, desc=None, endburst_delay=0)
Spawns a server off a PyLink server. desc (server description)
defaults to the one in the config. uplink defaults to the main PyLink
server, and sid (the server ID) is automatically generated if not
-given.
+given.
+ 
+If endburst_delay is set greater than zero, the sending of ENDBURST
+will be delayed by the amount given. This can be used to prevent
+pseudoserver bursts from triggering IRCd join-flood preventions,
+and prevent connections from filling up the snomasks too much.
squitServer(self, source, target, text='No reason given')
SQUITs a PyLink server.
@@ -392,6 +414,8 @@ be used for multi-word arguments that last un
removeClient(self, numeric)
Internal function to remove a client from our internal state.
+
updateTS(self, channel, their_ts)
+
Data descriptors inherited from classes.Protocol:
__dict__
@@ -407,6 +431,6 @@ Data descriptors inherited from classes.Protocol Data
-
       curdir = 'protocols'
+		curdir = '../../protocols'
log = <logging.RootLogger object>
\ No newline at end of file diff --git a/docs/technical/pmodule-spec.md b/docs/technical/pmodule-spec.md index afa9c32..948c7fe 100644 --- a/docs/technical/pmodule-spec.md +++ b/docs/technical/pmodule-spec.md @@ -1,42 +1,45 @@ # PyLink Protocol Module Specification -In PyLink, each protocol module is a single file consisting of a protocol class, and a global `Class` attribute that is set equal to it (e.g. `Class = InspIRCdProtocol`). These classes should be based off of either [`classes.Protocol`](https://github.com/GLolol/PyLink/blob/0.4.0-dev/classes.py#L404), a boilerplate class that only defines a few variables, or [`ts6_common.TS6BaseProtocol`](https://github.com/GLolol/PyLink/blob/0.4.0-dev/protocols/ts6_common.py#L10), which includes elements of the TS6 protocol that are shared by both the InspIRCd and TS6 protocols. IRC objects initialize protocol modules by creating an instance of its class, and passing it the IRC object itself. +In PyLink, each protocol module is a single file consisting of a protocol class, and a global `Class` attribute that is set equal to it (e.g. `Class = InspIRCdProtocol`). These classes should be based off of either [`classes.Protocol`](https://github.com/GLolol/PyLink/blob/e4fb64aebaf542122c70a8f3a49061386a00b0ca/classes.py#L532), a boilerplate class that only defines a few basic things, or [`ts6_common.TS6BaseProtocol`](https://github.com/GLolol/PyLink/blob/0.5.0-dev/protocols/ts6_common.py), which includes elements of the TS6 protocol that are shared by the InspIRCd, UnrealIRCd, and TS6 protocols. IRC objects load protocol modules by creating an instance of its main class, and sends it commands accordingly. -See also: [inspircd.html](inspircd.html) for an auto-generated specification of the InspIRCd protocol module. +See also: [inspircd.html](inspircd.html) for auto-generated documentation the InspIRCd protocol module. ## Tasks -Protocol modules have some *very* ***important*** jobs. If any of these aren't done correctly, you will be left with a very **broken, desynced** services server: +Protocol modules have some very important jobs. If any of these aren't done correctly, you will be left with a broken, desynced services server: 1) Handle incoming commands from the uplink IRCd. 2) Return [hook data](hooks-reference.md) for relevant commands, so that plugins can receive data from IRC. -3) Make sure channel/user states are kept correctly. Joins, quits, parts, kicks, mode changes, nick changes, etc. **must** be handled accurately. +3) Make sure channel/user states are kept correctly. Joins, quits, parts, kicks, mode changes, nick changes, etc. should all be handled accurately. -4) Respond to both pings *and* pongs - the `irc.lastping` attribute **must** be set to the current time whenever a `PONG` is received from the uplink, so PyLink's internals don't [lag out the uplink thinking it isn't responding to our `PING`s](https://github.com/GLolol/PyLink/blob/0.4.0-dev/classes.py#L202-L204). +4) Respond to both pings *and* pongs - the `irc.lastping` attribute **must** be set to the current time whenever a `PONG` is received from the uplink, so PyLink's doesn't [lag out the uplink thinking that it isn't responding to our pings](https://github.com/GLolol/PyLink/blob/e4fb64aebaf542122c70a8f3a49061386a00b0ca/classes.py#L309-L311). 5) Implement a series of camelCase `commandServer/Client` functions - plugins use these for sending outgoing commands. See the `Outbound commands` section below for a list of which ones are needed. -6) Set the threaded event `irc.connected` (via `irc.connected.set()`) when the initial connection + burst phase is complete. This is important for plugins like relay that do state checking, and they will fail to work if this is not set. +6) Set the threading.Event object `irc.connected` (via `irc.connected.set()`) when the protocol negotiation with the uplink is complete. This is important for plugins like relay which must check that links are ready before spawning clients, and they will fail to work if this is not set. ## Core functions -The following functions *must* be implemented by any protocol module within its main class, since they are used by the IRC internals. +The following functions *must* be implemented by any protocol module within its main class, since they are used by the IRC object internals. - **`connect`**`(self)` - Initializes a connection to a server. -- **`handle_events`**`(self, line)` - Handles inbound data (lines of text) from the uplink IRC server. Normally, this will pass commands to other command handlers within the protocol module, dropping commands that are unrecognized (wildcard handling), but it's really up to you how to structure your modules. You will want to be able to parse command arguments properly into a list: many protocols send RFC1459-style commands that can be parsed using the [`self.parseArgs(line)` function within the `Protocol` class](https://github.com/GLolol/PyLink/blob/c77d170765d20b0ac55b945fba4a6257fb15cf43/classes.py#L411). - - All of the outbound commands mentioned in the next section (minus raw numerics) should have their incoming version handled and [hook data](hooks-reference.md) returned. +- **`handle_events`**`(self, line)` - Handles inbound data (lines of text) from the uplink IRC server. Normally, this will pass commands to other command handlers within the protocol module, while dropping commands that are unrecognized (wildcard handling). But, it's really up to you how to structure your modules. You will want to be able to parse command arguments properly into a list: many protocols send RFC1459-style commands that can be parsed using the [`Protocol.parseArgs()`](https://github.com/GLolol/PyLink/blob/e4fb64aebaf542122c70a8f3a49061386a00b0ca/classes.py#L539) function. ### Outgoing command functions -- **`spawnClient`**`(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype=None)` - Spawns a client on the given IRC connection. Note that no nick collision / valid nickname checks are done here, and it is up to plugins to make sure they don't introduce anything invalid. +- **`spawnClient`**`(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype=None, manipulatable=False)` - Spawns a client on the PyLink server. No nick collision / valid nickname checks are done by protocol modules, as it is up to plugins to make sure they don't introduce anything invalid. - `modes` is a set of `(mode char, mode arg)` tuples in the form of [`utils.parseModes()` output](using-utils.md#parseModes). - `ident` and `host` default to "null", while `realhost` defaults to the same things as `host` if not defined. - - `realname` defaults to the real name specified in the PyLink config, if not given. `ts` defaults to the current time and `opertype` (the oper type name, if applicable) defaults to the simple text of `IRC Operator`. + - `realname` defaults to the real name specified in the PyLink config, if not given. + - `ts` defaults to the current time if not given. + - `opertype` (the oper type name, if applicable) defaults to the simple text of `IRC Operator`. + - The `manipulatable` option toggles whether the client spawned should be considered protected. Currently, all this does is prevent commands from plugins like `bots` from modifying these clients, but future client protections (anti-kill flood, etc.) may also depend on this. + - The `server` option optionally takes a SID of any PyLink server, and spawns the client on the one given. It will default to the root PyLink server. -- **`joinClient`**`(self, client, channel)` - Joins the client UID given to a channel. +- **`joinClient`**`(self, client, channel)` - Joins the given client UID given to a channel. - **`awayClient`**`(self, source, text)` - Sends an AWAY message from a PyLink client. `text` can be an empty string to unset AWAY status. @@ -87,9 +90,10 @@ optional, and defaults to the one we've stored in the channel state if not given - **`updateClient`**`(self, source, field, text)` - Updates the ident, host, or realname of a PyLink client. `field` should be either "IDENT", "HOST", "GECOS", or "REALNAME". If changing the field given on the IRCd isn't supported, `NotImplementedError` should be raised. -## Variables to note +## Special variables A protocol module should also set the following variables in their protocol class: -- `self.casemapping`: set this to `rfc1459` (default) or `ascii` to determine which case mapping should be used. -- `self.hook_map`: map a list of non-standard command names sent by the IRCd to those more commonly used: examples in the [TS6](https://github.com/GLolol/PyLink/blob/0.4.0-dev/protocols/ts6.py#L19) and [InspIRCd](https://github.com/GLolol/PyLink/blob/0.4.0-dev/protocols/inspircd.py#L24) modules. +- `self.casemapping`: set this to `rfc1459` (default) or `ascii` to determine which case mapping the IRCd uses. +- `self.hook_map`: this is a `dict`, which maps non-standard command names sent by the IRCd to those that PyLink plugins use internally. + - Examples exist in the [UnrealIRCd](https://github.com/GLolol/PyLink/blob/0.5-dev/protocols/unreal.py#L22) and [InspIRCd](https://github.com/GLolol/PyLink/blob/0.5-dev/protocols/inspircd.py#L24) modules. diff --git a/docs/technical/using-utils.md b/docs/technical/using-utils.md index 2ea79ac..06d09d1 100644 --- a/docs/technical/using-utils.md +++ b/docs/technical/using-utils.md @@ -1 +1 @@ -This page is under construction: see [utils.html ](utils.html) for autogenerated documentation for the utils module. +See [utils.html](utils.html) for auto-generated documentation for the utils module. diff --git a/docs/technical/utils.html b/docs/technical/utils.html index 32844c8..ac07fc2 100644 --- a/docs/technical/utils.html +++ b/docs/technical/utils.html @@ -9,7 +9,10 @@  
utilsindex
/home/gl/pylink/utils.py -

+

utils.py - PyLink utilities module.
+ 
+This module contains various utility functions related to IRC and/or the PyLink
+framework.

@@ -17,12 +20,14 @@ Modules -
       
imp
-inspect
+
conf
+importlib
+		inspect
+os
re
string
world
-

+

- + - -
 
@@ -51,7 +56,8 @@ class NotAuthenticatedError(builtins.Exception)
   # This is separate from classes.py to prevent import loops.
 
Exception raised by checkAuthenticated() when a user fails authentication
+requirements.
 
 
Method resolution order:
NotAuthenticatedError
@@ -129,9 +135,9 @@ Example queries:
Methods defined here:
__init__(self, irc)
-
increment(self, pos=2)
+
increment(self, pos=2)
Increments the SID generator to the next available SID.
-
next_sid(self)
+
next_sid(self)
Returns the next unused TS6 SID for the server.
Data descriptors defined here:
@@ -148,15 +154,15 @@ Data descriptors defined here:
class TS6UIDGenerator(builtins.object)
   TS6 UID Generator module, adapted from InspIRCd source
+		TS6 UID Generator module, adapted from InspIRCd source:
https://github.com/inspircd/inspircd/blob/f449c6b296ab/src/server.cpp#L85-L156
 
  Methods defined here:
__init__(self, sid)
-
increment(self, pos=5)
+
increment(self, pos=5)
Increments the SID generator to the next available SID.
-
next_uid(self)
+
next_uid(self)
Returns the next unused TS6 UID for the server.
Data descriptors defined here:
@@ -173,17 +179,24 @@ Data descriptors defined here:
Functions
       
add_cmd(func, name=None)
-
add_hook(func, command)
Add a hook <func> for command <command>.
+
add_cmd(func, name=None)
Binds an IRC command function to the given command name.
+
add_hook(func, command)
Binds a hook function to the given command name.
applyModes(irc, target, changedmodes)
Takes a list of parsed IRC modes, and applies them on the given target.
 
The target can be either a channel or a user; this is handled automatically.
-
checkAuthenticated(irc, uid, allowAuthed=True, allowOper=True)
Checks whetherthe given user has operator status on PyLink, raising
+
checkAuthenticated(irc, uid, allowAuthed=True, allowOper=True)
Checks whether the given user has operator status on PyLink, raising
NotAuthenticatedError and logging the access denial if not.
clientToServer(irc, numeric)
Finds the SID of the server a user is on.
-
getHostmask(irc, user)
Gets the hostmask of the given user, if present.
-
getProtoModule(protoname)
Imports and returns the protocol module requested.
-
isChannel(s)
Checks whether the string given is a valid channel name.
+
getDatabaseName(dbname)
Returns a database filename with the given base DB name appropriate for the
+current PyLink instance.
+ 
+This returns '<dbname>.db' if the running config name is PyLink's default
+(config.yml), and '<dbname>-<config name>.db' for anything else. For example,
+if this is called from an instance running as './pylink testing.yml', it
+would return '<dbname>-testing.db'.
+
getHostmask(irc, user)
Returns the hostmask of the given user, if present.
+
getProtocolModule(protoname)
Imports and returns the protocol module requested.
+
isChannel(s)
Returns whether the string given is a valid channel name.
isHostmask(text)
Returns whether the given text is a valid hostmask.
isInternalClient(irc, numeric)
Checks whether the given numeric is a PyLink Client,
returning the SID of the server it's on if so.
@@ -192,18 +205,18 @@ returning the SID of the server it's on  client. Usually, automatically spawned services clients should have this
set True to prevent interactions with opers (like mode changes) from
causing desyncs.
-
isNick(s, nicklen=None)
Checks whether the string given is a valid nick.
+
isNick(s, nicklen=None)
Returns whether the string given is a valid nick.
isOper(irc, uid, allowAuthed=True, allowOper=True)
Returns whether the given user has operator status on PyLink. This can be achieved
by either identifying to PyLink as admin (if allowAuthed is True),
or having user mode +o set (if allowOper is True). At least one of
allowAuthed or allowOper must be True for this to give any meaningful
results.
-
isServerName(s)
Checks whether the string given is a server name.
+
isServerName(s)
Returns whether the string given is a valid IRC server name.
joinModes(modes)
Takes a list of (mode, arg) tuples in parseModes() format, and
joins them into a string.
 
See testJoinModes in tests/test_utils.py for some examples.
-
loadModuleFromFolder(name, folder)
Attempts an import of name from a specific folder, returning the resulting module.
+
loadModuleFromFolder(name, folder)
Imports and returns a module, if existing, from a specific folder.
nickToUid(irc, nick)
Returns the UID of a user named nick, if present.
parseModes(irc, target, args)
Parses a modestring list into a list of (mode, argument) tuples.
['+mitl-o', '3', 'person'] => [('+m', None), ('+i', None), ('+t', None), ('+l', '3'), ('-o', 'person')]
diff --git a/protocols/inspircd.py b/protocols/inspircd.py index 2050c18..523240d 100644 --- a/protocols/inspircd.py +++ b/protocols/inspircd.py @@ -1,3 +1,7 @@ +""" +inspircd.py: InspIRCd 2.x protocol module for PyLink. +""" + import time import sys import os diff --git a/protocols/ts6.py b/protocols/ts6.py index 8592ce8..8ebcb91 100644 --- a/protocols/ts6.py +++ b/protocols/ts6.py @@ -1,3 +1,7 @@ +""" +ts6.py: PyLink protocol module for TS6-based IRCds (charybdis, elemental-ircd). +""" + import time import sys import os diff --git a/protocols/ts6_common.py b/protocols/ts6_common.py index 0f59950..5028098 100644 --- a/protocols/ts6_common.py +++ b/protocols/ts6_common.py @@ -1,8 +1,14 @@ +""" +ts6_common.py: Common base protocol class with functions shared by the UnrealIRCd, InspIRCd, and TS6 protocol modules. +""" + import sys import os +# Import hacks to access utils and classes... curdir = os.path.dirname(__file__) sys.path += [curdir, os.path.dirname(curdir)] + import utils from log import log from classes import * diff --git a/protocols/unreal.py b/protocols/unreal.py index a6b9564..9723cc9 100644 --- a/protocols/unreal.py +++ b/protocols/unreal.py @@ -1,3 +1,7 @@ +""" +unreal.py: UnrealIRCd 4.0 protocol module for PyLink. +""" + import time import sys import os @@ -5,8 +9,10 @@ import codecs import socket import re +# Import hacks to access utils and classes... curdir = os.path.dirname(__file__) sys.path += [curdir, os.path.dirname(curdir)] + import utils from log import log from classes import * diff --git a/utils.py b/utils.py index 5d78f78..f4de2a6 100644 --- a/utils.py +++ b/utils.py @@ -16,10 +16,15 @@ import world import conf class NotAuthenticatedError(Exception): + """ + Exception raised by checkAuthenticated() when a user fails authentication + requirements. + """ pass class TS6UIDGenerator(): - """TS6 UID Generator module, adapted from InspIRCd source + """ + TS6 UID Generator module, adapted from InspIRCd source: https://github.com/inspircd/inspircd/blob/f449c6b296ab/src/server.cpp#L85-L156 """ @@ -32,6 +37,9 @@ class TS6UIDGenerator(): self.sid = sid def increment(self, pos=5): + """ + Increments the SID generator to the next available SID. + """ # If we're at the last character in the list of allowed ones, reset # and increment the next level above. if self.uidchars[pos] == self.allowedchars[-1]: @@ -44,6 +52,9 @@ class TS6UIDGenerator(): self.uidchars[pos] = self.allowedchars[idx+1] def next_uid(self): + """ + Returns the next unused TS6 UID for the server. + """ uid = self.sid + ''.join(self.uidchars) self.increment() return uid @@ -71,13 +82,18 @@ class TS6SIDGenerator(): self.query = query = list(irc.serverdata["sidrange"]) except KeyError: raise RuntimeError('(%s) "sidrange" is missing from your server configuration block!' % irc.name) + self.iters = self.query.copy() self.output = self.query.copy() self.allowedchars = {} qlen = len(query) + assert qlen == 3, 'Incorrect length for a SID (must be 3, got %s)' % qlen assert '#' in query, "Must be at least one wildcard (#) in query" + for idx, char in enumerate(query): + # Iterate over each character in the query string we got, along + # with its index in the string. assert char in (string.digits+string.ascii_uppercase+"#"), \ "Invalid character %r found." % char if char == '#': @@ -91,6 +107,9 @@ class TS6SIDGenerator(): def increment(self, pos=2): + """ + Increments the SID generator to the next available SID. + """ if pos < 0: # Oh no, we've wrapped back to the start! raise RuntimeError('No more available SIDs!') @@ -106,7 +125,11 @@ class TS6SIDGenerator(): self.increment(pos-1) def next_sid(self): + """ + Returns the next unused TS6 SID for the server. + """ while ''.join(self.output) in self.irc.servers: + # Increment until the SID we have doesn't already exist. self.increment() sid = ''.join(self.output) return sid @@ -474,7 +497,7 @@ def isOper(irc, uid, allowAuthed=True, allowOper=True): def checkAuthenticated(irc, uid, allowAuthed=True, allowOper=True): """ - Checks whetherthe given user has operator status on PyLink, raising + Checks whether the given user has operator status on PyLink, raising NotAuthenticatedError and logging the access denial if not. """ lastfunc = inspect.stack()[1][3] @@ -494,7 +517,7 @@ def isManipulatableClient(irc, uid): return isInternalClient(irc, uid) and irc.users[uid].manipulatable def getHostmask(irc, user): - """Gets the hostmask of the given user, if present.""" + """Returns the hostmask of the given user, if present.""" userobj = irc.users.get(user) if userobj is None: return '' @@ -513,14 +536,17 @@ def getHostmask(irc, user): return '%s!%s@%s' % (nick, ident, host) def loadModuleFromFolder(name, folder): - """Attempts and returns an import of the given module name from a specific - folder.""" + """ + Imports and returns a module, if existing, from a specific folder. + """ fullpath = os.path.join(folder, '%s.py' % name) m = importlib.machinery.SourceFileLoader(name, fullpath).load_module() return m def getProtocolModule(protoname): - """Imports and returns the protocol module requested.""" + """ + Imports and returns the protocol module requested. + """ return loadModuleFromFolder(protoname, world.protocols_folder) def getDatabaseName(dbname):