#!python -u
#
# dulwich - Simple command-line interface to Dulwich
# Copyright (C) 2008-2011 Jelmer Vernooij <jelmer@jelmer.uk>
# vim: expandtab
#
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as public by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
"""Simple command-line interface to Dulwich>
This is a very simple command-line wrapper for Dulwich. It is by
no means intended to be a full-blown Git command-line interface but just
a way to test Dulwich.
"""
import os
import sys
from getopt import getopt
import optparse
import signal
def signal_int(signal, frame):
sys.exit(1)
def signal_quit(signal, frame):
import pdb
pdb.set_trace()
if 'DULWICH_PDB' in os.environ:
signal.signal(signal.SIGQUIT, signal_quit)
signal.signal(signal.SIGINT, signal_int)
from dulwich import porcelain
from dulwich.client import get_transport_and_path
from dulwich.errors import ApplyDeltaError
from dulwich.index import Index
from dulwich.pack import Pack, sha_to_hex
from dulwich.patch import write_tree_diff
from dulwich.repo import Repo
class Command(object):
"""A Dulwich subcommand."""
def run(self, args):
"""Run the command."""
raise NotImplementedError(self.run)
class cmd_archive(Command):
def run(self, args):
parser = optparse.OptionParser()
parser.add_option("--remote", type=str,
help="Retrieve archive from specified remote repo")
options, args = parser.parse_args(args)
committish = args.pop(0)
if options.remote:
client, path = get_transport_and_path(options.remote)
client.archive(path, committish, sys.stdout.write,
write_error=sys.stderr.write)
else:
porcelain.archive('.', committish, outstream=sys.stdout,
errstream=sys.stderr)
class cmd_add(Command):
def run(self, args):
opts, args = getopt(args, "", [])
porcelain.add(".", paths=args)
class cmd_rm(Command):
def run(self, args):
opts, args = getopt(args, "", [])
porcelain.rm(".", paths=args)
class cmd_fetch_pack(Command):
def run(self, args):
opts, args = getopt(args, "", ["all"])
opts = dict(opts)
client, path = get_transport_and_path(args.pop(0))
r = Repo(".")
if "--all" in opts:
determine_wants = r.object_store.determine_wants_all
else:
determine_wants = lambda x: [y for y in args if not y in r.object_store]
client.fetch(path, r, determine_wants)
class cmd_fetch(Command):
def run(self, args):
opts, args = getopt(args, "", [])
opts = dict(opts)
client, path = get_transport_and_path(args.pop(0))
r = Repo(".")
if "--all" in opts:
determine_wants = r.object_store.determine_wants_all
refs = client.fetch(path, r, progress=sys.stdout.write)
print("Remote refs:")
for item in refs.items():
print("%s -> %s" % item)
class cmd_fsck(Command):
def run(self, args):
opts, args = getopt(args, "", [])
opts = dict(opts)
for (obj, msg) in porcelain.fsck('.'):
print("%s: %s" % (obj, msg))
class cmd_log(Command):
def run(self, args):
parser = optparse.OptionParser()
parser.add_option("--reverse", dest="reverse", action="store_true",
help="Reverse order in which entries are printed")
parser.add_option("--name-status", dest="name_status", action="store_true",
help="Print name/status for each changed file")
options, args = parser.parse_args(args)
porcelain.log(".", paths=args, reverse=options.reverse,
name_status=options.name_status,
outstream=sys.stdout)
class cmd_diff(Command):
def run(self, args):
opts, args = getopt(args, "", [])
if args == []:
print("Usage: dulwich diff COMMITID")
sys.exit(1)
r = Repo(".")
commit_id = args[0]
commit = r[commit_id]
parent_commit = r[commit.parents[0]]
write_tree_diff(sys.stdout, r.object_store, parent_commit.tree, commit.tree)
class cmd_dump_pack(Command):
def run(self, args):
opts, args = getopt(args, "", [])
if args == []:
print("Usage: dulwich dump-pack FILENAME")
sys.exit(1)
basename, _ = os.path.splitext(args[0])
x = Pack(basename)
print("Object names checksum: %s" % x.name())
print("Checksum: %s" % sha_to_hex(x.get_stored_checksum()))
if not x.check():
print("CHECKSUM DOES NOT MATCH")
print("Length: %d" % len(x))
for name in x:
try:
print("\t%s" % x[name])
except KeyError as k:
print("\t%s: Unable to resolve base %s" % (name, k))
except ApplyDeltaError as e:
print("\t%s: Unable to apply delta: %r" % (name, e))
class cmd_dump_index(Command):
def run(self, args):
opts, args = getopt(args, "", [])
if args == []:
print("Usage: dulwich dump-index FILENAME")
sys.exit(1)
filename = args[0]
idx = Index(filename)
for o in idx:
print(o, idx[o])
class cmd_init(Command):
def run(self, args):
opts, args = getopt(args, "", ["bare"])
opts = dict(opts)
if args == []:
path = os.getcwd()
else:
path = args[0]
porcelain.init(path, bare=("--bare" in opts))
class cmd_clone(Command):
def run(self, args):
parser = optparse.OptionParser()
parser.add_option("--bare", dest="bare",
help="Whether to create a bare repository.",
action="store_true")
parser.add_option("--depth", dest="depth",
type=int, help="Depth at which to fetch")
options, args = parser.parse_args(args)
if args == []:
print("usage: dulwich clone host:path [PATH]")
sys.exit(1)
source = args.pop(0)
if len(args) > 0:
target = args.pop(0)
else:
target = None
porcelain.clone(source, target, bare=options.bare, depth=options.depth)
class cmd_commit(Command):
def run(self, args):
opts, args = getopt(args, "", ["message"])
opts = dict(opts)
porcelain.commit(".", message=opts["--message"])
class cmd_commit_tree(Command):
def run(self, args):
opts, args = getopt(args, "", ["message"])
if args == []:
print("usage: dulwich commit-tree tree")
sys.exit(1)
opts = dict(opts)
porcelain.commit_tree(".", tree=args[0], message=opts["--message"])
class cmd_update_server_info(Command):
def run(self, args):
porcelain.update_server_info(".")
class cmd_symbolic_ref(Command):
def run(self, args):
opts, args = getopt(args, "", ["ref-name", "force"])
if not args:
print("Usage: dulwich symbolic-ref REF_NAME [--force]")
sys.exit(1)
ref_name = args.pop(0)
porcelain.symbolic_ref(".", ref_name=ref_name, force='--force' in args)
class cmd_show(Command):
def run(self, args):
opts, args = getopt(args, "", [])
porcelain.show(".", args)
class cmd_diff_tree(Command):
def run(self, args):
opts, args = getopt(args, "", [])
if len(args) < 2:
print("Usage: dulwich diff-tree OLD-TREE NEW-TREE")
sys.exit(1)
porcelain.diff_tree(".", args[0], args[1])
class cmd_rev_list(Command):
def run(self, args):
opts, args = getopt(args, "", [])
if len(args) < 1:
print('Usage: dulwich rev-list COMMITID...')
sys.exit(1)
porcelain.rev_list('.', args)
class cmd_tag(Command):
def run(self, args):
parser = optparse.OptionParser()
parser.add_option("-a", "--annotated", help="Create an annotated tag.", action="store_true")
parser.add_option("-s", "--sign", help="Sign the annotated tag.", action="store_true")
options, args = parser.parse_args(args)
porcelain.tag_create(
'.', args[0], annotated=options.annotated,
sign=options.sign)
class cmd_repack(Command):
def run(self, args):
opts, args = getopt(args, "", [])
opts = dict(opts)
porcelain.repack('.')
class cmd_reset(Command):
def run(self, args):
opts, args = getopt(args, "", ["hard", "soft", "mixed"])
opts = dict(opts)
mode = ""
if "--hard" in opts:
mode = "hard"
elif "--soft" in opts:
mode = "soft"
elif "--mixed" in opts:
mode = "mixed"
porcelain.reset('.', mode=mode, *args)
class cmd_daemon(Command):
def run(self, args):
from dulwich import log_utils
from dulwich.protocol import TCP_GIT_PORT
parser = optparse.OptionParser()
parser.add_option("-l", "--listen_address", dest="listen_address",
default="localhost",
help="Binding IP address.")
parser.add_option("-p", "--port", dest="port", type=int,
default=TCP_GIT_PORT,
help="Binding TCP port.")
options, args = parser.parse_args(args)
log_utils.default_logging_config()
if len(args) >= 1:
gitdir = args[0]
else:
gitdir = '.'
from dulwich import porcelain
porcelain.daemon(gitdir, address=options.listen_address,
port=options.port)
class cmd_web_daemon(Command):
def run(self, args):
from dulwich import log_utils
parser = optparse.OptionParser()
parser.add_option("-l", "--listen_address", dest="listen_address",
default="",
help="Binding IP address.")
parser.add_option("-p", "--port", dest="port", type=int,
default=8000,
help="Binding TCP port.")
options, args = parser.parse_args(args)
log_utils.default_logging_config()
if len(args) >= 1:
gitdir = args[0]
else:
gitdir = '.'
from dulwich import porcelain
porcelain.web_daemon(gitdir, address=options.listen_address,
port=options.port)
class cmd_write_tree(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
sys.stdout.write('%s\n' % porcelain.write_tree('.'))
class cmd_receive_pack(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
if len(args) >= 1:
gitdir = args[0]
else:
gitdir = '.'
porcelain.receive_pack(gitdir)
class cmd_upload_pack(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
if len(args) >= 1:
gitdir = args[0]
else:
gitdir = '.'
porcelain.upload_pack(gitdir)
class cmd_status(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
if len(args) >= 1:
gitdir = args[0]
else:
gitdir = '.'
status = porcelain.status(gitdir)
if any(names for (kind, names) in status.staged.items()):
sys.stdout.write("Changes to be committed:\n\n")
for kind, names in status.staged.items():
for name in names:
sys.stdout.write("\t%s: %s\n" % (
kind, name.decode(sys.getfilesystemencoding())))
sys.stdout.write("\n")
if status.unstaged:
sys.stdout.write("Changes not staged for commit:\n\n")
for name in status.unstaged:
sys.stdout.write("\t%s\n" %
name.decode(sys.getfilesystemencoding()))
sys.stdout.write("\n")
if status.untracked:
sys.stdout.write("Untracked files:\n\n")
for name in status.untracked:
sys.stdout.write("\t%s\n" % name)
sys.stdout.write("\n")
class cmd_ls_remote(Command):
def run(self, args):
opts, args = getopt(args, '', [])
if len(args) < 1:
print('Usage: dulwich ls-remote URL')
sys.exit(1)
refs = porcelain.ls_remote(args[0])
for ref in sorted(refs):
sys.stdout.write("%s\t%s\n" % (ref, refs[ref]))
class cmd_ls_tree(Command):
def run(self, args):
parser = optparse.OptionParser()
parser.add_option("-r", "--recursive", action="store_true",
help="Recusively list tree contents.")
parser.add_option("--name-only", action="store_true",
help="Only display name.")
options, args = parser.parse_args(args)
try:
treeish = args.pop(0)
except IndexError:
treeish = None
porcelain.ls_tree(
'.', treeish, outstream=sys.stdout, recursive=options.recursive,
name_only=options.name_only)
class cmd_pack_objects(Command):
def run(self, args):
opts, args = getopt(args, '', ['stdout'])
opts = dict(opts)
if len(args) < 1 and not '--stdout' in args:
print('Usage: dulwich pack-objects basename')
sys.exit(1)
object_ids = [l.strip() for l in sys.stdin.readlines()]
basename = args[0]
if '--stdout' in opts:
packf = getattr(sys.stdout, 'buffer', sys.stdout)
idxf = None
close = []
else:
packf = open(basename + '.pack', 'w')
idxf = open(basename + '.idx', 'w')
close = [packf, idxf]
porcelain.pack_objects('.', object_ids, packf, idxf)
for f in close:
f.close()
class cmd_pull(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
try:
from_location = args[0]
except IndexError:
from_location = None
porcelain.pull('.', from_location)
class cmd_push(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
if len(args) < 2:
print("Usage: dulwich push TO-LOCATION REFSPEC..")
sys.exit(1)
to_location = args[0]
refspecs = args[1:]
porcelain.push('.', to_location, refspecs)
class cmd_remote_add(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
porcelain.remote_add('.', args[0], args[1])
class SuperCommand(Command):
subcommands = {}
def run(self, args):
if not args:
print("Supported subcommands: %s" % ', '.join(self.subcommands.keys()))
return False
cmd = args[0]
try:
cmd_kls = self.subcommands[cmd]
except KeyError:
print('No such subcommand: %s' % args[0])
return False
return cmd_kls().run(args[1:])
class cmd_remote(SuperCommand):
subcommands = {
"add": cmd_remote_add,
}
class cmd_check_ignore(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
ret = 1
for path in porcelain.check_ignore('.', args):
print(path)
ret = 0
return ret
class cmd_check_mailmap(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
for arg in args:
canonical_identity = porcelain.check_mailmap('.', arg)
print(canonical_identity)
class cmd_stash_list(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
for i, entry in porcelain.stash_list('.'):
print("stash@{%d}: %s" % (i, entry.message.rstrip('\n')))
class cmd_stash_push(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
porcelain.stash_push('.')
print("Saved working directory and index state")
class cmd_stash_pop(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
porcelain.stash_pop('.')
print("Restrored working directory and index state")
class cmd_stash(SuperCommand):
subcommands = {
"list": cmd_stash_list,
"pop": cmd_stash_pop,
"push": cmd_stash_push,
}
class cmd_ls_files(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
for name in porcelain.ls_files('.'):
print(name)
class cmd_describe(Command):
def run(self, args):
parser = optparse.OptionParser()
options, args = parser.parse_args(args)
print(porcelain.describe('.'))
class cmd_help(Command):
def run(self, args):
parser = optparse.OptionParser()
parser.add_option("-a", "--all", dest="all",
action="store_true",
help="List all commands.")
options, args = parser.parse_args(args)
if options.all:
print('Available commands:')
for cmd in sorted(commands):
print(' %s' % cmd)
else:
print("""\
The dulwich command line tool is currently a very basic frontend for the
Dulwich python module. For full functionality, please see the API reference.
For a list of supported commands, see 'dulwich help -a'.
""")
commands = {
"add": cmd_add,
"archive": cmd_archive,
"check-ignore": cmd_check_ignore,
"check-mailmap": cmd_check_mailmap,
"clone": cmd_clone,
"commit": cmd_commit,
"commit-tree": cmd_commit_tree,
"describe": cmd_describe,
"daemon": cmd_daemon,
"diff": cmd_diff,
"diff-tree": cmd_diff_tree,
"dump-pack": cmd_dump_pack,
"dump-index": cmd_dump_index,
"fetch-pack": cmd_fetch_pack,
"fetch": cmd_fetch,
"fsck": cmd_fsck,
"help": cmd_help,
"init": cmd_init,
"log": cmd_log,
"ls-files": cmd_ls_files,
"ls-remote": cmd_ls_remote,
"ls-tree": cmd_ls_tree,
"pack-objects": cmd_pack_objects,
"pull": cmd_pull,
"push": cmd_push,
"receive-pack": cmd_receive_pack,
"remote": cmd_remote,
"repack": cmd_repack,
"reset": cmd_reset,
"rev-list": cmd_rev_list,
"rm": cmd_rm,
"show": cmd_show,
"stash": cmd_stash,
"status": cmd_status,
"symbolic-ref": cmd_symbolic_ref,
"tag": cmd_tag,
"update-server-info": cmd_update_server_info,
"upload-pack": cmd_upload_pack,
"web-daemon": cmd_web_daemon,
"write-tree": cmd_write_tree,
}
if len(sys.argv) < 2:
print("Usage: %s <%s> [OPTIONS...]" % (sys.argv[0], "|".join(commands.keys())))
sys.exit(1)
cmd = sys.argv[1]
try:
cmd_kls = commands[cmd]
except KeyError:
print("No such subcommand: %s" % cmd)
sys.exit(1)
# TODO(jelmer): Return non-0 on errors
cmd_kls().run(sys.argv[2:])