gozerbot.dbusers

bots users for mysql interface

class gozerbot.dbusers.Dbusers

Bases: object

users class

add(name, userhosts, perms)

add an user

addperm(name, perm)

add permission

addpermall(perm)

add permission to all users

addpermit(name, who, what)

add permission

addstatus(name, status)

add permission

adduserhost(name, userhost)

add userhost

allowed(userhost, perms, log=True)

check if user with userhosts is allowed to execute perm command

delallemail(userhost)

delete user with name

delete(name)

delete user with name

delperm(name, perm)

add permission

delpermall(perm)

delete permission from all users

deluserhost(name, userhost)

delete user with name

deluserpermit(name, permit)

delete user with name

deluserperms(name, perm)

delete user with name

deluserstatus(name, status)

delete user with name

exist(name)

see if user with <name> exists

getemail(name)

get email of user

gethosts(name)

check if user has userhost

getname(userhost)

get name of user belonging to <userhost>

getpermits(userhost)

check if user permits something

getperms(userhost)

return permission of user

getpermusers(perm)

getstatuses(userhost)

check if user had permission

getstatususers(status)

getuseremail(name)

check if user had permission

getuserhosts(name)

check if user has userhost

getuserpermits(name)

check if user permits something

getuserperms(name)

check if user had permission

getuserstatus(name)

check if user has status

getuserstatuses(name)

check if user had permission

gotperm(name, perm)

check if user had permission

gotpermit(name, permit)

check if user permits something

gotstatus(name, status)

check if user has status

gotuserhost(name, userhost)

check if user has userhost

make_owner(userhosts)

see if owner already has a user account if not merge otherwise add.

merge(name, userhost)

add userhosts to user with name

names()

get names of all users

permitted(userhost, who, what)

check if (who,what) is in users permit list

setemail(name, email)

set email of user

size()

return nr of users

status(userhost, status)

check if user with <userhost> has <status> set

usersearch(name)

search users for mathing name.

CODE

# gozerbot/dbusers.py
#
#

""" bots users for mysql interface"""

__status__ = "seen"

gozerbot imports

from gozerbot.utils.log import rlog
from gozerbot.database.db import db

basic imports

import types
import logging

Dbusers class

class Dbusers(object):

    """ users class """

    def __init__(self):
        self.db = db

auxilary functions

def size(self):
    """ return nr of users """
    result = self.db.execute(""" SELECT DISTINCT COUNT(*) FROM userhosts """)
    if result: return result[0][0]

def getperms(self, userhost):
    """ return permission of user"""
    name = self.getname(userhost)
    if not name: return ['ANON', ]
    result = self.db.execute(""" SELECT perm FROM perms WHERE name = %s """, name)
    res = []
    for i in result: res.append(i[0])
    return res

def exist(self, name):
    """ see if user with <name> exists """
    name = name.lower()
    result = self.db.execute(""" SELECT name,userhost FROM userhosts WHERE name = %s """, name)
    return result

def getname(self, userhost):
    """ get name of user belonging to <userhost> """
    result = self.db.execute(""" SELECT name FROM userhosts WHERE %s LIKE userhost """, userhost)
    if result: return result[0][0]

add functions

def add(self, name, userhosts, perms):
    """ add an user """
    if type(userhosts) != types.ListType: rlog(10, 'dbusers', 'i need a list of userhosts') ; return 0
    for i in userhosts: self.adduserhost(name, i)
    for i in perms: self.addperm(name, i)
    rlog(10, 'users', '%s added to user database' % name)
    return 1

def adduserhost(self, name, userhost):
    """ add userhost """
    name = name.lower()
    res = None
    try: result = self.db.execute(""" INSERT INTO userhosts(name, userhost) values(%s, %s) """, (name, userhost))
    except Exception, ex:
        if 'not unique' in str(ex): logging.warn("%s already in database" % name) ; return 0
    if result: res = 1 ; rlog(10, 'users', '%s (%s) added to userhosts' % (name, userhost))
    return res

def addperm(self, name, perm):
    """ add permission """
    name = name.lower()
    perm = perm.upper()
    res = None
    try: result = self.db.execute(""" INSERT INTO perms(name, perm) values(%s, %s) """, (name, perm))
    except Exception, ex:
        if 'not unique' in str(ex): logging.warn("%s already in database" % name) ; return 0
    if result: res = 1 ; rlog(10, 'users', '%s perm %s added' % (name, perm))
    return res

