Use wiki to format search pages (saves 12 lines)
[geekigeeki.git] / geekigeeki.py
index 263c4829187a28dd11e3fd3cd0eff068eabedaf1..b3eed3c52d509732419e6ed9546be3aebe3353b6 100755 (executable)
@@ -1,16 +1,16 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
-# Copyright 1999, 2000 Martin Pool <mbp@humbug.org.au>
-# Copyright 2002 Gerardo Poggiali
-# Copyright 2007, 2008, 2009 Bernie Innocenti <bernie@codewiz.org>
+# Copyright (C) 1999, 2000 Martin Pool <mbp@humbug.org.au>
+# Copyright (C) 2002 Gerardo Poggiali
+# Copyright (C) 2007, 2008, 2009 Bernie Innocenti <bernie@codewiz.org>
 #
 # This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.  You should have received a copy
-# of the GNU General Public License along with this program.
-# If not, see <http://www.gnu.org/licenses/>.
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 __version__ = '4.0-' + '$Id$'[4:11]
 
@@ -22,11 +22,11 @@ import cgi, sys, os, re, errno, stat, glob
 
 image_ext = 'png|gif|jpg|jpeg|bmp|ico'
 video_ext = "ogg|ogv|oga" # Not supported by Firefox 3.5: mkv|mpg|mpeg|mp4|avi|asf|flv|wmv|qt
-image_re = re.compile(r".*\.(" + image_ext + "|" +  video_ext + ")", re.IGNORECASE)
-video_re = re.compile(r".*\.(" + video_ext + ")", re.IGNORECASE)
+image_re = re.compile(r".*\.(" + image_ext + "|" +  video_ext + ")$", re.IGNORECASE)
+video_re = re.compile(r".*\.(" + video_ext + ")$", re.IGNORECASE)
 # FIXME: we accept stuff like foo/../bar and we shouldn't
-file_re  = re.compile(r"([A-Za-z0-9_\-][A-Za-z0-9_\.\-/]*)")
-url_re   = re.compile(r"[a-z]{3,8}://[^\s'\"]+\S")
+file_re  = re.compile(r"([A-Za-z0-9_\-][A-Za-z0-9_\.\-/ ]*)$")
+url_re   = re.compile(r"[a-z]{3,8}://[^\s'\"]+\S$")
 ext_re   = re.compile(r"\.([^\./]+)$")
 
 # CGI stuff ---------------------------------------------------------
@@ -36,6 +36,7 @@ def config_get(key, default=None):
 def script_name():
     return os.environ.get('SCRIPT_NAME', '')
 
+#TODO: move post-edit hook into wiki, then kill this
 def script_path():
     return os.path.split(os.environ.get('SCRIPT_FILENAME', ''))[0]
 
@@ -46,8 +47,9 @@ def query_string():
     else:
         return os.environ.get('QUERY_STRING', '') or 'FrontPage'
 
-def privileged_path():
-    return config_get('privileged_url') or script_name()
+def is_privileged():
+    purl = config_get('privileged_url')
+    return (purl is not None) and os.environ.get('SCRIPT_URI', '').startswith(purl)
 
 def remote_user():
     user = os.environ.get('REMOTE_USER', '')
@@ -71,7 +73,7 @@ def is_external_url(pathname):
 def relative_url(pathname, privileged=False):
     if not is_external_url(pathname):
         if privileged:
-            url = privileged_path()
+            url = config_get('privileged_url') or script_name()
         else:
             url = script_name()
         pathname = url + '/' + pathname
@@ -118,92 +120,20 @@ def send_guru(msg_text, msg_type):
     print(cgi.escape(msg_text))
     if msg_type == 'error':
         print '\n           Guru Meditation #DEADBEEF.ABADC0DE'
