hgwebdir: split out makeindex function, facilitate test failure diagnosis

mercurial/hgweb/hgwebdir_mod.py

@@ -1,262 +1,261 b''
 # hgweb/hgwebdir_mod.py - Web interface for a directory of repositories.
 #
 # Copyright 21 May 2005 - (c) 2005 Jake Edge <[e-mail]>
 # Copyright 2005, 2006 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms
 # of the GNU General Public License, incorporated herein by reference.
 
 import os, mimetools, cStringIO
 from mercurial.i18n import gettext as _
 from mercurial import ui, hg, util, templater
 from common import ErrorResponse, get_mtime, staticfile, style_map, paritygen
 from hgweb_mod import hgweb
 from request import wsgirequest
 
 # This is a stopgap
 class hgwebdir(object):
     def __init__(self, config, parentui=None):
         def cleannames(items):
             return [(util.pconvert(name).strip('/'), path)
                     for name, path in items]
 
-        self.parentui = parentui
+        self.parentui = parentui or ui.ui(report_untrusted=False,
+                                          interactive = False)
         self.motd = None
         self.style = None
         self.stripecount = None
         self.repos_sorted = ('name', False)
         if isinstance(config, (list, tuple)):
             self.repos = cleannames(config)
             self.repos_sorted = ('', False)
         elif isinstance(config, dict):
             self.repos = cleannames(config.items())
             self.repos.sort()
         else:
             if isinstance(config, util.configparser):
                 cp = config
             else:
                 cp = util.configparser()
                 cp.read(config)
             self.repos = []
             if cp.has_section('web'):
                 if cp.has_option('web', 'motd'):
                     self.motd = cp.get('web', 'motd')
                 if cp.has_option('web', 'style'):
                     self.style = cp.get('web', 'style')
                 if cp.has_option('web', 'stripes'):
                     self.stripecount = int(cp.get('web', 'stripes'))
             if cp.has_section('paths'):
                 self.repos.extend(cleannames(cp.items('paths')))
             if cp.has_section('collections'):
                 for prefix, root in cp.items('collections'):
                     for path in util.walkrepos(root):
                         repo = os.path.normpath(path)
                         name = repo
                         if name.startswith(prefix):
                             name = name[len(prefix):]
                         self.repos.append((name.lstrip(os.sep), repo))
             self.repos.sort()
 
     def run(self):
         if not os.environ.get('GATEWAY_INTERFACE', '').startswith("CGI/1."):
             raise RuntimeError("This function is only intended to be called while running as a CGI script.")
         import mercurial.hgweb.wsgicgi as wsgicgi
         wsgicgi.launch(self)
 
     def __call__(self, env, respond):
         req = wsgirequest(env, respond)
         self.run_wsgi(req)
         return req
 
     def run_wsgi(self, req):
         def header(**map):
             header_file = cStringIO.StringIO(
                 ''.join(tmpl("header", encoding=util._encoding, **map)))
             msg = mimetools.Message(header_file, 0)
             req.header(msg.items())
             yield header_file.read()
 
         def footer(**map):
             yield tmpl("footer", **map)
 
         def motd(**map):
             if self.motd is not None:
                 yield self.motd
             else:
                 yield config('web', 'motd', '')
 
-        parentui = self.parentui or ui.ui(report_untrusted=False,
-                                          interactive=False)
-
         def config(section, name, default=None, untrusted=True):
-            return parentui.config(section, name, default, untrusted)
+            return self.parentui.config(section, name, default, untrusted)
 
         url = req.env.get('SCRIPT_NAME', '')
         if not url.endswith('/'):
             url += '/'
 
         staticurl = config('web', 'staticurl') or url + 'static/'
         if not staticurl.endswith('/'):
             staticurl += '/'
 
         style = self.style
         if style is None:
             style = config('web', 'style', '')
         if req.form.has_key('style'):
             style = req.form['style'][0]
         if self.stripecount is None:
             self.stripecount = int(config('web', 'stripes', 1))
         mapfile = style_map(templater.templatepath(), style)
         tmpl = templater.templater(mapfile, templater.common_filters,
                                    defaults={"header": header,
                                              "footer": footer,
                                              "motd": motd,
                                              "url": url,
                                              "staticurl": staticurl})
 
