X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=cmd%2Fweb-cmd.py;h=eeb9107d3e93e19e98c2c1bb61a7cf68d571d82b;hb=6b6559e405d264d4127211b935b21a3dda93ad93;hp=29523158ee0882065ceeb39322423781dabedb80;hpb=98805befbcccd27869d9f5f70132a3e847477d75;p=bup.git
diff --git a/cmd/web-cmd.py b/cmd/web-cmd.py
index 2952315..eeb9107 100755
--- a/cmd/web-cmd.py
+++ b/cmd/web-cmd.py
@@ -1,137 +1,195 @@
-#!/usr/bin/env python
-import sys, stat, cgi, shutil, urllib, mimetypes, posixpath
-import BaseHTTPServer
+#!/bin/sh
+"""": # -*-python-*-
+bup_python="$(dirname "$0")/bup-python" || exit $?
+exec "$bup_python" "$0" ${1+"$@"}
+"""
+# end of bup preamble
+
+from __future__ import absolute_import, print_function
+from collections import namedtuple
+import mimetypes, os, posixpath, signal, stat, sys, time, urllib, webbrowser
+
from bup import options, git, vfs
-from bup.helpers import *
+from bup.helpers import (chunkyreader, debug1, format_filesize, handle_ctrl_c,
+ log, saved_errors)
+from bup.metadata import Metadata
+from bup.path import resource_path
+from bup.repo import LocalRepo
+
try:
- from cStringIO import StringIO
+ from tornado import gen
+ from tornado.httpserver import HTTPServer
+ from tornado.ioloop import IOLoop
+ from tornado.netutil import bind_unix_socket
+ import tornado.web
except ImportError:
- from StringIO import StringIO
+ log('error: cannot find the python "tornado" module; please install it\n')
+ sys.exit(1)
+
+
+# FIXME: right now the way hidden files are handled causes every
+# directory to be traversed twice.
handle_ctrl_c()
-class BupHTTPServer(BaseHTTPServer.HTTPServer):
- def handle_error(self, request, client_address):
- # If we get a KeyboardInterrupt error than just reraise it
- # so that we cause the server to exit.
- if sys.exc_info()[0] == KeyboardInterrupt:
- raise
-class BupRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):
- server_version = 'BupHTTP/%s' % version_tag()
- protocol_version = 'HTTP/1.1'
- def do_GET(self):
- self._process_request()
+def http_date_from_utc_ns(utc_ns):
+ return time.strftime('%a, %d %b %Y %H:%M:%S', time.gmtime(utc_ns / 10**9))
- def do_HEAD(self):
- self._process_request()
- def _process_request(self):
- """Common code for GET and HEAD commands.
+def _compute_breadcrumbs(path, show_hidden=False):
+ """Returns a list of breadcrumb objects for a path."""
+ breadcrumbs = []
+ breadcrumbs.append(('[root]', '/'))
+ path_parts = path.split('/')[1:-1]
+ full_path = '/'
+ for part in path_parts:
+ full_path += part + "/"
+ url_append = ""
+ if show_hidden:
+ url_append = '?hidden=1'
+ breadcrumbs.append((part, full_path+url_append))
+ return breadcrumbs
- This sends the response code and MIME headers along with the content
- of the response.
- """
- path = urllib.unquote(self.path)
- try:
- n = top.resolve(path)
- except vfs.NoSuchFile:
+
+def _contains_hidden_files(repo, dir_item):
+ """Return true if the directory contains items with names other than
+ '.' and '..' that begin with '.'
+
+ """
+ for name, item in vfs.contents(repo, dir_item, want_meta=False):
+ if name in ('.', '..'):
+ continue
+ if name.startswith('.'):
+ return True
+ return False
+
+
+def _dir_contents(repo, resolution, show_hidden=False):
+ """Yield the display information for the contents of dir_item."""
+
+ url_query = '?hidden=1' if show_hidden else ''
+
+ def display_info(name, item, resolved_item, display_name=None):
+ # link should be based on fully resolved type to avoid extra
+ # HTTP redirect.
+ if stat.S_ISDIR(vfs.item_mode(resolved_item)):
+ link = urllib.quote(name) + '/'
+ else:
+ link = urllib.quote(name)
+
+ size = vfs.item_size(repo, item)
+ if opt.human_readable:
+ display_size = format_filesize(size)
+ else:
+ display_size = size
+
+ if not display_name:
+ mode = vfs.item_mode(item)
+ if stat.S_ISDIR(mode):
+ display_name = name + '/'
+ elif stat.S_ISLNK(mode):
+ display_name = name + '@'
+ else:
+ display_name = name
+
+ return display_name, link + url_query, display_size
+
+ dir_item = resolution[-1][1]
+ for name, item in vfs.contents(repo, dir_item):
+ if not show_hidden:
+ if (name not in ('.', '..')) and name.startswith('.'):
+ continue
+ if name == '.':
+ yield display_info(name, item, item, '.')
+ parent_item = resolution[-2][1] if len(resolution) > 1 else dir_item
+ yield display_info('..', parent_item, parent_item, '..')
+ continue
+ res = vfs.try_resolve(repo, name, parent=resolution, want_meta=False)
+ res_name, res_item = res[-1]
+ yield display_info(name, item, res_item)
+
+
+class BupRequestHandler(tornado.web.RequestHandler):
+
+ def initialize(self, repo=None):
+ self.repo = repo
+
+ def decode_argument(self, value, name=None):
+ if name == 'path':
+ return value
+ return super(BupRequestHandler, self).decode_argument(value, name)
+
+ def get(self, path):
+ return self._process_request(path)
+
+ def head(self, path):
+ return self._process_request(path)
+
+ def _process_request(self, path):
+ path = urllib.unquote(path)
+ print('Handling request for %s' % path)
+ # Set want_meta because dir metadata won't be fetched, and if
+ # it's not a dir, then we're going to want the metadata.
+ res = vfs.resolve(self.repo, path, want_meta=True)
+ leaf_name, leaf_item = res[-1]
+ if not leaf_item:
self.send_error(404)
return
- f = None
- if stat.S_ISDIR(n.mode):
- self._list_directory(path, n)
+ mode = vfs.item_mode(leaf_item)
+ if stat.S_ISDIR(mode):
+ self._list_directory(path, res)
else:
- self._get_file(path, n)
+ self._get_file(self.repo, path, res)
- def _list_directory(self, path, n):
+ def _list_directory(self, path, resolution):
"""Helper to produce a directory listing.
Return value is either a file object, or None (indicating an
error). In either case, the headers are sent.
"""
- if not path.endswith('/'):
- # redirect browser - doing basically what apache does
- self.send_response(301)
- self.send_header("Location", path + "/")
- self.send_header("Content-Length", 0)
- self.end_headers()
- return
+ if not path.endswith('/') and len(path) > 0:
+ print('Redirecting from %s to %s' % (path, path + '/'))
+ return self.redirect(path + '/', permanent=True)
- # Note that it is necessary to buffer the output into a StringIO here
- # so that we can compute the content length before we send the
- # content. The only other option would be to do chunked encoding, or
- # not support content length.
- f = StringIO()
- displaypath = cgi.escape(path)
- f.write("""
-
-
- Directory listing for %(displaypath)s
-
-
-
- Directory listing for %(displaypath)s
-
-
- | Name |
- Size |
- |
-""" % { 'displaypath': displaypath })
- for sub in n:
- displayname = linkname = sub.name
- # Append / for directories or @ for symbolic links
- size = str(sub.size())
- if stat.S_ISDIR(sub.mode):
- displayname = sub.name + "/"
- linkname = sub.name + "/"
- size = ' '
- if stat.S_ISLNK(sub.mode):
- displayname = sub.name + "@"
- # Note: a link to a directory displays with @ and links with /
- size = ' '
- f.write("""
- | %s |
- %s |
-
""" % (urllib.quote(linkname), cgi.escape(displayname), size))
- f.write("""
-
-
-""")
- length = f.tell()
- f.seek(0)
- self.send_response(200)
- self.send_header("Content-type", "text/html")
- self.send_header("Content-Length", str(length))
- self.end_headers()
- self._send_content(f)
- f.close()
-
- def _get_file(self, path, n):
+ hidden_arg = self.request.arguments.get('hidden', [0])[-1]
+ try:
+ show_hidden = int(hidden_arg)
+ except ValueError as e:
+ show_hidden = False
+
+ self.render(
+ 'list-directory.html',
+ path=path,
+ breadcrumbs=_compute_breadcrumbs(path, show_hidden),
+ files_hidden=_contains_hidden_files(self.repo, resolution[-1][1]),
+ hidden_shown=show_hidden,
+ dir_contents=_dir_contents(self.repo, resolution,
+ show_hidden=show_hidden))
+
+ @gen.coroutine
+ def _get_file(self, repo, path, resolved):
"""Process a request on a file.
Return value is either a file object, or None (indicating an error).
In either case, the headers are sent.
"""
+ file_item = resolved[-1][1]
+ file_item = vfs.augment_item_meta(repo, file_item, include_size=True)
+ meta = file_item.meta
ctype = self._guess_type(path)
- f = n.open()
- self.send_response(200)
- self.send_header("Content-type", ctype)
- self.send_header("Content-Length", str(n.size()))
- self.send_header("Last-Modified", self.date_time_string(n.mtime))
- self.end_headers()
- self._send_content(f)
- f.close()
-
- def _send_content(self, f):
- """Send the content file as the response if necessary."""
- if self.command != 'HEAD':
- for blob in chunkyreader(f):
- self.wfile.write(blob)
+ self.set_header("Last-Modified", http_date_from_utc_ns(meta.mtime))
+ self.set_header("Content-Type", ctype)
+
+ self.set_header("Content-Length", str(meta.size))
+ assert len(file_item.oid) == 20
+ self.set_header("Etag", file_item.oid.encode('hex'))
+ if self.request.method != 'HEAD':
+ with vfs.fopen(self.repo, file_item) as f:
+ it = chunkyreader(f)
+ for blob in chunkyreader(f):
+ self.write(blob)
+ raise gen.Return()
def _guess_type(self, path):
"""Guess the type of a file.
@@ -166,31 +224,93 @@ class BupRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):
})
+io_loop = None
+
+def handle_sigterm(signum, frame):
+ global io_loop
+ debug1('\nbup-web: signal %d received\n' % signum)
+ log('Shutdown requested\n')
+ if not io_loop:
+ sys.exit(0)
+ io_loop.stop()
+
+
+signal.signal(signal.SIGTERM, handle_sigterm)
+
+UnixAddress = namedtuple('UnixAddress', ['path'])
+InetAddress = namedtuple('InetAddress', ['host', 'port'])
+
optspec = """
bup web [[hostname]:port]
+bup web unix://path
--
+human-readable display human readable file sizes (i.e. 3.9K, 4.7M)
+browser show repository in default browser (incompatible with unix://)
"""
-o = options.Options('bup web', optspec)
+o = options.Options(optspec)
(opt, flags, extra) = o.parse(sys.argv[1:])
if len(extra) > 1:
o.fatal("at most one argument expected")
-address = ('127.0.0.1', 8080)
-if len(extra) > 0:
- addressl = extra[0].split(':', 1)
- addressl[1] = int(addressl[1])
- address = tuple(addressl)
+if len(extra) == 0:
+ address = InetAddress(host='127.0.0.1', port=8080)
+else:
+ bind_url = extra[0]
+ if bind_url.startswith('unix://'):
+ address = UnixAddress(path=bind_url[len('unix://'):])
+ else:
+ addr_parts = extra[0].split(':', 1)
+ if len(addr_parts) == 1:
+ host = '127.0.0.1'
+ port = addr_parts[0]
+ else:
+ host, port = addr_parts
+ try:
+ port = int(port)
+ except (TypeError, ValueError) as ex:
+ o.fatal('port must be an integer, not %r', port)
+ address = InetAddress(host=host, port=port)
git.check_repo_or_die()
-top = vfs.RefList(None)
-try:
- httpd = BupHTTPServer(address, BupRequestHandler)
-except socket.error, e:
- log('socket%r: %s\n' % (address, e.args[1]))
+settings = dict(
+ debug = 1,
+ template_path = resource_path('web'),
+ static_path = resource_path('web/static')
+)
+
+# Disable buffering on stdout, for debug messages
+sys.stdout = os.fdopen(sys.stdout.fileno(), 'w', 0)
+
+application = tornado.web.Application([
+ (r"(?P/.*)", BupRequestHandler, dict(repo=LocalRepo())),
+], **settings)
+
+http_server = HTTPServer(application)
+io_loop_pending = IOLoop.instance()
+
+if isinstance(address, InetAddress):
+ http_server.listen(address.port, address.host)
+ try:
+ sock = http_server._socket # tornado < 2.0
+ except AttributeError as e:
+ sock = http_server._sockets.values()[0]
+ print('Serving HTTP on %s:%d...' % sock.getsockname())
+ if opt.browser:
+ browser_addr = 'http://' + address[0] + ':' + str(address[1])
+ io_loop_pending.add_callback(lambda : webbrowser.open(browser_addr))
+elif isinstance(address, UnixAddress):
+ unix_socket = bind_unix_socket(address.path)
+ http_server.add_socket(unix_socket)
+ print('Serving HTTP on filesystem socket %r' % address.path)
+else:
+ log('error: unexpected address %r', address)
sys.exit(1)
-sa = httpd.socket.getsockname()
-log("Serving HTTP on %s:%d...\n" % sa)
-httpd.serve_forever()
+io_loop = io_loop_pending
+io_loop.start()
+
+if saved_errors:
+ log('WARNING: %d errors encountered while saving.\n' % len(saved_errors))
+ sys.exit(1)