wantzel.py 17.9 KB
Newer Older
1 2
#encoding: utf-8
"""
Mindiell's avatar
Mindiell committed
3
Bot Wantzel from La Quadrature du Net.
4

Mindiell's avatar
Mindiell committed
5 6 7 8
License : AGPLv3
Doc     : https://wiki.laquadrature.net/Wantzel

TODO:
Mindiell's avatar
Mindiell committed
9 10 11 12 13
- Ajouter des commandes permettant de gérer le mediakit (moderators only)
    - Parser les urls et voir ce qu'on peut faire:
        - upload de vidéo
        - tag de vidéo
        - obtenir un lien vers une vidéo
14 15
"""

Mindiell's avatar
Mindiell committed
16
import feedparser
17
import HTMLParser
Mindiell's avatar
Mindiell committed
18
import importlib
19 20 21
from irc import IrcClientFactory
import MySQLdb
import re
Mindiell's avatar
Mindiell committed
22 23
import sqlite3
import time
24
from twisted.internet import reactor
Mindiell's avatar
Mindiell committed
25
from twitter import Twitter, OAuth
26 27 28 29 30
import urllib

import config
from messages import messages

Mindiell's avatar
Mindiell committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
LOG_FILE = "wantzel.log"
DEBUG = 3
WARNING = 2
INFO = 1
ERROR = 0
LOG_LEVEL = DEBUG

class Utils(object):
    @classmethod
    def log(cls, message):
        with open(LOG_FILE, 'a') as f:
            f.write("%s: %s\n" % (time.strftime("%Y-%m-%d %H:%M:%S", time.localtime()), message))

    @classmethod
    def debug(cls, message):
        if LOG_LEVEL>=DEBUG:
            cls.log("%s: %s" % ("DEBUG", message))

    @classmethod
    def warning(cls, message):
        if LOG_LEVEL>=WARNING:
            cls.log("%s: %s" % ("WARNING", message))

    @classmethod
    def info(cls, message):
        if LOG_LEVEL>=INFO:
            cls.log("%s: %s" % ("INFO", message))

    @classmethod
    def error(cls, message):
        if LOG_LEVEL>=ERROR:
            cls.log("%s: %s" % ("ERROR", message))



Mindiell's avatar
Mindiell committed
66 67
def get_cursor():
    """
Mindiell's avatar
Mindiell committed
68
    This function connects to a MySQL database and returns a usable cursor.
Mindiell's avatar
Mindiell committed
69
    """
Mindiell's avatar
Mindiell committed
70
    connection = MySQLdb.connect(
Mindiell's avatar
Mindiell committed
71 72 73 74 75
        host=config.dbserver,
        user=config.dbuser,
        passwd=config.dbpassword,
        db=config.dbname
    )
Mindiell's avatar
Mindiell committed
76 77
    if connection:
        return connection.cursor()
Mindiell's avatar
Mindiell committed
78 79
    return None

80
def get_url(message):
Mindiell's avatar
Mindiell committed
81
    """
82
    Retrieve the url in the message.
Mindiell's avatar
Mindiell committed
83
    """
84 85
    # Let's get the url
    result = re.search("(https?[^ ]+)", message)
Mindiell's avatar
Mindiell committed
86 87
    if not result:
        return "http"
88
    url = result.group(1)
Mindiell's avatar
Mindiell committed
89 90 91 92 93 94 95 96
    # Removing anchor if needed
    result = re.search("^([^#]*)", url)
    if result:
        url = result.group(1)
    # Removing trackers
    url = re.sub("[?&](utm_medium|utm_source|utm_campaign|xtor)=[^&]*", "", url)
    return url

97 98 99
def get_title(message):
    title = ""
    website = ""
100 101 102 103
    exceptions = [
        "twitter.com",
        "github.com",
    ]
104
    try:
105 106 107 108
        url = get_url(message)
        for exception in exceptions:
            if exception in url:
                return ("", "")
109 110 111 112 113 114
        website = re.search("//([^/]*)", url).group(1)
        f = urllib.URLopener().open(url)
        content = f.read()
        title = re.search("<title>([^<]+)</title>", content).group(1)
    except:
        pass
115 116
    # Unescaping HTML entities and removing multiple lines
    title = HTMLParser.HTMLParser().unescape(re.sub("\n|\r", "", title))
117 118
    return (title, website)

