X-Git-Url: https://git.llucax.com/software/blitiri.git/blobdiff_plain/72a7e1dd08a61f423fd2356a022f932777468f9a..5e8777f5ad10826e8b5c5869e1547710772fb6e4:/blitiri.cgi diff --git a/blitiri.cgi b/blitiri.cgi index fdefadb..8c6c6dc 100755 --- a/blitiri.cgi +++ b/blitiri.cgi @@ -24,9 +24,11 @@ comments_path = "/tmp/blog/comments" # default templates. If they're not found, the built-in ones will be used. templates_path = "/tmp/blog/templates" -# Path where the cache is stored (must be writeable by the web server) -# If None is specified, cache is disabled -cache_path = "/tmp/blog/cache" +# Path where the cache is stored (must be writeable by the web server); +# set to None to disable. When enabled, you must take care of cleaning it up +# every once in a while. +#cache_path = "/tmp/blog/cache" +cache_path = None # URL to the blog, including the name. Can be a full URL or just the path. blog_url = "/blog/blitiri.cgi" @@ -44,32 +46,10 @@ author = "Hartmut Kegan" # Article encoding encoding = "utf8" -# Captcha class -class Captcha (object): - def __init__(self, article): - self.article = article - words = article.title.split() - self.nword = hash(article.title) % len(words) % 5 - self.answer = words[self.nword] - self.help = 'gotcha, damn spam bot!' - - def get_puzzle(self): - nword = self.nword + 1 - if nword == 1: - n = '1st' - elif nword == 2: - n = '2nd' - elif nword == 3: - n = '3rd' - else: - n = str(nword) + 'th' - return "enter the %s word of the article's title" % n - puzzle = property(fget = get_puzzle) - - def validate(self, form_data): - if form_data.captcha.lower() == self.answer.lower(): - return True - return False +# Captcha method to use. At the moment only "title" is supported, but if you +# are keen with Python you can provide your own captcha implementation, see +# below for details. +captcha_method = "title" # @@ -105,6 +85,84 @@ except: data_path = os.path.realpath(data_path) templates_path = os.path.realpath(templates_path) + +# +# Captcha classes +# +# They must follow the interface described below. +# +# Constructor: +# Captcha(article) -> constructor, takes an article[1] as argument +# Attributes: +# puzzle -> a string with the puzzle the user must solve to prove he is +# not a bot (can be raw HTML) +# help -> a string with extra instructions, shown only when the user +# failed to solve the puzzle +# Methods: +# validate(form_data) -> based on the form data[2], returns True if +# the user has solved the puzzle uccessfully +# (False otherwise). +# +# Note you must ensure that the puzzle attribute and validate() method can +# "communicate" because they are executed in different requests. You can pass a +# cookie or just calculate the answer based on the article's data, for example. +# +# [1] article is an object with all the article's information: +# path -> string +# created -> datetime +# updated -> datetime +# uuid -> string (unique ID) +# title -> string +# author -> string +# tags -> list of strings +# raw_contents -> string in rst format +# comments -> list of Comment objects (not too relevant here) +# [2] form_data is an object with the form fields (all strings): +# author, author_error +# link, link_error +# catpcha, captcha_error +# body, body_error +# action, method + +class TitleCaptcha (object): + "Captcha that uses the article's title for the puzzle" + def __init__(self, article): + self.article = article + words = article.title.split() + self.nword = hash(article.title) % len(words) % 5 + self.answer = words[self.nword] + self.help = 'gotcha, damn spam bot!' + + @property + def puzzle(self): + nword = self.nword + 1 + if nword == 1: + n = '1st' + elif nword == 2: + n = '2nd' + elif nword == 3: + n = '3rd' + else: + n = str(nword) + 'th' + return "enter the %s word of the article's title" % n + + def validate(self, form_data): + if form_data.captcha.lower() == self.answer.lower(): + return True + return False + +known_captcha_methods = { + 'title': TitleCaptcha, +} + +# If the configured captcha method was a known string, replace it by the +# matching class; otherwise assume it's already a class and leave it +# alone. This way the user can either use one of our methods, or provide one +# of his/her own. +if captcha_method in known_captcha_methods: + captcha_method = known_captcha_methods[captcha_method] + + # Default template default_main_header = """\ @@ -408,23 +466,32 @@ div.section h1 { """ + # Cache decorator +# It only works if the function is pure (that is, its return value depends +# only on its arguments), and if all the arguments are hash()eable. def cached(f): - def decorate(obj, *args, **kwargs): - if cache_path is None: # cache disabled - s = f(obj, *args, **kwargs) - else: - cache_file = os.path.join(cache_path, - 'blitiri.cache.%s.html' % hash(obj)) - try: - s = open(cache_file).read() - except: - s = f(obj, *args, **kwargs) - open(cache_file, 'w').write(s) + # do not decorate if the cache is disabled + if cache_path is None: + return f + + def decorate(*args, **kwargs): + hashes = '-'.join( str(hash(x)) for x in args + + tuple(kwargs.items()) ) + fname = 'blitiri.%s.%s.cache' % (f.__name__, hashes) + cache_file = os.path.join(cache_path, fname) + try: + s = open(cache_file).read() + except: + s = f(*args, **kwargs) + open(cache_file, 'w').write(s) return s + return decorate + # helper functions +@cached def rst_to_html(rst, secure = True): settings = { 'input_encoding': encoding, @@ -437,7 +504,6 @@ def rst_to_html(rst, secure = True): parts = publish_parts(rst, settings_overrides = settings, writer_name = "html") return parts['body'].encode('utf8') -rst_to_html = cached(rst_to_html) def validate_rst(rst, secure = True): try: @@ -617,25 +683,23 @@ class Comment (object): self._link = '' self._raw_content = 'Removed comment' - - def get_author(self): + @property + def author(self): if not self.loaded: self.load() return self._author - author = property(fget = get_author) - def get_link(self): + @property + def link(self): if not self.loaded: self.load() return self._link - link = property(fget = get_link) - def get_raw_content(self): + @property + def raw_content(self): if not self.loaded: self.load() return self._raw_content - raw_content = property(fget = get_raw_content) - def set(self, author, raw_content, link = '', created = None): self.loaded = True @@ -759,37 +823,35 @@ class Article (object): self._raw_content = '' self._comments = [] - - def get_title(self): + @property + def title(self): if not self.loaded: self.load() return self._title - title = property(fget = get_title) - def get_author(self): + @property + def author(self): if not self.loaded: self.load() return self._author - author = property(fget = get_author) - def get_tags(self): + @property + def tags(self): if not self.loaded: self.load() return self._tags - tags = property(fget = get_tags) - def get_raw_content(self): + @property + def raw_content(self): if not self.loaded: self.load() return self._raw_content - raw_content = property(fget = get_raw_content) - def get_comments(self): + @property + def comments(self): if not self.loaded: self.load() return self._comments - comments = property(fget = get_comments) - def __cmp__(self, other): if self.path == other.path: @@ -980,7 +1042,7 @@ def render_comments(article, template, form_data): if not form_data: form_data = CommentFormData() form_data.action = blog_url + '/comment/' + article.uuid + '#comment' - captcha = Captcha(article) + captcha = captcha_method(article) print template.get_comment_form(article, form_data, captcha.puzzle) def render_html(articles, db, actyear = None, show_comments = False, @@ -1150,7 +1212,7 @@ def handle_cgi(): link.strip().replace('\n', ' '), captcha, body.replace('\r', '')) article = db.get_article(uuid) - captcha = Captcha(article) + captcha = captcha_method(article) redirect = False valid = True if not form_data.author: @@ -1177,7 +1239,8 @@ def handle_cgi(): at = '' if line: at = ' at line %d' % line - form_data.body_error = 'error%s: %s' % (at, desc) + form_data.body_error = 'error%s: %s' \ + % (at, desc) valid = False if valid: c = article.add_comment(form_data.author,