wantzel.py 18.9 KB
Newer Older
1
# encoding: utf-8
2
"""
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:
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 16
"""

import re
17 18
import sqlite3
import time
19 20 21 22

import feedparser
from irc import IrcClientFactory
import MySQLdb
23
from twisted.internet import reactor
24
from twitter import Twitter, OAuth
25 26 27 28

import config
from messages import messages

Mindiell's avatar
Mindiell committed
29 30 31 32 33 34 35 36
LOG_FILE = "wantzel.log"
DEBUG = 3
WARNING = 2
INFO = 1
ERROR = 0
LOG_LEVEL = DEBUG

class Utils(object):
37 38 39
    """
    Simple utility class to log easily.
    """
Mindiell's avatar
Mindiell committed
40 41
    @classmethod
    def log(cls, message):
42 43 44 45 46
        """
        Logging message with timestamp.
        """
        actual_time = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime())
        with open(LOG_FILE, 'a') as file_handle:
47
            try:
48
                file_handle.write("%s: %s\n" % (actual_time, message.encode("utf-8")))
49 50
            except UnicodeDecodeError:
                file_handle.write("%s: %s\n" % (actual_time, message))
Mindiell's avatar
Mindiell committed
51 52 53

    @classmethod
    def debug(cls, message):
54 55 56 57
        """
        Manage DEBUG level of logging.
        """
        if LOG_LEVEL >= DEBUG:
Mindiell's avatar
Mindiell committed
58 59 60 61
            cls.log("%s: %s" % ("DEBUG", message))

    @classmethod
    def warning(cls, message):
62 63 64 65
        """
        Manage WARNING level of logging.
        """
        if LOG_LEVEL >= WARNING:
Mindiell's avatar
Mindiell committed
66 67 68 69
            cls.log("%s: %s" % ("WARNING", message))

    @classmethod
    def info(cls, message):
70 71 72 73
        """
        Manage INFO level of logging.
        """
        if LOG_LEVEL >= INFO:
Mindiell's avatar
Mindiell committed
74 75 76 77
            cls.log("%s: %s" % ("INFO", message))

    @classmethod
    def error(cls, message):
78 79 80 81
        """
        Manage ERROR level of logging.
        """
        if LOG_LEVEL >= ERROR:
Mindiell's avatar
Mindiell committed
82 83 84 85
            cls.log("%s: %s" % ("ERROR", message))



Mindiell's avatar
Mindiell committed
86 87
def get_cursor():
    """
88
    This function connects to a MySQL database and returns a usable cursor.
Mindiell's avatar
Mindiell committed
89
    """
90
    connection = MySQLdb.connect(
Mindiell's avatar
Mindiell committed
91 92 93 94 95
        host=config.dbserver,
        user=config.dbuser,
        passwd=config.dbpassword,
        db=config.dbname
    )
96 97
    if connection:
        return connection.cursor()
Mindiell's avatar
Mindiell committed
98 99
    return None

100

101
def get_url(message):
Mindiell's avatar
Mindiell committed
102
    """
103
    Retrieve the url in the message.
Mindiell's avatar
Mindiell committed
104
    """
105 106
    # Let's get the url
    result = re.search("(https?[^ ]+)", message)
Mindiell's avatar
Mindiell committed
107
    if not result:
108
        return
109
    url = result.group(1)
Mindiell's avatar
Mindiell committed
110 111 112 113 114 115 116 117
    # 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

118

119 120 121 122 123 124 125
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, ))
126
    if int(cursor.fetchone()[0]) == 1:
127 128 129 130
        return True
    return False


131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
def tweet(message):
    """
    Tweet message on specified account
    """
    Utils.debug("tweet method")
    auth = OAuth(
        config.TOKEN,
        config.TOKENSEC,
        config.CONSKEY,
        config.CONSSEC
    )
    twitter = Twitter(auth=auth)
    try:
        Utils.debug("Tweeting: %s" % message)
        twitter.statuses.update(status=message)
    except Exception:
        pass


150 151 152 153 154 155 156 157
class Wantzel(object):
    """
    Wantzel bot.
    """
    def __init__(self):
        """
        Initialization of bot over IRC.
        """
158
        self.number = None
159 160 161 162 163 164 165 166 167
        # 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"
            )
