Full support for highlighting TODO, FIXME, DONE keywords.
[geekigeeki.git] / geekigeeki.py
index ec64ca9f42d41eebedeaf7e7f385b77429be360a..57992d288b93eb1774a2a82ce051dba49cfea5ab 100755 (executable)
@@ -19,7 +19,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-__version__ = '$Revision: 1.63+gerry+bernie $'[11:-2];
+__version__ = '$Revision: 1.63+gerry+bernie $'[11:-2]
 
 import cgi, sys, string, os, re, errno, time, stat
 from os import path, environ
@@ -43,7 +43,10 @@ def privileged_path():
     return privileged_url or script_name()
 
 def remote_user():
-    return environ.get('REMOTE_USER', 'AnonymousCoward')
+    user = environ.get('REMOTE_USER', '')
+    if user is None or user == '' or user == 'anonymous':
+        user = 'AnonymousCoward'
+    return user
 
 def remote_host():
     return environ.get('REMOTE_ADDR', '')
@@ -53,7 +56,7 @@ def get_hostname(addr):
         from socket import gethostbyaddr
         return gethostbyaddr(addr)[0] + ' (' + addr + ')'
     except:
-        return addr;
+        return addr
 
 # Formatting stuff --------------------------------------------------
 
@@ -62,7 +65,7 @@ def emit_header(type="text/html"):
     print
 
 def send_guru(msg, msg_type):
-    if msg is None or len(msg) == 0: return
+    if msg is None or msg == '': return
     print '<pre id="guru" onclick="this.style.display = \'none\'" class="' + msg_type + '">'
     if msg_type == 'error':
         print '    Software Failure.  Press left mouse button to continue.\n'