-    print('</pre><script language="JavaScript" type="text/javascript" src="%s" defer="defer"></script>' \
+    print('</pre><script type="text/javascript" src="%s" defer="defer"></script>' \
         % relative_url('sys/GuruMeditation.js'))
 
-def send_title(name, text="Limbo", msg_text=None, msg_type='error', writable=False, mtime=None):
-    global title_done
-    if title_done: return
-
-    # Head
-    emit_header(mtime)
-    print('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"')
-    print('  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">')
-    print('<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">')
-
-    print("<head><title>%s: %s</title>" % (config_get('site_name', "Unconfigured Wiki"), text))
-    print(' <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" />')
-    if not name:
-        print(' <meta name="robots" content="noindex,nofollow" />')
-
-    for http_equiv, content in config_get('meta_urls', {}):
-        print(' <meta http-equiv="%s" content="%s" />' % (http_equiv, relative_url(content)))
-
-    for link in config_get('link_urls', {}):
-        rel, href = link
-        print(' <link rel="%s" href="%s" />' % (rel, relative_url(href)))
-
-    editable = name and writable and config_get('privileged_url') is not None
-    if editable:
-        print(' <link rel="alternate" type="application/x-wiki" title="Edit this page" href="%s" />' \
-            % relative_url('?a=edit&q=' + name, privileged=True))
-
-    history = config_get('history_url')
-    if history is not None:
-        print(' <link rel="alternate" type="application/rss+xml" title="RSS" href="%s" />' \
-            % relative_url(history + '?a=rss'))
-
-    print('</head>')
-
-    # Body
-    if editable:
-        print('<body ondblclick="location.href=\'' + relative_url('?a=edit&q=' + name, privileged=True) + '\'">')
-    else:
-        print('<body>')
-
-    title_done = True
-    send_guru(msg_text, msg_type)
-
-    # Navbar
-    print('<div class="nav">')
-    print link_tag('FrontPage', config_get('site_icon', 'Home'), cssclass='navlink')
-    if name:
-        print('  <b>' + link_tag('?fullsearch=' + name, text, cssclass='navlink') + '</b> ')
-    else:
-        print('  <b>' + text + '</b> ')
-    print(' | ' + link_tag('FindPage', 'Find Page', cssclass='navlink'))
-    if history:
-        print(' | <a href="' + relative_url(history) + '" class="navlink">Recent Changes</a>')
-        if name:
-            print(' | <a href="' + relative_url(history + '?a=history;f=' + name) + '" class="navlink">Page History</a>')
-
-    if name:
-        print(' | ' + link_tag(name + '?a=raw', 'Raw Text', cssclass='navlink'))
-        if config_get('privileged_url') is not None:
-            if writable:
-                print(' | ' + link_tag('?a=edit&q=' + name, 'Edit', cssclass='navlink', privileged=True))
-            else:
-                print(' | ' + link_tag(name, 'Login', cssclass='navlink', privileged=True))
-
-    else:
-        print(' | <i>Immutable Page</i>')
-
-    user = remote_user()
-    if user != 'AnonymousCoward':
-        print(' | <span class="login"><i><b>' + link_tag('User/' + user, user) + '</b></i></span>')
-
-    print('<hr /></div>')
-
 def send_httperror(status="403 Not Found", query=""):
     print("Status: %s" % status)
-    send_title(None, msg_text=("%s: on query '%s'" % (status, query)))
-    send_footer()
+    page = Page()
+    page.send_title(msg_text=("%s: on query '%s'" % (status, query)))
+    page.send_footer()
 
 def link_tag(dest, text=None, privileged=False, **kvargs):
     if text is None:
         text = humanlink(dest)
     elif image_re.match(text):
-        text = '<img border="0" src="' + relative_url(text) + '" alt="' + text + '" />'
+        text = '<img style="border: 0" src="' + relative_url(text) + '" alt="' + text + '" />'
 
     link_class = kvargs.get('class', kvargs.get('cssclass', None))
     if not link_class:
@@ -247,12 +177,12 @@ def link_inline_glob(pattern, descr=None, kvargs={}):
 
 # Search ---------------------------------------------------
 
-def print_search_stats(hits, searched):
-    print("<p>%d hits out of %d pages searched.</p>" % (hits, searched))
+def search_stats(hits, searched):
+    return("%d hits out of %d pages searched.\n" % (hits, searched))
 
 def handle_fullsearch(query, form):
     needle = form['q'].value
-    send_title(None, 'Full text search for "' + needle + '"')
+    Page().send_title(text='Full text search for "' + needle + '"')
 
     needle_re = re.compile(needle, re.IGNORECASE)
     hits = []
@@ -263,35 +193,31 @@ def handle_fullsearch(query, form):
         if count:
             hits.append((count, page_name))
 
-    # The default comparison for tuples compares elements in order,
-    # so this sorts by number of hits
+    # The default comparison for tuples compares elements in order, so this sorts by number of hits
     hits.sort()
     hits.reverse()
 
-    print("<ul>")
+    out = ''
     for (count, page_name) in hits:
-        print('<li><p>' + link_tag(page_name))
-        print(' . . . . ' + `count`)
-        print(['match', 'matches'][count != 1])
-        print('</p></li>')
-    print("</ul>")
+        out += ' * [[' + page_name + ']] . . . ' + str(count) + ' ' + ['match', 'matches'][count != 1] + '\n'
 
-    print_search_stats(len(hits), len(all_pages))
+    out += search_stats(len(hits), len(all_pages))
+    WikiFormatter(out).print_html()
 
 def handle_titlesearch(query, form):
     needle = form['q'].value
-    send_title(None, 'Title search for "' + needle + '"')
+    Page().send_title(text='Title search for "' + needle + '"')
 
     needle_re = re.compile(needle, re.IGNORECASE)
     all_pages = page_list()
     hits = list(filter(needle_re.search, all_pages))
 
-    print("<ul>")
+    out = ''
     for filename in hits:
-        print('<li><p>' + link_tag(filename) + "</p></li>")
-    print("</ul>")
+        out += ' * [[' + filename + ']]\n'
 
-    print_search_stats(len(hits), len(all_pages))
+    out += search_stats(len(hits), len(all_pages))
+    WikiFormatter(out).print_html()
 
 def handle_raw(pagename, form):
     if not file_re.match(pagename):
@@ -305,7 +231,7 @@ def handle_edit(pagename, form):
         send_httperror("403 Forbidden", pagename)
         return
 
-    pg = Page(form['q'].value)
+    pg  = Page(form['q'].value)
     if 'save' in form:
         if form['file'].value:
             pg.save(form['file'].file.read(), form['changelog'].value)
@@ -345,16 +271,6 @@ def page_list(dirname=None, search_re=None):
         search_re = re.compile(r"^\b((([A-Z][a-z0-9]+){2,}/)*([A-Z][a-z0-9]+){2,})\b$")
     return sorted(filter(search_re.match, os.listdir(dirname or '.')))
 
-def send_footer(mtime=None):
-    if config_get('debug_cgi', False):
-        cgi.print_arguments()
-        cgi.print_form(form)
-        cgi.print_environ()
-    link_inline("sys/footer", kvargs = {
-        'LAST_MODIFIED': strftime(config_get('datetime_fmt', '%a %d %b %Y %I:%M %p'), localtime(mtime))
-    })
-    print("</body></html>")
-
 def _macro_ELAPSED_TIME(*args, **kvargs):
     return "%03f" % (clock() - start_time)
 
@@ -362,11 +278,7 @@ def _macro_VERSION(*args, **kvargs):
     return __version__
 
 class WikiFormatter:
-    """Object that turns Wiki markup into HTML.
-
-    All formatting commands can be parsed one line at a time, though
-    some state is carried over between lines.
-    """
+    """Object that turns Wiki markup into HTML."""
     def __init__(self, raw, kvargs=None):
         self.raw = raw
         self.kvargs = kvargs or {}
@@ -386,7 +298,6 @@ class WikiFormatter:
             ",,":  ["sub", False],
             "''":  ["em",  False], # LEGACY
             "'''": ["b",   False], # LEGACY
-            "``":  ["tt",  False], # LEGACY
         }
 
     def _b_repl(self, word):
