"""Common code for listing files from a bup repository."""
-import stat
-from bup import options, vfs
-from helpers import *
+from __future__ import absolute_import
+from binascii import hexlify
+from itertools import chain
+from stat import S_ISDIR, S_ISLNK
+import copy, locale, os.path, stat, sys
-def node_name(text, n, show_hash):
- """Add symbols to a node's name to differentiate file types."""
- prefix = ''
+from bup import metadata, options, vfs, xstat
+from bup.compat import argv_bytes
+from bup.io import path_msg
+from bup.options import Options
+from bup.repo import LocalRepo, RemoteRepo
+from bup.helpers import columnate, istty1, last, log
+
+def item_hash(item, tree_for_commit):
+ """If the item is a Commit, return its commit oid, otherwise return
+ the item's oid, if it has one.
+
+ """
+ if tree_for_commit and isinstance(item, vfs.Commit):
+ return item.coid
+ return getattr(item, 'oid', None)
+
+def item_info(item, name,
+ show_hash = False,
+ commit_hash=False,
+ long_fmt = False,
+ classification = None,
+ numeric_ids = False,
+ human_readable = False):
+ """Return bytes containing the information to display for the VFS
+ item. Classification may be "all", "type", or None.
+
+ """
+ result = b''
if show_hash:
- prefix += "%s " % n.hash.encode('hex')
- if stat.S_ISDIR(n.mode):
- return '%s%s/' % (prefix, text)
- elif stat.S_ISLNK(n.mode):
- return '%s%s@' % (prefix, text)
+ oid = item_hash(item, commit_hash)
+ result += b'%s ' % (hexlify(oid) if oid
+ else b'0000000000000000000000000000000000000000')
+ if long_fmt:
+ meta = item.meta.copy()
+ meta.path = name
+ # FIXME: need some way to track fake vs real meta items?
+ result += metadata.summary_bytes(meta,
+ numeric_ids=numeric_ids,
+ classification=classification,
+ human_readable=human_readable)
else:
- return '%s%s' % (prefix, text)
+ result += name
+ if classification:
+ cls = xstat.classification_str(vfs.item_mode(item),
+ classification == 'all')
+ result += cls.encode('iso-8859-1')
+ return result
optspec = """
-%sls [-a] [path...]
+bup ls [-r host:path] [-l] [-d] [-F] [-a] [-A] [-s] [-n] [path...]
--
+r,remote= remote repository path
s,hash show hash for each file
+commit-hash show commit hash instead of tree for commits (implies -s)
a,all show hidden files
+A,almost-all show hidden files except . and ..
+l use a detailed, long listing format
+d,directory show directories, not contents; don't follow symlinks
+F,classify append type indicator: dir/ sym@ fifo| sock= exec*
+file-type append type indicator: dir/ sym@ fifo| sock=
+human-readable print human readable file sizes (i.e. 3.9K, 4.7M)
+n,numeric-ids list numeric IDs (user, group, etc.) rather than names
"""
-def do_ls(args, pwd, default='.', onabort=None, spec_prefix=''):
- """Output a listing of a file or directory in the bup repository.
+def opts_from_cmdline(args, onabort=None):
+ """Parse ls command line arguments and return a dictionary of ls
+ options, agumented with "classification", "long_listing",
+ "paths", and "show_hidden".
- When stdout is attached to a tty, the output is formatted in columns. When
- not attached to tty (for example when the output is piped to another
- command), one file is listed per line.
"""
if onabort:
- o = options.Options(optspec % spec_prefix, onabort=onabort)
+ opt, flags, extra = Options(optspec, onabort=onabort).parse(args)
else:
- o = options.Options(optspec % spec_prefix)
- (opt, flags, extra) = o.parse(args)
+ opt, flags, extra = Options(optspec).parse(args)
+
+ opt.paths = [argv_bytes(x) for x in extra] or (b'/',)
+ opt.long_listing = opt.l
+ opt.classification = None
+ opt.show_hidden = None
+ for flag in flags:
+ option, parameter = flag
+ if option in ('-F', '--classify'):
+ opt.classification = 'all'
+ elif option == '--file-type':
+ opt.classification = 'type'
+ elif option in ('-a', '--all'):
+ opt.show_hidden = 'all'
+ elif option in ('-A', '--almost-all'):
+ opt.show_hidden = 'almost'
+ return opt
+
+def within_repo(repo, opt, out):
- L = []
+ if opt.commit_hash:
+ opt.hash = True
+
+ def item_line(item, name):
+ return item_info(item, name,
+ show_hash=opt.hash,
+ commit_hash=opt.commit_hash,
+ long_fmt=opt.long_listing,
+ classification=opt.classification,
+ numeric_ids=opt.numeric_ids,
+ human_readable=opt.human_readable)
ret = 0
- for path in (extra or [default]):
+ pending = []
+ for path in opt.paths:
try:
- n = pwd.try_resolve(path)
-
- if stat.S_ISDIR(n.mode):
- for sub in n:
- name = sub.name
- if opt.all or not len(name)>1 or not name.startswith('.'):
- if istty1:
- L.append(node_name(name, sub, opt.hash))
- else:
- print node_name(name, sub, opt.hash)
+ if opt.directory:
+ resolved = vfs.resolve(repo, path, follow=False)
+ else:
+ resolved = vfs.try_resolve(repo, path)
+
+ leaf_name, leaf_item = resolved[-1]
+ if not leaf_item:
+ log('error: cannot access %r in %r\n'
+ % ('/'.join(path_msg(name) for name, item in resolved),
+ path_msg(path)))
+ ret = 1
+ continue
+ if not opt.directory and S_ISDIR(vfs.item_mode(leaf_item)):
+ items = vfs.contents(repo, leaf_item)
+ if opt.show_hidden == 'all':
+ # Match non-bup "ls -a ... /".
+ parent = resolved[-2] if len(resolved) > 1 else resolved[0]
+ items = chain(items, ((b'..', parent[1]),))
+ for sub_name, sub_item in sorted(items, key=lambda x: x[0]):
+ if opt.show_hidden != 'all' and sub_name == b'.':
+ continue
+ if sub_name.startswith(b'.') and \
+ opt.show_hidden not in ('almost', 'all'):
+ continue
+ if opt.l:
+ sub_item = vfs.ensure_item_has_metadata(repo, sub_item,
+ include_size=True)
+ else:
+ sub_item = vfs.augment_item_meta(repo, sub_item,
+ include_size=True)
+ line = item_line(sub_item, sub_name)
+ if not opt.long_listing and istty1:
+ pending.append(line)
+ else:
+ out.write(line)
+ out.write(b'\n')
else:
- if istty1:
- L.append(node_name(path, n, opt.hash))
+ leaf_item = vfs.augment_item_meta(repo, leaf_item,
+ include_size=True)
+ line = item_line(leaf_item, os.path.normpath(path))
+ if not opt.long_listing and istty1:
+ pending.append(line)
else:
- print node_name(path, n, opt.hash)
- except vfs.NodeError, e:
- log('error: %s\n' % e)
+ out.write(line)
+ out.write(b'\n')
+ except vfs.IOError as ex:
+ log('bup: %s\n' % ex)
ret = 1
- if istty1:
- sys.stdout.write(columnate(L, ''))
+ if pending:
+ out.write(columnate(pending, b''))
return ret
+
+def via_cmdline(args, out=None, onabort=None):
+ """Write a listing of a file or directory in the bup repository to out.
+
+ When a long listing is not requested and stdout is attached to a
+ tty, the output is formatted in columns. When not attached to tty
+ (for example when the output is piped to another command), one
+ file is listed per line.
+
+ """
+ assert out
+ opt = opts_from_cmdline(args, onabort=onabort)
+ repo = RemoteRepo(argv_bytes(opt.remote)) if opt.remote else LocalRepo()
+ return within_repo(repo, opt, out)
projects / bup.git / blobdiff