GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2025-01-24 03:04:05 +01:00
Code Issues Projects Releases Wiki Activity

utils: modularize UID generators

Browse Source
This commit is contained in:
James Lu 2016-04-05 18:05:52 -07:00
parent 8ee64d5ec1
commit cb8ea473df
1 changed files with 23 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
utils.py
View File

@ -36,9 +36,9 @@ class NotAuthenticatedError(Exception):
""" """
pass pass
class TS6UIDGenerator(): class IncrementalUIDGenerator():
""" """
TS6 UID Generator module, adapted from InspIRCd source: Incremental UID Generator module, adapted from InspIRCd source:
https://github.com/inspircd/inspircd/blob/f449c6b296ab/src/server.cpp#L85-L156 https://github.com/inspircd/inspircd/blob/f449c6b296ab/src/server.cpp#L85-L156
""" """
@ -46,14 +46,20 @@ class TS6UIDGenerator():
# TS6 UIDs are 6 characters in length (9 including the SID). # TS6 UIDs are 6 characters in length (9 including the SID).
# They wrap from ABCDEFGHIJKLMNOPQRSTUVWXYZ -> 0123456789 -> wrap around: # They wrap from ABCDEFGHIJKLMNOPQRSTUVWXYZ -> 0123456789 -> wrap around:
# (e.g. AAAAAA, AAAAAB ..., AAAAA8, AAAAA9, AAAABA) # (e.g. AAAAAA, AAAAAB ..., AAAAA8, AAAAA9, AAAABA)
self.allowedchars = string.ascii_uppercase + string.digits if not (hasattr(self, 'allowedchars') and hasattr(self, 'length')):
self.uidchars = [self.allowedchars[0]]*6 raise RuntimeError("Allowed characters list not defined. Subclass "
"%s by defining self.allowedchars and self.length "
"and then calling super().__init__()." % self.__class__.__name__)
self.uidchars = [self.allowedchars[0]]*self.length
self.sid = sid self.sid = sid
def increment(self, pos=5): def increment(self, pos=None):
""" """
Increments the SID generator to the next available SID. Increments the UID generator to the next available UID.
""" """
# Position starts at 1 less than the UID length.
pos = pos or (self.length - 1)
# If we're at the last character in the list of allowed ones, reset # If we're at the last character in the list of allowed ones, reset
# and increment the next level above. # and increment the next level above.
if self.uidchars[pos] == self.allowedchars[-1]: if self.uidchars[pos] == self.allowedchars[-1]:
@ -67,12 +73,22 @@ class TS6UIDGenerator():
def next_uid(self): def next_uid(self):
""" """
Returns the next unused TS6 UID for the server. Returns the next unused UID for the server.
""" """
uid = self.sid + ''.join(self.uidchars) uid = self.sid + ''.join(self.uidchars)
self.increment() self.increment()
return uid return uid
class TS6UIDGenerator(IncrementalUIDGenerator):
"""Implements an incremental TS6 UID Generator."""
def __init__(self, sid):
# Define the options for IncrementalUIDGenerator, and then
# initialize its functions.
self.allowedchars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456879'
self.length = 6
super().__init__(sid)
class TS6SIDGenerator(): class TS6SIDGenerator():
""" """
TS6 SID Generator. <query> is a 3 character string with any combination of TS6 SID Generator. <query> is a 3 character string with any combination of