Mindiell's avatar
Mindiell committed
119 120 121 122 123 124 125 126 127 128 129 130
def is_moderator(name):
    """
    This function verify if a user is a moderator.
    """
    connection = sqlite3.connect(config.sqlite_db)
    cursor = connection.cursor()
    cursor.execute("SELECT count(*) FROM moderator WHERE name=?", (name, ))
    if int(cursor.fetchone()[0])==1:
        return True
    return False


131 132 133 134 135 136 137 138
class Wantzel(object):
    """
    Wantzel bot.
    """
    def __init__(self):
        """
        Initialization of bot over IRC.
        """
Mindiell's avatar
Mindiell committed
139 140 141 142 143 144 145 146 147 148
        self.number = 0
        # default last_entry_published
        self.last_entry_published = time.strptime("2000-01-01", "%Y-%m-%d")
        # See if there is something in the db
        connection = sqlite3.connect(config.sqlite_db)
        for row in connection.execute("SELECT last_entry_published FROM tweets"):
            self.last_entry_published = time.strptime(
                row[0].encode("utf-8"),
                "%Y-%m-%d %H:%M:%S %Z"
            )
149 150 151
        self.irc = IrcClientFactory(config)
        self.irc.set_privmsg = self.set_privmsg
        reactor.connectTCP(config.server, config.port, self.irc)
Mindiell's avatar
Mindiell committed
152 153 154 155 156 157 158
        # Prepare timer
        reactor.callLater(config.timer, self.timer)

    def timer(self):
        """
        This method launches function regularly (see config.timer).
        """
Mindiell's avatar
Mindiell committed
159
        Utils.debug("Timer called")
Mindiell's avatar
Mindiell committed
160 161 162 163 164
        self.rp_to_twitter("http://www.laquadrature.net/fr/revue-de-presse/feed")
        self.rp_to_twitter("http://www.laquadrature.net/en/press-review/feed")
        self.count_articles()
        # Recalling the timer
        reactor.callLater(config.timer, self.timer)
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180

    def set_privmsg(self):
        """
        This method set the methods to call for each callback received from IRC.
        """
        self.irc.client.privmsg = self.on_privmsg

    def send_message(self, channel, messages):
        """
        Sends a message on specified channel, cutting each line in a new message
        """
        for message in messages.splitlines():
            self.irc.client.msg(channel, message)

    def on_privmsg(self, user, channel, msg):
        """
Mindiell's avatar
Mindiell committed
181 182
        Wantzel can understand a lot of commands. Commands followed by a (*)
        are accessible only to moderators:
183 184 185 186 187
        - help
            Returns a message about how to use the bot.
            If a command is passed after help, the message explains how to use
            the command. 
        - rp(acp)
Mindiell's avatar
Mindiell committed
188
            Add an article in the database
189
        - stats
Mindiell's avatar
Mindiell committed
190
            Show some statistics about the RP
Mindiell's avatar
Mindiell committed
191
        - kill (*)
Mindiell's avatar
Mindiell committed
192
            Kill an article by giving it a score of -100
Mindiell's avatar
Mindiell committed
193 194 195 196 197 198
        - moderate list (*)
            List rights in private
        - moderate add (*)
            Add a new moderator to list
        - moderate remove (*)
            Remove a moderator from list
199 200
        """
        # Cleaning user name
Mindiell's avatar
Mindiell committed
201
        user = re.search("([^!]*)!", user).group(1)
Mindiell's avatar
Mindiell committed
202
        Utils.debug("Message received: %s %s %s" % (user, channel, msg))
203
        # Whatever is done, get the title of an existing url in a message
Mindiell's avatar
Mindiell committed
204 205 206
        #title = ""
        #if "http" in msg:
        #    title, website = get_title(msg)
Mindiell's avatar
Mindiell committed
207 208 209 210 211 212 213
        # Never answer to botself
        if user!=config.nickname:
            # If it's a query, bot should answer to the user as the channel
            if "#" not in channel:
                channel = user
            # Help command, specific
            if "wantzel" in msg and ("help" in msg or "aide" in msg):
214
                self.help(user, channel, msg)
Mindiell's avatar
Mindiell committed
215
            # Find known command
Mindiell's avatar
Mindiell committed
216
            command = re.search("!(rp[acp]*|kill|help|stats|admin)", msg)
Mindiell's avatar
Mindiell committed
217 218
            if command:
                command = command.group(1)
Mindiell's avatar
Mindiell committed
219
                Utils.debug("Command: %s" % command)
Mindiell's avatar
Mindiell committed
220
                if command.startswith("rp"):
221
                    self.rp(command, user, channel, msg, title)
