26
23
from inventory import Inventory
27
24
from trace import mutter, note
28
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
25
from tree import Tree, EmptyTree, RevisionTree
29
26
from inventory import InventoryEntry, Inventory
30
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
27
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
31
28
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
32
joinpath, sha_string, file_kind, local_time_offset
29
joinpath, sha_string, file_kind, local_time_offset, appendpath
33
30
from store import ImmutableStore
34
31
from revision import Revision
35
from errors import bailout
32
from errors import bailout, BzrError
36
33
from textui import show_status
37
from diff import diff_trees
39
35
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
40
36
## TODO: Maybe include checks for common corruption of newlines, etc?
40
def find_branch(f, **args):
41
if f and (f.startswith('http://') or f.startswith('https://')):
43
return remotebranch.RemoteBranch(f, **args)
45
return Branch(f, **args)
48
def find_branch_root(f=None):
49
"""Find the branch root enclosing f, or pwd.
51
f may be a filename or a URL.
53
It is not necessary that f exists.
55
Basically we keep looking up until we find the control directory or
59
elif hasattr(os.path, 'realpath'):
60
f = os.path.realpath(f)
62
f = os.path.abspath(f)
63
if not os.path.exists(f):
64
raise BzrError('%r does not exist' % f)
70
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
72
head, tail = os.path.split(f)
74
# reached the root, whatever that may be
75
raise BzrError('%r is not in a branch' % orig_f)
46
80
######################################################################
50
84
"""Branch holding a history of revisions.
52
:todo: Perhaps use different stores for different classes of object,
53
so that we can keep track of how much space each one uses,
54
or garbage-collect them.
56
:todo: Add a RemoteBranch subclass. For the basic case of read-only
57
HTTP access this should be very easy by,
58
just redirecting controlfile access into HTTP requests.
59
We would need a RemoteStore working similarly.
61
:todo: Keep the on-disk branch locked while the object exists.
63
:todo: mkdir() method.
87
Base directory of the branch.
65
def __init__(self, base, init=False):
92
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
66
93
"""Create new branch object at a particular location.
68
:param base: Base directory for the branch.
70
:param init: If True, create new control files in a previously
95
base -- Base directory for the branch.
97
init -- If True, create new control files in a previously
71
98
unversioned directory. If False, the branch must already
101
find_root -- If true and init is false, find the root of the
102
existing branch containing base.
74
104
In the test suite, creation of new trees is tested using the
75
105
`ScratchBranch` class.
77
self.base = os.path.realpath(base)
108
self.base = os.path.realpath(base)
79
109
self._make_control()
111
self.base = find_branch_root(base)
113
self.base = os.path.realpath(base)
81
114
if not isdir(self.controlfilename('.')):
82
115
bailout("not a bzr branch: %s" % quotefn(base),
83
116
['use "bzr init" to initialize a new working tree',
84
117
'current bzr can only operate from top-of-tree'])
87
121
self.text_store = ImmutableStore(self.controlfilename('text-store'))
88
122
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
96
130
__repr__ = __str__
100
"""Return filename relative to branch top"""
134
def lock(self, mode='w'):
135
"""Lock the on-disk branch, excluding other processes."""
141
om = os.O_WRONLY | os.O_CREAT
146
raise BzrError("invalid locking mode %r" % mode)
149
lockfile = os.open(self.controlfilename('branch-lock'), om)
151
if e.errno == errno.ENOENT:
152
# might not exist on branches from <0.0.4
153
self.controlfile('branch-lock', 'w').close()
154
lockfile = os.open(self.controlfilename('branch-lock'), om)
158
fcntl.lockf(lockfile, lm)
160
fcntl.lockf(lockfile, fcntl.LOCK_UN)
162
self._lockmode = None
164
self._lockmode = mode
166
warning("please write a locking method for platform %r" % sys.platform)
168
self._lockmode = None
170
self._lockmode = mode
173
def _need_readlock(self):
174
if self._lockmode not in ['r', 'w']:
175
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
177
def _need_writelock(self):
178
if self._lockmode not in ['w']:
179
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
182
def abspath(self, name):
183
"""Return absolute filename for something in the branch"""
101
184
return os.path.join(self.base, name)
187
def relpath(self, path):
188
"""Return path relative to this branch of something inside it.
190
Raises an error if path is not in this branch."""
191
rp = os.path.realpath(path)
193
if not rp.startswith(self.base):
194
bailout("path %r is not within branch %r" % (rp, self.base))
195
rp = rp[len(self.base):]
196
rp = rp.lstrip(os.sep)
104
200
def controlfilename(self, file_or_path):
105
201
"""Return location relative to branch."""
172
302
"""Inventory for the working copy.""")
175
def add(self, files, verbose=False):
305
def add(self, files, verbose=False, ids=None):
176
306
"""Make files versioned.
308
Note that the command line normally calls smart_add instead.
178
310
This puts the files in the Added state, so that they will be
179
311
recorded by the next commit.
181
:todo: Perhaps have an option to add the ids even if the files do
313
TODO: Perhaps have an option to add the ids even if the files do
184
:todo: Perhaps return the ids of the files? But then again it
316
TODO: Perhaps return the ids of the files? But then again it
185
317
is easy to retrieve them if they're needed.
187
:todo: Option to specify file id.
319
TODO: Option to specify file id.
189
:todo: Adding a directory should optionally recurse down and
321
TODO: Adding a directory should optionally recurse down and
190
322
add all non-ignored children. Perhaps do that in a
191
323
higher-level method.
193
>>> b = ScratchBranch(files=['foo'])
194
>>> 'foo' in b.unknowns()
199
>>> 'foo' in b.unknowns()
201
>>> bool(b.inventory.path2id('foo'))
207
Traceback (most recent call last):
209
BzrError: ('foo is already versioned', [])
211
>>> b.add(['nothere'])
212
Traceback (most recent call last):
213
BzrError: ('cannot add: not a regular file or directory: nothere', [])
325
self._need_writelock()
216
327
# TODO: Re-adding a file that is removed in the working copy
217
328
# should probably put it back with the previous ID.
218
329
if isinstance(files, types.StringTypes):
330
assert(ids is None or isinstance(ids, types.StringTypes))
336
ids = [None] * len(files)
338
assert(len(ids) == len(files))
221
340
inv = self.read_working_inventory()
341
for f,file_id in zip(files, ids):
223
342
if is_control_file(f):
224
343
bailout("cannot add control file %s" % quotefn(f))
229
348
bailout("cannot add top-level %r" % f)
231
fullpath = os.path.normpath(self._rel(f))
235
elif isdir(fullpath):
238
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
241
parent_name = joinpath(fp[:-1])
242
mutter("lookup parent %r" % parent_name)
243
parent_id = inv.path2id(parent_name)
244
if parent_id == None:
245
bailout("cannot add: parent %r is not versioned"
250
file_id = _gen_file_id(fp[-1])
251
inv.add(InventoryEntry(file_id, fp[-1], kind=kind, parent_id=parent_id))
350
fullpath = os.path.normpath(self.abspath(f))
353
kind = file_kind(fullpath)
355
# maybe something better?
356
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
358
if kind != 'file' and kind != 'directory':
359
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
362
file_id = gen_file_id(f)
363
inv.add_path(f, kind=kind, file_id=file_id)
253
366
show_status('A', kind, quotefn(f))
255
mutter("add file %s file_id:{%s} kind=%r parent_id={%s}"
256
% (f, file_id, kind, parent_id))
368
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
257
370
self._write_inventory(inv)
373
def print_file(self, file, revno):
374
"""Print `file` to stdout."""
375
self._need_readlock()
376
tree = self.revision_tree(self.lookup_revision(revno))
377
# use inventory as it was in that revision
378
file_id = tree.inventory.path2id(file)
380
bailout("%r is not present in revision %d" % (file, revno))
381
tree.print_file(file_id)
261
384
def remove(self, files, verbose=False):
262
385
"""Mark nominated files for removal from the inventory.
264
387
This does not remove their text. This does not run on
266
:todo: Refuse to remove modified files unless --force is given?
268
>>> b = ScratchBranch(files=['foo'])
270
>>> b.inventory.has_filename('foo')
273
>>> b.working_tree().has_filename('foo')
275
>>> b.inventory.has_filename('foo')
278
>>> b = ScratchBranch(files=['foo'])
283
>>> b.inventory.has_filename('foo')
285
>>> b.basis_tree().has_filename('foo')
287
>>> b.working_tree().has_filename('foo')
290
:todo: Do something useful with directories.
292
:todo: Should this remove the text or not? Tough call; not
389
TODO: Refuse to remove modified files unless --force is given?
391
TODO: Do something useful with directories.
393
TODO: Should this remove the text or not? Tough call; not
293
394
removing may be useful and the user can just use use rm, and
294
395
is the opposite of add. Removing it is consistent with most
295
396
other tools. Maybe an option.
297
398
## TODO: Normalize names
298
399
## TODO: Remove nested loops; better scalability
400
self._need_writelock()
300
402
if isinstance(files, types.StringTypes):
340
451
return self.working_tree().unknowns()
343
def commit(self, message, timestamp=None, timezone=None,
346
"""Commit working copy as a new revision.
348
The basic approach is to add all the file texts into the
349
store, then the inventory, then make a new revision pointing
350
to that inventory and store that.
352
This is not quite safe if the working copy changes during the
353
commit; for the moment that is simply not allowed. A better
354
approach is to make a temporary copy of the files before
355
computing their hashes, and then add those hashes in turn to
356
the inventory. This should mean at least that there are no
357
broken hash pointers. There is no way we can get a snapshot
358
of the whole directory at an instant. This would also have to
359
be robust against files disappearing, moving, etc. So the
360
whole thing is a bit hard.
362
:param timestamp: if not None, seconds-since-epoch for a
363
postdated/predated commit.
366
## TODO: Show branch names
368
# TODO: Don't commit if there are no changes, unless forced?
370
# First walk over the working inventory; and both update that
371
# and also build a new revision inventory. The revision
372
# inventory needs to hold the text-id, sha1 and size of the
373
# actual file versions committed in the revision. (These are
374
# not present in the working inventory.) We also need to
375
# detect missing/deleted files, and remove them from the
378
work_inv = self.read_working_inventory()
380
basis = self.basis_tree()
381
basis_inv = basis.inventory
383
for path, entry in work_inv.iter_entries():
384
## TODO: Cope with files that have gone missing.
386
## TODO: Check that the file kind has not changed from the previous
387
## revision of this file (if any).
392
file_id = entry.file_id
393
mutter('commit prep file %s, id %r ' % (p, file_id))
395
if not os.path.exists(p):
396
mutter(" file is missing, removing from inventory")
398
show_status('D', entry.kind, quotefn(path))
399
missing_ids.append(file_id)
402
# TODO: Handle files that have been deleted
404
# TODO: Maybe a special case for empty files? Seems a
405
# waste to store them many times.
409
if basis_inv.has_id(file_id):
410
old_kind = basis_inv[file_id].kind
411
if old_kind != entry.kind:
412
bailout("entry %r changed kind from %r to %r"
413
% (file_id, old_kind, entry.kind))
415
if entry.kind == 'directory':
417
bailout("%s is entered as directory but not a directory" % quotefn(p))
418
elif entry.kind == 'file':
420
bailout("%s is entered as file but is not a file" % quotefn(p))
422
content = file(p, 'rb').read()
424
entry.text_sha1 = sha_string(content)
425
entry.text_size = len(content)
427
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
429
and (old_ie.text_size == entry.text_size)
430
and (old_ie.text_sha1 == entry.text_sha1)):
431
## assert content == basis.get_file(file_id).read()
432
entry.text_id = basis_inv[file_id].text_id
433
mutter(' unchanged from previous text_id {%s}' %
437
entry.text_id = _gen_file_id(entry.name)
438
self.text_store.add(content, entry.text_id)
439
mutter(' stored with text_id {%s}' % entry.text_id)
443
elif (old_ie.name == entry.name
444
and old_ie.parent_id == entry.parent_id):
449
show_status(state, entry.kind, quotefn(path))
451
for file_id in missing_ids:
452
# have to do this later so we don't mess up the iterator.
453
# since parents may be removed before their children we
456
# FIXME: There's probably a better way to do this; perhaps
457
# the workingtree should know how to filter itself.
458
if work_inv.has_id(file_id):
459
del work_inv[file_id]
462
inv_id = rev_id = _gen_revision_id(time.time())
464
inv_tmp = tempfile.TemporaryFile()
465
inv.write_xml(inv_tmp)
467
self.inventory_store.add(inv_tmp, inv_id)
468
mutter('new inventory_id is {%s}' % inv_id)
470
self._write_inventory(work_inv)
472
if timestamp == None:
473
timestamp = time.time()
475
if committer == None:
476
committer = username()
479
timezone = local_time_offset()
481
mutter("building commit log message")
482
rev = Revision(timestamp=timestamp,
485
precursor = self.last_patch(),
490
rev_tmp = tempfile.TemporaryFile()
491
rev.write_xml(rev_tmp)
493
self.revision_store.add(rev_tmp, rev_id)
494
mutter("new revision_id is {%s}" % rev_id)
496
## XXX: Everything up to here can simply be orphaned if we abort
497
## the commit; it will leave junk files behind but that doesn't
500
## TODO: Read back the just-generated changeset, and make sure it
501
## applies and recreates the right state.
503
## TODO: Also calculate and store the inventory SHA1
504
mutter("committing patch r%d" % (self.revno() + 1))
506
mutter("append to revision-history")
507
self.controlfile('revision-history', 'at').write(rev_id + '\n')
454
def append_revision(self, revision_id):
455
mutter("add {%s} to revision-history" % revision_id)
456
rev_history = self.revision_history()
458
tmprhname = self.controlfilename('revision-history.tmp')
459
rhname = self.controlfilename('revision-history')
461
f = file(tmprhname, 'wt')
462
rev_history.append(revision_id)
463
f.write('\n'.join(rev_history))
467
if sys.platform == 'win32':
469
os.rename(tmprhname, rhname)
512
473
def get_revision(self, revision_id):
513
474
"""Return the Revision object for a named revision"""
475
self._need_readlock()
514
476
r = Revision.read_xml(self.revision_store[revision_id])
515
477
assert r.revision_id == revision_id
626
def write_log(self, show_timezone='original'):
627
"""Write out human-readable log of commits to this branch
629
:param utc: If true, show dates in universal time, not local time."""
630
## TODO: Option to choose either original, utc or local timezone
633
for p in self.revision_history():
635
print 'revno:', revno
636
## TODO: Show hash if --id is given.
637
##print 'revision-hash:', p
638
rev = self.get_revision(p)
639
print 'committer:', rev.committer
640
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
643
## opportunistic consistency check, same as check_patch_chaining
644
if rev.precursor != precursor:
645
bailout("mismatched precursor!")
649
print ' (no message)'
651
for l in rev.message.split('\n'):
659
def show_status(branch, show_all=False):
660
"""Display single-line status for non-ignored working files.
662
The list is show sorted in order by file name.
664
>>> b = ScratchBranch(files=['foo', 'foo~'])
670
>>> b.commit("add foo")
672
>>> os.unlink(b._rel('foo'))
604
def rename_one(self, from_rel, to_rel):
607
This can change the directory or the filename or both.
609
self._need_writelock()
610
tree = self.working_tree()
612
if not tree.has_filename(from_rel):
613
bailout("can't rename: old working file %r does not exist" % from_rel)
614
if tree.has_filename(to_rel):
615
bailout("can't rename: new working file %r already exists" % to_rel)
617
file_id = inv.path2id(from_rel)
619
bailout("can't rename: old name %r is not versioned" % from_rel)
621
if inv.path2id(to_rel):
622
bailout("can't rename: new name %r is already versioned" % to_rel)
624
to_dir, to_tail = os.path.split(to_rel)
625
to_dir_id = inv.path2id(to_dir)
626
if to_dir_id == None and to_dir != '':
627
bailout("can't determine destination directory id for %r" % to_dir)
629
mutter("rename_one:")
630
mutter(" file_id {%s}" % file_id)
631
mutter(" from_rel %r" % from_rel)
632
mutter(" to_rel %r" % to_rel)
633
mutter(" to_dir %r" % to_dir)
634
mutter(" to_dir_id {%s}" % to_dir_id)
636
inv.rename(file_id, to_dir_id, to_tail)
638
print "%s => %s" % (from_rel, to_rel)
677
:todo: Get state for single files.
679
:todo: Perhaps show a slash at the end of directory names.
640
from_abs = self.abspath(from_rel)
641
to_abs = self.abspath(to_rel)
643
os.rename(from_abs, to_abs)
645
bailout("failed to rename %r to %r: %s"
646
% (from_abs, to_abs, e[1]),
647
["rename rolled back"])
649
self._write_inventory(inv)
653
def move(self, from_paths, to_name):
656
to_name must exist as a versioned directory.
658
If to_name exists and is a directory, the files are moved into
659
it, keeping their old names. If it is a directory,
661
Note that to_name is only the last component of the new name;
662
this doesn't change the directory.
683
# We have to build everything into a list first so that it can
684
# sorted by name, incorporating all the different sources.
686
# FIXME: Rather than getting things in random order and then sorting,
687
# just step through in order.
689
# Interesting case: the old ID for a file has been removed,
690
# but a new file has been created under that name.
692
old = branch.basis_tree()
693
old_inv = old.inventory
694
new = branch.working_tree()
695
new_inv = new.inventory
697
for fs, fid, oldname, newname, kind in diff_trees(old, new):
699
show_status(fs, kind,
700
oldname + ' => ' + newname)
701
elif fs == 'A' or fs == 'M':
702
show_status(fs, kind, newname)
704
show_status(fs, kind, oldname)
707
show_status(fs, kind, newname)
710
show_status(fs, kind, newname)
712
show_status(fs, kind, newname)
714
bailout("wierd file state %r" % ((fs, fid),))
664
self._need_writelock()
665
## TODO: Option to move IDs only
666
assert not isinstance(from_paths, basestring)
667
tree = self.working_tree()
669
to_abs = self.abspath(to_name)
670
if not isdir(to_abs):
671
bailout("destination %r is not a directory" % to_abs)
672
if not tree.has_filename(to_name):
673
bailout("destination %r not in working directory" % to_abs)
674
to_dir_id = inv.path2id(to_name)
675
if to_dir_id == None and to_name != '':
676
bailout("destination %r is not a versioned directory" % to_name)
677
to_dir_ie = inv[to_dir_id]
678
if to_dir_ie.kind not in ('directory', 'root_directory'):
679
bailout("destination %r is not a directory" % to_abs)
681
to_idpath = inv.get_idpath(to_dir_id)
684
if not tree.has_filename(f):
685
bailout("%r does not exist in working tree" % f)
686
f_id = inv.path2id(f)
688
bailout("%r is not versioned" % f)
689
name_tail = splitpath(f)[-1]
690
dest_path = appendpath(to_name, name_tail)
691
if tree.has_filename(dest_path):
692
bailout("destination %r already exists" % dest_path)
693
if f_id in to_idpath:
694
bailout("can't move %r to a subdirectory of itself" % f)
696
# OK, so there's a race here, it's possible that someone will
697
# create a file in this interval and then the rename might be
698
# left half-done. But we should have caught most problems.
701
name_tail = splitpath(f)[-1]
702
dest_path = appendpath(to_name, name_tail)
703
print "%s => %s" % (f, dest_path)
704
inv.rename(inv.path2id(f), to_dir_id, name_tail)
706
os.rename(self.abspath(f), self.abspath(dest_path))
708
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
709
["rename rolled back"])
711
self._write_inventory(inv)
718
716
class ScratchBranch(Branch):