X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=cmd%2Fweb-cmd.py;h=810af2d069e610e8a8c054a9c7fd2391016f8c6e;hb=c40b3dd5fd74e72024fbaad3daf5a958aefa1c54;hp=4bcc5480dac13eecfed75bc5f6b4ff50c92f36c7;hpb=9fce16ff68357c6b41bed94c5be2ed985dccb9d7;p=bup.git diff --git a/cmd/web-cmd.py b/cmd/web-cmd.py index 4bcc548..810af2d 100755 --- a/cmd/web-cmd.py +++ b/cmd/web-cmd.py @@ -1,124 +1,194 @@ -#!/usr/bin/env python -import sys, stat, urllib, mimetypes, posixpath, time -import tornado.httpserver -import tornado.ioloop -import tornado.web +#!/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, resource_path, saved_errors) +from bup.metadata import Metadata +from bup.repo import LocalRepo + +try: + 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: + 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() -def _compute_breadcrumbs(path): +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 _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 + '/' - breadcrumbs.append((part, full_path)) + full_path += part + "/" + url_append = "" + if show_hidden: + url_append = '?hidden=1' + breadcrumbs.append((part, full_path+url_append)) return breadcrumbs -def _contains_hidden_files(n): - """Return True if n contains files starting with a '.', False otherwise.""" - for sub in n: - name = sub.name - if len(name)>1 and name.startswith('.'): - return True +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 _compute_dir_contents(n, show_hidden=False): - """Given a vfs node, returns an iterator for display info of all subs.""" - for sub in n: - display = link = sub.name +def _dir_contents(repo, resolution, show_hidden=False): + """Yield the display information for the contents of dir_item.""" - if not show_hidden and len(display)>1 and display.startswith('.'): - continue + 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(sub.try_resolve().mode): - link = sub.name + "/" - - size = None - if stat.S_ISDIR(sub.mode): - display = sub.name + '/' - elif stat.S_ISLNK(sub.mode): - display = sub.name + '@' + if stat.S_ISDIR(vfs.item_mode(resolved_item)): + link = urllib.quote(name) + '/' else: - size = sub.size() + link = urllib.quote(name) - yield (display, link, size) + 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 - try: - n = top.resolve(path) - except vfs.NoSuchFile: + 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('/') and len(path) > 0: - print 'Redirecting from %s to %s' % (path, path + '/') + print('Redirecting from %s to %s' % (path, path + '/')) return self.redirect(path + '/', permanent=True) + hidden_arg = self.request.arguments.get('hidden', [0])[-1] try: - show_hidden = int(self.request.arguments.get('hidden', [0])[-1]) - except ValueError, e: + show_hidden = int(hidden_arg) + except ValueError as e: show_hidden = False self.render( 'list-directory.html', path=path, - breadcrumbs=_compute_breadcrumbs(path), - files_hidden=_contains_hidden_files(n), + breadcrumbs=_compute_breadcrumbs(path, show_hidden), + files_hidden=_contains_hidden_files(self.repo, resolution[-1][1]), hidden_shown=show_hidden, - dir_contents=_compute_dir_contents(n, show_hidden), - # We need the standard url_escape so we don't escape / - url_escape=urllib.quote) + dir_contents=_dir_contents(self.repo, resolution, + show_hidden=show_hidden)) - def _get_file(self, path, n): + @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) - - self.set_header("Last-Modified", self.date_time_string(n.mtime)) + self.set_header("Last-Modified", http_date_from_utc_ns(meta.mtime)) self.set_header("Content-Type", ctype) - size = n.size() - self.set_header("Content-Length", str(size)) - + + 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': - f = n.open() - for blob in chunkyreader(f): - self.write(blob) - f.close() + 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. @@ -152,28 +222,56 @@ class BupRequestHandler(tornado.web.RequestHandler): '.h': 'text/plain', }) - def date_time_string(self, t): - return time.strftime('%a, %d %b %Y %H:%M:%S', time.gmtime(t)) +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) settings = dict( debug = 1, @@ -185,14 +283,33 @@ settings = dict( sys.stdout = os.fdopen(sys.stdout.fileno(), 'w', 0) application = tornado.web.Application([ - (r"(/.*)", BupRequestHandler), + (r"(?P/.*)", BupRequestHandler, dict(repo=LocalRepo())), ], **settings) -if __name__ == "__main__": - http_server = tornado.httpserver.HTTPServer(application) - http_server.listen(address[1], address=address[0]) - - print "Serving HTTP on %s:%d..." % http_server._socket.getsockname() - loop = tornado.ioloop.IOLoop.instance() - loop.start() - +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) + +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)