diff --git a/docs/technical/README.md b/docs/technical/README.md index 4739550..a051c33 100644 --- a/docs/technical/README.md +++ b/docs/technical/README.md @@ -18,8 +18,6 @@ PyLink is an a modular, plugin-based IRC services framework. It uses swappable p - [PyLink hooks reference](hooks-reference.md) - [Supported named channel modes](channel-modes.csv) - [Supported named user modes](user-modes.csv) -- [API reference: utils.py](autogen/utils.html) -- [API reference: classes.py](autogen/classes.html) ### Future topics (not yet available) - [Writing tests for PyLink modules](writing-tests.md) diff --git a/docs/technical/autogen/classes.html b/docs/technical/autogen/classes.html deleted file mode 100644 index 38f3ff8..0000000 --- a/docs/technical/autogen/classes.html +++ /dev/null @@ -1,569 +0,0 @@ - -Python: module classes - - - - - -
 
- 
classes		index
/home/gl/pylink/classes.py
-

classes.py - Base classes for PyLink IRC Services.
- 
-This module contains the base classes used by PyLink, including threaded IRC
-connections and objects used to represent IRC servers, users, and channels.
- 
-Here be dragons.

-

- - - - - -
 
-Modules
       
hashlib
-inspect
-logging
-		os
-socket
-ssl
-		structures
-sys
-threading
-		time
-utils
-world
-

- - - - - -
 
-Classes
       
-
builtins.Exception(builtins.BaseException) -
-
-
ProtocolError -
-
-
builtins.object -
-
-
Irc -
-
-
FakeIRC -
-
-
IrcChannel -
IrcServer -
IrcUser -
Protocol -
-
-
FakeProto -
-
-
-
-
-

- - - - - - - -
 
-class FakeIRC(Irc)
   Fake IRC object used for unit tests.
 
 
Method resolution order:
-
FakeIRC
-
Irc
-
builtins.object
-
-
-Methods defined here:
-
connect(self)
Runs the connect loop for the IRC object. This is usually called by
-__init__ in a separate thread to allow multiple concurrent connections.
- -
run(self, data)
Queues a message to the fake IRC server.
- -
send(self, data)
Sends raw text to the uplink server.
- -
takeCommands(self, msgs)
Returns a list of commands parsed from the output of takeMsgs().
- -
takeHooks(self)
Returns a list of hook arguments sent by the protocol module since
-the last takeHooks() call.
- -
takeMsgs(self)
Returns a list of messages sent by the protocol module since
-the last takeMsgs() call, so we can track what has been sent.
- -
-Methods inherited from Irc:
-
__init__(self, netname, proto, conf)
Initializes an IRC object. This takes 3 variables: the network name
-(a string), the name of the protocol module to use for this connection,
-and a configuration object.
- -
__repr__(self)
Return repr(self).
- -
applyModes(self, 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.
- -
callCommand(self, source, text)
Calls a PyLink bot command. source is the caller's UID, and text is the
-full, unparsed text of the message.
- -
callHooks(self, hook_args)
Calls a hook function with the given hook args.
- -
checkAuthenticated(self, uid, allowAuthed=True, allowOper=True)
Checks whether the given user has operator status on PyLink, raising
-NotAuthenticatedError and logging the access denial if not.
- -
disconnect(self)
Handle disconnects from the remote server.
- -
getHostmask(self, user, realhost=False, ip=False)
Returns the hostmask of the given user, if present. If the realhost option
-is given, return the real host of the user instead of the displayed host.
-If the ip option is given, return the IP address of the user (this overrides
-realhost).
- -
getServer(self, numeric)
Finds the SID of the server a user is on.
- -
initVars(self)
(Re)sets an IRC object to its default state. This should be called when
-an IRC object is first created, and on every reconnection to a network.
- -
isInternalClient(self, numeric)
Checks whether the given numeric is a PyLink Client,
-returning the SID of the server it's on if so.
- -
isInternalServer(self, sid)
Returns whether the given SID is an internal PyLink server.
- -
isManipulatableClient(self, uid)
Returns whether the given user is marked as an internal, manipulatable
-client. Usually, automatically spawned services clients should have this
-set True to prevent interactions with opers (like mode changes) from
-causing desyncs.
- -
isOper(self, 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.
- -
isServiceBot(self, uid)
Checks whether the given UID is a registered service bot. If True,
-returns the cooresponding ServiceBot object.
- -
logSetup(self)
Initializes any channel loggers defined for the current network.
- -
msg(self, target, text, notice=False, source=None)
Handy function to send messages/notices to clients. Source
-is optional, and defaults to the main PyLink client if not specified.
- -
nickToUid(self, nick)
Looks up the UID of a user with the given nick, if one is present.
- -
parseModes(self, 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')]
- -
reply(self, text, notice=False, source=None)
Replies to the last caller in the right context (channel or PM).
- -
reverseModes(self, target, modes, oldobj=None)
Reverses/Inverts the mode string or mode list given.
- 
-Optionally, an oldobj argument can be given to look at an earlier state of
-a channel/user object, e.g. for checking the op status of a mode setter
-before their modes are processed and added to the channel state.
- 
-This function allows both mode strings or mode lists. Example uses:
-    "+mi-lk test => "-mi+lk test"
-    "mi-k test => "-mi+k test"
-    [('+m', None), ('+r', None), ('+l', '3'), ('-o', 'person')
-     => {('-m', None), ('-r', None), ('-l', None), ('+o', 'person')})
-    {('s', None), ('+o', 'whoever') => {('-s', None), ('-o', 'whoever')})
- -
runline(self, line)
Sends a command to the protocol module.
- -
schedulePing(self)
Schedules periodic pings in a loop.
- -
toLower(self, text)
Returns a lowercase representation of text based on the IRC object's
-casemapping (rfc1459 or ascii).
- -
version(self)
Returns a detailed version string including the PyLink daemon version,
-the protocol module in use, and the server hostname.
- -
-Static methods inherited from Irc:
-
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.
- -
-Data descriptors inherited from Irc:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class FakeProto(Protocol)
   Dummy protocol module for testing purposes.
 
 
Method resolution order:
-
FakeProto
-
Protocol
-
builtins.object
-
-
-Methods defined here:
-
connect(self)
- -
handle_events(self, data)
- -
join(self, client, channel)
- -
spawnClient(self, nick, *args, **kwargs)
- -
-Data and other attributes defined here:
-
Class = <class 'classes.FakeProto'>
Dummy protocol module for testing purposes.
- -
-Methods inherited from Protocol:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class Irc(builtins.object)
   Base IRC object for PyLink.
 
 Methods defined here:
-
__init__(self, netname, proto, conf)
Initializes an IRC object. This takes 3 variables: the network name
-(a string), the name of the protocol module to use for this connection,
-and a configuration object.
- -
__repr__(self)
Return repr(self).
- -
applyModes(self, 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.
- -
callCommand(self, source, text)
Calls a PyLink bot command. source is the caller's UID, and text is the
-full, unparsed text of the message.
- -
callHooks(self, hook_args)
Calls a hook function with the given hook args.
- -
checkAuthenticated(self, uid, allowAuthed=True, allowOper=True)
Checks whether the given user has operator status on PyLink, raising
-NotAuthenticatedError and logging the access denial if not.
- -
connect(self)
Runs the connect loop for the IRC object. This is usually called by
-__init__ in a separate thread to allow multiple concurrent connections.
- -
disconnect(self)
Handle disconnects from the remote server.
- -
getHostmask(self, user, realhost=False, ip=False)
Returns the hostmask of the given user, if present. If the realhost option
-is given, return the real host of the user instead of the displayed host.
-If the ip option is given, return the IP address of the user (this overrides
-realhost).
- -
getServer(self, numeric)
Finds the SID of the server a user is on.
- -
initVars(self)
(Re)sets an IRC object to its default state. This should be called when
-an IRC object is first created, and on every reconnection to a network.
- -
isInternalClient(self, numeric)
Checks whether the given numeric is a PyLink Client,
-returning the SID of the server it's on if so.
- -
isInternalServer(self, sid)
Returns whether the given SID is an internal PyLink server.
- -
isManipulatableClient(self, uid)
Returns whether the given user is marked as an internal, manipulatable
-client. Usually, automatically spawned services clients should have this
-set True to prevent interactions with opers (like mode changes) from
-causing desyncs.
- -
isOper(self, 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.
- -
isServiceBot(self, uid)
Checks whether the given UID is a registered service bot. If True,
-returns the cooresponding ServiceBot object.
- -
logSetup(self)
Initializes any channel loggers defined for the current network.
- -
msg(self, target, text, notice=False, source=None)
Handy function to send messages/notices to clients. Source
-is optional, and defaults to the main PyLink client if not specified.
- -
nickToUid(self, nick)
Looks up the UID of a user with the given nick, if one is present.
- -
parseModes(self, 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')]
- -
reply(self, text, notice=False, source=None)
Replies to the last caller in the right context (channel or PM).
- -
reverseModes(self, target, modes, oldobj=None)
Reverses/Inverts the mode string or mode list given.
- 
-Optionally, an oldobj argument can be given to look at an earlier state of
-a channel/user object, e.g. for checking the op status of a mode setter
-before their modes are processed and added to the channel state.
- 
-This function allows both mode strings or mode lists. Example uses:
-    "+mi-lk test => "-mi+lk test"
-    "mi-k test => "-mi+k test"
-    [('+m', None), ('+r', None), ('+l', '3'), ('-o', 'person')
-     => {('-m', None), ('-r', None), ('-l', None), ('+o', 'person')})
-    {('s', None), ('+o', 'whoever') => {('-s', None), ('-o', 'whoever')})
- -
run(self)
Main IRC loop which listens for messages.
- -
runline(self, line)
Sends a command to the protocol module.
- -
schedulePing(self)
Schedules periodic pings in a loop.
- -
send(self, data)
Sends raw text to the uplink server.
- -
toLower(self, text)
Returns a lowercase representation of text based on the IRC object's
-casemapping (rfc1459 or ascii).
- -
version(self)
Returns a detailed version string including the PyLink daemon version,
-the protocol module in use, and the server hostname.
- -
-Static methods defined here:
-
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.
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class IrcChannel(builtins.object)
   PyLink IRC channel class.
 
 Methods defined here:
-
__init__(self, name=None)
Initialize self.  See help(type(self)) for accurate signature.
- -
__repr__(self)
Return repr(self).
- -
deepcopy(self)
Returns a deep copy of the channel object.
- -
getPrefixModes(self, uid, prefixmodes=None)
Returns a list of all named prefix modes the given user has in the channel.
- 
-Optionally, a prefixmodes argument can be given to look at an earlier state of
-the channel's prefix modes mapping, e.g. for checking the op status of a mode
-setter before their modes are processed and added to the channel state.
- -
isAdmin(self, uid)
Returns whether the given user is admin (&) in the channel.
- -
isHalfop(self, uid)
Returns whether the given user is halfop in the channel.
- -
isHalfopPlus(self, uid)
Returns whether the given user is halfop or above in the channel.
- -
isOp(self, uid)
Returns whether the given user is op in the channel.
- -
isOpPlus(self, uid)
Returns whether the given user is op or above in the channel.
- -
isOwner(self, uid)
Returns whether the given user is owner (~) in the channel.
- -
isVoice(self, uid)
Returns whether the given user is voice in the channel.
- -
isVoicePlus(self, uid)
Returns whether the given user is voice or above in the channel.
- -
removeuser(self, target)
Removes a user from a channel.
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class IrcServer(builtins.object)
   PyLink IRC server class.
- 
-uplink: The SID of this IrcServer instance's uplink. This is set to None
-        for the main PyLink PseudoServer!
-name: The name of the server.
-internal: Whether the server is an internal PyLink PseudoServer.
 
 Methods defined here:
-
__init__(self, uplink, name, internal=False, desc='(None given)')
Initialize self.  See help(type(self)) for accurate signature.
- -
__repr__(self)
Return repr(self).
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class IrcUser(builtins.object)
   PyLink IRC user class.
 
 Methods defined here:
-
__init__(self, nick, ts, uid, ident='null', host='null', realname='PyLink dummy client', realhost='null', ip='0.0.0.0', manipulatable=False, opertype='IRC Operator')
Initialize self.  See help(type(self)) for accurate signature.
- -
__repr__(self)
Return repr(self).
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class Protocol(builtins.object)
   Base Protocol module class for PyLink.
 
 Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class ProtocolError(builtins.Exception)
   Common base class for all non-exit exceptions.
 
 
Method resolution order:
-
ProtocolError
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Data descriptors defined here:
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Methods inherited from builtins.Exception:
-
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__delattr__(self, name, /)
Implement delattr(self, name).
- -
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(...)
helper for pickle
- -
__repr__(self, /)
Return repr(self).
- -
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
- -
__setstate__(...)
- -
__str__(self, /)
Return str(self).
- -
with_traceback(...)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - -
 
-Data
       conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fcfaf78de18>, {})}
-confname = 'testconf'
-curdir = '/home/gl/pylink'
-files = None
-log = <logging.RootLogger object>
-logdir = '/home/gl/pylink/log'
-logformatter = <logging.Formatter object>
-stdout_level = 'CRITICAL'
- \ No newline at end of file diff --git a/docs/technical/autogen/conf.html b/docs/technical/autogen/conf.html deleted file mode 100644 index 7aa280a..0000000 --- a/docs/technical/autogen/conf.html +++ /dev/null @@ -1,54 +0,0 @@ - -Python: module conf - - - - - -
 
- 
conf		index
/home/gl/pylink/conf.py
-

conf.py - PyLink configuration core.
- 
-This module is used to access the complete configuration for the current
-PyLink instance. It will load the config on first import, taking the
-configuration file name from the first command-line argument, but defaulting
-to 'config.yml' if this isn't given.
- 
-If world.testing is set to True, it will return a preset testing configuration
-instead.
- 
-This module also provides simple checks for validating and loading YAML-format
-configurations from arbitrary files.

-

- - - - - -
 
-Modules
       
sys
-		world
-		yaml
-

- - - - - -
 
-Functions
       
loadConf(fname, errors_fatal=True)
Loads a PyLink configuration file from the filename given.
-
validateConf(conf)
Validates a parsed configuration dict.
-

- - - - - -
 
-Data
       conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fee74c229d8>, {})}
-confname = 'testconf'
-fname = None
-testconf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fee74c229d8>, {})}
- \ No newline at end of file diff --git a/docs/technical/autogen/coreplugin.html b/docs/technical/autogen/coreplugin.html deleted file mode 100644 index 6eabff2..0000000 --- a/docs/technical/autogen/coreplugin.html +++ /dev/null @@ -1,77 +0,0 @@ - -Python: module coreplugin - - - - - -
 
