First pass of pylint warning removal
[geekigeeki.git] / geekigeeki.py
index 84f1db5f3a0305e5f9ef8a39ca101335b75356f6..b34f152188b0544747471a796258d521f9eb0aba 100755 (executable)
@@ -23,7 +23,7 @@ __version__ = '$Id$'[4:12]
 from time import clock
 start_time = clock()
 
-import cgi, sys, string, os, re, errno, stat
+import cgi, sys, os, re, errno, stat
 from os import path, environ
 
 # Regular expression defining a WikiWord
@@ -57,34 +57,33 @@ def get_hostname(addr):
     try:
         from socket import gethostbyaddr
         return gethostbyaddr(addr)[0] + ' (' + addr + ')'
-    except:
+    except Exception, er:
         return addr
 
-def relative_url(path, privileged=False):
-    if not (url_re.match(path) or path.startswith('/')):
+def relative_url(pathname, privileged=False):
+    if not (url_re.match(pathname) or pathname.startswith('/')):
         if privileged:
             url = privileged_path()
         else:
             url = script_name()
-        path = url + '/' + path
-    return path
+        pathname = url + '/' + pathname
+    return pathname
 
 # Formatting stuff --------------------------------------------------
 
-def emit_header(type="text/html"):
-    print "Content-type: " + type + "; charset=utf-8"
-    print
+def emit_header(mime_type="text/html"):
+    print "Content-type: " + mime_type + "; charset=utf-8\n"
 
-def send_guru(msg, msg_type):
-    if msg is None or msg == '': return
+def send_guru(msg_text, msg_type):
+    if not msg_text: 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'
-    print msg
+    print msg_text
     if msg_type == 'error':
         print '      Guru Meditation #DEADBEEF.ABADC0DE'
     print '</pre>'
-    # FIXME: This simple JS snippet is harder to pass than ACID 3.0 
+    # FIXME: This little JS snippet is harder to pass than ACID 3.0 
     print """
     <script language="JavaScript" type="text/javascript">
         var guru = document.getElementById('guru');
@@ -107,7 +106,7 @@ def send_guru(msg, msg_type):
         }
     </script>"""
 
-def send_title(name, text="Limbo", msg=None, msg_type='error'):
+def send_title(name, text="Limbo", msg_text=None, msg_type='error'):
     global title_done
     if title_done: return
 
@@ -133,7 +132,7 @@ def send_title(name, text="Limbo", msg=None, msg_type='error'):
         print '<body>'
 
     title_done = True
-    send_guru(msg, msg_type)
+    send_guru(msg_text, msg_type)
 
     # Navbar
     print '<div class="nav">'
@@ -222,15 +221,10 @@ def do_titlesearch(needle):
 def print_search_stats(hits, searched):
     print "<p>%d hits out of %d pages searched.</p>" % (hits, searched)
 
-#TODO: merge into do_savepage()
-def do_edit(pagename):
-    Page(pagename).send_editor()
-
 def do_raw(pagename):
     Page(pagename).send_raw()
 
-def do_savepage(pagename):
-    global form
+def do_edit(pagename):
     pg = Page(pagename)
     if 'preview' in form:
         pg.send_editor(form['savetext'].value)
@@ -238,19 +232,15 @@ def do_savepage(pagename):
         pg.save_text(form['savetext'].value)
         pg.send_page()
     elif 'cancel' in form:
-        pg.msg = 'Editing canceled'
+        pg.msg_text = 'Editing canceled'
         pg.msg_type = 'notice'
         pg.send_page()
     else:
-        raise 'What did you press?'
+        pg.send_editor()
 
 def make_index_key():
-    s = '<p><center>'
-    links = map(lambda ch: '<a href="#%s">%s</a>' % (ch, ch),
-                string.lowercase)
-    s = s + string.join(links, ' | ')
-    s = s + '</center></p>'
-    return s
+    links = map(lambda ch: '<a href="#%s">%s</a>' % (ch, ch), 'abcdefghijklmnopqrstuvwxyz')
+    return '<p><center>'+ ' | '.join(links) + '</center></p>'
 
 def page_list():
     return filter(word_re.match, os.listdir(data_dir))
@@ -260,7 +250,6 @@ def send_footer(name, mod_string=None):
         cgi.print_arguments()
         cgi.print_form(cgi.FieldStorage())
         cgi.print_environ()
