25
26
from inventory import Inventory
26
27
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree
28
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
28
29
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
30
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
30
31
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset, appendpath
32
joinpath, sha_string, file_kind, local_time_offset
32
33
from store import ImmutableStore
33
34
from revision import Revision
34
from errors import bailout, BzrError
35
from errors import bailout
35
36
from textui import show_status
37
from diff import diff_trees
37
39
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
38
40
## TODO: Maybe include checks for common corruption of newlines, etc?
42
def find_branch(f, **args):
43
if f and (f.startswith('http://') or f.startswith('https://')):
45
return remotebranch.RemoteBranch(f, **args)
47
return Branch(f, **args)
50
def find_branch_root(f=None):
51
"""Find the branch root enclosing f, or pwd.
53
f may be a filename or a URL.
55
It is not necessary that f exists.
57
Basically we keep looking up until we find the control directory or
61
elif hasattr(os.path, 'realpath'):
62
f = os.path.realpath(f)
64
f = os.path.abspath(f)
65
if not os.path.exists(f):
66
raise BzrError('%r does not exist' % f)
72
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
74
head, tail = os.path.split(f)
76
# reached the root, whatever that may be
77
raise BzrError('%r is not in a branch' % orig_f)
82
46
######################################################################
86
50
"""Branch holding a history of revisions.
89
Base directory of the branch.
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.
93
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
65
def __init__(self, base, init=False):
94
66
"""Create new branch object at a particular location.
96
base -- Base directory for the branch.
98
init -- If True, create new control files in a previously
68
:param base: Base directory for the branch.
70
:param init: If True, create new control files in a previously
99
71
unversioned directory. If False, the branch must already
102
find_root -- If true and init is false, find the root of the
103
existing branch containing base.
105
74
In the test suite, creation of new trees is tested using the
106
75
`ScratchBranch` class.
77
self.base = os.path.realpath(base)
109
self.base = os.path.realpath(base)
110
79
self._make_control()
112
self.base = find_branch_root(base)
114
self.base = os.path.realpath(base)
115
81
if not isdir(self.controlfilename('.')):
116
82
bailout("not a bzr branch: %s" % quotefn(base),
117
83
['use "bzr init" to initialize a new working tree',
118
84
'current bzr can only operate from top-of-tree'])
122
87
self.text_store = ImmutableStore(self.controlfilename('text-store'))
123
88
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
131
96
__repr__ = __str__
135
def lock(self, mode='w'):
136
"""Lock the on-disk branch, excluding other processes."""
142
om = os.O_WRONLY | os.O_CREAT
147
raise BzrError("invalid locking mode %r" % mode)
150
lockfile = os.open(self.controlfilename('branch-lock'), om)
152
if e.errno == errno.ENOENT:
153
# might not exist on branches from <0.0.4
154
self.controlfile('branch-lock', 'w').close()
155
lockfile = os.open(self.controlfilename('branch-lock'), om)
159
fcntl.lockf(lockfile, lm)
161
fcntl.lockf(lockfile, fcntl.LOCK_UN)
163
self._lockmode = None
165
self._lockmode = mode
167
warning("please write a locking method for platform %r" % sys.platform)
169
self._lockmode = None
171
self._lockmode = mode
174
def _need_readlock(self):
175
if self._lockmode not in ['r', 'w']:
176
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
178
def _need_writelock(self):
179
if self._lockmode not in ['w']:
180
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
183
def abspath(self, name):
184
"""Return absolute filename for something in the branch"""
100
"""Return filename relative to branch top"""
185
101
return os.path.join(self.base, name)
188
def relpath(self, path):
189
"""Return path relative to this branch of something inside it.
191
Raises an error if path is not in this branch."""
192
rp = os.path.realpath(path)
194
if not rp.startswith(self.base):
195
bailout("path %r is not within branch %r" % (rp, self.base))
196
rp = rp[len(self.base):]
197
rp = rp.lstrip(os.sep)
201
104
def controlfilename(self, file_or_path):
202
105
"""Return location relative to branch."""
306
175
def add(self, files, verbose=False):
307
176
"""Make files versioned.
309
Note that the command line normally calls smart_add instead.
311
178
This puts the files in the Added state, so that they will be
312
179
recorded by the next commit.
314
TODO: Perhaps have an option to add the ids even if the files do
181
:todo: Perhaps have an option to add the ids even if the files do
317
TODO: Perhaps return the ids of the files? But then again it
184
:todo: Perhaps return the ids of the files? But then again it
318
185
is easy to retrieve them if they're needed.
320
TODO: Option to specify file id.
187
:todo: Option to specify file id.
322
TODO: Adding a directory should optionally recurse down and
189
:todo: Adding a directory should optionally recurse down and
323
190
add all non-ignored children. Perhaps do that in a
324
191
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', [])
326
self._need_writelock()
328
216
# TODO: Re-adding a file that is removed in the working copy
329
217
# should probably put it back with the previous ID.
341
229
bailout("cannot add top-level %r" % f)
343
fullpath = os.path.normpath(self.abspath(f))
346
kind = file_kind(fullpath)
348
# maybe something better?
349
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
351
if kind != 'file' and kind != 'directory':
352
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
354
file_id = gen_file_id(f)
355
inv.add_path(f, kind=kind, file_id=file_id)
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))
358
253
show_status('A', kind, quotefn(f))
360
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
255
mutter("add file %s file_id:{%s} kind=%r parent_id={%s}"
256
% (f, file_id, kind, parent_id))
362
257
self._write_inventory(inv)
365
def print_file(self, file, revno):
366
"""Print `file` to stdout."""
367
self._need_readlock()
368
tree = self.revision_tree(self.lookup_revision(revno))
369
# use inventory as it was in that revision
370
file_id = tree.inventory.path2id(file)
372
bailout("%r is not present in revision %d" % (file, revno))
373
tree.print_file(file_id)
376
261
def remove(self, files, verbose=False):
377
262
"""Mark nominated files for removal from the inventory.
379
264
This does not remove their text. This does not run on
381
TODO: Refuse to remove modified files unless --force is given?
383
TODO: Do something useful with directories.
385
TODO: Should this remove the text or not? Tough call; not
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
386
293
removing may be useful and the user can just use use rm, and
387
294
is the opposite of add. Removing it is consistent with most
388
295
other tools. Maybe an option.
390
297
## TODO: Normalize names
391
298
## TODO: Remove nested loops; better scalability
392
self._need_writelock()
394
300
if isinstance(files, types.StringTypes):
397
tree = self.working_tree()
303
inv = self.read_working_inventory()
400
305
# do this before any modifications
434
334
return self.working_tree().unknowns()
437
def append_revision(self, revision_id):
438
mutter("add {%s} to revision-history" % revision_id)
439
rev_history = self.revision_history()
441
tmprhname = self.controlfilename('revision-history.tmp')
442
rhname = self.controlfilename('revision-history')
444
f = file(tmprhname, 'wt')
445
rev_history.append(revision_id)
446
f.write('\n'.join(rev_history))
450
if sys.platform == 'win32':
452
os.rename(tmprhname, rhname)
337
def commit(self, message, timestamp=None, timezone=None,
340
"""Commit working copy as a new revision.
342
The basic approach is to add all the file texts into the
343
store, then the inventory, then make a new revision pointing
344
to that inventory and store that.
346
This is not quite safe if the working copy changes during the
347
commit; for the moment that is simply not allowed. A better
348
approach is to make a temporary copy of the files before
349
computing their hashes, and then add those hashes in turn to
350
the inventory. This should mean at least that there are no
351
broken hash pointers. There is no way we can get a snapshot
352
of the whole directory at an instant. This would also have to
353
be robust against files disappearing, moving, etc. So the
354
whole thing is a bit hard.
356
:param timestamp: if not None, seconds-since-epoch for a
357
postdated/predated commit.
360
## TODO: Show branch names
362
# TODO: Don't commit if there are no changes, unless forced?
364
# First walk over the working inventory; and both update that
365
# and also build a new revision inventory. The revision
366
# inventory needs to hold the text-id, sha1 and size of the
367
# actual file versions committed in the revision. (These are
368
# not present in the working inventory.) We also need to
369
# detect missing/deleted files, and remove them from the
372
work_inv = self.read_working_inventory()
374
basis = self.basis_tree()
375
basis_inv = basis.inventory
377
for path, entry in work_inv.iter_entries():
378
## TODO: Cope with files that have gone missing.
380
## TODO: Check that the file kind has not changed from the previous
381
## revision of this file (if any).
386
file_id = entry.file_id
387
mutter('commit prep file %s, id %r ' % (p, file_id))
389
if not os.path.exists(p):
390
mutter(" file is missing, removing from inventory")
392
show_status('D', entry.kind, quotefn(path))
393
missing_ids.append(file_id)
396
# TODO: Handle files that have been deleted
398
# TODO: Maybe a special case for empty files? Seems a
399
# waste to store them many times.
403
if basis_inv.has_id(file_id):
404
old_kind = basis_inv[file_id].kind
405
if old_kind != entry.kind:
406
bailout("entry %r changed kind from %r to %r"
407
% (file_id, old_kind, entry.kind))
409
if entry.kind == 'directory':
411
bailout("%s is entered as directory but not a directory" % quotefn(p))
412
elif entry.kind == 'file':
414
bailout("%s is entered as file but is not a file" % quotefn(p))
416
content = file(p, 'rb').read()
418
entry.text_sha1 = sha_string(content)
419
entry.text_size = len(content)
421
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
423
and (old_ie.text_size == entry.text_size)
424
and (old_ie.text_sha1 == entry.text_sha1)):
425
## assert content == basis.get_file(file_id).read()
426
entry.text_id = basis_inv[file_id].text_id
427
mutter(' unchanged from previous text_id {%s}' %
431
entry.text_id = _gen_file_id(entry.name)
432
self.text_store.add(content, entry.text_id)
433
mutter(' stored with text_id {%s}' % entry.text_id)
437
elif (old_ie.name == entry.name
438
and old_ie.parent_id == entry.parent_id):
443
show_status(state, entry.kind, quotefn(path))
445
for file_id in missing_ids:
446
# have to do this later so we don't mess up the iterator.
447
# since parents may be removed before their children we
450
# FIXME: There's probably a better way to do this; perhaps
451
# the workingtree should know how to filter itself.
452
if work_inv.has_id(file_id):
453
del work_inv[file_id]
456
inv_id = rev_id = _gen_revision_id(time.time())
458
inv_tmp = tempfile.TemporaryFile()
459
inv.write_xml(inv_tmp)
461
self.inventory_store.add(inv_tmp, inv_id)
462
mutter('new inventory_id is {%s}' % inv_id)
464
self._write_inventory(work_inv)
466
if timestamp == None:
467
timestamp = time.time()
469
if committer == None:
470
committer = username()
473
timezone = local_time_offset()
475
mutter("building commit log message")
476
rev = Revision(timestamp=timestamp,
479
precursor = self.last_patch(),
484
rev_tmp = tempfile.TemporaryFile()
485
rev.write_xml(rev_tmp)
487
self.revision_store.add(rev_tmp, rev_id)
488
mutter("new revision_id is {%s}" % rev_id)
490
## XXX: Everything up to here can simply be orphaned if we abort
491
## the commit; it will leave junk files behind but that doesn't
494
## TODO: Read back the just-generated changeset, and make sure it
495
## applies and recreates the right state.
497
## TODO: Also calculate and store the inventory SHA1
498
mutter("committing patch r%d" % (self.revno() + 1))
500
mutter("append to revision-history")
501
self.controlfile('revision-history', 'at').write(rev_id + '\n')
456
506
def get_revision(self, revision_id):
457
507
"""Return the Revision object for a named revision"""
458
self._need_readlock()
459
508
r = Revision.read_xml(self.revision_store[revision_id])
460
509
assert r.revision_id == revision_id
585
def rename_one(self, from_rel, to_rel):
588
This can change the directory or the filename or both.
590
self._need_writelock()
591
tree = self.working_tree()
593
if not tree.has_filename(from_rel):
594
bailout("can't rename: old working file %r does not exist" % from_rel)
595
if tree.has_filename(to_rel):
596
bailout("can't rename: new working file %r already exists" % to_rel)
598
file_id = inv.path2id(from_rel)
600
bailout("can't rename: old name %r is not versioned" % from_rel)
602
if inv.path2id(to_rel):
603
bailout("can't rename: new name %r is already versioned" % to_rel)
605
to_dir, to_tail = os.path.split(to_rel)
606
to_dir_id = inv.path2id(to_dir)
607
if to_dir_id == None and to_dir != '':
608
bailout("can't determine destination directory id for %r" % to_dir)
610
mutter("rename_one:")
611
mutter(" file_id {%s}" % file_id)
612
mutter(" from_rel %r" % from_rel)
613
mutter(" to_rel %r" % to_rel)
614
mutter(" to_dir %r" % to_dir)
615
mutter(" to_dir_id {%s}" % to_dir_id)
617
inv.rename(file_id, to_dir_id, to_tail)
619
print "%s => %s" % (from_rel, to_rel)
620
def write_log(self, show_timezone='original'):
621
"""Write out human-readable log of commits to this branch
623
:param utc: If true, show dates in universal time, not local time."""
624
## TODO: Option to choose either original, utc or local timezone
627
for p in self.revision_history():
629
print 'revno:', revno
630
## TODO: Show hash if --id is given.
631
##print 'revision-hash:', p
632
rev = self.get_revision(p)
633
print 'committer:', rev.committer
634
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
637
## opportunistic consistency check, same as check_patch_chaining
638
if rev.precursor != precursor:
639
bailout("mismatched precursor!")
643
print ' (no message)'
645
for l in rev.message.split('\n'):
653
def show_status(branch, show_all=False):
654
"""Display single-line status for non-ignored working files.
656
The list is show sorted in order by file name.
658
>>> b = ScratchBranch(files=['foo', 'foo~'])
664
>>> b.commit("add foo")
666
>>> os.unlink(b._rel('foo'))
621
from_abs = self.abspath(from_rel)
622
to_abs = self.abspath(to_rel)
624
os.rename(from_abs, to_abs)
626
bailout("failed to rename %r to %r: %s"
627
% (from_abs, to_abs, e[1]),
628
["rename rolled back"])
630
self._write_inventory(inv)
634
def move(self, from_paths, to_name):
637
to_name must exist as a versioned directory.
639
If to_name exists and is a directory, the files are moved into
640
it, keeping their old names. If it is a directory,
642
Note that to_name is only the last component of the new name;
643
this doesn't change the directory.
671
:todo: Get state for single files.
673
:todo: Perhaps show a slash at the end of directory names.
645
self._need_writelock()
646
## TODO: Option to move IDs only
647
assert not isinstance(from_paths, basestring)
648
tree = self.working_tree()
650
to_abs = self.abspath(to_name)
651
if not isdir(to_abs):
652
bailout("destination %r is not a directory" % to_abs)
653
if not tree.has_filename(to_name):
654
bailout("destination %r not in working directory" % to_abs)
655
to_dir_id = inv.path2id(to_name)
656
if to_dir_id == None and to_name != '':
657
bailout("destination %r is not a versioned directory" % to_name)
658
to_dir_ie = inv[to_dir_id]
659
if to_dir_ie.kind not in ('directory', 'root_directory'):
660
bailout("destination %r is not a directory" % to_abs)
662
to_idpath = Set(inv.get_idpath(to_dir_id))
665
if not tree.has_filename(f):
666
bailout("%r does not exist in working tree" % f)
667
f_id = inv.path2id(f)
669
bailout("%r is not versioned" % f)
670
name_tail = splitpath(f)[-1]
671
dest_path = appendpath(to_name, name_tail)
672
if tree.has_filename(dest_path):
673
bailout("destination %r already exists" % dest_path)
674
if f_id in to_idpath:
675
bailout("can't move %r to a subdirectory of itself" % f)
677
# OK, so there's a race here, it's possible that someone will
678
# create a file in this interval and then the rename might be
679
# left half-done. But we should have caught most problems.
682
name_tail = splitpath(f)[-1]
683
dest_path = appendpath(to_name, name_tail)
684
print "%s => %s" % (f, dest_path)
685
inv.rename(inv.path2id(f), to_dir_id, name_tail)
687
os.rename(self.abspath(f), self.abspath(dest_path))
689
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
690
["rename rolled back"])
692
self._write_inventory(inv)
677
# We have to build everything into a list first so that it can
678
# sorted by name, incorporating all the different sources.
680
# FIXME: Rather than getting things in random order and then sorting,
681
# just step through in order.
683
# Interesting case: the old ID for a file has been removed,
684
# but a new file has been created under that name.
686
old = branch.basis_tree()
687
old_inv = old.inventory
688
new = branch.working_tree()
689
new_inv = new.inventory
691
for fs, fid, oldname, newname, kind in diff_trees(old, new):
693
show_status(fs, kind,
694
oldname + ' => ' + newname)
695
elif fs == 'A' or fs == 'M':
696
show_status(fs, kind, newname)
698
show_status(fs, kind, oldname)
701
show_status(fs, kind, newname)
704
show_status(fs, kind, newname)
706
show_status(fs, kind, newname)
708
bailout("wierd file state %r" % ((fs, fid),))
697
712
class ScratchBranch(Branch):