quotes.py

   1 #!/usr/bin/env python
   2 # -*- encoding: utf-8 -*-
   3
   4 """ Gestion des quotes """
   5
   6 import datetime
   7 import time
   8 import re
   9 import json
  10 import random
  11
  12 import config
  13
  14 quote_matcher = re.compile(config.quote_regexp, flags=re.UNICODE)
  15 quote_matcher_with_timestamp = re.compile(config.quote_regexp_with_timestamp, flags=re.UNICODE)
  16 spaces_matcher = re.compile(u"\s", flags=re.U)
  17
  18 def equivalence_partition(iterable, relation):
  19     """ Partitionne l'itérable en classes d'équivalences. """
  20     classes = []
  21     for o in iterable:
  22         # find the class it is in
  23         found = False
  24         for c in classes:
  25             if relation( iter(c).next(), o ): # is it equivalent to this class?
  26                 c.add( o )
  27                 found = True
  28                 break
  29         if not found: # it is in a new class
  30             classes.append( set( [ o ] ) )
  31     return classes
  32
  33 def get_now():
  34     """ Renvoie la date actuelle """
  35     return datetime.datetime(*time.localtime()[:6])
  36
  37 def sanitize_author(raw):
  38     """Proprifie l'auteur : enlève les espaces insécables."""
  39     return spaces_matcher.sub(u" ", raw)
  40
  41 class Quote(object):
  42     """ Une citation """
  43     def __init__(self, author, content, timestamp=None, place=None, quoter=None):
  44         if timestamp is None:
  45             timestamp = get_now()
  46         elif isinstance(timestamp, basestring):
  47             timestamp = datetime.datetime(*time.strptime(timestamp, u"%Y-%m-%d_%H:%M:%S")[:6])
  48         self.author = sanitize_author(author)
  49         self.content = content
  50         self.timestamp = timestamp
  51         self.place = place
  52         self.quoter = quoter
  53
  54     def jsonize(self):
  55         d = {"author" : self.author, "content" : self.content,
  56              "timestamp" : self.timestamp.strftime(u"%F_%T"),
  57              "place" : self.place, "quoter" : self.quoter}
  58         return d
  59
  60     def __unicode__(self):
  61         """ Retourne la quote affichable """
  62         if self.place and self.place.strip() != u"":
  63             return config.quote_template_withcontext % self.__dict__
  64         else:
  65             return config.quote_template % self.__dict__
  66     def __str__(self):
  67         return unicode(self).encode("utf-8")
  68
  69     def full_str(self):
  70         """ Retourne une chaîne représentant la totalité des infos de la quote,
  71             tout en étant parsable et human-readable. """
  72         place = self.place if self.place and self.place.strip() != u"" else u""
  73         quoter = self.quoter if self.quoter and self.quoter.strip() != u"" else u""
  74         return (u"%s %s | %s | %s" % (self.timestamp.strftime("%F_%T"), config.quote_template % self.__dict__
  75                   , place, quoter)).encode("utf-8")
  76
  77     def __eq__(self, otherquote):
  78         """ Vérifie si cette phrase n'a pas déjà été dite par la même personne.
  79             Indépendamment de la date et de la casse. """
  80         return [self.author.lower(), self.content.lower()] == [otherquote.author.lower(), otherquote.content.lower()]
  81
  82
  83 def parse(text, date=None):
  84     """ Parse le ``text`` et renvoie une quote ou None. """
  85     if date == None:
  86         date = get_now()
  87     get = quote_matcher.match(text)
  88     if not get is None:
  89         d = get.groupdict()
  90         return Quote(d["author"], d["content"], date)
  91
  92 def load_file(filename):
  93     """ Récupère les quotes depuis le fichier """
  94     with open(filename) as f:
  95         jsonquotes = json.load(f)
  96         quotes = [Quote(**q) for q in jsonquotes]
  97     return quotes
  98
  99 def save_file(quotes, filename):
 100     """ Enregistre les quotes dans le fichier """
 101     with open(filename, "w") as f:
 102         raws = [q.jsonize() for q in quotes]
 103         json.dump(raws, f)
 104
 105 class QuoteDB(object):
 106     """ Stocke et distribue des quotes. """
 107     def __init__(self):
 108         self.quotelist = []
 109
 110     def load(self):
 111         """ Charge le fichier de quotes dans la DB """
 112         self.quotelist = load_file(config.quote_file)
 113
 114     def save(self):
 115         """ Sauvegarde la DB dans le fichier de quotes """
 116         save_file(self.quotelist, config.quote_file)
 117
 118     def _collapse_author(self, author):
 119         """ Renvoie ``author`` avec la casse déjà utilisée si il a déjà été quoté
 120             sinon, le renvoie sans le modifier. """
 121         authors = list(set([q.author for q in self.quotelist if q.author.lower() == author.lower()]))
 122         if len(authors) > 1:
 123             print "Warning : authors %s" % authors
 124         if authors:
 125             return authors[0]
 126         else:
 127             return author
 128
 129     def get_clash_authors(self):
 130         """ Renvoie une liste de liste d'auteurs qui sont enregistrés avec des casses différentes. """
 131         authors = list(set([q.author for q in self.quotelist]))
 132         authors = equivalence_partition(authors, lambda x,y: x.lower() == y.lower())
 133         authors = [list(c) for c in authors if len(c) > 1]
 134         return authors
 135
 136     def store(self, timestamp=None, **kwargs):
 137         """ Enregistre une nouvelle quote, sauf si elle existe déjà.
 138             Force l'auteur à utiliser la même casse si un auteur de casse différente existait déjà.
 139             Renvoie ``True`` si elle a été ajoutée, ``False`` si elle existait. """
 140         kwargs["author"] = self._collapse_author(kwargs["author"])
 141         kwargs["timestamp"] = timestamp
 142         newquote = Quote(**kwargs)
 143         if not newquote in self.quotelist:
 144             self.quotelist.append(newquote)
 145             return True
 146         return False
 147
 148     def __repr__(self):
 149         return repr(self.quotelist)
 150
 151     def random(self):
 152         """ Sort une quote aléatoire """
 153         return random.choice(self.quotelist)
 154
 155     def quotesfrom(self, author):
 156         """ Sort toutes les quotes de ``author`` """
 157         return [q for q in self.quotelist if q.author == author]
 158     def randomfrom(self, author):
 159         """ Sort une quote aléatoire de ``author`` """
 160         return random.choice(self.quotesfrom(author))
 161
 162     def search(self, inquote=None, author=None, regexp=False):
 163         """Fait une recherche dans les quotes."""
 164         if regexp:
 165             if inquote is None:
 166                 inquote = ".*"
 167             if author is None:
 168                 author = ".*"
 169             qreg = re.compile(inquote, flags=re.UNICODE)
 170             areg = re.compile(author, flags=re.UNICODE)
 171             l = [q for q in self.quotelist if qreg.match(q.content) and areg.match(q.author)]
 172         else:
 173             if inquote is None:
 174                 inquote = ""
 175             if author is None:
 176                 author = ""
 177             l = [q for q in self.quotelist if inquote in q.content and author in q.author]
 178         return l
 179
 180     def search_authors(self, author=None, regexp=False):
 181         """Renvoie la liste des auteurs contenant ``author`` ou qui matchent la regexp."""
 182         if regexp:
 183             if author is None:
 184                 author = ".*"
 185             areg = re.compile(author, flags=re.UNICODE)
 186             l = list(set([q.author for q in self.quotelist if areg.match(q.author)]))
 187         else:
 188             if author is None:
 189                 author = ""
 190             l = list(set([q.author for q in self.quotelist if author in q.author]))
 191         return l
 192
 193 def dump(quotedb, dump_file=None):
 194     """Pour exporter les quotes dans un format readable vers un fichier."""
 195     if dump_file is None:
 196         dump_file = config.quote_dump_file
 197     t = "\n".join([q.full_str() for q in quotedb.quotelist]) + "\n"
 198     with open(dump_file, "w") as f:
 199         f.write(t)
 200
 201 def restore(dump_file=None):
 202     """Crée un DB de quotes en parsant le contenu d'un fichier de dump."""
 203     if dump_file is None:
 204         dump_file = config.quote_dump_file
 205     with open(dump_file) as f:
 206         t = f.read()
 207     t = t.decode("utf-8") # Oui, ça peut fail, mais on ne doit alors pas continuer
 208     l = [m.groupdict() for m in quote_matcher_with_timestamp.finditer(t)]
 209     # On instancie les quotes grâce aux dicos qui ont déjà la bonne tronche
 210     l = [Quote(**q) for q in l]
 211     newquotedb = QuoteDB()
 212     newquotedb.quotelist = l
 213     return newquotedb