+        try:
+            try:
+                virtual = req.env.get("PATH_INFO", "").strip('/')
+                if virtual.startswith('static/'):
+                    static = os.path.join(templater.templatepath(), 'static')
+                    fname = virtual[7:]
+                    req.write(staticfile(static, fname, req))
+                elif virtual:
+                    repos = dict(self.repos)
+                    while virtual:
+                        real = repos.get(virtual)
+                        if real:
+                            req.env['REPO_NAME'] = virtual
+                            try:
+                                repo = hg.repository(self.parentui, real)
+                                hgweb(repo).run_wsgi(req)
+                                return
+                            except IOError, inst:
+                                raise ErrorResponse(500, inst.strerror)
+                            except hg.RepoError, inst:
+                                raise ErrorResponse(500, str(inst))
+
+                        # browse subdirectories
+                        subdir = virtual + '/'
+                        if [r for r in repos if r.startswith(subdir)]:
+                            self.makeindex(req, tmpl, subdir)
+                            return
+
+                        up = virtual.rfind('/')
+                        if up < 0:
+                            break
+                        virtual = virtual[:up]
+
+                    req.respond(404, tmpl("notfound", repo=virtual))
+                else:
+                    if req.form.has_key('static'):
+                        static = os.path.join(templater.templatepath(), "static")
+                        fname = req.form['static'][0]
+                        req.write(staticfile(static, fname, req))
+                    else:
+                        self.makeindex(req, tmpl)
+            except ErrorResponse, err:
+                req.respond(err.code, tmpl('error', error=err.message or ''))
+        finally:
+            tmpl = None
+
+    def makeindex(self, req, tmpl, subdir=""):
+
         def archivelist(ui, nodeid, url):
             allowed = ui.configlist("web", "allow_archive", untrusted=True)
             for i in [('zip', '.zip'), ('gz', '.tar.gz'), ('bz2', '.tar.bz2')]:
                 if i[0] in allowed or ui.configbool("web", "allow" + i[0],
                                                     untrusted=True):
                     yield {"type" : i[0], "extension": i[1],
                            "node": nodeid, "url": url}
 
         def entries(sortcolumn="", descending=False, subdir="", **map):
             def sessionvars(**map):
                 fields = []
                 if req.form.has_key('style'):
                     style = req.form['style'][0]
                     if style != get('web', 'style', ''):
                         fields.append(('style', style))
 
                 separator = url[-1] == '?' and ';' or '?'
                 for name, value in fields:
                     yield dict(name=name, value=value, separator=separator)
                     separator = ';'
 
             rows = []
             parity = paritygen(self.stripecount)
             for name, path in self.repos:
                 if not name.startswith(subdir):
                     continue
                 name = name[len(subdir):]
 
-                u = ui.ui(parentui=parentui)
+                u = ui.ui(parentui=self.parentui)
                 try:
                     u.readconfig(os.path.join(path, '.hg', 'hgrc'))
                 except Exception, e:
                     u.warn(_('error reading %s/.hg/hgrc: %s\n' % (path, e)))
                     continue
                 def get(section, name, default=None):
                     return u.config(section, name, default, untrusted=True)
 
                 if u.configbool("web", "hidden", untrusted=True):
                     continue
 
                 parts = [req.env['PATH_INFO'], name]
                 if req.env['SCRIPT_NAME']:
                 	parts.insert(0, req.env['SCRIPT_NAME'])
                 url = ('/'.join(parts).replace("//", "/")) + '/'
 
                 # update time with local timezone
                 try:
                     d = (get_mtime(path), util.makedate()[1])
                 except OSError:
                     continue
 
                 contact = (get("ui", "username") or # preferred
                            get("web", "contact") or # deprecated
                            get("web", "author", "")) # also
                 description = get("web", "description", "")
                 name = get("web", "name", name)
                 row = dict(contact=contact or "unknown",
                            contact_sort=contact.upper() or "unknown",
                            name=name,
                            name_sort=name,
                            url=url,
                            description=description or "unknown",
                            description_sort=description.upper() or "unknown",
                            lastchange=d,
                            lastchange_sort=d[1]-d[0],
                            sessionvars=sessionvars,
                            archives=archivelist(u, "tip", url))
                 if (not sortcolumn
                     or (sortcolumn, descending) == self.repos_sorted):
                     # fast path for unsorted output
                     row['parity'] = parity.next()
                     yield row
                 else:
                     rows.append((row["%s_sort" % sortcolumn], row))
             if rows:
                 rows.sort()
                 if descending:
                     rows.reverse()
                 for key, row in rows:
                     row['parity'] = parity.next()
                     yield row
 