@@ -550,7 +461,7 @@ class WikiFormatter:
 
         scan_re = re.compile(r"""(?:
             # Styles and formatting ("--" must cling to a word to disambiguate it from the dash)
-              (?P<b>     \*\* | // | \#\# | __ | --\b | \b-- | \^\^ | ,, | ''' | '' | `` )
+              (?P<b>     \*\* | // | \#\# | __ | --\b | \b-- | \^\^ | ,, | ''' | '' )
             | (?P<tit>   \={2,6})
             | (?P<br>    \\\\)
             | (?P<rule>  ^-{3,})
@@ -558,8 +469,8 @@ class WikiFormatter:
             | (?P<glyph> --)
 
             # Links
-            | (?P<macro> \<\<([^\s\|\>]+)(?:\s*\|\s*([^\>]+)|)\>\>)
-            | (?P<hurl>  \[\[([^\s\|]+)(?:\s*\|\s*([^\]]+)|)\]\])
+            | (?P<macro> \<\<[^\>]+\>\>)
+            | (?P<hurl>  \[\[[^\]]+\]\])
 
             # Inline HTML
             | (?P<html>             <(br|hr|div|span|form|iframe|input|textarea|a|img|h[1-5])\b )
@@ -575,7 +486,7 @@ class WikiFormatter:
             # Lists, divs, spans and inline objects
             | (?P<li>    ^\s+[\*\#]\s+)
             | (?P<pre>   \{\{\{|\s*\}\}\})
-            | (?P<inl>   \{\{([^\s\|]+)(?:\s*\|\s*([^\]]+)|)\}\})
+            | (?P<inl>   \{\{[^\}]+\}\})
 
             # Tables
             | (?P<tr>    ^\s*\|\|(=|)\s*)
@@ -612,8 +523,8 @@ class WikiFormatter:
                     print('</p><p>')
                 else:
                     indent = indent_re.match(self.line)
-                    #3.0: print(self._indent_to(len(indent.group(0))), end=' ')
                     print(self._indent_to(len(indent.group(1)), indent.group(2)))
+                    # Stand back! Here we apply the monster regex that does all the parsing
                     print(re.sub(scan_re, self.replace, self.line))
 
         if self.in_pre: print('</pre>')
@@ -622,8 +533,8 @@ class WikiFormatter:
         print('</p></div>')
 
 class Page:
-    def __init__(self, page_name):
-        self.page_name = page_name
+    def __init__(self, page_name="Limbo"):
+        self.page_name = page_name.rstrip('/');
         self.msg_text = ''
         self.msg_type = 'error'
 
@@ -666,19 +577,20 @@ class Page:
         out = '== '
         pathname = ''
         for dirname in self.page_name.strip('/').split('/'):
-            pathname = (pathname + '/' + dirname) if pathname else dirname
+            pathname = (pathname and pathname + '/' ) + dirname
             out += '[[' + pathname + '|' + dirname + ']]/'
         out += ' ==\n'
+        images_out = '\n'
  
         for filename in page_list(self._filename(), file_re):
             if image_re.match(filename):
                 maxwidth = config_get('image_maxwidth', '400')
                 if maxwidth:
                     maxwidth = ' | maxwidth=' + str(maxwidth)
-                out += '{{' + self.page_name + '/' + filename + ' | ' + humanlink(filename) + maxwidth + ' | class=thumbleft}}\n'
+                images_out += '{{' + self.page_name + '/' + filename + ' | ' + humanlink(filename) + maxwidth + ' | class=thumbleft}}\n'
             else:
                 out += ' * [[' + self.page_name + '/' + filename + ']]\n'
-        return out
+        return out + images_out
 
     def pragmas(self):
         if not '_pragmas' in self.__dict__:
@@ -721,6 +633,92 @@ class Page:
     def can_read(self):
         return self.can("read", True)
 
+    def send_title(self, name=None, text="Limbo", msg_text=None, msg_type='error'):
+        global title_done
+        if title_done: return
+
+        # HEAD
+        emit_header(self._mtime())
+        print('<!doctype html>\n<html lang="en">')
+        print("<head><title>%s: %s</title>" % (config_get('site_name', "Unconfigured Wiki"), text))
+        print(' <meta charset="UTF-8">')
+        if not name:
+            print(' <meta name="robots" content="noindex,nofollow" />')
+
+        for http_equiv, content in config_get('meta_urls', {}):
+            print(' <meta http-equiv="%s" content="%s" />' % (http_equiv, relative_url(content)))
+
+        for link in config_get('link_urls', {}):
+            rel, href = link
+            print(' <link rel="%s" href="%s" />' % (rel, relative_url(href)))
+
+        editable = name and self.can_write() and is_privileged()
+        if editable:
+            print(' <link rel="alternate" type="application/x-wiki" title="Edit this page" href="%s" />' \
+                % relative_url('?a=edit&q=' + name, privileged=True))
+
+        history = config_get('history_url')
+        if history is not None:
+            print(' <link rel="alternate" type="application/rss+xml" title="RSS" href="%s" />' \
+                % relative_url(history + '?a=rss'))
+
+        print('</head>')
+
+        # BODY
+        if editable:
+            print('<body ondblclick="location.href=\'' + relative_url('?a=edit&q=' + name, privileged=True) + '\'">')
+        else:
+            print('<body>')
+
+        title_done = True
+        send_guru(msg_text, msg_type)
+
+        if self.pragma("navbar", "on") != "on":
+            return
+
+        # NAVBAR
+        print('<nav><div class="nav">')
+        print link_tag('FrontPage', config_get('site_icon', 'Home'), cssclass='navlink')
+        if name:
+            print('  <b>' + link_tag('?a=titlesearch&q=' + name, text, cssclass='navlink') + '</b> ')
+        else:
+            print('  <b>' + text + '</b> ')
+        print(' | ' + link_tag('FindPage', 'Find Page', cssclass='navlink'))
+        if history:
+            print(' | <a href="' + relative_url(history) + '" class="navlink">Recent Changes</a>')
+            if name:
+                print(' | <a href="' + relative_url(history + '?a=history;f=' + name) + '" class="navlink">Page History</a>')
+
+        if name:
+            print(' | ' + link_tag(name + '?a=raw', 'Raw Text', cssclass='navlink'))
+            if config_get('privileged_url') is not None:
+                if self.can_write():
+                    print(' | ' + link_tag('?a=edit&q=' + name, 'Edit', cssclass='navlink', privileged=True))
+                else:
+                    print(' | ' + link_tag(name, 'Login', cssclass='navlink', privileged=True))
+
+        else:
+            print(' | <i>Immutable Page</i>')
+
+        user = remote_user()
+        if user != 'AnonymousCoward':
+            print(' | <span class="login"><i><b>' + link_tag('User/' + user, user) + '</b></i></span>')
+
+        print('<hr /></div></nav>')
+
+
+    def send_footer(self):
+        if config_get('debug_cgi', False):
+            cgi.print_arguments()
+            cgi.print_form(form)
+            cgi.print_environ()
+        footer = self.pragma("footer", "sys/footer")
+        if footer != "off":
+            link_inline(footer, kvargs = {
+                'LAST_MODIFIED': strftime(config_get('datetime_fmt', '%a %d %b %Y %I:%M %p'), localtime(self._mtime()))
+            })
+        print("</body></html>")
+
     def send_naked(self, kvargs=None):
         if self.can_read():
             WikiFormatter(self.get_raw_body(), kvargs).print_html()
@@ -734,13 +732,12 @@ class Page:
             global link_urls
             link_urls += [ [ "stylesheet", value ] ]
 
-        send_title(self.page_name, self.split_title(),
-            msg_text=self.msg_text, msg_type=self.msg_type, writable=self.can_write(), mtime=self._mtime())
+        self.send_title(name=self.page_name, text=self.split_title(), msg_text=self.msg_text, msg_type=self.msg_type)
         self.send_naked()
-        send_footer(mtime=self._mtime())
+        self.send_footer()
 
     def send_editor(self, preview=None):
-        send_title(None, 'Edit ' + self.split_title(), msg_text=self.msg_text, msg_type=self.msg_type)
+        self.send_title(text='Edit ' + self.split_title(), msg_text=self.msg_text, msg_type=self.msg_type)
         if not self.can_write():
             send_guru("Write access denied by ACLs", "error")
             return
@@ -757,11 +754,11 @@ class Page:
             print("<div class='preview'>")
             WikiFormatter(preview).print_html()
             print("</div>")
-        send_footer()
+        self.send_footer()
 
     def send_raw(self, mimetype='text/plain', args=[]):
         if not self.can_read():
-            send_title(None, msg_text='Read access denied by ACLs', msg_type='notice', mtime=self._mtime())
+            self.send_title(msg_text='Read access denied by ACLs', msg_type='notice')
             return
 
         emit_header(self._mtime(), mimetype)
@@ -791,8 +788,10 @@ class Page:
 
     def save(self, newdata, changelog):
         if not self.can_write():
-            self.msg_text = 'Write access denied by ACLs'
-            self.msg_type = 'error'
+            self.msg_text = 'Write access denied by Access Control List'
+            return
+        if not is_privileged():
+            self.msg_text = 'Unauthenticated access denied'
             return
 
         self._write_file(newdata)
@@ -828,10 +827,11 @@ try:
 except Exception:
     import traceback
     msg_text = traceback.format_exc()
+    page = Page()
     if title_done:
         send_guru(msg_text, "error")
     else:
-        send_title(None, msg_text=msg_text)
-    send_footer()
+        page.send_title(msg_text=msg_text)
+    page.send_footer()
 
 sys.stdout.flush()