168
        Utils.debug("Dernier tweet: %s" % self.last_entry_published)
169 170 171
        self.irc = IrcClientFactory(config)
        self.irc.set_privmsg = self.set_privmsg
        reactor.connectTCP(config.server, config.port, self.irc)
172 173 174 175 176 177 178
        # Prepare timer
        reactor.callLater(config.timer, self.timer)

    def timer(self):
        """
        This method launches function regularly (see config.timer).
        """
Mindiell's avatar
Mindiell committed
179
        Utils.debug("Timer called")
180 181 182 183 184
        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)
185 186 187 188 189 190 191

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

192
    def send_message(self, channel, multiline_message):
193 194 195
        """
        Sends a message on specified channel, cutting each line in a new message
        """
196
        for message in multiline_message.splitlines():
197 198 199 200
            self.irc.client.msg(channel, message)

    def on_privmsg(self, user, channel, msg):
        """
201 202
        Wantzel can understand a lot of commands. Commands followed by a (*)
        are accessible only to moderators:
203 204 205
        - help
            Returns a message about how to use the bot.
            If a command is passed after help, the message explains how to use
206
            the command.
207
        - rp(acp)
Mindiell's avatar
Mindiell committed
208
            Add an article in the database
209
        - stats
Mindiell's avatar
Mindiell committed
210
            Show some statistics about the RP
211
        - kill (*)
Mindiell's avatar
Mindiell committed
212
            Kill an article by giving it a score of -100
213
        - admin list (*)
214
            List rights in private
215
        - admin add (*)
216 217 218
            Add one or more new moderator to list
        - admin del (*)
            Delete one or more moderator from list
219
        - admin timer
220
            Relaunch a timer
221 222
        """
        # Cleaning user name
Mindiell's avatar
Mindiell committed
223
        user = re.search("([^!]*)!", user).group(1)
Mindiell's avatar
Mindiell committed
224
        Utils.debug("Message received: %s %s %s" % (user, channel, msg))
Mindiell's avatar
Mindiell committed
225
        # Never answer to botself
226
        if user != config.nickname:
Mindiell's avatar
Mindiell committed
227 228 229 230 231
            # 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):
232
                self.help(channel, msg)
Mindiell's avatar
Mindiell committed
233
            # Find known command
234
            command = re.search("[!~](rp[acp]*|kill|help|stats|admin)", msg)
Mindiell's avatar
Mindiell committed
235
            Utils.debug("Command: %s" % command)
Mindiell's avatar
Mindiell committed
236
            if command:
Mindiell's avatar
Mindiell committed
237
                Utils.debug("group(0): %s" % command.group(0))
238 239
                if command.group(0).startswith('!'):
                    self.send_message(channel, messages["new_starter"])
Mindiell's avatar
Mindiell committed
240
                command = command.group(1)
Mindiell's avatar
Mindiell committed
241
                Utils.debug("Command: %s" % command)
Mindiell's avatar
Mindiell committed
242
                if command.startswith("rp"):
Mindiell's avatar
Mindiell committed
243
                    Utils.debug("Calling self.rp")
244
                    self.rp(command, user, channel, msg)
245
                elif command == "help":
Mindiell's avatar
Mindiell committed
246
                    Utils.debug("Calling self.help")
247 248
                    self.help(channel, msg)
                elif command == "kill":
Mindiell's avatar
Mindiell committed
249
                    Utils.debug("Calling self.kill")
Mindiell's avatar
Mindiell committed
250
                    self.kill(user, channel, msg)
251
                elif command == "stats":
Mindiell's avatar
Mindiell committed
252
                    Utils.debug("Calling self.stats")
253 254
                    self.stats(channel)
                elif command == "admin":
Mindiell's avatar
Mindiell committed
255
                    Utils.debug("Calling self.admin")
256
                    self.admin(user, channel, msg)
257 258 259
        # No more giving the title of an url
        #if title and website:
        #    self.send_message(channel, messages["title"] % (title, website))
260

261
    def help(self, channel, msg):
262 263
        """
        Show global help.
264
        If a known command is behind the ~help command, an adequate message is
265 266
        returned.
        """
Mindiell's avatar
Mindiell committed
267
        Utils.debug("help command")
Mindiell's avatar
Mindiell committed
268
        # Searching for a command after help keyword