Mindiell's avatar
Mindiell committed
222 223 224 225 226 227
                elif command=="help":
                    self.help(user, channel, msg)
                elif command=="kill":
                    self.kill(user, channel, msg)
                elif command=="stats":
                    self.stats(user, channel, msg)
Mindiell's avatar
Mindiell committed
228 229
                elif command=="admin":
                    self.admin(user, channel, msg)
Mindiell's avatar
Mindiell committed
230 231 232
        # No more giving the title of an url
        #if title and website:
        #    self.send_message(channel, messages["title"] % (title, website))
233 234 235 236 237 238 239

    def help(self, user, channel, msg):
        """
        Show global help.
        If a known command is behind the !help command, an adequate message is
        returned.
        """
Mindiell's avatar
Mindiell committed
240
        Utils.debug("help command")
Mindiell's avatar
Mindiell committed
241
        # Searching for a command after help keyword
Mindiell's avatar
Mindiell committed
242
        command = re.search("!help (stats|rp|help|kill|admin)", msg)
Mindiell's avatar
Mindiell committed
243 244
        if command:
            command = command.group(1)
245
            self.send_message(channel, messages["help_"+command])            
Mindiell's avatar
Mindiell committed
246 247
        else:
            self.send_message(channel, messages["help"])
248

249
    def rp(self, command, user, channel, msg, title=""):
250 251 252
        """
        Adding the article in rp database.
        """
Mindiell's avatar
Mindiell committed
253
        Utils.debug("rp command %s" % command)
254 255
        cite = 0
        note = 0
256
        url = get_url(msg)
Mindiell's avatar
Mindiell committed
257
        Utils.debug("url: %s" % url)
Mindiell's avatar
Mindiell committed
258 259 260 261 262
        if url=="":
            return
        elif url=="http":
            self.send_message(channel, messages["rp_http"] % user)
            return
263

Mindiell's avatar
Mindiell committed
264 265
        # Looking for such an article in database
        cursor = get_cursor()
266 267 268 269 270 271 272 273 274 275 276 277
        cursor.execute("SELECT id, note, provenance FROM presse WHERE url = %s", (url, ))
        rows = cursor.fetchall()
        if not rows:
            # LQdN is quoted
            if "c" in command:
                cite += 2
            # the article speak about LQdN
            if command.count("p")>1:
                cite += 2
            # Archive this article
            if "a" in command:
                note -= 2
Mindiell's avatar
Mindiell committed
278
            Utils.debug("Adding an article by %s: %s" % (user, url))
279
            result = cursor.execute(
280 281 282 283 284
                """INSERT INTO presse SET 
                url=%s, provenance=%s, cite=%s, note=%s, datec=NOW(), title=%s,
                lang='', published=0, nid=0, screenshot=0, fetched=0, seemscite=0
                """,
                (url, user, cite, note, title)
285
            )
Mindiell's avatar
Mindiell committed
286
            self.send_message(channel, messages["rp_new_article"] % user)
287 288
        else:
            if rows[0][2]!=user:
Mindiell's avatar
Mindiell committed
289
                Utils.debug("Adding a point by %s on %s" % (user, rows[0][0]))
290 291 292 293 294
                result = cursor.execute(
                    "UPDATE presse SET note=note+1 WHERE id=%s",
                    (rows[0][0], )
                )
            if (rows[0][1]+1)<3:
Mindiell's avatar
Mindiell committed
295
                self.send_message(channel, messages["rp_known_article"] % user)
296
            else:
Mindiell's avatar
Mindiell committed
297
                self.send_message(channel, messages["rp_taken_article"] % user)
Mindiell's avatar
Mindiell committed
298 299
                # Update number of articles to do
                self.count_articles()
300 301 302

    def kill(self, user, channel, msg):
        """
Mindiell's avatar
Mindiell committed
303
        Kill an article by setting its score to -100.
304
        """
Mindiell's avatar
Mindiell committed
305
        Utils.debug("kill command")
Mindiell's avatar
Mindiell committed
306 307
        if is_moderator(user):
            url = get_url(msg)
Mindiell's avatar
Mindiell committed
308
            Utils.debug("url: %s" % url)
Mindiell's avatar
Mindiell committed
309 310 311 312 313 314 315 316 317 318 319 320 321 322
            if url=="":
                return
            elif url=="http":
                self.send_message(channel, messages["rp_http"] % user)
                return
            # Looking for such an article in database
            cursor = get_cursor()
            cursor.execute("SELECT id, note FROM presse WHERE url=%s", (url, ))
            rows = cursor.fetchall()
            if not rows:
                self.send_message(channel, messages["kill_none"] % url)
            else:
                cursor.execute("UPDATE presse SET note=-100 WHERE id=%s", (rows[0][0], ))
                self.send_message(channel, messages["kill_done"] % url)
