dbstuff.getLevel now uses join statements to the database to make sure,

that zdvuser is not visible somewhere at any time!

Also the code of dbstuff was generally very much cleaned up and 
commented very much!

Next big change will be converting this "library" to a class that will be
instantiated in the ircbot for making its database queries.

Author: moschlar

dbstuff.py

@@ -1,33 +1,49 @@
-"""
-Database abstraction layer for getting user modes in specified IRC channels
+"""Database connection for getting IRC user levels in IRC channels.
+
+Uses sqlalchemy as database abstraction layer and the defined model here
 
-@version: beta 0.1
+@version: 0.1
 @author: moschlar
 """
 
+DEBUG = 0
 CONFIG_FILE = "testbot.cfg"
-path_to_db = "sqlite:///:memory:"
+
+#-----------------------------------------------------------------------------------
+# Parsing Database Configuration
+#-----------------------------------------------------------------------------------
 
 from ConfigParser import SafeConfigParser
 config = SafeConfigParser()
 config.read(CONFIG_FILE)
 
-db_engine = config.get("database","engine")
-db_server = config.get("database", "server")
-user = config.get("database", "user")
-passwd = config.get("database", "passwd")
-db = config.get("database", "database")
+# Getting database information from CONFIG_FILE
+try:
+    db_engine = config.get("database","engine")
+    db_server = config.get("database", "server")
+    user = config.get("database", "user")
+    passwd = config.get("database", "password")
+    db = config.get("database", "database")
+except:
+    raise Exception("Could not read database path from %s" % CONFIG_FILE)
 
-# Parsing usable information from CONFIG_FILE
-if db_engine == "mysql":
-    path_to_db = "mysql://"
+# Parsing database information to path-string
+try:
+    path_to_db = db_engine + "://"
     if user:
         path_to_db += user
         if passwd:
             path_to_db += ":" + passwd
         path_to_db += "@"
     path_to_db += db_server + "/"
     path_to_db += db
+except:
+    raise Exception("Could not parse path to database!")
+
+if DEBUG:
+    print path_to_db
+
+#-----------------------------------------------------------------------------------
 
 import socket
 
@@ -37,6 +53,10 @@
 
 from sqlalchemy.ext.declarative import declarative_base
 
+#-----------------------------------------------------------------------------------
+# Declaring the database model
+#-----------------------------------------------------------------------------------
+
 Base = declarative_base()
 class irc(Base):
     __tablename__ = 'irc'
@@ -59,57 +79,64 @@ class host(Base):
     lastmod = Column(Integer)
     modby = Column(String)
 
+#-----------------------------------------------------------------------------------
+
 engine = create_engine(path_to_db, echo=False)
 Session = sessionmaker(bind=engine)
 session = Session()
 
+#-----------------------------------------------------------------------------------
+# The only function that makes this class useful
+#-----------------------------------------------------------------------------------
+
 def getLevel(channel,hostname):
+    """Returns IRC user level from database.
+    
+    The database model is used through sqlalchemy as defined above.
+    The first query tries to get an entry just by submitting the ip address,
+    the second query joins the host.zdvuser which has the given ip address with 
+    irc.user.
+    """
     level = "n"
-    #print channel
+    
+    if DEBUG:
+        print channel
     if channel.startswith("#"):
         channel = channel[1:]
-    #print hostname
+    if DEBUG:
+        print hostname
+    
     ip = socket.gethostbyname(hostname)
-    #print ip
-    q = session.query(irc.stat).filter(irc.user == ip).filter(irc.chan == channel).first()
-    #print "q: %s"%q
+    if DEBUG:
+        print ip
 
+    q = session.query(irc.stat).filter(irc.user == ip).filter(irc.chan == channel).first()
     if q:
+        if DEBUG:
+            print "User level by ip address: %s" % q
         level = q[0]
 
-    # USE JOINS
-    
-    p = session.query(host.zdvuser).filter(host.ipv4 == ip).first()
-    #print "p: %s"%p
+#    This SQL query shall be performed:
+#    
+#    SELECT irc.`stat` FROM `irc`
+#    LEFT JOIN `host` ON irc.`user` = host.`zdvuser`
+#    WHERE host.`ipv4` = 'ip' AND irc.`chan` = 'channel'
 
+    p = session.query(irc.stat).join((host, irc.user == host.zdvuser)).filter(host.ipv4 == ip).filter(irc.chan == channel).first()
     if p:
-        p = p[0]
-        r = session.query(irc.stat).filter(irc.user == p).filter(irc.chan == channel).first()
-        #print "r: %s"%r
-        if r:
-            level = r[0]
+        if DEBUG:
+            print "User level by ZDV-Username: %s" % p
+        level = p[0]
 
     return level
 
-def getChannelLevels(channel):
-    
-    levels = {}
-    
-    #print channel
-    if channel.startswith("#"):
-        channel = channel[1:]
-        
-    q = session.query(irc.user,irc.stat).filter(irc.chan == channel).all()
-    #print q
-    
-    # Lets make a nice dictionary out of the tuples
-    for (user,mode) in q:
-        levels[user] = mode
-    
-    return levels
+#-----------------------------------------------------------------------------------
+# And finally some test cases
+#-----------------------------------------------------------------------------------
 
 if __name__ == "__main__":
+    print ("My level in #public: %c" % getLevel("#public","134.93.50.65"))
+    print ("My level in #spielplatz: %c" % getLevel("#spielplatz","134.93.50.65"))
     #print getLevel("#public","stewie.k3.wohnheim.uni-mainz.de")
     #print getLevel("#public","134.93.136.6")
     #print getLevel("#k3","134.93.136.6")
-    print getChannelLevels("#public")

ircbot.cfg.default

@@ -7,9 +7,10 @@ nickname:       masterbot
 realname:       Master of the Universe
 
 [database]
+engine:     mysql
 server:     2.3.4.5
 user:       user
-passwd:     passwd
+password:   passwd
 database:   db
 
 [responses]