-    global __version__
     print '<div id="footer"><hr />'
     print ('<p class="copyright"><span class="benchmark">generated in %0.3fs</span>' +
         ' by <a href="http://www.codewiz.org/wiki/GeekiGeeki">GeekiGeeki</a>' +
@@ -301,7 +290,7 @@ def _macro_WordIndex(*vargs):
     last_letter = None
     # set title
     for word in all_words:
-        letter = string.lower(word[0])
+        letter = word[0].lower()
         if letter != last_letter:
             s = s + '; <a name="%s"><h3>%s</h3></a>' % (letter, letter)
             last_letter = letter
@@ -323,13 +312,13 @@ def _macro_TitleIndex(*vargs):
     pages.sort()
     current_letter = None
     for name in pages:
-        letter = string.lower(name[0])
+        letter = name[0].lower()
         if letter != current_letter:
-            s = s + '<a name="%s"><h3>%s</h3></a>' % (letter, letter)
+            s += '<a name="%s"><h3>%s</h3></a>' % (letter, letter)
             current_letter = letter
         else:
-            s = s + '<br />'
-        s = s + Page(name).link_to()
+            s += '<br />'
+        s += Page(name).link_to()
     return s
 
 
@@ -363,7 +352,7 @@ class PageFormatter:
     def _b_repl(self, word):
         style = self.styles[word]
         style[1] = not style[1]
-        return ['</','<'][style[1]] + style[0] + '>'
+        return ['</', '<'][style[1]] + style[0] + '>'
 
     def _tit_repl(self, word):
         if self.h_level:
@@ -437,13 +426,7 @@ class PageFormatter:
         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>'
+        return '<strong class="highlight ' + word + '">' + word + '</strong>'
 
     def _tr_repl(self, word):
         out = ''
@@ -500,7 +483,7 @@ class PageFormatter:
 
         # For each line, we scan through looking for magic
         # strings, outputting verbatim any intervening text
-        # TODO: highlight search words (look at referer)
+        # TODO: highlight search words (look at referrer)
         scan_re = re.compile(
             r"(?:"
             # Formatting
@@ -531,17 +514,17 @@ class PageFormatter:
         pre_re = re.compile(
             r"(?:"
             + r"(?P<pre>\s*\}\}\})"
+            + r"|(?P<ent>[<>&])"
             + r")")
         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):
+        for line in eol_re.split(self.raw.expandtabs()):
             # Skip ACLs
             if self.in_header:
                 if line.startswith('#'):
-                   continue
+                    continue
                 self.in_header = False
 
             if self.in_pre:
@@ -567,19 +550,18 @@ class PageFormatter:
 class Page:
     def __init__(self, page_name):
         self.page_name = page_name
-        self.msg = ''
+        self.msg_text = ''
         self.msg_type = 'error'
 
     def split_title(self):
-        # look for the end of words and the start of a new word,
-        # and insert a space there
+        # look for the end of words and the start of a new word and insert a space there
         return re.sub('([a-z])([A-Z])', r'\1 \2', self.page_name)
 
     def _text_filename(self):
         return path.join(data_dir, self.page_name)
 
     def _tmp_filename(self):
-        return path.join(data_dir, ('#' + self.page_name + '.' + `os.getpid()` + '#'))
+        return path.join(data_dir, ('#' + self.page_name.replace('/','_') + '.' + `os.getpid()` + '#'))
 
     def exists(self):
         try:
@@ -588,8 +570,7 @@ class Page:
         except OSError, er:
             if er.errno == errno.ENOENT:
                 return False
-            else:
-                raise er
+            raise er
 
     def link_to(self):
         word = self.page_name
@@ -600,10 +581,12 @@ class Page:
 
     def get_raw_body(self):
         try:
-            return open(self._text_filename(), 'rt').read()
+            return open(self._text_filename(), 'rb').read()
         except IOError, er:
             if er.errno == errno.ENOENT:
                 return '' # just doesn't exist, use default
+            if er.errno == errno.EISDIR:
+                return 'DIR'
             raise er
 
     def get_attrs(self):
@@ -625,22 +608,16 @@ class Page:
         return self.attrs
 
     def get_attr(self, name, default):
-        if self.get_attrs().has_key(name):
-            return self.get_attrs()[name]
-        else:
-            return default
+        return self.get_attrs().get(name, default)
 
     def can(self, action, default=True):
         try:
             #acl SomeUser:read,write All:read
             acl = self.get_attr("acl", None)
             for rule in acl.split():
-                (user,perms) = rule.split(':')
+                (user, perms) = rule.split(':')
                 if user == remote_user() or user == "All":
-                    if action in perms.split(','):
-                        return True
-                    else:
-                        return False
+                    return action in perms.split(',')
             return False
         except Exception, er:
             pass
@@ -657,12 +634,11 @@ class Page:
         if self.can_write():
             page_name = self.page_name
 
-        #FIXME: are there security implications?
         #css foo.css bar.css
         global css_url
-        css_url = css_url + self.get_attr("css", "").split()
+        css_url = self.get_attr("css", "").split() + css_url
 
-        send_title(page_name, self.split_title(), msg=self.msg, msg_type=self.msg_type)
+        send_title(page_name, self.split_title(), msg_text=self.msg_text, msg_type=self.msg_type)
         if self.can_read():
             PageFormatter(self.get_raw_body()).print_html()
         else:
@@ -680,7 +656,7 @@ class Page:
         return strftime(datetime_fmt, modtime)
 
     def send_editor(self, preview=None):
-        send_title(None, 'Edit ' + self.split_title(), msg=self.msg, msg_type=self.msg_type)
+        send_title(None, '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
@@ -690,7 +666,7 @@ class Page:
             + ' from ' + cgi.escape(get_hostname(remote_host()))
             + '</b></p>')
         print '<div class="editor"><form method="post" action="%s">' % relative_url(self.page_name)
-        print '<input type="hidden" name="savepage" value="%s">' % (self.page_name)
+        print '<input type="hidden" name="edit" value="%s">' % (self.page_name)
         print """<textarea wrap="off" spellcheck="true" id="editor" name="savetext" rows="17" cols="100">%s</textarea>""" % (preview or self.get_raw_body())
         print """
             <br />
@@ -707,12 +683,13 @@ class Page:
             print "</div>"
         send_footer(self.page_name)
 
-    def send_raw(self):
-        if not self.can_read():
-            send_title(None, msg='Read access denied by ACLs', msg_type='notice')
-            return
-        emit_header("text/plain")
-        print self.get_raw_body()
+    def send_raw(self, mimetype='text/plain'):
+        if self.can_read():
+            body = self.get_raw_body()
+            emit_header(mimetype)
+            print body
+        else:
+            send_title(None, msg_text='Read access denied by ACLs', msg_type='notice')
 
     def _write_file(self, text):
         tmp_filename = self._tmp_filename()
@@ -728,7 +705,7 @@ class Page:
 
     def save_text(self, newtext):
         if not self.can_write():
-            self.msg = 'Write access denied by ACLs'
+            self.msg_text = 'Write access denied by ACLs'
             self.msg_type = 'error'
             return
 
@@ -742,35 +719,27 @@ class Page:
                 + "' '" + remote_host() + "'"
             )
             out = os.popen(cmd)
-            msg = out.read()
+            output = out.read()
             rc = out.close()
         if rc:
-            self.msg += "Post-editing hook returned %d.\n" % rc
-            self.msg += 'Command was: ' + cmd + '\n'
-            if msg:
-                self.msg += 'Output follows:\n' + msg
+            self.msg_text += "Post-editing hook returned %d.\n" % rc
+            self.msg_text += 'Command was: ' + cmd + '\n'
+            if output:
+                self.msg_text += 'Output follows:\n' + output
         else:
-            self.msg = 'Thank you for your contribution.  Your attention to detail is appreciated.'
+            self.msg_text = 'Thank you for your contribution.  Your attention to detail is appreciated.'
             self.msg_type = 'success'
 
-#TODO: merge into send_raw()
-def send_verbatim(filename, mime_type='application/octet-stream'):
-    pathname = path.join(data_dir, filename)
-    data = open(pathname, 'rb').read()
-    emit_header(mime_type)
-    sys.stdout.write(data)
-
 # Main ---------------------------------------------------------------
 try:
     execfile("geekigeeki.conf.py")
-
     form = cgi.FieldStorage()
-
-    handlers = { 'fullsearch':  do_fullsearch,
-                 'titlesearch': do_titlesearch,
-                 'edit':        do_edit,
-                 'raw':         do_raw,
-                 'savepage':    do_savepage }
+    handlers = {
+        'fullsearch':  do_fullsearch,
+        'titlesearch': do_titlesearch,
+        'edit':        do_edit,
+        'raw':         do_raw,
+    }
 
     for cmd in handlers.keys():
         if form.has_key(cmd):
@@ -788,19 +757,19 @@ try:
                 Page(query).send_page()
             elif img_re.match(query):
                 #FIXME: use correct mime type
-                send_verbatim(query, 'image/jpeg')
+                Page(query).send_raw(mimetype='image/jpeg')
             else:
-                send_verbatim(query)
+                Page(query).send_raw(mimetype='application/octet-stream')
         else:
             print "Status: 404 Not Found"
-            send_title(None, msg='Can\'t work out query: ' + query)
-except:
+            send_title(None, msg_text='Can\'t work out query: ' + query)
+except Exception:
     import traceback
-    msg=traceback.format_exc()
+    msg_text = traceback.format_exc()
     if title_done:
-        send_guru(msg, "error")
+        send_guru(msg_text, "error")
     else:
-        send_title(None, msg=msg)
+        send_title(None, msg_text=msg_text)
     send_footer(None)
 
 sys.stdout.flush()