- 
coreplugin		index
/home/gl/pylink/coreplugin.py
-

coreplugin.py - Implements core PyLink functions as a plugin.

-

- - - - - -
 
-Modules
       
classes
-conf
-		gc
-os
-		signal
-sys
-		utils
-world
-

- - - - - -
 
-Functions
       
handle_commands(irc, source, command, args)
Handle commands sent to the PyLink service bots (PRIVMSG).
-
handle_disconnect(irc, source, command, args)
Handles network disconnections.
-
handle_endburst(irc, source, command, args)
Handles network bursts.
-
handle_kick(irc, source, command, args)
Handle KICKs to the PyLink service bots, rejoining channels as needed.
-
handle_kill(irc, source, command, args)
Handle KILLs to PyLink service bots, respawning them as needed.
-
handle_mode(irc, source, command, args)
Protect against forced deoper attempts.
-
handle_operup(irc, source, command, args)
Logs successful oper-ups on networks.
-
handle_services_login(irc, source, command, args)
Sets services login status for users.
-
handle_version(irc, source, command, args)
Handles requests for the PyLink server version.
-
handle_whois(irc, source, command, args)
Handle WHOIS queries, for IRCds that send them across servers (charybdis, UnrealIRCd; NOT InspIRCd).
-
identify(irc, source, args)
<username> <password>
- 
-Logs in to PyLink using the configured administrator account.
-
load(irc, source, args)
<plugin name>.
- 
-Loads a plugin from the plugin folder.
-
rehash(irc, source, args)
takes no arguments.
- 
-Reloads the configuration file for PyLink, (dis)connecting added/removed networks.
-Plugins must be manually reloaded.
-
reload(irc, source, args)
<plugin name>.
- 
-Loads a plugin from the plugin folder.
-
shutdown(irc, source, args)
takes no arguments.
- 
-Exits PyLink by disconnecting all networks.
-
sighup_handler(_signo, _stack_frame)
Handles SIGHUP by rehashing the PyLink daemon.
-
sigterm_handler(_signo, _stack_frame)
Handles SIGTERM gracefully by shutting down the PyLink daemon.
-
spawn_service(irc, source, command, args)
Handles new service bot introductions.
-
unload(irc, source, args)
<plugin name>.
- 
-Unloads a currently loaded plugin.
-

- - - - - -
 
-Data
       log = <logging.RootLogger object>
-myident = 'pylink'
-mynick = 'PyLink'
- \ No newline at end of file diff --git a/docs/technical/autogen/hybrid.html b/docs/technical/autogen/hybrid.html deleted file mode 100644 index 685af49..0000000 --- a/docs/technical/autogen/hybrid.html +++ /dev/null @@ -1,470 +0,0 @@ - -Python: module hybrid - - - - - -
 
- 
hybrid		index
/home/gl/pylink/protocols/hybrid.py
-

-

- - - - - -
 
-Modules
       
hashlib
-inspect
-logging
-os
-		re
-socket
-ssl
-string
-		structures
-sys
-threading
-time
-		utils
-world
-

- - - - - -
 
-Classes
       
-
ts6.TS6Protocol(ts6_common.TS6BaseProtocol) -
-
-
HybridProtocol -
-
-
-

- - - - - - - -
 
-Class = class HybridProtocol(ts6.TS6Protocol)
   Base Protocol module class for PyLink.
 
 
