pep.py/objects/osuToken.py

326 lines
8.2 KiB
Python
Raw Normal View History

from constants import actions
2016-05-18 17:12:46 +00:00
from constants import gameModes
from helpers import userHelper
from constants import serverPackets
from events import logoutEvent
from helpers import logHelper as log
from objects import glob
import uuid
import time
2016-06-02 17:07:33 +00:00
import threading
from helpers import logHelper as log
from helpers import chatHelper as chat
2016-04-19 17:40:59 +00:00
class token:
2016-06-10 11:15:42 +00:00
"""
Osu Token object
2016-04-19 17:40:59 +00:00
token -- token string
userID -- userID associated to that token
username -- username relative to userID (cache)
actionID -- current user action (see actions.py)
actionText -- current user action text
actionMd5 -- md5 relative to user action
actionMods -- current acton mods
gameMode -- current user game mode
location -- [latitude,longitude]
queue -- packets queue
joinedChannels -- list. Contains joined channel names
spectating -- userID of spectating user. 0 if not spectating.
spectators -- list. Contains userIDs of spectators
country -- osu country code. Use countryHelper to convert from letter country code to osu country code
pingTime -- latest packet received UNIX time
loginTime -- login UNIX time
latestTillerino -- beatmap ID of latest song from tillerino bot
2016-04-19 17:40:59 +00:00
"""
def __init__(self, __userID, token = None, ip = "", irc = False):
2016-04-19 17:40:59 +00:00
"""
Create a token object and set userID and token
__userID -- user associated to this token
2016-06-10 11:15:42 +00:00
token -- if passed, set token to that value
2016-04-19 17:40:59 +00:00
if not passed, token will be generated
2016-06-10 11:15:42 +00:00
ip -- client ip. optional.
irc -- if True, set this token as IRC client. optional.
2016-04-19 17:40:59 +00:00
"""
# Set stuff
self.userID = __userID
self.username = userHelper.getUsername(self.userID)
self.privileges = userHelper.getPrivileges(self.userID)
self.admin = userHelper.isInPrivilegeGroup(self.userID, "developer") or userHelper.isInPrivilegeGroup(self.userID, "community manager")
self.irc = irc
self.restricted = userHelper.isRestricted(self.userID)
2016-04-19 17:40:59 +00:00
self.loginTime = int(time.time())
self.pingTime = self.loginTime
2016-06-10 11:15:42 +00:00
self.lock = threading.Lock() # Sync primitive
2016-04-19 17:40:59 +00:00
# Default variables
self.spectators = []
self.spectating = 0
self.location = [0,0]
self.joinedChannels = []
2016-06-10 11:15:42 +00:00
self.ip = ip
self.country = 0
self.location = [0,0]
2016-04-19 17:40:59 +00:00
self.awayMessage = ""
self.matchID = -1
self.tillerino = [0,0,-1.0] # beatmap, mods, acc
self.silenceEndTime = 0
self.queue = bytes()
self.osuDirectAlert = False # NOTE: Remove this when osu!direct will be fixed
2016-04-19 17:40:59 +00:00
# Spam protection
self.spamRate = 0
# Stats cache
self.actionID = actions.idle
self.actionText = ""
self.actionMd5 = ""
self.actionMods = 0
self.gameMode = gameModes.std
self.rankedScore = 0
self.accuracy = 0.0
self.playcount = 0
self.totalScore = 0
self.gameRank = 0
self.pp = 0
2016-04-19 17:40:59 +00:00
# Generate/set token
2016-06-10 11:15:42 +00:00
if token != None:
self.token = token
2016-04-19 17:40:59 +00:00
else:
self.token = str(uuid.uuid4())
# Set stats
self.updateCachedStats()
2016-06-10 11:15:42 +00:00
# If we have a valid ip, save bancho session in DB so we can cache LETS logins
if ip != "":
userHelper.saveBanchoSession(self.userID, self.ip)
# If we are restricted, send message from FokaBot to user
# NOTE: Sent later
#if self.restricted == True:
# self.setRestricted()
2016-04-19 17:40:59 +00:00
def enqueue(self, __bytes):
"""
Add bytes (packets) to queue
__bytes -- (packet) bytes to enqueue
"""
if self.irc == False:
self.queue += __bytes
2016-04-19 17:40:59 +00:00
def resetQueue(self):
"""Resets the queue. Call when enqueued packets have been sent"""
self.queue = bytes()
def joinChannel(self, __channel):
"""Add __channel to joined channels list
__channel -- channel name"""
if __channel not in self.joinedChannels:
self.joinedChannels.append(__channel)
def partChannel(self, __channel):
"""Remove __channel from joined channels list
__channel -- channel name"""
if __channel in self.joinedChannels:
self.joinedChannels.remove(__channel)
def setLocation(self, __location):
"""Set location (latitude and longitude)
__location -- [latitude, longitude]"""
self.location = __location
def getLatitude(self):
"""Get latitude
return -- latitude"""
return self.location[0]
def getLongitude(self):
"""Get longitude
return -- longitude"""
return self.location[1]
def startSpectating(self, __userID):
"""Set the spectating user to __userID
__userID -- target userID"""
self.spectating = __userID
def stopSpectating(self):
"""Set the spectating user to 0, aka no user"""
self.spectating = 0
def addSpectator(self, __userID):
"""Add __userID to our spectators
userID -- new spectator userID"""
# Add userID to spectators if not already in
if __userID not in self.spectators:
self.spectators.append(__userID)
def removeSpectator(self, __userID):
"""Remove __userID from our spectators
userID -- old spectator userID"""
# Remove spectator
if __userID in self.spectators:
self.spectators.remove(__userID)
def setCountry(self, __countryID):
"""Set country to __countryID
__countryID -- numeric country ID. See countryHelper.py"""
self.country = __countryID
def getCountry(self):
"""Get numeric country ID
return -- numeric country ID. See countryHelper.py"""
return self.country
def updatePingTime(self):
"""Update latest ping time"""
self.pingTime = int(time.time())
def setAwayMessage(self, __awayMessage):
"""Set a new away message"""
self.awayMessage = __awayMessage
def joinMatch(self, __matchID):
"""
Set match to matchID
__matchID -- new match ID
"""
self.matchID = __matchID
def partMatch(self):
"""Set match to -1"""
self.matchID = -1
def kick(self, message="You have been kicked from the server. Please login again."):
2016-04-19 17:40:59 +00:00
"""Kick this user from the server"""
# Send packet to target
log.info("{} has been disconnected. (kick)".format(self.username))
self.enqueue(serverPackets.notification(message))
2016-04-19 17:40:59 +00:00
self.enqueue(serverPackets.loginFailed())
# Logout event
logoutEvent.handle(self, None)
def silence(self, seconds, reason, author = 999):
"""
Silences this user (db, packet and token)
seconds -- silence length in seconds
reason -- silence reason
author -- userID of who has silenced the target. Optional. Default: 999 (fokabot)
"""
# Silence in db and token
self.silenceEndTime = int(time.time())+seconds
2016-06-08 09:33:27 +00:00
userHelper.silence(self.userID, seconds, reason, author)
# Send silence packet to target
self.enqueue(serverPackets.silenceEndTime(seconds))
# Send silenced packet to everyone else
glob.tokens.enqueueAll(serverPackets.userSilenced(self.userID))
def spamProtection(self, increaseSpamRate = True):
"""
Silences the user if is spamming.
increaseSpamRate -- pass True if the user has sent a new message. Optional. Default: True
"""
2016-06-10 14:22:14 +00:00
# Increase the spam rate if needed
if increaseSpamRate == True:
2016-06-10 14:22:14 +00:00
self.spamRate += 1
# Silence the user if needed
if self.spamRate > 10:
self.silence(1800, "Spamming (auto spam protection)")
def isSilenced(self):
"""
Returns True if this user is silenced, otherwise False
return -- True/False
"""
return self.silenceEndTime-int(time.time()) > 0
def getSilenceSecondsLeft(self):
"""
Returns the seconds left for this user's silence
(0 if user is not silenced)
return -- silence seconds left
"""
return max(0, self.silenceEndTime-int(time.time()))
def updateCachedStats(self):
"""Update all cached stats for this token"""
stats = userHelper.getUserStats(self.userID, self.gameMode)
log.debug(str(stats))
if stats == None:
log.warning("Stats query returned None")
return
self.rankedScore = stats["rankedScore"]
self.accuracy = stats["accuracy"]/100
self.playcount = stats["playcount"]
self.totalScore = stats["totalScore"]
self.gameRank = stats["gameRank"]
self.pp = stats["pp"]
def checkRestricted(self, force=False):
"""
Check if this token is restricted. If so, send fokabot message
force -- If True, get restricted value from db.
If false, get the cached one. Optional. Default: False
"""
if force == True:
self.restricted = userHelper.isRestricted(self.userID)
if self.restricted == True:
self.setRestricted()
def setRestricted(self):
"""
Set this token as restricted, send FokaBot message to user
and send offline packet to everyone
"""
self.restricted = True
chat.sendMessage("FokaBot",self.username, "Your account is currently in restricted mode. Please visit ripple's website for more information.")