New strings, karma penalization for flooding, Greetings probability

Author: sentenza

bot_core/irc_bot.py

@@ -1,6 +1,7 @@
 import time
 import sys
 import re
+import random
 from twisted.words.protocols import irc
 
 from message_logger import MessageLogger
@@ -97,31 +98,35 @@ def evaluate_command(self, user, channel, msg):
                 fetch_user = user
             elif len(msg_splits) == 2:
                 fetch_user = msg_splits[1]
+            else: return
             self.msg(channel, self.karma_manager.fetch_karma(fetch_user)) 
-        elif msg.startswith('!ciao'):
-            if len(msg_splits) == 2:
-                self.msg(channel, self.welcome_machine.ciao(msg_splits[1]))
         elif msg.startswith( ('!commands', '!help') ):
             if len(msg_splits) == 1:
                 self.msg(channel, self._help_command() )
             elif len(msg_splits) == 2:
                 self.msg(channel, self._help_command(msg_splits[1]) )
 
     def userJoined(self, user, channel):
-        """Called when a user joins the channel"""
+        """Called when a user joins the channel (10% chance)"""
         ciao_msg = self.welcome_machine.ciao(user)
-        self.msg(channel, ciao_msg)
+        if random.randint(1,100) <= self.factory.cm.greeting_probability:
+            self.msg(channel, ciao_msg)
 
     def karma_update(self, user, channel, msg):
         """Try to modify the Karma for a given nickname"""
         receiver_nickname = msg[:-2]
-        # TODO (sentenza) Check if the given nick is present on DB or if is on chan with /WHO command
         if receiver_nickname == user:
             self.msg(channel, "%s: you can't alter your own karma!" % user)
             return
-        if self.karmrator.is_rate_limited(user):
-            waiting_minutes = self.karmrator.user_timeout(user) / 60
-            self.msg(channel, "%s: you have to wait %s min for your next karmic request!" % (user, waiting_minutes))
+        limit = self.karmrator.rate_limit(user)
+        if  limit == 2:
+            waiting_minutes = self.karmrator.user_timeout(user)
+            self.msg(user, "%s: you have to wait %s sec for your next karmic request!" % (user, waiting_minutes))
+            return
+        if limit == 1:
+            # Penalize User
+            self.msg(channel, "%s: I warned you... Now you have lost karma. :(" % user )
+            self.karma_manager.update_karma(user, plus=False)
             return
         if msg.endswith('++'):
             self.karma_manager.update_karma(receiver_nickname, plus=True)

config.py

@@ -37,6 +37,7 @@ def __init__(self):
         self._bot_nick = self._config_parser.get('pyircbot', 'nick')
         self._verbose = False
         self._update_data_path()
+        self.greeting_probability = 30
 
     def _update_data_path(self):
         """Internal method called to update information about data folder. Data folder path depends on channel name."""

karma/karma_manager.py

@@ -40,10 +40,9 @@ def fetch_karma(self, cursor, nick=None):
         if nick:
             cursor.execute("SELECT score FROM %s WHERE nick=?" % self.karma_table, (nick,))
             karma_score = cursor.fetchone()
-            if not karma_score:
+            if karma_score is None:
                 return "Karma is inscrutable for %s" % nick
-            else:
-                return "%s has karma of %s" % (nick, karma_score[0])
+            return "%s: %s" % (nick, karma_score[0])
 
     @db_commit
     def update_karma(self, cursor, nick, plus=True):

karma/karma_rate.py

@@ -3,28 +3,39 @@
 
 class KarmaRateLimiter(object):
 
-    def __init__(self, timeout=3600):
-        """timeout in seconds - default 1 h"""
+    def __init__(self, timeout=360, penalty=3):
+        """timeout in seconds - default 6 min"""
         self.timeout = timeout
+        self.penalty = penalty
         # http://goo.gl/ZFmFX
         # http://stackoverflow.com/a/5900628
-        self.user_last_request = defaultdict(int)
+        self.user_last_request = defaultdict(lambda:[int, int])
+        # defaultdict needs callable obj
 
-    def is_rate_limited(self, nick):
+    def rate_limit(self, nick):
+        """Return 0 if not rate_limited, 1 if has penalization, 2 otherwise"""
         now = int(time.time())
         if nick not in self.user_last_request:
-            self.user_last_request[nick] = now
-            return False
-        elif (now - self.user_last_request[nick]) < self.timeout:
-            return True
+            self.user_last_request[nick] = [now,0]
+            return 0
+        elif (now - self.user_last_request[nick][0]) < self.timeout:
+            # Timeout not expired, so increase the counter
+            self.user_last_request[nick][1] += 1
+            # User is rate limited
+            if self.user_last_request[nick][1] % self.penalty == 0:
+                # give him the penalization!
+                return 1
+            else:
+                return 2
         else:
-            self.user_last_request[nick] = now
-            return False
+            # > timeout OK
+            self.user_last_request[nick] = [now, 0]
+            return 0
 
     def user_timeout(self, nick):
         """Return the user specific timeout"""
         if nick not in self.user_last_request:
             return 0
         else:
-            wait_time = self.timeout - (int(time.time()) - self.user_last_request[nick])
+            wait_time = self.timeout - (int(time.time()) - self.user_last_request[nick][0])
             return wait_time

pyircbot.py

@@ -36,9 +36,16 @@
                     action="store",
                     default = config_manager.bot_nick,
                     help="Bot nickname %s" % config_manager.bot_nick)
+    parser.add_option("-g", "--greeting", dest="greeting_probability",
+                    action="store",
+                    type="int",
+                    default = 30,
+                    help="Greeting probability [1 - 100]")
     parser.add_option("-v", "--verbose", dest="verbose",
                     action="store_true",
                     help="Print a lot of stuff...")
+
+ 
     options, args = parser.parse_args()
 
     # Set options to ConfigManager
@@ -47,6 +54,7 @@
     config_manager.channel = options.channel
     config_manager.bot_nick = options.nick
     config_manager.verbose = options.verbose
+    config_manager.greeting_probability = options.greeting_probability
 
     #if not options.<something>:
     #    parser.error('Must choose one option try -n or -c or --help')