269
        command = re.search("~help (help|rp|stats|kill|admin)", msg)
Mindiell's avatar
Mindiell committed
270 271
        if command:
            command = command.group(1)
272
            self.send_message(channel, messages["help_"+command])
Mindiell's avatar
Mindiell committed
273 274
        else:
            self.send_message(channel, messages["help"])
275

276
    def rp(self, command, user, channel, msg):
277 278 279
        """
        Adding the article in rp database.
        """
Mindiell's avatar
Mindiell committed
280 281 282 283
        Utils.debug("rp command : %s" % command)
        Utils.debug("rp user : %s" % user)
        Utils.debug("rp channel : %s" % channel)
        Utils.debug("rp msg : %s" % msg)
284
        cite = 0
285
        note = 1
286
        url = get_url(msg)
Mindiell's avatar
Mindiell committed
287
        Utils.debug("url: %s" % url)
288
        if not url:
Mindiell's avatar
Mindiell committed
289
            return
290

Mindiell's avatar
Mindiell committed
291 292
        # Looking for such an article in database
        cursor = get_cursor()
293 294 295 296 297 298 299
        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
300
            if command.count("p") > 1:
301 302 303
                cite += 2
            # Archive this article
            if "a" in command:
304
                note = -2
Mindiell's avatar
Mindiell committed
305
            Utils.debug("Adding an article by %s: %s" % (user, url))
306 307
            cursor.execute(
                """INSERT INTO presse SET
308
                url=%s, provenance=%s, cite=%s, note=%s, datec=NOW(), title='',
309 310
                lang='', published=0, nid=0, screenshot=0, fetched=0, seemscite=0
                """,
311
                (url, user, cite, note)
312
            )
Mindiell's avatar
Mindiell committed
313
            self.send_message(channel, messages["rp_new_article"] % user)
314
        else:
315
            if rows[0][2] != user:
Mindiell's avatar
Mindiell committed
316
                Utils.debug("Adding a point by %s on %s" % (user, rows[0][0]))
317
                cursor.execute(
318 319 320
                    "UPDATE presse SET note=note+1 WHERE id=%s",
                    (rows[0][0], )
                )
321
            if (rows[0][1]+1) < 3:
Mindiell's avatar
Mindiell committed
322
                self.send_message(channel, messages["rp_known_article"] % user)
323
            else:
Mindiell's avatar
Mindiell committed
324
                self.send_message(channel, messages["rp_taken_article"] % user)
325 326
                # Update number of articles to do
                self.count_articles()
327 328 329

    def kill(self, user, channel, msg):
        """
Mindiell's avatar
Mindiell committed
330
        Kill an article by setting its score to -100.
331
        """
Mindiell's avatar
Mindiell committed
332
        Utils.debug("kill command")
333 334
        if is_moderator(user):
            url = get_url(msg)
Mindiell's avatar
Mindiell committed
335
            Utils.debug("url: %s" % url)
336
            if url == "":
337
                return
338
            elif url == "http":
339 340 341 342 343 344 345 346 347 348 349
                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
350
        else:
351
            self.send_message(channel, messages["not_moderator"])
352

353
    def stats(self, channel):
354 355 356
        """
        Returns stats on articles in press review.
        """
Mindiell's avatar
Mindiell committed
357
        Utils.debug("stats command")
358
        cursor = get_cursor()
359
        periods = [1, 3, 7, 15]
360
        notes = [0, 3, 4]
361 362 363 364 365
        notnull = 0
        somethingatall = 0
        result = ""
        for note in notes:
            notnull = 0
366
            period_result = ""
367 368
            for period in periods:
                cursor.execute(
369
                    """SELECT COUNT(id) AS cid FROM presse
370 371 372 373 374 375
                    WHERE nid=0
                    AND datec>(NOW()-INTERVAL %s DAY)
                    AND note>=%s""",
                    (period, note)
                )
                rows = cursor.fetchall()
376
                if rows[0][0] > 0:
377
                    period_result = period_result + "%sj:%s, " % (period, rows[0][0])
378
                    notnull = 1
Mindiell's avatar
Mindiell committed
379
                    somethingatall = 1
380
            if notnull:
381
                result = result + "note>=%s: " % note + period_result[:-2] + "\n"
382
        if somethingatall == 0:
Mindiell's avatar
Mindiell committed
383
            result = messages["stats_bravo"] % periods[-1]
384 385
        self.send_message(channel, result)

386 387 388
    def admin(self, user, channel, msg):
        """
        Manage moderation.
389
        A sub-command should be behind the ~admin command.
390
        """
Mindiell's avatar
Mindiell committed
391
        Utils.debug("admin command")
392
        # Searching for a command after admin keyword
Mindiell's avatar
Mindiell committed
393
        command = re.search("~admin (list|add|del|timer)", msg)
394 395
        if command:
            command = command.group(1)
396 397 398
            if command == "list":
                self.admin_list(user, channel)
            elif command == "add":
399
                self.admin_add(user, channel, msg)
400
            elif command == "del":
401
                self.admin_del(user, channel, msg)
402 403
            elif command == "timer":
                self.admin_timer(user, channel)
404

405
    def admin_list(self, user, channel):
406 407 408
        """
        List actual moderators.
        """
Mindiell's avatar
Mindiell committed
409
        Utils.debug("admin_list command")
410 411 412 413 414 415 416 417 418 419 420 421 422
        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
423
        Utils.debug("admin_add command")
424 425 426 427
        if is_moderator(user):
            try:
                names = []
                connection = sqlite3.connect(config.sqlite_db)
428
                result = re.search("~admin add (([^,]+, ?)+)?(.*)", msg)
429
                if result.group(1):
430
                    names = [name for name in result.group(1).split(", ") if name != ""]
431 432 433 434 435
                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"))
436
                names = list(set([name for name in names if name not in moderators]))
437 438 439 440 441 442 443 444
                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"])
445
            except Exception:
446 447 448 449 450 451 452 453
                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
454
        Utils.debug("admin_del command")
455 456 457
        if is_moderator(user):
            try:
                names = []
458
                result = re.search("~admin del (([^,]+, ?)+)?(.*)", msg)
459
                if result.group(1):
460
                    names = [name for name in result.group(1).split(", ") if name != ""]
461
                names.append(result.group(3))
462
                names = list(set(names))
Mindiell's avatar
Mindiell committed
463
                Utils.debug(names)
464 465 466 467 468
                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))
469
            except Exception:
470 471 472 473
                pass
        else:
            self.send_message(channel, messages["not_moderator"])

474
    def admin_timer(self, user, channel):
475 476 477 478 479 480 481 482
        """
        Relaunch a timer.
        """
        Utils.debug("admin_timer command")
        if is_moderator(user):
            try:
                # Recalling the timer
                reactor.callLater(config.timer, self.timer)
483
            except Exception:
484 485 486 487
                pass
        else:
            self.send_message(channel, messages["not_moderator"])

488 489 490 491 492
    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
493
        Utils.debug("count_articles method")
494 495 496 497 498 499 500
        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])
501
        Utils.debug("Found %s articles." % number)
502
        if self.number != number:
Mindiell's avatar
Mindiell committed
503
            self.irc.client.topic("#lqdn-rp", messages["topic"] % number)
504 505 506 507 508 509
        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
510
        Utils.debug("rp_to_twitter method")
511 512
        now = time.localtime()
        today = time.strptime("%s-%s-%s %s" % (
513 514 515 516 517
            now.tm_year,
            now.tm_mon,
            now.tm_mday,
            time.tzname[0]
            ), "%Y-%m-%d %Z")
Mindiell's avatar
Mindiell committed
518 519 520
        language = "fr"
        if "/en/" in rss:
            language = "en"
521 522
        entries = feedparser.parse(rss)['entries']
        entries.reverse()
523
        Utils.debug(self.last_entry_published)
524 525 526 527 528
        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:
529
                    tweet(messages["tweet_rp_%s" % language] % (
530 531 532
                        entry.title.encode("utf-8"),
                        entry.link.encode("utf-8")
                    ))
Mindiell's avatar
Mindiell committed
533
                    Utils.debug(entry.published_parsed)
Mindiell's avatar
Mindiell committed
534
                    Utils.debug(entry.title)
535 536 537 538 539 540 541 542 543 544 545 546 547 548
                    # 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
549 550 551
                else:
                    Utils.debug(entry.title)
                    Utils.debug(entry.published_parsed)
552

553 554

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