def addstatus(self, name, status):
    """ add permission """
    name = name.lower()
    status = status.upper()
    res = None
    result = self.db.execute(""" INSERT INTO statuses(name, status) values(%s, %s) """, (name, status))
    if result: res = 1 ; rlog(10, 'users', '%s status %s added' % (name, status))
    return res

def addpermit(self, name, who, what):
    """ add permission """
    p = '%s %s' % (who, what)
    res = None
    result = self.db.execute(""" INSERT INTO permits(name, permit) values(%s, %s) """, (name, p))
    if result: res = 1 ; rlog(10, 'users', '%s permit %s added' % (name, p))
    return res

def delperm(self, name, perm):
    """ add permission """
    name = name.lower()
    perm = perm.upper()
    result = self.db.execute(""" DELETE FROM perms WHERE name = %s AND perm = %s """, (name, perm))
    if result:
        rlog(10, 'users', '%s perm %s deleted' % (name, perm))
        return result

def permitted(self, userhost, who, what):
    """ check if (who,what) is in users permit list """
    name = self.getname(userhost)
    res = None
    if name:
        result = self.db.execute(""" SELECT permit FROM permits WHERE name = %s """, name)
        if result:
            for i in result:
                if "%s %s" % (who, what) == i[0]: res = 1
    return res

def names(self):
    """ get names of all users """
    res = []
    result = self.db.execute(""" SELECT DISTINCT name FROM userhosts """)
    if result:
        for i in result: res.append(i[0])
    return res

def merge(self, name, userhost):
    """ add userhosts to user with name """
    name = name.lower()
    if not self.exist(name): return 0
    res = None
    result = self.db.execute(""" INSERT INTO userhosts(userhost, name) VALUES (%s, %s) """, (userhost, name))
    if result: res = 1
    return res

delete functions

def deluserpermit(self, name, permit):
    """ delete user with name """
    name = name.lower()
    p = '%s %s' % permit
    return self.db.execute(""" DELETE FROM permits WHERE name = %s AND permit = %s """, (name, p))

def deluserhost(self, name, userhost):
    """ delete user with name """
    name = name.lower()
    return self.db.execute(""" DELETE FROM userhosts WHERE name = %s AND userhost = %s """, (name, userhost))

def deluserperms(self, name, perm):
    """ delete user with name """
    name = name.lower()
    return self.db.execute(""" DELETE FROM perms WHERE name = %s AND perm = %s """, (name, perm))

def deluserstatus(self, name, status):
    """ delete user with name """
    name = name.lower()
    return self.db.execute(""" DELETE FROM statuses WHERE name = %s AND status = %s """, (name, status))

def delallemail(self, userhost):
    """ delete user with name """
    name = self.getname(userhost)
    return self.db.execute(""" DELETE FROM email WHERE name = %s """, (name, ))

def deluserstatus(self, name, status):
    """ delete user with name """
    name = name.lower()
    return self.db.execute(""" DELETE FROM statuses WHERE name = %s AND status = %s """, (name, status))

def delete(self, name):
    """ delete user with name """
    name = name.lower()
    res = None
    nr1 = self.db.execute(""" DELETE FROM userhosts WHERE name = %s """, name)
    nr2 = self.db.execute(""" DELETE FROM perms WHERE name = %s """, name)
    if nr1 and nr2: res = 1
    return res

def status(self, userhost, status):
    """ check if user with <userhost> has <status> set """
    name = self.getname(userhost)
    res = None
    if name:
        status = status.upper()
        result = self.db.execute(""" SELECT status FROM statuses WHERE name = %s """, name)
        if result:
            for i in result:
                if status == i[0]: res = 1
    return res

def gotperm(self, name, perm):
    """ check if user had permission """
    name = name.lower()
    perm = perm.upper()
    result = self.db.execute(""" SELECT perm FROM perms WHERE name = %s """, name)
    if result:
        for i in result:
            if i[0] == perm: return True

def getuserstatuses(self, name):
    """ check if user had permission """
    name = name.lower()
    return self.db.execute(""" SELECT status FROM statuses WHERE name = %s """, name)

def getstatuses(self, userhost):
    """ check if user had permission """
    name = self.getname(userhost)
    return self.db.execute(""" SELECT status FROM statuses WHERE name = %s """, name)

def getuseremail(self, name):
    """ check if user had permission """
    name = name.lower()
    return self.db.execute(""" SELECT email FROM email WHERE name = %s """, name)