-        def makeindex(req, subdir=""):
-            sortable = ["name", "description", "contact", "lastchange"]
-            sortcolumn, descending = self.repos_sorted
-            if req.form.has_key('sort'):
-                sortcolumn = req.form['sort'][0]
-                descending = sortcolumn.startswith('-')
-                if descending:
-                    sortcolumn = sortcolumn[1:]
-                if sortcolumn not in sortable:
-                    sortcolumn = ""
-
-            sort = [("sort_%s" % column,
-                     "%s%s" % ((not descending and column == sortcolumn)
-                               and "-" or "", column))
-                    for column in sortable]
-            req.write(tmpl("index", entries=entries, subdir=subdir,
-                           sortcolumn=sortcolumn, descending=descending,
-                           **dict(sort)))
+        sortable = ["name", "description", "contact", "lastchange"]
+        sortcolumn, descending = self.repos_sorted
+        if req.form.has_key('sort'):
+            sortcolumn = req.form['sort'][0]
+            descending = sortcolumn.startswith('-')
+            if descending:
+                sortcolumn = sortcolumn[1:]
+            if sortcolumn not in sortable:
+                sortcolumn = ""
 
-        try:
-            try:
-                virtual = req.env.get("PATH_INFO", "").strip('/')
-                if virtual.startswith('static/'):
-                    static = os.path.join(templater.templatepath(), 'static')
-                    fname = virtual[7:]
-                    req.write(staticfile(static, fname, req))
-                elif virtual:
-                    repos = dict(self.repos)
-                    while virtual:
-                        real = repos.get(virtual)
-                        if real:
-                            req.env['REPO_NAME'] = virtual
-                            try:
-                                repo = hg.repository(parentui, real)
-                                hgweb(repo).run_wsgi(req)
-                                return
-                            except IOError, inst:
-                                raise ErrorResponse(500, inst.strerror)
-                            except hg.RepoError, inst:
-                                raise ErrorResponse(500, str(inst))
-
-                        # browse subdirectories
-                        subdir = virtual + '/'
-                        if [r for r in repos if r.startswith(subdir)]:
-                            makeindex(req, subdir)
-                            return
-
-                        up = virtual.rfind('/')
-                        if up < 0:
-                            break
-                        virtual = virtual[:up]
-
-                    req.respond(404, tmpl("notfound", repo=virtual))
-                else:
-                    if req.form.has_key('static'):
-                        static = os.path.join(templater.templatepath(), "static")
-                        fname = req.form['static'][0]
-                        req.write(staticfile(static, fname, req))
-                    else:
-                        makeindex(req)
-            except ErrorResponse, err:
-                req.respond(err.code, tmpl('error', error=err.message or ''))
-        finally:
-            tmpl = None
+        sort = [("sort_%s" % column,
+                 "%s%s" % ((not descending and column == sortcolumn)
+                            and "-" or "", column))
+                for column in sortable]
+        req.write(tmpl("index", entries=entries, subdir=subdir,
+                       sortcolumn=sortcolumn, descending=descending,
+                       **dict(sort)))

tests/test-hgwebdir

@@ -1,77 +1,84 b''
 #!/bin/sh
 # Tests some basic hgwebdir functionality. Tests setting up paths and
 # collection, different forms of 404s and the subdirectory support.
 
 mkdir webdir
 cd webdir
 
 hg init a
 echo a > a/a
 hg --cwd a ci -Ama -d'1 0'
 
 hg init b
 echo b > b/b
 hg --cwd b ci -Amb -d'2 0'
 
 hg init c
 echo c > c/c
 hg --cwd c ci -Amc -d'3 0'
 root=`pwd`
 
 cd ..
 
 cat > paths.conf <<EOF
 [paths]
 a=$root/a
 b=$root/b
 EOF
 
 hg serve -p $HGPORT -d --pid-file=hg.pid --webdir-conf paths.conf \
-    -A access-paths.log -E error-paths.log
+    -A access-paths.log -E error-paths-1.log
 cat hg.pid >> $DAEMON_PIDS
 
 echo % should give a 404 - file does not exist
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT '/a/file/tip/bork?style=raw'
 
 echo % should succeed
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT '/?style=raw'
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT '/a/file/tip/a?style=raw'
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT '/b/file/tip/b?style=raw'
 
 echo % should give a 404 - repo is not published
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT '/c/file/tip/c?style=raw'
 
 cat > paths.conf <<EOF
 [paths]
 t/a/=$root/a
 b=$root/b
 EOF
 
 hg serve -p $HGPORT1 -d --pid-file=hg.pid --webdir-conf paths.conf \