Method resolution order:
-
HybridProtocol
-
ts6.TS6Protocol
-
ts6_common.TS6BaseProtocol
-
classes.Protocol
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
connect(self)
Initializes a connection to a server.
- -
handle_capab(self, numeric, command, args)
Handles the CAPAB command, used for TS6 capability negotiation.
- -
handle_eob(self, numeric, command, args)
- -
handle_svsmode(self, numeric, command, args)
Handles SVSMODE, which is used for sending services metadata
-(vhosts, account logins), and other forced usermode changes.
- -
handle_tburst(self, numeric, command, args)
Handles incoming topic burst (TBURST) commands.
- -
handle_uid(self, numeric, command, args)
Handles Hybrid-style UID commands (user introduction). This is INCOMPATIBLE
-with standard TS6 implementations, as the arguments are slightly different.
- -
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 new client with the given options.
- 
-Note: No nick collision / valid nickname checks are done here; it is
-up to plugins to make sure they don't introduce anything invalid.
- -
topicBurst(self, numeric, target, text)
Sends a topic change from a PyLink server. This is usually used on burst.
- -
updateClient(self, target, field, text)
Updates the ident, host, or realname of a PyLink client.
- -
-Methods inherited from ts6.TS6Protocol:
-
handle_472(self, numeric, command, args)
Handles the incoming 472 numeric.
- 
-472 is sent to us when one of our clients tries to set a mode the uplink
-server doesn't support. In this case, we'll raise a warning to alert
-the administrator that certain extensions should be loaded for the best
-compatibility.
- -
handle_bmask(self, numeric, command, args)
Handles incoming BMASK commands (ban propagation on burst).
- -
handle_chghost(self, numeric, command, args)
Handles incoming CHGHOST commands.
- -
handle_encap(self, numeric, command, args)
Handles the ENCAP command - encapsulated TS6 commands with a variety of
-subcommands used for different purposes.
- -
handle_euid(self, numeric, command, args)
Handles incoming EUID commands (user introduction).
- -
handle_invite(self, numeric, command, args)
Handles incoming INVITEs.
- -
handle_join(self, numeric, command, args)
Handles incoming channel JOINs.
- -
handle_mode(self, numeric, command, args)
Handles incoming user mode changes.
- -
handle_pass(self, numeric, command, args)
Handles the PASS command, used to send the server's SID and negotiate
-passwords on connect.
- -
handle_ping(self, source, command, args)
Handles incoming PING commands.
- -
handle_pong(self, source, command, args)
Handles incoming PONG commands.
- -
handle_server(self, numeric, command, args)
Handles 1) incoming legacy (no SID) server introductions,
-2) Sending server data in initial connection.
- -
handle_sid(self, numeric, command, args)
Handles incoming server introductions.
- -
handle_sjoin(self, servernumeric, command, args)
Handles incoming SJOIN commands.
- -
handle_tb(self, numeric, command, args)
Handles incoming topic burst (TB) commands.
- -
handle_tmode(self, numeric, command, args)
Handles incoming TMODE commands (channel mode change).
- -
handle_whois(self, numeric, command, args)
Handles incoming WHOIS commands.
- 
-Note: The core of WHOIS handling is done by coreplugin.py
-(IRCd-independent), and not here.
- -
invite(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
- -
join(self, client, channel)
Joins a PyLink client to a channel.
- -
kill(self, numeric, target, reason)
Sends a kill from a PyLink client/server.
- -
knock(self, numeric, target, text)
Sends a KNOCK from a PyLink client.
- -
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server.
- -
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
-automatically by the Irc() internals; plugins shouldn't have to use this.
- -
sjoin(self, server, channel, users, ts=None)
Sends an SJOIN for a group of users to a channel.
- 
-The sender should always be a Server ID (SID). TS is optional, and defaults
-to the one we've stored in the channel state if not given.
-<users> is a list of (prefix mode, UID) pairs:
- 
-Example uses:
-    sjoin('100', '#test', [('', '100AAABBC'), ('o', 100AAABBB'), ('v', '100AAADDD')])
-    sjoin(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
- -
-Methods inherited from ts6_common.TS6BaseProtocol:
-
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
-to unset AWAY status.
- -
handle_away(self, numeric, command, args)
Handles incoming AWAY messages.
- -
handle_error(self, numeric, command, args)
Handles ERROR messages - these mean that our uplink has disconnected us!
- -
handle_events(self, data)
Event handler for TS6 protocols.
- 
-This passes most commands to the various handle_ABCD() functions
-elsewhere defined protocol modules, coersing various sender prefixes
-from nicks and server names to UIDs and SIDs respectively,
-whenever possible.
- 
-Commands sent without an explicit sender prefix will have them set to
-the SID of the uplink server.
- -
handle_kick(self, source, command, args)
Handles incoming KICKs.
- -
handle_kill(self, source, command, args)
Handles incoming KILLs.
- -
handle_nick(self, numeric, command, args)
Handles incoming NICK changes.
- -
handle_notice = handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_part(self, source, command, args)
Handles incoming PART commands.
- -
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_quit(self, numeric, command, args)
Handles incoming QUIT commands.
- -
handle_save(self, numeric, command, args)
Handles incoming SAVE messages, used to handle nick collisions.
- -
handle_squit(self, numeric, command, args)
Handles incoming SQUITs (netsplits).
- -
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
-TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
- -
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
- -
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
- -
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
- -
nick(self, numeric, newnick)
Changes the nick of a PyLink client.
- -
notice(self, numeric, target, text)
Sends a NOTICE from a PyLink client.
- -
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client, used for WHOIS
-replies.
- -
parseTS6Args(self, args)
Similar to parseArgs(), but stripping leading colons from the first argument
-of a line (usually the sender field).
- -
part(self, client, channel, reason=None)
Sends a part from a PyLink client.
- -
quit(self, numeric, reason)
Quits a PyLink client.
- -
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.
- 
-Note: TS6 doesn't use a specific ENDBURST command, so the endburst_delay
-option will be ignored if given.
- -
squit(self, source, target, text='No reason given')
SQUITs a PyLink server.
- -
topic(self, numeric, target, text)
Sends a TOPIC change from a PyLink client.
- -
-Methods inherited from classes.Protocol:
-
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from classes.Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class HybridProtocol(ts6.TS6Protocol)
   Base Protocol module class for PyLink.
 
 
Method resolution order:
-
HybridProtocol
-
ts6.TS6Protocol
-
ts6_common.TS6BaseProtocol
-
classes.Protocol
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
connect(self)
Initializes a connection to a server.
- -
handle_capab(self, numeric, command, args)
Handles the CAPAB command, used for TS6 capability negotiation.
- -
handle_eob(self, numeric, command, args)
- -
handle_svsmode(self, numeric, command, args)
Handles SVSMODE, which is used for sending services metadata
-(vhosts, account logins), and other forced usermode changes.
- -
handle_tburst(self, numeric, command, args)
Handles incoming topic burst (TBURST) commands.
- -
handle_uid(self, numeric, command, args)
Handles Hybrid-style UID commands (user introduction). This is INCOMPATIBLE
-with standard TS6 implementations, as the arguments are slightly different.
- -
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 new client with the given options.
- 
-Note: No nick collision / valid nickname checks are done here; it is
-up to plugins to make sure they don't introduce anything invalid.
- -
topicBurst(self, numeric, target, text)
Sends a topic change from a PyLink server. This is usually used on burst.
- -
updateClient(self, target, field, text)
Updates the ident, host, or realname of a PyLink client.
- -
-Methods inherited from ts6.TS6Protocol:
-
handle_472(self, numeric, command, args)
Handles the incoming 472 numeric.
- 
-472 is sent to us when one of our clients tries to set a mode the uplink
-server doesn't support. In this case, we'll raise a warning to alert
-the administrator that certain extensions should be loaded for the best
-compatibility.
- -
handle_bmask(self, numeric, command, args)
Handles incoming BMASK commands (ban propagation on burst).
- -
handle_chghost(self, numeric, command, args)
Handles incoming CHGHOST commands.
- -
handle_encap(self, numeric, command, args)
Handles the ENCAP command - encapsulated TS6 commands with a variety of
-subcommands used for different purposes.
- -
handle_euid(self, numeric, command, args)
Handles incoming EUID commands (user introduction).
- -
handle_invite(self, numeric, command, args)
Handles incoming INVITEs.
- -
handle_join(self, numeric, command, args)
Handles incoming channel JOINs.
- -
handle_mode(self, numeric, command, args)
Handles incoming user mode changes.
- -
handle_pass(self, numeric, command, args)
Handles the PASS command, used to send the server's SID and negotiate
-passwords on connect.
- -
handle_ping(self, source, command, args)
Handles incoming PING commands.
- -
handle_pong(self, source, command, args)
Handles incoming PONG commands.
- -
handle_server(self, numeric, command, args)
Handles 1) incoming legacy (no SID) server introductions,
-2) Sending server data in initial connection.
- -
handle_sid(self, numeric, command, args)
Handles incoming server introductions.
- -
handle_sjoin(self, servernumeric, command, args)
Handles incoming SJOIN commands.
- -
handle_tb(self, numeric, command, args)
Handles incoming topic burst (TB) commands.
- -
handle_tmode(self, numeric, command, args)
Handles incoming TMODE commands (channel mode change).
- -
handle_whois(self, numeric, command, args)
Handles incoming WHOIS commands.
- 
-Note: The core of WHOIS handling is done by coreplugin.py
-(IRCd-independent), and not here.
- -
invite(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
- -
join(self, client, channel)
Joins a PyLink client to a channel.
- -
kill(self, numeric, target, reason)
Sends a kill from a PyLink client/server.
- -
knock(self, numeric, target, text)
Sends a KNOCK from a PyLink client.
- -
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server.
- -
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
-automatically by the Irc() internals; plugins shouldn't have to use this.
- -
sjoin(self, server, channel, users, ts=None)
Sends an SJOIN for a group of users to a channel.
- 
-The sender should always be a Server ID (SID). TS is optional, and defaults
-to the one we've stored in the channel state if not given.
-<users> is a list of (prefix mode, UID) pairs:
- 
-Example uses:
-    sjoin('100', '#test', [('', '100AAABBC'), ('o', 100AAABBB'), ('v', '100AAADDD')])
-    sjoin(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
- -
-Methods inherited from ts6_common.TS6BaseProtocol:
-
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
-to unset AWAY status.
- -
handle_away(self, numeric, command, args)
Handles incoming AWAY messages.
- -
handle_error(self, numeric, command, args)
Handles ERROR messages - these mean that our uplink has disconnected us!
- -
handle_events(self, data)
Event handler for TS6 protocols.
- 
-This passes most commands to the various handle_ABCD() functions
-elsewhere defined protocol modules, coersing various sender prefixes
-from nicks and server names to UIDs and SIDs respectively,
-whenever possible.
- 
-Commands sent without an explicit sender prefix will have them set to
-the SID of the uplink server.
- -
handle_kick(self, source, command, args)
Handles incoming KICKs.
- -
handle_kill(self, source, command, args)
Handles incoming KILLs.
- -
handle_nick(self, numeric, command, args)
Handles incoming NICK changes.
- -
handle_notice = handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_part(self, source, command, args)
Handles incoming PART commands.
- -
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_quit(self, numeric, command, args)
Handles incoming QUIT commands.
- -
handle_save(self, numeric, command, args)
Handles incoming SAVE messages, used to handle nick collisions.
- -
handle_squit(self, numeric, command, args)
Handles incoming SQUITs (netsplits).
- -
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
-TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
- -
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
- -
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
- -
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
- -
nick(self, numeric, newnick)
Changes the nick of a PyLink client.
- -
notice(self, numeric, target, text)
Sends a NOTICE from a PyLink client.
- -
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client, used for WHOIS
-replies.
- -
parseTS6Args(self, args)
Similar to parseArgs(), but stripping leading colons from the first argument
-of a line (usually the sender field).
- -
part(self, client, channel, reason=None)
Sends a part from a PyLink client.
- -
quit(self, numeric, reason)
Quits a PyLink client.
- -
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.
- 
-Note: TS6 doesn't use a specific ENDBURST command, so the endburst_delay
-option will be ignored if given.
- -
squit(self, source, target, text='No reason given')
SQUITs a PyLink server.
- -
topic(self, numeric, target, text)
Sends a TOPIC change from a PyLink client.
- -
-Methods inherited from classes.Protocol:
-
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from classes.Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - -
 
-Data
       conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f737f074378>, {})}
-confname = 'testconf'
-curdir = '/home/gl/pylink'
-files = None
-log = <logging.RootLogger object>
-logdir = '/home/gl/pylink/log'
-logformatter = <logging.Formatter object>
-stdout_level = 'CRITICAL'
- \ No newline at end of file diff --git a/docs/technical/autogen/inspircd.html b/docs/technical/autogen/inspircd.html deleted file mode 100644 index 6df8d9a..0000000 --- a/docs/technical/autogen/inspircd.html +++ /dev/null @@ -1,462 +0,0 @@ - -Python: module inspircd - - - - - -
 
- 
inspircd		index
/home/gl/pylink/protocols/inspircd.py
-

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

-

- - - - - -
 
-Modules
       
hashlib
-inspect
-logging
-os
-		re
-socket
-ssl
-string
-		structures
-sys
-threading
-time
-		utils
-world
-

- - - - - -
 
-Classes
       
-
ts6_common.TS6BaseProtocol(classes.Protocol) -
-
-
InspIRCdProtocol -
-
-
-

- - - - - - - -
 
-Class = class InspIRCdProtocol(ts6_common.TS6BaseProtocol)
   Base Protocol module class for PyLink.
 
 
Method resolution order:
-
InspIRCdProtocol
-
ts6_common.TS6BaseProtocol
-
classes.Protocol
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
-to unset AWAY status.
- -
connect(self)
Initializes a connection to a server.
- -
handle_away(self, numeric, command, args)
Handles incoming AWAY messages.
- -
handle_capab(self, source, command, args)
Handles the CAPAB command, used for capability negotiation with our
-uplink.
- -
handle_encap(self, numeric, command, args)
Handles incoming encapsulated commands (ENCAP). Hook arguments
-returned by this should have a parse_as field, that sets the correct
-hook name for the message.
- 
-For InspIRCd, the only ENCAP command we handle right now is KNOCK.
- -
handle_endburst(self, numeric, command, args)
ENDBURST handler; sends a hook with empty contents.
- -
handle_fhost(self, numeric, command, args)
Handles FHOST, used for denoting hostname changes.
- -
handle_fident(self, numeric, command, args)
Handles FIDENT, used for denoting ident changes.
- -
handle_fjoin(self, servernumeric, command, args)
Handles incoming FJOIN commands (InspIRCd equivalent of JOIN/SJOIN).
- -
handle_fmode(self, numeric, command, args)
Handles the FMODE command, used for channel mode changes.
- -
handle_fname(self, numeric, command, args)
Handles FNAME, used for denoting real name/gecos changes.
- -
handle_ftopic(self, numeric, command, args)
Handles incoming FTOPIC (sets topic on burst).
- -
handle_idle(self, numeric, command, args)
Handles the IDLE command, sent between servers in remote WHOIS queries.
- -
handle_invite(self, numeric, command, args)
Handles incoming INVITEs.
- -
handle_metadata(self, numeric, command, args)
Handles the METADATA command, used by servers to send metadata (services
-login name, certfp data, etc.) for clients.
- -
handle_mode(self, numeric, command, args)
Handles incoming user mode changes.
- -
handle_opertype(self, numeric, command, args)
Handles incoming OPERTYPE, which is used to denote an oper up.
- 
-This calls the internal hook CLIENT_OPERED, sets the internal
-opertype of the client, and assumes setting user mode +o on the caller.
- -
handle_ping(self, source, command, args)
Handles incoming PING commands, so we don't time out.
- -
handle_pong(self, source, command, args)
Handles incoming PONG commands.
- 
-This is used to keep track of whether the uplink is alive by the Irc()
-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).
- -
handle_version(self, numeric, command, args)
Stub VERSION handler (does nothing) to override the one in ts6_common.
- -
invite(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
- -
join(self, client, channel)
Joins a PyLink client to a channel.
- -
kill(self, numeric, target, reason)
Sends a kill from a PyLink client/server.
- -
knock(self, numeric, target, text)
Sends a KNOCK from a PyLink client.
- -
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server.
- -
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client, used for WHOIS
-replies.
- -
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
-automatically by the Irc() internals; plugins shouldn't have to use this.
- -
sjoin(self, server, channel, users, ts=None)
Sends an SJOIN for a group of users to a channel.
- 
-The sender should always be a Server ID (SID). TS is optional, and defaults
-to the one we've stored in the channel state if not given.
-<users> is a list of (prefix mode, UID) pairs:
- 
-Example uses:
-    sjoin('100', '#test', [('', '100AAABBC'), ('qo', 100AAABBB'), ('h', '100AAADDD')])
-    sjoin(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
- -
spawnClient(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype='IRC Operator', manipulatable=False)
Spawns a new client with the given options.
- 
-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, 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.
- 
-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.
- -
squit(self, source, target, text='No reason given')
SQUITs a PyLink server.
- -
topicBurst(self, numeric, target, text)
Sends a topic change from a PyLink server. This is usually used on burst.
- -
updateClient(self, target, field, text)
Updates the ident, host, or realname of any connected client.
- -
-Methods inherited from ts6_common.TS6BaseProtocol:
-
handle_error(self, numeric, command, args)
Handles ERROR messages - these mean that our uplink has disconnected us!
- -
handle_events(self, data)
Event handler for TS6 protocols.
- 
-This passes most commands to the various handle_ABCD() functions
-elsewhere defined protocol modules, coersing various sender prefixes
-from nicks and server names to UIDs and SIDs respectively,
-whenever possible.
- 
-Commands sent without an explicit sender prefix will have them set to
-the SID of the uplink server.
- -
handle_kick(self, source, command, args)
Handles incoming KICKs.
- -
handle_kill(self, source, command, args)
Handles incoming KILLs.
- -
handle_nick(self, numeric, command, args)
Handles incoming NICK changes.
- -
handle_notice = handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_part(self, source, command, args)
Handles incoming PART commands.
- -
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_quit(self, numeric, command, args)
Handles incoming QUIT commands.
- -
handle_save(self, numeric, command, args)
Handles incoming SAVE messages, used to handle nick collisions.
- -
handle_squit(self, numeric, command, args)
Handles incoming SQUITs (netsplits).
- -
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
-TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
- -
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
- -
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
- -
nick(self, numeric, newnick)
Changes the nick of a PyLink client.
- -
notice(self, numeric, target, text)
Sends a NOTICE from a PyLink client.
- -
parseTS6Args(self, args)
Similar to parseArgs(), but stripping leading colons from the first argument
-of a line (usually the sender field).
- -
part(self, client, channel, reason=None)
Sends a part from a PyLink client.
- -
quit(self, numeric, reason)
Quits a PyLink client.
- -
topic(self, numeric, target, text)
Sends a TOPIC change from a PyLink client.
- -
-Methods inherited from classes.Protocol:
-
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from classes.Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class InspIRCdProtocol(ts6_common.TS6BaseProtocol)
   Base Protocol module class for PyLink.
 
 
Method resolution order:
-
InspIRCdProtocol
-
ts6_common.TS6BaseProtocol
-
classes.Protocol
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
-to unset AWAY status.
- -
connect(self)
Initializes a connection to a server.
- -
handle_away(self, numeric, command, args)
Handles incoming AWAY messages.
- -
handle_capab(self, source, command, args)
Handles the CAPAB command, used for capability negotiation with our
-uplink.
- -
handle_encap(self, numeric, command, args)
Handles incoming encapsulated commands (ENCAP). Hook arguments
-returned by this should have a parse_as field, that sets the correct
-hook name for the message.
- 
-For InspIRCd, the only ENCAP command we handle right now is KNOCK.
- -
handle_endburst(self, numeric, command, args)
ENDBURST handler; sends a hook with empty contents.
- -
handle_fhost(self, numeric, command, args)
Handles FHOST, used for denoting hostname changes.
- -
handle_fident(self, numeric, command, args)
Handles FIDENT, used for denoting ident changes.
- -
handle_fjoin(self, servernumeric, command, args)
Handles incoming FJOIN commands (InspIRCd equivalent of JOIN/SJOIN).
- -
handle_fmode(self, numeric, command, args)
Handles the FMODE command, used for channel mode changes.
- -
handle_fname(self, numeric, command, args)
Handles FNAME, used for denoting real name/gecos changes.
- -
handle_ftopic(self, numeric, command, args)
Handles incoming FTOPIC (sets topic on burst).
- -
handle_idle(self, numeric, command, args)
Handles the IDLE command, sent between servers in remote WHOIS queries.
- -
handle_invite(self, numeric, command, args)
Handles incoming INVITEs.
- -
handle_metadata(self, numeric, command, args)
Handles the METADATA command, used by servers to send metadata (services
-login name, certfp data, etc.) for clients.
- -
handle_mode(self, numeric, command, args)
Handles incoming user mode changes.
- -
handle_opertype(self, numeric, command, args)
Handles incoming OPERTYPE, which is used to denote an oper up.
- 
-This calls the internal hook CLIENT_OPERED, sets the internal
-opertype of the client, and assumes setting user mode +o on the caller.
- -
handle_ping(self, source, command, args)
Handles incoming PING commands, so we don't time out.
- -
handle_pong(self, source, command, args)
Handles incoming PONG commands.
- 
-This is used to keep track of whether the uplink is alive by the Irc()
-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).
- -
handle_version(self, numeric, command, args)
Stub VERSION handler (does nothing) to override the one in ts6_common.
- -
invite(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
- -
join(self, client, channel)
Joins a PyLink client to a channel.
- -
kill(self, numeric, target, reason)
Sends a kill from a PyLink client/server.
- -
knock(self, numeric, target, text)
Sends a KNOCK from a PyLink client.
- -
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server.
- -
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client, used for WHOIS
-replies.
- -
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
-automatically by the Irc() internals; plugins shouldn't have to use this.
- -
sjoin(self, server, channel, users, ts=None)
Sends an SJOIN for a group of users to a channel.
- 
-The sender should always be a Server ID (SID). TS is optional, and defaults
-to the one we've stored in the channel state if not given.
-<users> is a list of (prefix mode, UID) pairs:
- 
-Example uses:
-    sjoin('100', '#test', [('', '100AAABBC'), ('qo', 100AAABBB'), ('h', '100AAADDD')])
-    sjoin(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
- -
spawnClient(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype='IRC Operator', manipulatable=False)
Spawns a new client with the given options.
- 
-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, 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.
- 
-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.
- -
squit(self, source, target, text='No reason given')
SQUITs a PyLink server.
- -
topicBurst(self, numeric, target, text)
Sends a topic change from a PyLink server. This is usually used on burst.
- -
updateClient(self, target, field, text)
Updates the ident, host, or realname of any connected client.
- -
-Methods inherited from ts6_common.TS6BaseProtocol:
-
handle_error(self, numeric, command, args)
Handles ERROR messages - these mean that our uplink has disconnected us!
- -
handle_events(self, data)
Event handler for TS6 protocols.
- 
-This passes most commands to the various handle_ABCD() functions
-elsewhere defined protocol modules, coersing various sender prefixes
-from nicks and server names to UIDs and SIDs respectively,
-whenever possible.
- 
-Commands sent without an explicit sender prefix will have them set to
-the SID of the uplink server.
- -
handle_kick(self, source, command, args)
Handles incoming KICKs.
- -
handle_kill(self, source, command, args)
Handles incoming KILLs.
- -
handle_nick(self, numeric, command, args)
Handles incoming NICK changes.
- -
handle_notice = handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_part(self, source, command, args)
Handles incoming PART commands.
- -
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_quit(self, numeric, command, args)
Handles incoming QUIT commands.
- -
handle_save(self, numeric, command, args)
Handles incoming SAVE messages, used to handle nick collisions.
- -
handle_squit(self, numeric, command, args)
Handles incoming SQUITs (netsplits).
- -
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
-TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
- -
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
- -
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
- -
nick(self, numeric, newnick)
Changes the nick of a PyLink client.
- -
notice(self, numeric, target, text)
Sends a NOTICE from a PyLink client.
- -
parseTS6Args(self, args)
Similar to parseArgs(), but stripping leading colons from the first argument
-of a line (usually the sender field).
- -
part(self, client, channel, reason=None)
Sends a part from a PyLink client.
- -
quit(self, numeric, reason)
Quits a PyLink client.
- -
topic(self, numeric, target, text)
Sends a TOPIC change from a PyLink client.
- -
-Methods inherited from classes.Protocol:
-
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from classes.Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - -
 
-Data
       conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7ff146c496a8>, {})}
-confname = 'testconf'
-curdir = '/home/gl/pylink'
-files = None
-log = <logging.RootLogger object>
-logdir = '/home/gl/pylink/log'
-logformatter = <logging.Formatter object>
-stdout_level = 'CRITICAL'
- \ No newline at end of file diff --git a/docs/technical/autogen/log.html b/docs/technical/autogen/log.html deleted file mode 100644 index 5bde462..0000000 --- a/docs/technical/autogen/log.html +++ /dev/null @@ -1,166 +0,0 @@ - -Python: module log - - - - - -
 
- 
log		index
/home/gl/pylink/log.py
-

log.py - PyLink logging module.
- 
-This module contains the logging portion of the PyLink framework. Plugins can
-access the global logger object by importing "log" from this module
-(from log import log).

-

- - - - - -
 
-Modules
       
logging
-		os
-		sys
-		world
-

- - - - - -
 
-Classes
       
-
logging.Handler(logging.Filterer) -
-
-
PyLinkChannelLogger -
-
-
-

- - - - - - - -
 
-class PyLinkChannelLogger(logging.Handler)
   Log handler to log to channels in PyLink.
 
 
Method resolution order:
-
PyLinkChannelLogger
-
logging.Handler
-
logging.Filterer
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc, channel, level=None)
Initializes the instance - basically setting the formatter to None
-and the filter list to empty.
- -
emit(self, record)
Logs a record to the configured channels for the network given.
- -
-Methods inherited from logging.Handler:
-
acquire(self)
Acquire the I/O thread lock.
- -
close(self)
Tidy up any resources used by the handler.
- 
-This version removes the handler from an internal map of handlers,
-_handlers, which is used for handler lookup by name. Subclasses
-should ensure that this gets called from overridden close()
-methods.
- -
createLock(self)
Acquire a thread lock for serializing access to the underlying I/O.
- -
flush(self)
Ensure all logging output has been flushed.
- 
-This version does nothing and is intended to be implemented by
-subclasses.
- -
format(self, record)
Format the specified record.
- 
-If a formatter is set, use it. Otherwise, use the default formatter
-for the module.
- -
get_name(self)
- -
handle(self, record)
Conditionally emit the specified logging record.
- 
-Emission depends on filters which may have been added to the handler.
-Wrap the actual emission of the record with acquisition/release of
-the I/O thread lock. Returns whether the filter passed the record for
-emission.
- -
handleError(self, record)
Handle errors which occur during an emit() call.
- 
-This method should be called from handlers when an exception is
-encountered during an emit() call. If raiseExceptions is false,
-exceptions get silently ignored. This is what is mostly wanted
-for a logging system - most users will not care about errors in
-the logging system, they are more interested in application errors.
-You could, however, replace this with a custom handler if you wish.
-The record which was being processed is passed in to this method.
- -
release(self)
Release the I/O thread lock.
- -
setFormatter(self, fmt)
Set the formatter for this handler.
- -
setLevel(self, level)
Set the logging level of this handler.  level must be an int or a str.
- -
set_name(self, name)
- -
-Data descriptors inherited from logging.Handler:
-
name
-
-
-Methods inherited from logging.Filterer:
-
addFilter(self, filter)
Add the specified filter to this handler.
- -
filter(self, record)
Determine if a record is loggable by consulting all the filters.
- 
-The default is to allow the record to be logged; any filter can veto
-this and the record is then dropped. Returns a zero value if a record
-is to be dropped, else non-zero.
- 
-.. versionchanged:: 3.2
- 
-   Allow filters to be just callables.
- -
removeFilter(self, filter)
Remove the specified filter from this handler.
- -
-Data descriptors inherited from logging.Filterer:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - -
 
-Functions
       
makeFileLogger(filename, level=None)
Initializes a file logging target with the given filename and level.
-

- - - - - -
 
-Data
       conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f496c510e18>, {})}
-confname = 'testconf'
-curdir = '/home/gl/pylink'
-files = None
-log = <logging.RootLogger object>
-logdir = '/home/gl/pylink/log'
-logformatter = <logging.Formatter object>
-stdout_level = 'CRITICAL'
- \ No newline at end of file diff --git a/docs/technical/autogen/nefarious.html b/docs/technical/autogen/nefarious.html deleted file mode 100644 index 9357aba..0000000 --- a/docs/technical/autogen/nefarious.html +++ /dev/null @@ -1,475 +0,0 @@ - -Python: module nefarious - - - - - -
 
- 
nefarious		index
/home/gl/pylink/protocols/nefarious.py
-

nefarious.py: Nefarious IRCu protocol module for PyLink.

-

- - - - - -
 
-Modules
       
base64
-hashlib
-inspect
-logging
-		os
-socket
-ssl
-struct
-		structures
-sys
-threading
-time
-		utils
-world
-

- - - - - -
 
-Classes
       
-
builtins.object -
-
-
P10SIDGenerator -
-
-
classes.Protocol(builtins.object) -
-
-
P10Protocol -
-
-
utils.IncrementalUIDGenerator(builtins.object) -
-
-
P10UIDGenerator -
-
-
-

- - - - - - - -
 
-Class = class P10Protocol(classes.Protocol)
   Base Protocol module class for PyLink.
 
 
Method resolution order:
-
P10Protocol
-
classes.Protocol
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
-to unset AWAY status.
- -
checkCloakChange(self, uid)
Checks for cloak changes on the given UID.
- -
connect(self)
Initializes a connection to a server.
- -
handle_account(self, numeric, command, args)
Handles services account changes.
- -
handle_away(self, numeric, command, args)
Handles incoming AWAY messages.
- -
handle_burst(self, source, command, args)
Handles the BURST command, used for bursting channels on link.
- 
-This is equivalent to SJOIN on most IRCds.
- -
handle_clearmode(self, numeric, command, args)
Handles CLEARMODE, which is used to clear a channel's modes.
- -
handle_create = handle_join(self, source, command, args)
- -
handle_end_of_burst(self, source, command, args)
Handles end of burst from our uplink.
- -
handle_events(self, data)
Event handler for the P10 protocol.
- 
-This passes most commands to the various handle_ABCD() functions defined elsewhere in the
-protocol modules, coersing various sender prefixes from nicks and server names to P10
-"numeric nicks", whenever possible.
- 
-Commands sent without an explicit sender prefix are treated as originating from the uplink
-server.
- -
handle_fake(self, numeric, command, args)
Handles incoming FAKE hostmask changes.
- -
handle_invite(self, source, command, args)
Handles incoming INVITEs.
- -
handle_join(self, source, command, args)
Handles incoming JOINs and channel creations.
- -
handle_kick(self, source, command, args)
Handles incoming KICKs.
- -
handle_kill(self, numeric, command, args)
Handles incoming KILLs.
- -
handle_mode(self, source, command, args)
Handles mode changes.
- -
handle_nick(self, source, command, args)
Handles the NICK command, used for user introductions and nick changes.
- -
handle_notice = handle_privmsg(self, source, command, args)
- -
handle_opmode = handle_mode(self, source, command, args)
- -
handle_part(self, source, command, args)
Handles user parts.
- -
handle_pass(self, source, command, args)
Handles authentication with our uplink.
- -
handle_ping(self, source, command, args)
Handles incoming PING requests.
- -
handle_pong(self, source, command, args)
Handles incoming PONGs.
- -
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_quit(self, numeric, command, args)
Handles incoming QUITs.
- -
handle_server(self, source, command, args)
Handles incoming server introductions.
- -
handle_squit(self, numeric, command, args)
Handles incoming SQUITs.
- -
handle_topic(self, source, command, args)
Handles TOPIC changes.
- -
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
- -
handle_whois(self, numeric, command, args)
Handles incoming WHOIS requests.
- -
invite(self, numeric, target, channel)
Sends INVITEs from a PyLink client.
- -
join(self, client, channel)
Joins a PyLink client to a channel.
- -
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
- -
kill(self, numeric, target, reason)
Sends a kill from a PyLink client/server.
- -
knock(self, numeric, target, text)
- -
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
- -
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server.
- -
nick(self, numeric, newnick)
Changes the nick of a PyLink client.
- -
notice(self, numeric, target, text)
Sends a NOTICE from a PyLink client.
- -
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client. This is used for WHOIS
-replies.
- -
part(self, client, channel, reason=None)
Sends a part from a PyLink client.
- -
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
-automatically by the Irc() internals; plugins shouldn't have to use this.
- -
quit(self, numeric, reason)
Quits a PyLink client.
- -
sjoin(self, server, channel, users, ts=None)
Sends an SJOIN for a group of users to a channel.
- 
-The sender should always be a Server ID (SID). TS is optional, and defaults
-to the one we've stored in the channel state if not given.
-<users> is a list of (prefix mode, UID) pairs:
- 
-Example uses:
-    sjoin('100', '#test', [('', '100AAABBC'), ('o', 100AAABBB'), ('v', '100AAADDD')])
-    sjoin(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
- -
spawnClient(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype='IRC Operator', manipulatable=False)
Spawns a new client with the given options.
- 
-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, 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.
- 
-Note: TS6 doesn't use a specific ENDBURST command, so the endburst_delay
-option will be ignored if given.
- -
squit(self, source, target, text='No reason given')
SQUITs a PyLink server.
- -
topic(self, numeric, target, text)
Sends a TOPIC change from a PyLink client.
- -
topicBurst(self, numeric, target, text)
Sends a TOPIC change from a PyLink server.
- -
updateClient(self, target, field, text)
Updates the ident or host of any connected client.
- -
-Static methods defined here:
-
decode_p10_ip(ip)
Decodes a P10 IP.
- -
-Methods inherited from classes.Protocol:
-
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from classes.Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class P10Protocol(classes.Protocol)
   Base Protocol module class for PyLink.
 
 
Method resolution order:
-
P10Protocol
-
classes.Protocol
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
-to unset AWAY status.
- -
checkCloakChange(self, uid)
Checks for cloak changes on the given UID.
- -
connect(self)
Initializes a connection to a server.
- -
handle_account(self, numeric, command, args)
Handles services account changes.
- -
handle_away(self, numeric, command, args)
Handles incoming AWAY messages.
- -
handle_burst(self, source, command, args)
Handles the BURST command, used for bursting channels on link.
- 
-This is equivalent to SJOIN on most IRCds.
- -
handle_clearmode(self, numeric, command, args)
Handles CLEARMODE, which is used to clear a channel's modes.
- -
handle_create = handle_join(self, source, command, args)
- -
handle_end_of_burst(self, source, command, args)
Handles end of burst from our uplink.
- -
handle_events(self, data)
Event handler for the P10 protocol.
- 
-This passes most commands to the various handle_ABCD() functions defined elsewhere in the
-protocol modules, coersing various sender prefixes from nicks and server names to P10
-"numeric nicks", whenever possible.
- 
-Commands sent without an explicit sender prefix are treated as originating from the uplink
-server.
- -
handle_fake(self, numeric, command, args)
Handles incoming FAKE hostmask changes.
- -
handle_invite(self, source, command, args)
Handles incoming INVITEs.
- -
handle_join(self, source, command, args)
Handles incoming JOINs and channel creations.
- -
handle_kick(self, source, command, args)
Handles incoming KICKs.
- -
handle_kill(self, numeric, command, args)
Handles incoming KILLs.
- -
handle_mode(self, source, command, args)
Handles mode changes.
- -
handle_nick(self, source, command, args)
Handles the NICK command, used for user introductions and nick changes.
- -
handle_notice = handle_privmsg(self, source, command, args)
- -
handle_opmode = handle_mode(self, source, command, args)
- -
handle_part(self, source, command, args)
Handles user parts.
- -
handle_pass(self, source, command, args)
Handles authentication with our uplink.
- -
handle_ping(self, source, command, args)
Handles incoming PING requests.
- -
handle_pong(self, source, command, args)
Handles incoming PONGs.
- -
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_quit(self, numeric, command, args)
Handles incoming QUITs.
- -
handle_server(self, source, command, args)
Handles incoming server introductions.
- -
handle_squit(self, numeric, command, args)
Handles incoming SQUITs.
- -
handle_topic(self, source, command, args)
Handles TOPIC changes.
- -
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
- -
handle_whois(self, numeric, command, args)
Handles incoming WHOIS requests.
- -
invite(self, numeric, target, channel)
Sends INVITEs from a PyLink client.
- -
join(self, client, channel)
Joins a PyLink client to a channel.
- -
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
- -
kill(self, numeric, target, reason)
Sends a kill from a PyLink client/server.
- -
knock(self, numeric, target, text)
- -
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
- -
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server.
- -
nick(self, numeric, newnick)
Changes the nick of a PyLink client.
- -
notice(self, numeric, target, text)
Sends a NOTICE from a PyLink client.
- -
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client. This is used for WHOIS
-replies.
- -
part(self, client, channel, reason=None)
Sends a part from a PyLink client.
- -
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
-automatically by the Irc() internals; plugins shouldn't have to use this.
- -
quit(self, numeric, reason)
Quits a PyLink client.
- -
sjoin(self, server, channel, users, ts=None)
Sends an SJOIN for a group of users to a channel.
- 
-The sender should always be a Server ID (SID). TS is optional, and defaults
-to the one we've stored in the channel state if not given.
-<users> is a list of (prefix mode, UID) pairs:
- 
-Example uses:
-    sjoin('100', '#test', [('', '100AAABBC'), ('o', 100AAABBB'), ('v', '100AAADDD')])
-    sjoin(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
- -
spawnClient(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype='IRC Operator', manipulatable=False)
Spawns a new client with the given options.
- 
-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, 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.
- 
-Note: TS6 doesn't use a specific ENDBURST command, so the endburst_delay
-option will be ignored if given.
- -
squit(self, source, target, text='No reason given')
SQUITs a PyLink server.
- -
topic(self, numeric, target, text)
Sends a TOPIC change from a PyLink client.
- -
topicBurst(self, numeric, target, text)
Sends a TOPIC change from a PyLink server.
- -
updateClient(self, target, field, text)
Updates the ident or host of any connected client.
- -
-Static methods defined here:
-
decode_p10_ip(ip)
Decodes a P10 IP.
- -
-Methods inherited from classes.Protocol:
-
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from classes.Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - -
 
-class P10SIDGenerator(builtins.object)
    Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
next_sid(self)
Returns the next available SID.
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class P10UIDGenerator(utils.IncrementalUIDGenerator)
   Implements an incremental P10 UID Generator.
 
 
Method resolution order:
-
P10UIDGenerator
-
utils.IncrementalUIDGenerator
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, sid)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Methods inherited from utils.IncrementalUIDGenerator:
-
increment(self, pos=None)
Increments the UID generator to the next available UID.
- -
next_uid(self)
Returns the next unused UID for the server.
- -
-Data descriptors inherited from utils.IncrementalUIDGenerator:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - -
 
-Functions
       
p10b64encode(num, length=2)
Encodes a given numeric using P10 Base64 numeric nicks, as documented at
-https://github.com/evilnet/nefarious2/blob/a29b63144/doc/p10.txt#L69-L92
-

- - - - - -
 
-Data
       conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fcf7b6db510>, {})}
-confname = 'testconf'
-curdir = '/home/gl/pylink'
-files = None
-log = <logging.RootLogger object>
-logdir = '/home/gl/pylink/log'
-logformatter = <logging.Formatter object>
-stdout_level = 'CRITICAL'
- \ No newline at end of file diff --git a/docs/technical/autogen/structures.html b/docs/technical/autogen/structures.html deleted file mode 100644 index 7495a92..0000000 --- a/docs/technical/autogen/structures.html +++ /dev/null @@ -1,194 +0,0 @@ - -Python: module structures - - - - - -
 
- 
structures		index
/home/gl/pylink/structures.py
-

structures.py - PyLink data structures module.
- 
-This module contains custom data structures that may be useful in various situations.

-

- - - - - -
 
-Modules
       
collections
-		json
-

- - - - - -
 
-Classes
       
-
builtins.object -
-
-
DataStore -
-
-
collections.defaultdict(builtins.dict) -
-
-
KeyedDefaultdict -
-
-
-

- - - - - -
 
-class DataStore(builtins.object)
    Methods defined here:
-
__contains__(self, key)
# single keys
- -
__init__(self, name, filename, db_format='json', save_frequency={'seconds': 30})
Initialize self.  See help(type(self)) for accurate signature.
- -
create_or_load(self)
- -
delete(self, key)
- -
delete_keys(self, prefix)
Delete all keys with the given prefix.
- -
get(self, key, default=None)
- -
list_keys(self, prefix=None)
Return all key names. If prefix given, return only keys that start with it.
- -
put(self, key, value)
- -
save(self)
- -
save_callback(self, starting=False)
Start the DB save loop.
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes defined here:
-
initial_version = 1
- -

- - - - - - - -
 
-class KeyedDefaultdict(collections.defaultdict)
   Subclass of defaultdict allowing the key to be passed to the default factory.
 
 
Method resolution order:
-
KeyedDefaultdict
-
collections.defaultdict
-
builtins.dict
-
builtins.object
-
-
-Methods defined here:
-
__missing__(self, key)
__missing__(key) # Called by __getitem__ for missing key; pseudo-code:
-if self.default_factory is None: raise KeyError((key,))
-self[key] = value = self.default_factory()
-return value
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Methods inherited from collections.defaultdict:
-
__copy__(...)
D.copy() -> a shallow copy of D.
- -
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__reduce__(...)
Return state information for pickling.
- -
__repr__(self, /)
Return repr(self).
- -
copy(...)
D.copy() -> a shallow copy of D.
- -
-Data descriptors inherited from collections.defaultdict:
-
default_factory
-
Factory for default value called by __missing__().
-
-
-Methods inherited from builtins.dict:
-
__contains__(self, key, /)
True if D has a key k, else False.
- -
__delitem__(self, key, /)
Delete self[key].
- -
__eq__(self, value, /)
Return self==value.
- -
__ge__(self, value, /)
Return self>=value.
- -
__getitem__(...)
x.__getitem__(y) <==> x[y]
- -
__gt__(self, value, /)
Return self>value.
- -
__iter__(self, /)
Implement iter(self).
- -
__le__(self, value, /)
Return self<=value.
- -
__len__(self, /)
Return len(self).
- -
__lt__(self, value, /)
Return self<value.
- -
__ne__(self, value, /)
Return self!=value.
- -
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
- -
__setitem__(self, key, value, /)
Set self[key] to value.
- -
__sizeof__(...)
D.__sizeof__() -> size of D in memory, in bytes
- -
clear(...)
D.clear() -> None.  Remove all items from D.
- -
fromkeys(iterable, value=None, /) from builtins.type
Returns a new dict with keys from iterable and values equal to value.
- -
get(...)
D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
- -
items(...)
D.items() -> a set-like object providing a view on D's items
- -
keys(...)
D.keys() -> a set-like object providing a view on D's keys
- -
pop(...)
D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
-If key is not found, d is returned if given, otherwise KeyError is raised
- -
popitem(...)
D.popitem() -> (k, v), remove and return some (key, value) pair as a
-2-tuple; but raise KeyError if D is empty.
- -
setdefault(...)
D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
- -
update(...)
D.update([E, ]**F) -> None.  Update D from dict/iterable E and F.
-If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
-If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
-In either case, this is followed by: for k in F:  D[k] = F[k]
- -
values(...)
D.values() -> an object providing a view on D's values
- -
-Data and other attributes inherited from builtins.dict:
-
__hash__ = None
- -

- \ No newline at end of file diff --git a/docs/technical/autogen/ts6.html b/docs/technical/autogen/ts6.html deleted file mode 100644 index cf678c9..0000000 --- a/docs/technical/autogen/ts6.html +++ /dev/null @@ -1,448 +0,0 @@ - -Python: module ts6 - - - - - -
 
- 
ts6		index
/home/gl/pylink/protocols/ts6.py
-

ts6.py: PyLink protocol module for TS6-based IRCds (charybdis, elemental-ircd).

-

- - - - - -
 
-Modules
       
hashlib
-inspect
-logging
-os
-		re
-socket
-ssl
-string
-		structures
-sys
-threading
-time
-		utils
-world
-

- - - - - -
 
-Classes
       
-
ts6_common.TS6BaseProtocol(classes.Protocol) -
-
-
TS6Protocol -
-
-
-

- - - - - - - -
 
-Class = class TS6Protocol(ts6_common.TS6BaseProtocol)
   Base Protocol module class for PyLink.
 
 
Method resolution order:
-
TS6Protocol
-
ts6_common.TS6BaseProtocol
-
classes.Protocol
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
connect(self)
Initializes a connection to a server.
- -
handle_472(self, numeric, command, args)
Handles the incoming 472 numeric.
- 
-472 is sent to us when one of our clients tries to set a mode the uplink
-server doesn't support. In this case, we'll raise a warning to alert
-the administrator that certain extensions should be loaded for the best
-compatibility.
- -
handle_bmask(self, numeric, command, args)
Handles incoming BMASK commands (ban propagation on burst).
- -
handle_capab(self, numeric, command, args)
Handles the CAPAB command, used for TS6 capability negotiation.
- -
handle_chghost(self, numeric, command, args)
Handles incoming CHGHOST commands.
- -
handle_encap(self, numeric, command, args)
Handles the ENCAP command - encapsulated TS6 commands with a variety of
-subcommands used for different purposes.
- -
handle_euid(self, numeric, command, args)
Handles incoming EUID commands (user introduction).
- -
handle_invite(self, numeric, command, args)
Handles incoming INVITEs.
- -
handle_join(self, numeric, command, args)
Handles incoming channel JOINs.
- -
handle_mode(self, numeric, command, args)
Handles incoming user mode changes.
- -
handle_pass(self, numeric, command, args)
Handles the PASS command, used to send the server's SID and negotiate
-passwords on connect.
- -
handle_ping(self, source, command, args)
Handles incoming PING commands.
- -
handle_pong(self, source, command, args)
Handles incoming PONG commands.
- -
handle_server(self, numeric, command, args)
Handles 1) incoming legacy (no SID) server introductions,
-2) Sending server data in initial connection.
- -
handle_sid(self, numeric, command, args)
Handles incoming server introductions.
- -
handle_sjoin(self, servernumeric, command, args)
Handles incoming SJOIN commands.
- -
handle_tb(self, numeric, command, args)
Handles incoming topic burst (TB) commands.
- -
handle_tmode(self, numeric, command, args)
Handles incoming TMODE commands (channel mode change).
- -
handle_uid(self, numeric, command, args)
- -
handle_whois(self, numeric, command, args)
Handles incoming WHOIS commands.
- 
-Note: The core of WHOIS handling is done by coreplugin.py
-(IRCd-independent), and not here.
- -
invite(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
- -
join(self, client, channel)
Joins a PyLink client to a channel.
- -
kill(self, numeric, target, reason)
Sends a kill from a PyLink client/server.
- -
knock(self, numeric, target, text)
Sends a KNOCK from a PyLink client.
- -
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server.
- -
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
-automatically by the Irc() internals; plugins shouldn't have to use this.
- -
sjoin(self, server, channel, users, ts=None)
Sends an SJOIN for a group of users to a channel.
- 
-The sender should always be a Server ID (SID). TS is optional, and defaults
-to the one we've stored in the channel state if not given.
-<users> is a list of (prefix mode, UID) pairs:
- 
-Example uses:
-    sjoin('100', '#test', [('', '100AAABBC'), ('o', 100AAABBB'), ('v', '100AAADDD')])
-    sjoin(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
- -
spawnClient(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype='IRC Operator', manipulatable=False)
Spawns a new client with the given options.
- 
-Note: No nick collision / valid nickname checks are done here; it is
-up to plugins to make sure they don't introduce anything invalid.
- -
topicBurst(self, numeric, target, text)
Sends a topic change from a PyLink server. This is usually used on burst.
- -
updateClient(self, target, field, text)
Updates the hostname of any connected client.
- -
-Methods inherited from ts6_common.TS6BaseProtocol:
-
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
-to unset AWAY status.
- -
handle_away(self, numeric, command, args)
Handles incoming AWAY messages.
- -
handle_error(self, numeric, command, args)
Handles ERROR messages - these mean that our uplink has disconnected us!
- -
handle_events(self, data)
Event handler for TS6 protocols.
- 
-This passes most commands to the various handle_ABCD() functions
-elsewhere defined protocol modules, coersing various sender prefixes
-from nicks and server names to UIDs and SIDs respectively,
-whenever possible.
- 
-Commands sent without an explicit sender prefix will have them set to
-the SID of the uplink server.
- -
handle_kick(self, source, command, args)
Handles incoming KICKs.
- -
handle_kill(self, source, command, args)
Handles incoming KILLs.
- -
handle_nick(self, numeric, command, args)
Handles incoming NICK changes.
- -
handle_notice = handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_part(self, source, command, args)
Handles incoming PART commands.
- -
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_quit(self, numeric, command, args)
Handles incoming QUIT commands.
- -
handle_save(self, numeric, command, args)
Handles incoming SAVE messages, used to handle nick collisions.
- -
handle_squit(self, numeric, command, args)
Handles incoming SQUITs (netsplits).
- -
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
-TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
- -
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
- -
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
- -
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
- -
nick(self, numeric, newnick)
Changes the nick of a PyLink client.
- -
notice(self, numeric, target, text)
Sends a NOTICE from a PyLink client.
- -
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client, used for WHOIS
-replies.
- -
parseTS6Args(self, args)
Similar to parseArgs(), but stripping leading colons from the first argument
-of a line (usually the sender field).
- -
part(self, client, channel, reason=None)
Sends a part from a PyLink client.
- -
quit(self, numeric, reason)
Quits a PyLink client.
- -
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.
- 
-Note: TS6 doesn't use a specific ENDBURST command, so the endburst_delay
-option will be ignored if given.
- -
squit(self, source, target, text='No reason given')
SQUITs a PyLink server.
- -
topic(self, numeric, target, text)
Sends a TOPIC change from a PyLink client.
- -
-Methods inherited from classes.Protocol:
-
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from classes.Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class TS6Protocol(ts6_common.TS6BaseProtocol)
   Base Protocol module class for PyLink.
 
 
Method resolution order:
-
TS6Protocol
-
ts6_common.TS6BaseProtocol
-
classes.Protocol
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
connect(self)
Initializes a connection to a server.
- -
handle_472(self, numeric, command, args)
Handles the incoming 472 numeric.
- 
-472 is sent to us when one of our clients tries to set a mode the uplink
-server doesn't support. In this case, we'll raise a warning to alert
-the administrator that certain extensions should be loaded for the best
-compatibility.
- -
handle_bmask(self, numeric, command, args)
Handles incoming BMASK commands (ban propagation on burst).
- -
handle_capab(self, numeric, command, args)
Handles the CAPAB command, used for TS6 capability negotiation.
- -
handle_chghost(self, numeric, command, args)
Handles incoming CHGHOST commands.
- -
handle_encap(self, numeric, command, args)
Handles the ENCAP command - encapsulated TS6 commands with a variety of
-subcommands used for different purposes.
- -
handle_euid(self, numeric, command, args)
Handles incoming EUID commands (user introduction).
- -
handle_invite(self, numeric, command, args)
Handles incoming INVITEs.
- -
handle_join(self, numeric, command, args)
Handles incoming channel JOINs.
- -
handle_mode(self, numeric, command, args)
Handles incoming user mode changes.
- -
handle_pass(self, numeric, command, args)
Handles the PASS command, used to send the server's SID and negotiate
-passwords on connect.
- -
handle_ping(self, source, command, args)
Handles incoming PING commands.
- -
handle_pong(self, source, command, args)
Handles incoming PONG commands.
- -
handle_server(self, numeric, command, args)
Handles 1) incoming legacy (no SID) server introductions,
-2) Sending server data in initial connection.
- -
handle_sid(self, numeric, command, args)
Handles incoming server introductions.
- -
handle_sjoin(self, servernumeric, command, args)
Handles incoming SJOIN commands.
- -
handle_tb(self, numeric, command, args)
Handles incoming topic burst (TB) commands.
- -
handle_tmode(self, numeric, command, args)
Handles incoming TMODE commands (channel mode change).
- -
handle_uid(self, numeric, command, args)
- -
handle_whois(self, numeric, command, args)
Handles incoming WHOIS commands.
- 
-Note: The core of WHOIS handling is done by coreplugin.py
-(IRCd-independent), and not here.
- -
invite(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
- -
join(self, client, channel)
Joins a PyLink client to a channel.
- -
kill(self, numeric, target, reason)
Sends a kill from a PyLink client/server.
- -
knock(self, numeric, target, text)
Sends a KNOCK from a PyLink client.
- -
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server.
- -
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
-automatically by the Irc() internals; plugins shouldn't have to use this.
- -
sjoin(self, server, channel, users, ts=None)
Sends an SJOIN for a group of users to a channel.
- 
-The sender should always be a Server ID (SID). TS is optional, and defaults
-to the one we've stored in the channel state if not given.
-<users> is a list of (prefix mode, UID) pairs:
- 
-Example uses:
-    sjoin('100', '#test', [('', '100AAABBC'), ('o', 100AAABBB'), ('v', '100AAADDD')])
-    sjoin(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
- -
spawnClient(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype='IRC Operator', manipulatable=False)
Spawns a new client with the given options.
- 
-Note: No nick collision / valid nickname checks are done here; it is
-up to plugins to make sure they don't introduce anything invalid.
- -
topicBurst(self, numeric, target, text)
Sends a topic change from a PyLink server. This is usually used on burst.
- -
updateClient(self, target, field, text)
Updates the hostname of any connected client.
- -
-Methods inherited from ts6_common.TS6BaseProtocol:
-
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
-to unset AWAY status.
- -
handle_away(self, numeric, command, args)
Handles incoming AWAY messages.
- -
handle_error(self, numeric, command, args)
Handles ERROR messages - these mean that our uplink has disconnected us!
- -
handle_events(self, data)
Event handler for TS6 protocols.
- 
-This passes most commands to the various handle_ABCD() functions
-elsewhere defined protocol modules, coersing various sender prefixes
-from nicks and server names to UIDs and SIDs respectively,
-whenever possible.
- 
-Commands sent without an explicit sender prefix will have them set to
-the SID of the uplink server.
- -
handle_kick(self, source, command, args)
Handles incoming KICKs.
- -
handle_kill(self, source, command, args)
Handles incoming KILLs.
- -
handle_nick(self, numeric, command, args)
Handles incoming NICK changes.
- -
handle_notice = handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_part(self, source, command, args)
Handles incoming PART commands.
- -
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_quit(self, numeric, command, args)
Handles incoming QUIT commands.
- -
handle_save(self, numeric, command, args)
Handles incoming SAVE messages, used to handle nick collisions.
- -
handle_squit(self, numeric, command, args)
Handles incoming SQUITs (netsplits).
- -
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
-TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
- -
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
- -
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
- -
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
- -
nick(self, numeric, newnick)
Changes the nick of a PyLink client.
- -
notice(self, numeric, target, text)
Sends a NOTICE from a PyLink client.
- -
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client, used for WHOIS
-replies.
- -
parseTS6Args(self, args)
Similar to parseArgs(), but stripping leading colons from the first argument
-of a line (usually the sender field).
- -
part(self, client, channel, reason=None)
Sends a part from a PyLink client.
- -
quit(self, numeric, reason)
Quits a PyLink client.
- -
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.
- 
-Note: TS6 doesn't use a specific ENDBURST command, so the endburst_delay
-option will be ignored if given.
- -
squit(self, source, target, text='No reason given')
SQUITs a PyLink server.
- -
topic(self, numeric, target, text)
Sends a TOPIC change from a PyLink client.
- -
-Methods inherited from classes.Protocol:
-
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from classes.Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - -
 
-Data
       conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f3f91da9488>, {})}
-confname = 'testconf'
-curdir = '/home/gl/pylink'
-files = None
-log = <logging.RootLogger object>
-logdir = '/home/gl/pylink/log'
-logformatter = <logging.Formatter object>
-stdout_level = 'CRITICAL'
- \ No newline at end of file diff --git a/docs/technical/autogen/ts6_common.html b/docs/technical/autogen/ts6_common.html deleted file mode 100644 index 95f1421..0000000 --- a/docs/technical/autogen/ts6_common.html +++ /dev/null @@ -1,249 +0,0 @@ - -Python: module ts6_common - - - - - -
 
- 
ts6_common		index
/home/gl/pylink/protocols/ts6_common.py
-

ts6_common.py: Common base protocol class with functions shared by the UnrealIRCd, InspIRCd, and TS6 protocol modules.

-

- - - - - -
 
-Modules
       
hashlib
-inspect
-logging
-os
-		socket
-ssl
-string
-structures
-		sys
-threading
-time
-utils
-		world
-

- - - - - -
 
-Classes
       
-
builtins.object -
-
-
TS6SIDGenerator -
-
-
classes.Protocol(builtins.object) -
-
-
TS6BaseProtocol -
-
-
utils.IncrementalUIDGenerator(builtins.object) -
-
-
TS6UIDGenerator -
-
-
-

- - - - - - - -
 
-class TS6BaseProtocol(classes.Protocol)
   Base Protocol module class for PyLink.
 
 
Method resolution order:
-
TS6BaseProtocol
-
classes.Protocol
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
-to unset AWAY status.
- -
handle_away(self, numeric, command, args)
Handles incoming AWAY messages.
- -
handle_error(self, numeric, command, args)
Handles ERROR messages - these mean that our uplink has disconnected us!
- -
handle_events(self, data)
Event handler for TS6 protocols.
- 
-This passes most commands to the various handle_ABCD() functions
-elsewhere defined protocol modules, coersing various sender prefixes
-from nicks and server names to UIDs and SIDs respectively,
-whenever possible.
- 
-Commands sent without an explicit sender prefix will have them set to
-the SID of the uplink server.
- -
handle_kick(self, source, command, args)
Handles incoming KICKs.
- -
handle_kill(self, source, command, args)
Handles incoming KILLs.
- -
handle_nick(self, numeric, command, args)
Handles incoming NICK changes.
- -
handle_notice = handle_privmsg(self, source, command, args)
- -
handle_part(self, source, command, args)
Handles incoming PART commands.
- -
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_quit(self, numeric, command, args)
Handles incoming QUIT commands.
- -
handle_save(self, numeric, command, args)
Handles incoming SAVE messages, used to handle nick collisions.
- -
handle_squit(self, numeric, command, args)
Handles incoming SQUITs (netsplits).
- -
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
-TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
- -
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
- -
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
- -
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
- -
nick(self, numeric, newnick)
Changes the nick of a PyLink client.
- -
notice(self, numeric, target, text)
Sends a NOTICE from a PyLink client.
- -
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client, used for WHOIS
-replies.
- -
parseTS6Args(self, args)
Similar to parseArgs(), but stripping leading colons from the first argument
-of a line (usually the sender field).
- -
part(self, client, channel, reason=None)
Sends a part from a PyLink client.
- -
quit(self, numeric, reason)
Quits a PyLink client.
- -
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.
- 
-Note: TS6 doesn't use a specific ENDBURST command, so the endburst_delay
-option will be ignored if given.
- -
squit(self, source, target, text='No reason given')
SQUITs a PyLink server.
- -
topic(self, numeric, target, text)
Sends a TOPIC change from a PyLink client.
- -
-Methods inherited from classes.Protocol:
-
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from classes.Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class TS6SIDGenerator(builtins.object)
   TS6 SID Generator. <query> is a 3 character string with any combination of
-uppercase letters, digits, and #'s. it must contain at least one #,
-which are used by the generator as a wildcard. On every next_sid() call,
-the first available wildcard character (from the right) will be
-incremented to generate the next SID.
- 
-When there are no more available SIDs left (SIDs are not reused, only
-incremented), RuntimeError is raised.
- 
-Example queries:
-    "1#A" would give: 10A, 11A, 12A ... 19A, 1AA, 1BA ... 1ZA (36 total results)
-    "#BQ" would give: 0BQ, 1BQ, 2BQ ... 9BQ (10 total results)
-    "6##" would give: 600, 601, 602, ... 60Y, 60Z, 610, 611, ... 6ZZ (1296 total results)
 
 Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
increment(self, pos=2)
Increments the SID generator to the next available SID.
- -
next_sid(self)
Returns the next unused TS6 SID for the server.
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class TS6UIDGenerator(utils.IncrementalUIDGenerator)
   Implements an incremental TS6 UID Generator.
 
 
Method resolution order:
-
TS6UIDGenerator
-
utils.IncrementalUIDGenerator
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, sid)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Methods inherited from utils.IncrementalUIDGenerator:
-
increment(self, pos=None)
Increments the UID generator to the next available UID.
- -
next_uid(self)
Returns the next unused UID for the server.
- -
-Data descriptors inherited from utils.IncrementalUIDGenerator:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - -
 
-Data
       conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f1e3a24e488>, {})}
-confname = 'testconf'
-curdir = '/home/gl/pylink'
-files = None
-log = <logging.RootLogger object>
-logdir = '/home/gl/pylink/log'
-logformatter = <logging.Formatter object>
-stdout_level = 'CRITICAL'
- \ No newline at end of file diff --git a/docs/technical/autogen/unreal.html b/docs/technical/autogen/unreal.html deleted file mode 100644 index 5d8894c..0000000 --- a/docs/technical/autogen/unreal.html +++ /dev/null @@ -1,455 +0,0 @@ - -Python: module unreal - - - - - -
 
- 
unreal		index
/home/gl/pylink/protocols/unreal.py
-

unreal.py: UnrealIRCd 4.0 protocol module for PyLink.

-

- - - - - -
 
-Modules
       
codecs
-hashlib
-inspect
-logging
-		os
-re
-socket
-ssl
-		string
-structures
-sys
-threading
-		time
-utils
-world
-

- - - - - -
 
-Classes
       
-
ts6_common.TS6BaseProtocol(classes.Protocol) -
-
-
UnrealProtocol -
-
-
-

- - - - - - - -
 
-Class = class UnrealProtocol(ts6_common.TS6BaseProtocol)
   Base Protocol module class for PyLink.
 
 
Method resolution order:
-
UnrealProtocol
-
ts6_common.TS6BaseProtocol
-
classes.Protocol
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
checkCloakChange(self, uid, parsedmodes)
Checks whether +x/-x was set in the mode query, and changes the
-hostname of the user given to or from their cloaked host if True.
- -
connect(self)
Initializes a connection to a server.
- -
handle_chghost(self, numeric, command, args)
Handles CHGHOST, used for denoting hostname changes.
- -
handle_chgident(self, numeric, command, args)
Handles CHGIDENT, used for denoting ident changes.
- -
handle_chgname(self, numeric, command, args)
Handles CHGNAME, used for denoting real name/gecos changes.
- -
handle_eos(self, numeric, command, args)
EOS is used to denote end of burst.
- -
handle_invite(self, numeric, command, args)
Handles incoming INVITEs.
- -
handle_join(self, numeric, command, args)
Handles the UnrealIRCd JOIN command.
- -
handle_kill(self, numeric, command, args)
Handles incoming KILLs.
- -
handle_mode(self, numeric, command, args)
- -
handle_nick(self, numeric, command, args)
Handles NICK changes, and legacy NICK introductions from pre-4.0 servers.
- -
handle_notice = handle_privmsg(self, source, command, args)
- -
handle_pass(self, numeric, command, args)
- -
handle_ping(self, numeric, command, args)
- -
handle_pong(self, source, command, args)
- -
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_protoctl(self, numeric, command, args)
Handles protocol negotiation.
- -
handle_server(self, numeric, command, args)
Handles the SERVER command, which is used for both authentication and
-introducing legacy (non-SID) servers.
- -
handle_sethost(self, numeric, command, args)
Handles CHGHOST, used for self hostname changes.
- -
handle_setident(self, numeric, command, args)
Handles SETIDENT, used for self ident changes.
- -
handle_setname(self, numeric, command, args)
Handles SETNAME, used for self real name/gecos changes.
- -
handle_sid(self, numeric, command, args)
Handles the SID command, used for introducing remote servers by our uplink.
- -
handle_sjoin(self, numeric, command, args)
Handles the UnrealIRCd SJOIN command.
- -
handle_squit(self, numeric, command, args)
Handles the SQUIT command.
- -
handle_svs2mode(self, sender, command, args)
Handles SVS2MODE, which sets services login information, and user modes on
-the given target.
- -
handle_svsmode(self, numeric, command, args)
Handles SVSMODE, used by services for setting user modes on others.
- -
handle_topic(self, numeric, command, args)
Handles the TOPIC command.
- -
handle_uid(self, numeric, command, args)
- -
handle_umode2(self, numeric, command, args)
Handles UMODE2, used to set user modes on oneself.
- -
handle_whois(self, numeric, command, args)
Handles WHOIS queries.
- -
invite(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
- -
join(self, client, channel)
Joins a PyLink client to a channel.
- -
kill(self, numeric, target, reason)
Sends a kill from a PyLink client/server.
- -
knock(self, numeric, target, text)
Sends a KNOCK from a PyLink client.
- -
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server. The mode list should be
-a list of (mode, arg) tuples, i.e. the format of utils.parseModes() output.
- -
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
-automatically by the Irc() internals; plugins shouldn't have to use this.
- -
sjoin(self, server, channel, users, ts=None)
Sends an SJOIN for a group of users to a channel.
- 
-The sender should always be a server (SID). TS is optional, and defaults
-to the one we've stored in the channel state if not given.
-<users> is a list of (prefix mode, UID) pairs:
- 
-Example uses:
-    sjoin('100', '#test', [('', '100AAABBC'), ('o', 100AAABBB'), ('v', '100AAADDD')])
-    sjoin(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
- 
-Note that for UnrealIRCd, no mode data is sent in an SJOIN command, only
-The channel name, TS, and user list.
- -
spawnClient(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype='IRC Operator', manipulatable=False)
Spawns a new client with the given options.
- 
-Note: No nick collision / valid nickname checks are done here; it is
-up to plugins to make sure they don't introduce anything invalid.
- -
topicBurst(self, numeric, target, text)
Sends a TOPIC change from a PyLink server.
- -
updateClient(self, target, field, text)
Updates the ident, host, or realname of any connected client.
- -
-Methods inherited from ts6_common.TS6BaseProtocol:
-
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
-to unset AWAY status.
- -
handle_away(self, numeric, command, args)
Handles incoming AWAY messages.
- -
handle_error(self, numeric, command, args)
Handles ERROR messages - these mean that our uplink has disconnected us!
- -
handle_events(self, data)
Event handler for TS6 protocols.
- 
-This passes most commands to the various handle_ABCD() functions
-elsewhere defined protocol modules, coersing various sender prefixes
-from nicks and server names to UIDs and SIDs respectively,
-whenever possible.
- 
-Commands sent without an explicit sender prefix will have them set to
-the SID of the uplink server.
- -
handle_kick(self, source, command, args)
Handles incoming KICKs.
- -
handle_part(self, source, command, args)
Handles incoming PART commands.
- -
handle_quit(self, numeric, command, args)
Handles incoming QUIT commands.
- -
handle_save(self, numeric, command, args)
Handles incoming SAVE messages, used to handle nick collisions.
- -
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
- -
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
- -
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
- -
nick(self, numeric, newnick)
Changes the nick of a PyLink client.
- -
notice(self, numeric, target, text)
Sends a NOTICE from a PyLink client.
- -
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client, used for WHOIS
-replies.
- -
parseTS6Args(self, args)
Similar to parseArgs(), but stripping leading colons from the first argument
-of a line (usually the sender field).
- -
part(self, client, channel, reason=None)
Sends a part from a PyLink client.
- -
quit(self, numeric, reason)
Quits a PyLink client.
- -
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.
- 
-Note: TS6 doesn't use a specific ENDBURST command, so the endburst_delay
-option will be ignored if given.
- -
squit(self, source, target, text='No reason given')
SQUITs a PyLink server.
- -
topic(self, numeric, target, text)
Sends a TOPIC change from a PyLink client.
- -
-Methods inherited from classes.Protocol:
-
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from classes.Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class UnrealProtocol(ts6_common.TS6BaseProtocol)
   Base Protocol module class for PyLink.
 
 
Method resolution order:
-
UnrealProtocol
-
ts6_common.TS6BaseProtocol
-
classes.Protocol
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
- -
checkCloakChange(self, uid, parsedmodes)
Checks whether +x/-x was set in the mode query, and changes the
-hostname of the user given to or from their cloaked host if True.
- -
connect(self)
Initializes a connection to a server.
- -
handle_chghost(self, numeric, command, args)
Handles CHGHOST, used for denoting hostname changes.
- -
handle_chgident(self, numeric, command, args)
Handles CHGIDENT, used for denoting ident changes.
- -
handle_chgname(self, numeric, command, args)
Handles CHGNAME, used for denoting real name/gecos changes.
- -
handle_eos(self, numeric, command, args)
EOS is used to denote end of burst.
- -
handle_invite(self, numeric, command, args)
Handles incoming INVITEs.
- -
handle_join(self, numeric, command, args)
Handles the UnrealIRCd JOIN command.
- -
handle_kill(self, numeric, command, args)
Handles incoming KILLs.
- -
handle_mode(self, numeric, command, args)
- -
handle_nick(self, numeric, command, args)
Handles NICK changes, and legacy NICK introductions from pre-4.0 servers.
- -
handle_notice = handle_privmsg(self, source, command, args)
- -
handle_pass(self, numeric, command, args)
- -
handle_ping(self, numeric, command, args)
- -
handle_pong(self, source, command, args)
- -
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
- -
handle_protoctl(self, numeric, command, args)
Handles protocol negotiation.
- -
handle_server(self, numeric, command, args)
Handles the SERVER command, which is used for both authentication and
-introducing legacy (non-SID) servers.
- -
handle_sethost(self, numeric, command, args)
Handles CHGHOST, used for self hostname changes.
- -
handle_setident(self, numeric, command, args)
Handles SETIDENT, used for self ident changes.
- -
handle_setname(self, numeric, command, args)
Handles SETNAME, used for self real name/gecos changes.
- -
handle_sid(self, numeric, command, args)
Handles the SID command, used for introducing remote servers by our uplink.
- -
handle_sjoin(self, numeric, command, args)
Handles the UnrealIRCd SJOIN command.
- -
handle_squit(self, numeric, command, args)
Handles the SQUIT command.
- -
handle_svs2mode(self, sender, command, args)
Handles SVS2MODE, which sets services login information, and user modes on
-the given target.
- -
handle_svsmode(self, numeric, command, args)
Handles SVSMODE, used by services for setting user modes on others.
- -
handle_topic(self, numeric, command, args)
Handles the TOPIC command.
- -
handle_uid(self, numeric, command, args)
- -
handle_umode2(self, numeric, command, args)
Handles UMODE2, used to set user modes on oneself.
- -
handle_whois(self, numeric, command, args)
Handles WHOIS queries.
- -
invite(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
- -
join(self, client, channel)
Joins a PyLink client to a channel.
- -
kill(self, numeric, target, reason)
Sends a kill from a PyLink client/server.
- -
knock(self, numeric, target, text)
Sends a KNOCK from a PyLink client.
- -
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server. The mode list should be
-a list of (mode, arg) tuples, i.e. the format of utils.parseModes() output.
- -
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
-automatically by the Irc() internals; plugins shouldn't have to use this.
- -
sjoin(self, server, channel, users, ts=None)
Sends an SJOIN for a group of users to a channel.
- 
-The sender should always be a server (SID). TS is optional, and defaults
-to the one we've stored in the channel state if not given.
-<users> is a list of (prefix mode, UID) pairs:
- 
-Example uses:
-    sjoin('100', '#test', [('', '100AAABBC'), ('o', 100AAABBB'), ('v', '100AAADDD')])
-    sjoin(self.irc.sid, '#test', [('o', self.irc.pseudoclient.uid)])
- 
-Note that for UnrealIRCd, no mode data is sent in an SJOIN command, only
-The channel name, TS, and user list.
- -
spawnClient(self, nick, ident='null', host='null', realhost=None, modes=set(), server=None, ip='0.0.0.0', realname=None, ts=None, opertype='IRC Operator', manipulatable=False)
Spawns a new client with the given options.
- 
-Note: No nick collision / valid nickname checks are done here; it is
-up to plugins to make sure they don't introduce anything invalid.
- -
topicBurst(self, numeric, target, text)
Sends a TOPIC change from a PyLink server.
- -
updateClient(self, target, field, text)
Updates the ident, host, or realname of any connected client.
- -
-Methods inherited from ts6_common.TS6BaseProtocol:
-
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
-to unset AWAY status.
- -
handle_away(self, numeric, command, args)
Handles incoming AWAY messages.
- -
handle_error(self, numeric, command, args)
Handles ERROR messages - these mean that our uplink has disconnected us!
- -
handle_events(self, data)
Event handler for TS6 protocols.
- 
-This passes most commands to the various handle_ABCD() functions
-elsewhere defined protocol modules, coersing various sender prefixes
-from nicks and server names to UIDs and SIDs respectively,
-whenever possible.
- 
-Commands sent without an explicit sender prefix will have them set to
-the SID of the uplink server.
- -
handle_kick(self, source, command, args)
Handles incoming KICKs.
- -
handle_part(self, source, command, args)
Handles incoming PART commands.
- -
handle_quit(self, numeric, command, args)
Handles incoming QUIT commands.
- -
handle_save(self, numeric, command, args)
Handles incoming SAVE messages, used to handle nick collisions.
- -
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
- -
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
- -
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
- -
nick(self, numeric, newnick)
Changes the nick of a PyLink client.
- -
notice(self, numeric, target, text)
Sends a NOTICE from a PyLink client.
- -
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client, used for WHOIS
-replies.
- -
parseTS6Args(self, args)
Similar to parseArgs(), but stripping leading colons from the first argument
-of a line (usually the sender field).
- -
part(self, client, channel, reason=None)
Sends a part from a PyLink client.
- -
quit(self, numeric, reason)
Quits a PyLink client.
- -
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.
- 
-Note: TS6 doesn't use a specific ENDBURST command, so the endburst_delay
-option will be ignored if given.
- -
squit(self, source, target, text='No reason given')
SQUITs a PyLink server.
- -
topic(self, numeric, target, text)
Sends a TOPIC change from a PyLink client.
- -
-Methods inherited from classes.Protocol:
-
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
-be used for multi-word arguments that last until the end of a line.
- -
removeClient(self, numeric)
Internal function to remove a client from our internal state.
- -
updateTS(self, channel, their_ts)
Compares the current TS of the channel given with the new TS, resetting
-all modes we have if the one given is older.
- -
-Data descriptors inherited from classes.Protocol:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - -
 
-Data
       conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f19895c4bf8>, {})}
-confname = 'testconf'
-curdir = '/home/gl/pylink'
-files = None
-log = <logging.RootLogger object>
-logdir = '/home/gl/pylink/log'
-logformatter = <logging.Formatter object>
-stdout_level = 'CRITICAL'
- \ No newline at end of file diff --git a/docs/technical/autogen/utils.html b/docs/technical/autogen/utils.html deleted file mode 100644 index 8c3273a..0000000 --- a/docs/technical/autogen/utils.html +++ /dev/null @@ -1,220 +0,0 @@ - -Python: module utils - - - - - -
 
- 
utils		index
/home/gl/pylink/utils.py
-

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

-

- - - - - -
 
-Modules
       
collections
-conf
-		importlib
-os
-		re
-string
-		world
-

- - - - - -
 
-Classes
       
-
builtins.Exception(builtins.BaseException) -
-
-
NotAuthenticatedError -
-
-
builtins.object -
-
-
IncrementalUIDGenerator -
ServiceBot -
-
-
-

- - - - - - - -
 
-class IncrementalUIDGenerator(builtins.object)
   Incremental 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)
Initialize self.  See help(type(self)) for accurate signature.
- -
increment(self, pos=None)
Increments the UID generator to the next available UID.
- -
next_uid(self)
Returns the next unused UID for the server.
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - - - -
 
-class NotAuthenticatedError(builtins.Exception)
   Exception raised by checkAuthenticated() when a user fails authentication
-requirements.
 
 
Method resolution order:
-
NotAuthenticatedError
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Data descriptors defined here:
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Methods inherited from builtins.Exception:
-
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__delattr__(self, name, /)
Implement delattr(self, name).
- -
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(...)
helper for pickle
- -
__repr__(self, /)
Return repr(self).
- -
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
- -
__setstate__(...)
- -
__str__(self, /)
Return str(self).
- -
with_traceback(...)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - -
 
-class ServiceBot(builtins.object)
    Methods defined here:
-
__init__(self, name, default_help=True, default_request=False, default_list=True, nick=None, ident=None, manipulatable=False)
Initialize self.  See help(type(self)) for accurate signature.
- -
add_cmd(self, func, name=None)
Binds an IRC command function to the given command name.
- -
call_cmd(self, irc, source, text, called_by=None, notice=True)
Calls a PyLink bot command. source is the caller's UID, and text is the
-full, unparsed text of the message.
- -
help(self, irc, source, args)
<command>
- 
-Gives help for <command>, if it is available.
- -
listcommands(self, irc, source, args)
takes no arguments.
- 
-Returns a list of available commands this service has to offer.
- -
remove(self, irc, source, args)
- -
reply(self, irc, text)
Replies to a message using the right service UID.
- -
request(self, irc, source, args)
- -
spawn(self, irc=None)
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-

- - - - - -
 
-Functions
       
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.
- 
-This method is deprecated. Use irc.applyModes() instead.
-
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'.
-
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.
-
isNick(s, nicklen=None)
Returns whether the string given is a valid nick.
-
isServerName(s)
Returns whether the string given is a valid IRC server name.
-
loadModuleFromFolder(name, folder)
Imports and returns a module, if existing, from a specific folder.
-
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')]
- 
-This method is deprecated. Use irc.parseModes() instead.
-
registerService(name, *args, **kwargs)
Registers a service bot.
-
unregisterService(name)
Unregisters an existing service bot.
-

- - - - - -
 
-Data
       hostmaskRe = re.compile('^\\S+!\\S+@\\S+$')
-log = <logging.RootLogger object>
- \ No newline at end of file diff --git a/docs/technical/autogen/world.html b/docs/technical/autogen/world.html deleted file mode 100644 index 2dad6d2..0000000 --- a/docs/technical/autogen/world.html +++ /dev/null @@ -1,41 +0,0 @@ - -Python: module world - - - - - -
 
- 
world		index
/home/gl/pylink/world.py
-

world.py: Stores global variables for PyLink, including lists of active IRC objects and plugins.

-

- - - - - -
 
-Modules
       
os
-		subprocess
-		threading
-

- - - - - -
 
-Data
       hooks = defaultdict(<class 'list'>, {})
-networkobjects = {}
-plugins = {}
-plugins_folder = '/home/gl/pylink/plugins'
-protocols_folder = '/home/gl/pylink/protocols'
-services = {}
-source = 'https://github.com/GLolol/PyLink'
-started = <threading.Event object>
-testing = True
-testing_ircd = 'inspircd'
-version = 'v0.8-alpha2-60-g8c55eb4'
- \ No newline at end of file diff --git a/docs/technical/pmodule-spec.md b/docs/technical/pmodule-spec.md index 69d2bf1..0842f7b 100644 --- a/docs/technical/pmodule-spec.md +++ b/docs/technical/pmodule-spec.md @@ -2,8 +2,6 @@ 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 something like [`ts6_common.TS6BaseProtocol`](https://github.com/GLolol/PyLink/blob/0.9-alpha1/protocols/ts6_common.py). (`ts6_common.TS6BaseProtocol` 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: [autogen/inspircd.html](autogen/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 broken, desynced services server: diff --git a/docs/technical/using-utils.md b/docs/technical/using-utils.md deleted file mode 100644 index a045487..0000000 --- a/docs/technical/using-utils.md +++ /dev/null @@ -1 +0,0 @@ -See [autogen/utils.html](autogen/utils.html) for auto-generated documentation for the utils module.