from urllib.parse import unquote as _unquote
import json as _json
-_LOG = _logging.getLogger('nmbug')
+_LOG = _logging.getLogger('notmuch-git')
_LOG.setLevel(_logging.WARNING)
_LOG.addHandler(_logging.StreamHandler())
NOTMUCH_GIT_DIR = None
TAG_PREFIX = None
+FORMAT_VERSION = 0
_HEX_ESCAPE_REGEX = _re.compile('%[0-9A-F]{2}')
_TAG_DIRECTORY = 'tags/'
-_TAG_FILE_REGEX = _re.compile(_TAG_DIRECTORY + '(?P<id>[^/]*)/(?P<tag>[^/]*)')
+_TAG_FILE_REGEX = ( _re.compile(_TAG_DIRECTORY + '(?P<id>[^/]*)/(?P<tag>[^/]*)'),
+ _re.compile(_TAG_DIRECTORY + '([0-9a-f]{2}/){2}(?P<id>[^/]*)/(?P<tag>[^/]*)'))
# magic hash for Git (git hash-object -t blob /dev/null)
_EMPTYBLOB = 'e69de29bb2d1d6434b8b29ae775ad8c2e48c5391'
def archive(treeish='HEAD', args=()):
"""
- Dump a tar archive of the current nmbug tag set.
+ Dump a tar archive of the current notmuch-git tag set.
Using 'git archive'.
Each tag $tag for message with Message-Id $id is written to
an empty file
- tags/encode($id)/encode($tag)
+ tags/hash1(id)/hash2(id)/encode($id)/encode($tag)
The encoding preserves alphanumerics, and the characters
"+-_@=.:," (not the quotes). All other octets are replaced with
def clone(repository):
"""
- Create a local nmbug repository from a remote source.
+ Create a local notmuch-git repository from a remote source.
This wraps 'git clone', adding some options to avoid creating a
working tree while preserving remote-tracking branches and
upstreams.
"""
- with _tempfile.TemporaryDirectory(prefix='nmbug-clone.') as workdir:
+ with _tempfile.TemporaryDirectory(prefix='notmuch-git-clone.') as workdir:
_spawn(
args=[
'git', 'clone', '--no-checkout', '--separate-git-dir', NOTMUCH_GIT_DIR,
def init(remote=None):
"""
- Create an empty nmbug repository.
+ Create an empty notmuch-git repository.
This wraps 'git init' with a few extra steps to support subsequent
status and commit commands.
_git(args=['config', 'core.logallrefupdates', 'true'], wait=True)
# create an empty blob (e69de29bb2d1d6434b8b29ae775ad8c2e48c5391)
_git(args=['hash-object', '-w', '--stdin'], input='', wait=True)
+ # create a blob for the FORMAT file
+ (status, stdout, _) = _git(args=['hash-object', '-w', '--stdin'], stdout=_subprocess.PIPE,
+ input='1\n', wait=True)
+ verhash=stdout.rstrip()
+ _LOG.debug('hash of FORMAT blob = {:s}'.format(verhash))
+ # Add FORMAT to the index
+ _git(args=['update-index', '--add', '--cacheinfo', '100644,{:s},FORMAT'.format(verhash)], wait=True)
+
_git(
args=[
- 'commit', '--allow-empty', '-m', 'Start a new nmbug repository'
+ 'commit', '-m', 'Start a new notmuch-git repository'
],
additional_env={'GIT_WORK_TREE': NOTMUCH_GIT_DIR},
wait=True)
_LOG.error('\n'.join([
'Uncommitted changes to {prefix}* tags in notmuch',
'',
- "For a summary of changes, run 'nmbug status'",
- "To save your changes, run 'nmbug commit' before merging/pull",
- "To discard your changes, run 'nmbug checkout'",
+ "For a summary of changes, run 'notmuch-git status'",
+ "To save your changes, run 'notmuch-git commit' before merging/pull",
+ "To discard your changes, run 'notmuch-git checkout'",
]).format(prefix=TAG_PREFIX))
_sys.exit(1)
args.append(repository)
if refspecs:
args.extend(refspecs)
- with _tempfile.TemporaryDirectory(prefix='nmbug-pull.') as workdir:
+ with _tempfile.TemporaryDirectory(prefix='notmuch-git-pull.') as workdir:
for command in [
['reset', '--hard'],
args]:
The default reference is '@{upstream}'.
"""
_insist_committed()
- with _tempfile.TemporaryDirectory(prefix='nmbug-merge.') as workdir:
+ with _tempfile.TemporaryDirectory(prefix='notmuch-git-merge.') as workdir:
for command in [
['reset', '--hard'],
['merge', reference]]:
"""
A simple wrapper for 'git log'.
- After running 'nmbug fetch', you can inspect the changes with
- 'nmbug log HEAD..@{upstream}'.
+ After running 'notmuch-git fetch', you can inspect the changes with
+ 'notmuch-git log HEAD..@{upstream}'.
"""
# we don't want output trapping here, because we want the pager.
args = ['log', '--name-status', '--no-renames'] + list(args)
def push(repository=None, refspecs=None):
- "Push the local nmbug Git state to a remote repository."
+ "Push the local notmuch-git Git state to a remote repository."
if refspecs and not repository:
repository = _get_remote()
args = ['push']
* A
- Tag is present in notmuch database, but not committed to nmbug
- (equivalently, tag has been deleted in nmbug repo, e.g. by a
+ Tag is present in notmuch database, but not committed to notmuch-git
+ (equivalently, tag has been deleted in notmuch-git repo, e.g. by a
pull, but not restored to notmuch database).
* D
- Tag is present in nmbug repo, but not restored to notmuch
+ Tag is present in notmuch-git repo, but not restored to notmuch
database (equivalently, tag has been deleted in notmuch).
* U
Message is unknown (missing from local notmuch database).
The second character (if present) represents a difference between
- local and upstream branches. Typically 'nmbug fetch' needs to be
+ local and upstream branches. Typically 'notmuch-git fetch' needs to be
run to update this.
* a
Neither 'id' nor the tags in 'tags' should be encoded/escaped.
"""
- dir = 'tags/{id}'.format(id=_hex_quote(string=id))
+ dir = _id_path(id)
with _git(
args=['ls-files', dir],
(count,uuid,lastmod_str) = notmuch.stdout.readline().split()
return (count,uuid,int(lastmod_str))
+def _id_path(id):
+ hid=_hex_quote(string=id)
+ from hashlib import blake2b
+
+ if FORMAT_VERSION==0:
+ return 'tags/{hid}'.format(hid=hid)
+ elif FORMAT_VERSION==1:
+ idhash = blake2b(hid.encode('utf8'), digest_size=2).hexdigest()
+ return 'tags/{dir1}/{dir2}/{hid}'.format(
+ hid=hid,
+ dir1=idhash[0:2],dir2=idhash[2:])
+ else:
+ _LOG.error("Unknown format version",FORMAT_VERSION)
+ _sys.exit(1)
+
def _index_tags_for_message(id, status, tags):
"""
Update the Git index to either create or delete an empty file.
hash = '0000000000000000000000000000000000000000'
for tag in tags:
- path = 'tags/{id}/{tag}'.format(
- id=_hex_quote(string=id), tag=_hex_quote(string=tag))
+ path = '{ipath}/{tag}'.format(ipath=_id_path(id),tag=_hex_quote(string=tag))
yield '{mode} {hash}\t{path}\n'.format(mode=mode, hash=hash, path=path)
def _unpack_diff_lines(stream):
"Iterate through (id, tag) tuples in a diff stream."
for line in stream:
- match = _TAG_FILE_REGEX.match(line.strip())
+ match = _TAG_FILE_REGEX[FORMAT_VERSION].match(line.strip())
if not match:
message = 'non-tag line in diff: {!r}'.format(line.strip())
if line.startswith(_TAG_DIRECTORY):
def _help(parser, command=None):
"""
- Show help for an nmbug command.
+ Show help for an notmuch-git command.
Because some folks prefer:
- $ nmbug help COMMAND
+ $ notmuch-git help COMMAND
to
- $ nmbug COMMAND --help
+ $ notmuch-git COMMAND --help
"""
if command:
parser.parse_args([command, '--help'])
_sys.exit(1)
return stdout.rstrip()
+def read_format_version():
+ try:
+ (status, stdout, stderr) = _git(
+ args=['cat-file', 'blob', 'master:FORMAT'],
+ stdout=_subprocess.PIPE, stderr=_subprocess.PIPE, wait=True)
+ except SubprocessError as e:
+ _LOG.debug("failed to read FORMAT file from git, assuming format version 0")
+ return 0
+
+ return int(stdout)
+
# based on BaseDirectory.save_data_path from pyxdg (LGPL2+)
def xdg_data_path(profile):
resource = _os.path.join('notmuch',profile,'git')
_LOG.debug('prefix = {:s}'.format(TAG_PREFIX))
_LOG.debug('repository = {:s}'.format(NOTMUCH_GIT_DIR))
+ FORMAT_VERSION = read_format_version()
+ _LOG.debug('FORMAT_VERSION={:d}'.format(FORMAT_VERSION))
+
if args.func == help:
arg_names = ['command']
else:
projects / notmuch / blobdiff