def getuserperms(self, name):
    """ check if user had permission """
    name = name.lower()
    return self.db.execute(""" SELECT perm FROM perms WHERE name = %s """, name)

def getstatususers(self, status):
    status = status.upper()
    return self.db.execute(""" SELECT name FROM statuses WHERE status = %s """, status)

def getpermusers(self, perm):
    perm = perm.upper()
    return self.db.execute(""" SELECT name FROM perms WHERE perm = %s """, perm)

def getuserstatus(self, name):
    """ check if user has status """
    name = name.lower()
    status = status.upper()
    return self.db.execute(""" SELECT status FROM statuses WHERE name = %s """, name)

def gotstatus(self, name, status):
    """ check if user has status """
    name = name.lower()
    status = status.upper()
    result = self.db.execute(""" SELECT status FROM statuses WHERE name = %s """, name)
    if result:
        for i in result:
            if status == i[0]: return True

def gotuserhost(self, name, userhost):
    """ check if user has userhost """
    name = name.lower()
    result = self.db.execute(""" SELECT userhost FROM userhosts WHERE name = %s """, name)
    if result:
        for i in result:
            if i[0] == userhost: return True

def getuserhosts(self, name):
    """ check if user has userhost """
    name = name.lower()
    return self.db.execute(""" SELECT userhost FROM userhosts WHERE name = %s """, name)

gethosts = getuserhosts

def gotpermit(self, name, permit):
    """ check if user permits something """
    name = name.lower()
    result = self.db.execute(""" SELECT permit FROM permits WHERE name = %s """, name)
    if result:
        for i in result:
            if "%s %s" % permit == i[0]: return True

def getuserpermits(self, name):
    """ check if user permits something """
    name = name.lower()
    return self.db.execute(""" SELECT permit FROM permits WHERE name = %s """, name)

def getpermits(self, userhost):
    """ check if user permits something """
    name = self.getname(userhost)
    return self.db.execute(""" SELECT permit FROM permits WHERE name = %s """, name)

def allowed(self, userhost, perms, log=True):
    """ check if user with userhosts is allowed to execute perm command """
    if not type(perms) == types.ListType: perms = [perms, ]
    if 'ANY' in perms: return 1
    res = None
    name = self.getname(userhost)
    if not name:
        if log: rlog(10, 'users', '%s userhost denied' % userhost)
        return res
    result = self.db.execute(""" SELECT perm FROM perms WHERE name = %s """, name)
    if result:
        for i in result:
            if i[0] in perms: res = 1
    if not res:
        if log: rlog(10, 'users', "%s perm %s denied" % (userhost, perms))
    return res

def getemail(self, name):
    """ get email of user """
    name = name.lower()
    email = None
    email = self.db.execute(""" SELECT email FROM email WHERE name = %s """, name)
    if email: return email[0][0]

def setemail(self, name, email):
    """ set email of user """
    res = 0
    try: result = self.db.execute(""" INSERT INTO email(name, email) VALUES (%s, %s) """, (name, email))
    except:
        try: result = self.db.execute(""" UPDATE email SET email = %s WHERE name = %s """, (email, name))
        except: pass
    if result: res = 1
    return res

def getuserhosts(self, name):
    """ check if user has userhost """
    name = name.lower()
    return self.db.execute(""" SELECT userhost FROM userhosts WHERE name = %s """, name)

def addpermall(self, perm):
    """ add permission to all users """
    perm = perm.upper()
    for i in self.names():
        try: self.addperm(i, perm)
        except: pass

def delpermall(self, perm):
    """ delete permission from all users """
    perm = perm.upper()
    for i in self.names():
        try: self.delperm(i, perm)
        except: pass

def make_owner(self, userhosts):
    """
        see if owner already has a user account if not merge otherwise
        add.

    """
    owner = []
    if type(userhosts) != types.ListType: owner.append(userhosts)
    else: owner = userhosts
    for userhost in owner:
        username = self.getname(unicode(userhost))
        if not username:
            if not self.merge('owner', unicode(userhost)): self.add('owner', [unicode(userhost), ], ['USER', 'OPER'])
        elif username != 'owner':
            self.delete(username)
            if not self.merge('owner', unicode(userhost)): self.add('owner', [unicode(userhost), ], ['USER', 'OPER'])

def usersearch(self, name):
    """ search users for mathing name. """
    name = name.lower()
    res = []
    for n in self.names():
        if name in n.lower(): res.append(n)
    return res