Mindiell's avatar
Mindiell committed
323
        else:
Mindiell's avatar
Mindiell committed
324
            self.send_message(channel, messages["not_moderator"])
325 326 327 328 329

    def stats(self, user, channel, msg):
        """
        Returns stats on articles in press review.
        """
Mindiell's avatar
Mindiell committed
330
        Utils.debug("stats command")
Mindiell's avatar
Mindiell committed
331
        cursor = get_cursor()
332 333 334 335 336 337 338
        periods = [1, 3, 7, 15]
        notes = [0, 3 ,4]
        notnull = 0
        somethingatall = 0
        result = ""
        for note in notes:
            notnull = 0
Mindiell's avatar
Mindiell committed
339
            result = result + "note>=%s: " % note
340 341 342 343 344 345 346 347 348 349 350 351
            for period in periods:
                cursor.execute(
                    """SELECT COUNT(id) AS cid FROM presse 
                    WHERE nid=0
                    AND datec>(NOW()-INTERVAL %s DAY)
                    AND note>=%s""",
                    (period, note)
                )
                rows = cursor.fetchall()
                if rows[0][0]>0:
                    result = result + "%sj:%s, " % (period, rows[0][0])
                    notnull = 1
Mindiell's avatar
Mindiell committed
352
                    somethingatall = 1
353 354
            if notnull:
                result = result[:-2] + "\n"
Mindiell's avatar
Mindiell committed
355 356
        if somethingatall==0:
            result = messages["stats_bravo"] % periods[-1]
357 358
        self.send_message(channel, result)

Mindiell's avatar
Mindiell committed
359 360 361 362 363
    def admin(self, user, channel, msg):
        """
        Manage moderation.
        A sub-command should be behind the !admin command.
        """
Mindiell's avatar
Mindiell committed
364
        Utils.debug("admin command")
Mindiell's avatar
Mindiell committed
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
        # Searching for a command after admin keyword
        command = re.search("!admin (list|add|del)", msg)
        if command:
            command = command.group(1)
            if command=="list":
                self.admin_list(user, channel, msg)
            elif command=="add":
                self.admin_add(user, channel, msg)
            elif command=="del":
                self.admin_del(user, channel, msg)

    def admin_list(self, user, channel, msg):
        """
        List actual moderators.
        """
Mindiell's avatar
Mindiell committed
380
        Utils.debug("admin_list command")
Mindiell's avatar
Mindiell committed
381 382 383 384 385 386 387 388 389 390 391 392 393
        if is_moderator(user):
            connection = sqlite3.connect(config.sqlite_db)
            names = []
            for row in connection.execute("SELECT name FROM moderator"):
                names.append(row[0].encode("utf-8"))
            self.send_message(channel, messages["admin_list"] % ", ".join(names))
        else:
            self.send_message(channel, messages["not_moderator"])

    def admin_add(self, user, channel, msg):
        """
        Add some new moderators if not existing yet.
        """
Mindiell's avatar
Mindiell committed
394
        Utils.debug("admin_add command")
Mindiell's avatar
Mindiell committed
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
        if is_moderator(user):
            try:
                names = []
                connection = sqlite3.connect(config.sqlite_db)
                result = re.search("!admin add (([^,]+, ?)+)?(.*)", msg)
                if result.group(1):
                    names = [name for name in result.group(1).split(", ") if name!=""]
                names.append(result.group(3))
                # Do not add actual moderators
                moderators = []
                for row in connection.execute("SELECT name FROM moderator"):
                    moderators.append(row[0].encode("utf-8"))
                names = set([name for name in names if name not in moderators])
                if names:
                    # Converting set in list of tuples
                    values = [(name,) for name in names]
                    connection.executemany("INSERT INTO moderator (name) VALUES (?)", values)
                    connection.commit()
                    self.send_message(channel, messages["admin_add"] % ", ".join(names))
                else:
                    self.send_message(channel, messages["admin_add_empty"])
            except:
                pass
        else:
            self.send_message(channel, messages["not_moderator"])

    def admin_del(self, user, channel, msg):
        """
        Delete a moderator from list.
        """
Mindiell's avatar
Mindiell committed
425
        Utils.debug("admin_del command")