-    -A access-paths.log -E error-paths.log
+    -A access-paths.log -E error-paths-2.log
 cat hg.pid >> $DAEMON_PIDS
 
 echo % should succeed, slashy names
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT1 '/?style=raw'
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT1 '/t?style=raw'
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT1 '/t/?style=raw'
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT1 '/t/a?style=atom' \
 	| sed "s/http:\/\/[^/]*\//http:\/\/127.0.0.1\//"
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT1 '/t/a/?style=atom' \
 	| sed "s/http:\/\/[^/]*\//http:\/\/127.0.0.1\//"
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT1 '/t/a/file/tip/a?style=raw'
 
 cat > collections.conf <<EOF
 [collections]
 $root=$root
 EOF
 
 hg serve -p $HGPORT2 -d --pid-file=hg.pid --webdir-conf collections.conf \
     -A access-collections.log -E error-collections.log
 cat hg.pid >> $DAEMON_PIDS
 
 echo % should succeed
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT2 '/?style=raw'
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT2 '/a/file/tip/a?style=raw'
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT2 '/b/file/tip/b?style=raw'
 "$TESTDIR/get-with-headers.py" localhost:$HGPORT2 '/c/file/tip/c?style=raw'
+
+echo % paths errors 1
+cat error-paths-1.log
+echo % paths errors 2
+cat error-paths-2.log
+echo % collections errors
+cat error-collections.log

tests/test-hgwebdir.out

@@ -1,121 +1,124 b''
 adding a
 adding b
 adding c
 % should give a 404 - file does not exist
 404 Not Found
 
 
 error: Path not found: bork/
 % should succeed
 200 Script output follows
 
 
 /a/
 /b/
 
 200 Script output follows
 
 a
 200 Script output follows
 
 b
 % should give a 404 - repo is not published
 404 Not Found
 
 
 error: repository c not found
 % should succeed, slashy names
 200 Script output follows
 
 
 /b/
 /t/a/
 
 200 Script output follows
 
 
 /t/a/
 
 200 Script output follows
 
 
 /t/a/
 
 200 Script output follows
 
 <?xml version="1.0" encoding="ascii"?>
 <feed xmlns="http://127.0.0.1/2005/Atom">
  <!-- Changelog -->
  <id>http://127.0.0.1/t/a/</id>
  <link rel="self" href="http://127.0.0.1/t/a/atom-log"/>
  <link rel="alternate" href="http://127.0.0.1/t/a/"/>
  <title>t/a Changelog</title>
  <updated>1970-01-01T00:00:01+00:00</updated>
 
  <entry>
   <title>a</title>
   <id>http://127.0.0.1/mercurial/#changeset-8580ff50825a50c8f716709acdf8de0deddcd6ab</id>
   <link href="http://127.0.0.1/t/a/rev/8580ff50825a50c8f716709acdf8de0deddcd6ab"/>
   <author>
    <name>test</name>
    <email>&#116;&#101;&#115;&#116;</email>
   </author>
   <updated>1970-01-01T00:00:01+00:00</updated>
   <published>1970-01-01T00:00:01+00:00</published>
   <content type="xhtml">
    <div xmlns="http://127.0.0.1/1999/xhtml">
     <pre xml:space="preserve">a</pre>
    </div>
   </content>
  </entry>
 
 </feed>
 200 Script output follows
 
 <?xml version="1.0" encoding="ascii"?>
 <feed xmlns="http://127.0.0.1/2005/Atom">
  <!-- Changelog -->
  <id>http://127.0.0.1/t/a/</id>
  <link rel="self" href="http://127.0.0.1/t/a/atom-log"/>
  <link rel="alternate" href="http://127.0.0.1/t/a/"/>
  <title>t/a Changelog</title>
  <updated>1970-01-01T00:00:01+00:00</updated>
 
  <entry>
   <title>a</title>
   <id>http://127.0.0.1/mercurial/#changeset-8580ff50825a50c8f716709acdf8de0deddcd6ab</id>
   <link href="http://127.0.0.1/t/a/rev/8580ff50825a50c8f716709acdf8de0deddcd6ab"/>
   <author>
    <name>test</name>
    <email>&#116;&#101;&#115;&#116;</email>
   </author>
   <updated>1970-01-01T00:00:01+00:00</updated>
   <published>1970-01-01T00:00:01+00:00</published>
   <content type="xhtml">
    <div xmlns="http://127.0.0.1/1999/xhtml">
     <pre xml:space="preserve">a</pre>
    </div>
   </content>
  </entry>
 
 </feed>
 200 Script output follows
 
 a
 % should succeed
 200 Script output follows
 
 
 /a/
 /b/
 /c/
 
 200 Script output follows
 
 a
 200 Script output follows
 
 b
 200 Script output follows
 
 c
+% paths errors 1
+% paths errors 2
+% collections errors