@@ -104,7 +107,7 @@ def send_title(name, text="Limbo", msg=None, msg_type='error'):
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 """
     print "<head><title>%s: %s</title>" % (site_name, text)
-    print ' <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'
+    print ' <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" />'
     if not name:
         print ' <meta name="robots" content="noindex,nofollow" />'
     if css_url:
@@ -117,10 +120,11 @@ def send_title(name, text="Limbo", msg=None, msg_type='error'):
     else:
         print '<body>'
 
+    title_done = True
     send_guru(msg, msg_type)
 
     # Navbar
-    print '<div class="navigator">'
+    print '<div class="nav">'
     print '  <b>' + site_name + ': ',
     if name:
         print link_tag('?fullsearch=' + name, text) + '</b> '
@@ -128,10 +132,10 @@ def send_title(name, text="Limbo", msg=None, msg_type='error'):
         print text + '</b> '
     print ' | ' + link_tag('FrontPage', 'Front Page', 'navlink')
     print ' | ' + link_tag('FindPage', 'Find Page', 'navlink')
-    print ' | <a href="/wikigit/wiki.git" class="navlink">Recent Changes</a>'
+    print ' | <a href="' + history_url + '" class="navlink">Recent Changes</a>'
 
     if name:
-        print ' | <a href="/wikigit/wiki.git?a=history;f=' + name + '" class="navlink">Page History</a>'
+        print ' | <a href="' + history_url + '?a=history;f=' + name + '" class="navlink">Page History</a>'
         print ' | ' + link_tag('?raw=' + name, 'Raw Text', 'navlink')
         if privileged_url is not None:
             print ' | ' + link_tag('?edit=' + name, 'Edit Page', 'navlink', authentication=True)
@@ -140,11 +144,9 @@ def send_title(name, text="Limbo", msg=None, msg_type='error'):
 
     user = remote_user()
     if user != 'AnonymousCoward':
-        print ' | <i>logged in as <b>' + cgi.escape(user) + '</b></i>'
-
-    print '</div>'
+        print ' | <span class="login"><i>logged in as <b>' + cgi.escape(user) + '</b></i></span>'
 
-    title_done = True
+    print '<hr /></div>'
 
 def link_tag(params, text=None, ss_class=None, authentication=False):
     if text is None:
@@ -253,9 +255,10 @@ def send_footer(name, mod_string=None):
         cgi.print_arguments()
         cgi.print_form(cgi.FieldStorage())
         cgi.print_environ()
-    print '<div class="footer">'
+    print '<div id="footer"><hr />'
+    print '<p class="copyright">Powered by <a href="http://www.codewiz.org/wiki/GeekiGeeki">GeekiGeeki</a></p>'
     if mod_string:
-        print "last modified %s" % mod_string
+        print '<p class="modified">last modified %s</p>' % mod_string
     print '</div></body></html>'
 
 
@@ -335,14 +338,16 @@ class PageFormatter:
         self.is_em = self.is_b = 0
         self.h_level = 0
         self.list_indents = []
-        self.in_pre = 0
-        self.in_var = 0
+        self.in_pre = False
+        self.in_table = False
+        self.tr_cnt = 0
+        self.in_var = False
         self.in_header = True
 
     def _emph_repl(self, word):
         if len(word) == 3:
             self.is_b = not self.is_b
-            return ['</b>', '<b>'][self.is_b]
+            return ['</strong>', '<strong>'][self.is_b]
         else:
             self.is_em = not self.is_em
             return ['</em>', '<em>'][self.is_em]
@@ -354,7 +359,7 @@ class PageFormatter:
         else:
             self.h_level = len(word) - 1
             result = "<h%d>" % self.h_level
-        return result;
+        return result
 
     def _rule_repl(self, word):
         s = self._undent()
@@ -405,23 +410,50 @@ class PageFormatter:
 
     def _pre_repl(self, word):
         if word == '{{{' and not self.in_pre:
-            self.in_pre = 1
+            self.in_pre = True
             return '<pre>'
         elif self.in_pre:
-            self.in_pre = 0
+            self.in_pre = False
             return '</pre>'
-        else:
-            return ''
+        return ''
+
+    def _hi_repl(self, word):
+        if word == 'FIXME':
+            cl = 'error'
+        elif word == 'DONE':
+            cl = 'success'
+        elif word == 'TODO':
+            cl = 'notice'
+        return '<strong class="highlight ' + cl + '">' + word + '</strong>'
 
     def _var_repl(self, word):
         if word == '{{' and not self.in_var:
-            self.in_var = 1
+            self.in_var = True
             return '<code>'
         elif self.in_var:
-            self.in_var = 0
+            self.in_var = False
             return '</code>'
-        else:
-            return ''
+        return ''
+
+    def _tr_repl(self, word):
+        out = ''
+        if not self.in_table:
+            self.in_table = True
+            self.tr_cnt = 0
+            out = '</p><table><tbody>\n'
+        self.tr_cnt += 1
+        return out + '<tr class="' + ['even', 'odd'][self.tr_cnt % 2] + '"><td>'
+
+    def _tre_repl(self, word):
+        if self.in_table:
+            return '</td></tr>'
+        return ''
+
+    def _td_repl(self, word):
+        if self.in_table:
+            return '</td><td>'
+        return ''
+
     def _macro_repl(self, word):
         macro_name = word[2:-2]
         # TODO: Somehow get the default value into the search field
@@ -462,29 +494,44 @@ class PageFormatter:
 
         # For each line, we scan through looking for magic
         # strings, outputting verbatim any intervening text
+        # TODO: highlight search words (look at referer)
         scan_re = re.compile(
             r"(?:"
+            # Formatting
             + r"(?P<emph>'{2,3})"
             + r"|(?P<tit>\={2,6})"
+            + r"|(?P<rule>^-{3,})"
             + r"|(?P<ent>[<>&])"
+            + r"|(?P<hi>\b(FIXME|TODO|DONE)\b)"
+
+            # Links
             + r"|(?P<img>\b[a-zA-Z0-9_-]+\.(png|gif|jpg|jpeg|bmp))"
             + r"|(?P<word>\b(?:[A-Z][a-z]+){2,}\b)"
-            + r"|(?P<rule>^-{3,})"
             + r"|(?P<hurl>\[\[\S+\s+.+\]\])"
             + r"|(?P<url>(http|ftp|nntp|news|mailto)\:[^\s'\"]+\S)"
             + r"|(?P<email>[-\w._+]+\@[\w.-]+)"
+
+            # Lists, divs, spans
             + r"|(?P<li>^\s+\*)"
             + r"|(?P<pre>(\{\{\{|\s*\}\}\}))"
             + r"|(?P<var>(\{\{|\}\}))"
+
+            # Tables
+            + r"|(?P<tr>^\s*\|\|\s*)"
+            + r"|(?P<tre>\s*\|\|\s*$)"
+            + r"|(?P<td>\s*\|\|\s*)"
+
+            # Macros
             + r"|(?P<macro>\[\[(TitleSearch|FullSearch|WordIndex|TitleIndex)\]\])"
             + r")")
         pre_re = re.compile(
             r"(?:"
             + r"(?P<pre>\s*\}\}\})"
             + r")")
-        blank_re = re.compile("^\s*$")
-        indent_re = re.compile("^\s*")
-        eol_re = re.compile(r'\r?\n')
+        blank_re = re.compile(r"^\s*$")
+        indent_re = re.compile(r"^\s*")
+        tr_re = re.compile(r"^\s*\|\|")
+        eol_re = re.compile(r"\r?\n")
         raw = string.expandtabs(self.raw)
         for line in eol_re.split(raw):
             # Skip ACLs
@@ -492,17 +539,23 @@ class PageFormatter:
                 if line.startswith('#'):
                    continue
                 self.in_header = False
+
             if self.in_pre:
                 print re.sub(pre_re, self.replace, line)
             else:
-                # XXX: Should we check these conditions in this order?
+                if self.in_table and not tr_re.match(line):
+                    self.in_table = False
+                    print '</tbody></table><p>'
+
                 if blank_re.match(line):
                     print '</p><p>'
-                    continue
-                indent = indent_re.match(line)
-                print self._indent_to(len(indent.group(0)))
-                print re.sub(scan_re, self.replace, line)
+                else:
+                    indent = indent_re.match(line)
+                    print self._indent_to(len(indent.group(0)))
+                    print re.sub(scan_re, self.replace, line)
+
         if self.in_pre: print '</pre>'
+        if self.in_table: print '</tbody></table><p>'
         print self._undent()
         print "</p></div>"
 
@@ -685,6 +738,7 @@ try:
     data_dir = '/home/bernie/public_html/wiki'
     text_dir = path.join(data_dir, 'text')
     css_url = '../wikidata/geekigeeki.css'  # optional stylesheet link
+    history_url = '../wikigit/wiki.git'
     post_edit_hook = './post_edit_hook.sh'
     datetime_fmt = '%a %d %b %Y %I:%M %p'
     allow_edit = True                       # Is it possible to edit pages?