Mindiell's avatar
Mindiell committed
426 427 428 429 430 431 432 433
        if is_moderator(user):
            try:
                names = []
                result = re.search("!admin del (([^,]+, ?)+)?(.*)", msg)
                if result.group(1):
                    names = [name for name in result.group(1).split(", ") if name!=""]
                names.append(result.group(3))
                names = set(names)
Mindiell's avatar
Mindiell committed
434
                Utils.debug(names)
Mindiell's avatar
Mindiell committed
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
                connection = sqlite3.connect(config.sqlite_db)
                for name in names:
                    connection.execute("DELETE FROM moderator WHERE name=?", (name, ))
                connection.commit()
                self.send_message(channel, messages["admin_del"] % ", ".join(names))
            except:
                pass
        else:
            self.send_message(channel, messages["not_moderator"])

    def count_articles(self):
        """
        Count number of articles not done in RP and updates the topic of the
        press review channel if needed.
        """
Mindiell's avatar
Mindiell committed
450
        Utils.debug("count_articles method")
Mindiell's avatar
Mindiell committed
451 452 453 454 455 456 457 458
        cursor = get_cursor()
        cursor.execute("""SELECT COUNT(*) FROM presse
            WHERE DATE_SUB(NOW(), INTERVAL 2 MONTH)<datec
            AND note > 2
            AND nid = 0""")
        rows = cursor.fetchall()
        number = int(rows[0][0])
        if self.number!=number:
Mindiell's avatar
Mindiell committed
459
            self.irc.client.topic("#lqdn-rp", messages["topic"] % number)
Mindiell's avatar
Mindiell committed
460 461 462 463 464 465 466
            pass
        self.number = number

    def rp_to_twitter(self, rss):
        """
        By parsing the RSS feed of the press-review, we know what to tweet.
        """
Mindiell's avatar
Mindiell committed
467
        Utils.debug("rp_to_twitter method")
Mindiell's avatar
Mindiell committed
468 469 470 471 472
        now = time.localtime()
        today = time.strptime("%s-%s-%s %s" % (
                now.tm_year,
                now.tm_mon,
                now.tm_mday,
Mindiell's avatar
Mindiell committed
473
                time.tzname[0]
Mindiell's avatar
Mindiell committed
474 475 476
            ),
            "%Y-%m-%d %Z"
        )
Mindiell's avatar
Mindiell committed
477 478 479
        language = "fr"
        if "/en/" in rss:
            language = "en"
Mindiell's avatar
Mindiell committed
480 481 482 483 484 485 486
        entries = feedparser.parse(rss)['entries']
        entries.reverse()
        for entry in entries:
            # if date of publication is greater than today, midnight, and
            # lesser than future
            if today < entry.published_parsed < now:
                if self.last_entry_published < entry.published_parsed:
Mindiell's avatar
Mindiell committed
487
                    self.tweet(messages["tweet_rp_%s" % language] % (
Mindiell's avatar
Mindiell committed
488 489 490
                        entry.title.encode("utf-8"),
                        entry.link.encode("utf-8")
                    ))
Mindiell's avatar
Mindiell committed
491 492
                    Utils.debug(entry.published_parsed)
                    Utils.debug(entry.title)
Mindiell's avatar
Mindiell committed
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
                    # Save last_entry_published
                    self.last_entry_published = entry.published_parsed
                    last_entry_published = time.strftime(
                        "%Y-%m-%d %H:%M:%S %Z",
                        self.last_entry_published
                    )
                    connection = sqlite3.connect(config.sqlite_db)
                    connection.execute(
                        "UPDATE tweets SET last_entry_published=?",
                        (last_entry_published,)
                    )
                    connection.commit()
                    # Tweet only one message in order not to spam
                    return

    def tweet(self, message):
        """
        Tweet message on specified account
        """
Mindiell's avatar
Mindiell committed
512
        Utils.debug("tweet method")
Mindiell's avatar
Mindiell committed
513 514 515 516 517 518 519 520
        auth = OAuth(
            config.TOKEN,
            config.TOKENSEC,
            config.CONSKEY,
            config.CONSSEC
        )
        twitter = Twitter(auth=auth)
        try:
Mindiell's avatar
Mindiell committed
521
            Utils.debug("Tweeting: %s" % message)
Mindiell's avatar
Mindiell committed
522
            twitter.statuses.update(status=message)
Mindiell's avatar
Mindiell committed
523 524 525
        except:
            pass

526 527 528 529

if __name__ == '__main__':
    wantzel = Wantzel()
    reactor.run()