15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
22
import traceback, socket, fnmatch, difflib, time
23
from binascii import hexlify
21
from bzrlib.trace import mutter, note
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
23
sha_file, appendpath, file_kind
24
from bzrlib.errors import BzrError
26
from inventory import Inventory
27
from trace import mutter, note
28
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
29
from inventory import InventoryEntry, Inventory
30
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
31
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
32
joinpath, sha_string, file_kind
33
from store import ImmutableStore
34
from revision import Revision
35
from errors import bailout
36
from textui import show_status
37
from diff import diff_trees
26
39
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
40
## TODO: Maybe include checks for common corruption of newlines, etc?
31
def find_branch(f, **args):
32
if f and (f.startswith('http://') or f.startswith('https://')):
34
return remotebranch.RemoteBranch(f, **args)
36
return Branch(f, **args)
39
def find_cached_branch(f, cache_root, **args):
40
from remotebranch import RemoteBranch
41
br = find_branch(f, **args)
42
def cacheify(br, store_name):
43
from meta_store import CachedStore
44
cache_path = os.path.join(cache_root, store_name)
46
new_store = CachedStore(getattr(br, store_name), cache_path)
47
setattr(br, store_name, new_store)
49
if isinstance(br, RemoteBranch):
50
cacheify(br, 'inventory_store')
51
cacheify(br, 'text_store')
52
cacheify(br, 'revision_store')
56
def _relpath(base, path):
57
"""Return path relative to base, or raise exception.
59
The path may be either an absolute path or a path relative to the
60
current working directory.
62
Lifted out of Branch.relpath for ease of testing.
64
os.path.commonprefix (python2.4) has a bad bug that it works just
65
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
66
avoids that problem."""
67
rp = os.path.abspath(path)
71
while len(head) >= len(base):
74
head, tail = os.path.split(head)
78
from errors import NotBranchError
79
raise NotBranchError("path %r is not within branch %r" % (rp, base))
84
def find_branch_root(f=None):
85
"""Find the branch root enclosing f, or pwd.
87
f may be a filename or a URL.
89
It is not necessary that f exists.
91
Basically we keep looking up until we find the control directory or
95
elif hasattr(os.path, 'realpath'):
96
f = os.path.realpath(f)
98
f = os.path.abspath(f)
99
if not os.path.exists(f):
100
raise BzrError('%r does not exist' % f)
106
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
108
head, tail = os.path.split(f)
110
# reached the root, whatever that may be
111
raise BzrError('%r is not in a branch' % orig_f)
114
class DivergedBranches(Exception):
115
def __init__(self, branch1, branch2):
116
self.branch1 = branch1
117
self.branch2 = branch2
118
Exception.__init__(self, "These branches have diverged.")
121
class NoSuchRevision(BzrError):
122
def __init__(self, branch, revision):
124
self.revision = revision
125
msg = "Branch %s has no revision %d" % (branch, revision)
126
BzrError.__init__(self, msg)
129
46
######################################################################
132
class Branch(object):
133
50
"""Branch holding a history of revisions.
136
Base directory of the branch.
142
If _lock_mode is true, a positive count of the number of times the
146
Lock object from bzrlib.lock.
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.
153
def __init__(self, base, init=False, find_root=True):
65
def __init__(self, base, init=False):
154
66
"""Create new branch object at a particular location.
156
base -- Base directory for the branch.
158
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
159
71
unversioned directory. If False, the branch must already
162
find_root -- If true and init is false, find the root of the
163
existing branch containing base.
165
74
In the test suite, creation of new trees is tested using the
166
75
`ScratchBranch` class.
168
from bzrlib.store import ImmutableStore
77
self.base = os.path.realpath(base)
170
self.base = os.path.realpath(base)
171
79
self._make_control()
173
self.base = find_branch_root(base)
175
self.base = os.path.realpath(base)
176
81
if not isdir(self.controlfilename('.')):
177
from errors import NotBranchError
178
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
179
['use "bzr init" to initialize a new working tree',
180
'current bzr can only operate from top-of-tree'])
82
bailout("not a bzr branch: %s" % quotefn(base),
83
['use "bzr init" to initialize a new working tree',
84
'current bzr can only operate from top-of-tree'])
183
87
self.text_store = ImmutableStore(self.controlfilename('text-store'))
184
88
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
192
96
__repr__ = __str__
196
if self._lock_mode or self._lock:
197
from warnings import warn
198
warn("branch %r was not explicitly unlocked" % self)
203
def lock_write(self):
205
if self._lock_mode != 'w':
206
from errors import LockError
207
raise LockError("can't upgrade to a write lock from %r" %
209
self._lock_count += 1
211
from bzrlib.lock import WriteLock
213
self._lock = WriteLock(self.controlfilename('branch-lock'))
214
self._lock_mode = 'w'
221
assert self._lock_mode in ('r', 'w'), \
222
"invalid lock mode %r" % self._lock_mode
223
self._lock_count += 1
225
from bzrlib.lock import ReadLock
227
self._lock = ReadLock(self.controlfilename('branch-lock'))
228
self._lock_mode = 'r'
234
if not self._lock_mode:
235
from errors import LockError
236
raise LockError('branch %r is not locked' % (self))
238
if self._lock_count > 1:
239
self._lock_count -= 1
243
self._lock_mode = self._lock_count = None
246
def abspath(self, name):
247
"""Return absolute filename for something in the branch"""
100
"""Return filename relative to branch top"""
248
101
return os.path.join(self.base, name)
251
def relpath(self, path):
252
"""Return path relative to this branch of something inside it.
254
Raises an error if path is not in this branch."""
255
return _relpath(self.base, path)
258
104
def controlfilename(self, file_or_path):
259
105
"""Return location relative to branch."""
260
if isinstance(file_or_path, basestring):
106
if isinstance(file_or_path, types.StringTypes):
261
107
file_or_path = [file_or_path]
262
108
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
265
111
def controlfile(self, file_or_path, mode='r'):
266
"""Open a control file for this branch.
268
There are two classes of file in the control directory: text
269
and binary. binary files are untranslated byte streams. Text
270
control files are stored with Unix newlines and in UTF-8, even
271
if the platform or locale defaults are different.
273
Controlfiles should almost never be opened in write mode but
274
rather should be atomically copied and replaced using atomicfile.
277
fn = self.controlfilename(file_or_path)
279
if mode == 'rb' or mode == 'wb':
280
return file(fn, mode)
281
elif mode == 'r' or mode == 'w':
282
# open in binary mode anyhow so there's no newline translation;
283
# codecs uses line buffering by default; don't want that.
285
return codecs.open(fn, mode + 'b', 'utf-8',
288
raise BzrError("invalid controlfile mode %r" % mode)
112
"""Open a control file for this branch"""
113
return file(self.controlfilename(file_or_path), mode)
292
116
def _make_control(self):
293
from bzrlib.inventory import Inventory
294
from bzrlib.xml import pack_xml
296
117
os.mkdir(self.controlfilename([]))
297
118
self.controlfile('README', 'w').write(
298
119
"This is a Bazaar-NG control directory.\n"
299
"Do not change any files in this directory.\n")
120
"Do not change any files in this directory.")
300
121
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
301
122
for d in ('text-store', 'inventory-store', 'revision-store'):
302
123
os.mkdir(self.controlfilename(d))
303
124
for f in ('revision-history', 'merged-patches',
304
'pending-merged-patches', 'branch-name',
125
'pending-merged-patches', 'branch-name'):
306
126
self.controlfile(f, 'w').write('')
307
127
mutter('created control directory in ' + self.base)
309
pack_xml(Inventory(), self.controlfile('inventory','w'))
128
Inventory().write_xml(self.controlfile('inventory','w'))
312
131
def _check_format(self):
317
136
In the future, we might need different in-memory Branch
318
137
classes to support downlevel branches. But not yet.
320
# This ignores newlines so that we can open branches created
321
# on Windows from Linux and so on. I think it might be better
322
# to always make all internal files in unix format.
323
fmt = self.controlfile('branch-format', 'r').read()
324
fmt.replace('\r\n', '')
139
# read in binary mode to detect newline wierdness.
140
fmt = self.controlfile('branch-format', 'rb').read()
325
141
if fmt != BZR_BRANCH_FORMAT:
326
raise BzrError('sorry, branch format %r not supported' % fmt,
327
['use a different bzr version',
328
'or remove the .bzr directory and "bzr init" again'])
142
bailout('sorry, branch format %r not supported' % fmt,
143
['use a different bzr version',
144
'or remove the .bzr directory and "bzr init" again'])
332
147
def read_working_inventory(self):
333
148
"""Read the working inventory."""
334
from bzrlib.inventory import Inventory
335
from bzrlib.xml import unpack_xml
336
from time import time
340
# ElementTree does its own conversion from UTF-8, so open in
342
inv = unpack_xml(Inventory,
343
self.controlfile('inventory', 'rb'))
344
mutter("loaded inventory of %d items in %f"
345
% (len(inv), time() - before))
150
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
151
mutter("loaded inventory of %d items in %f"
152
% (len(inv), time.time() - before))
351
156
def _write_inventory(self, inv):
352
157
"""Update the working inventory.
354
159
That is to say, the inventory describing changes underway, that
355
160
will be committed to the next revision.
357
from bzrlib.atomicfile import AtomicFile
358
from bzrlib.xml import pack_xml
362
f = AtomicFile(self.controlfilename('inventory'), 'wb')
371
mutter('wrote working inventory')
162
inv.write_xml(self.controlfile('inventory', 'w'))
163
mutter('wrote inventory to %s' % quotefn(self.controlfilename('inventory')))
374
166
inventory = property(read_working_inventory, _write_inventory, None,
375
167
"""Inventory for the working copy.""")
378
def add(self, files, verbose=False, ids=None):
170
def add(self, files, verbose=False):
379
171
"""Make files versioned.
381
Note that the command line normally calls smart_add instead.
383
173
This puts the files in the Added state, so that they will be
384
174
recorded by the next commit.
387
List of paths to add, relative to the base of the tree.
390
If set, use these instead of automatically generated ids.
391
Must be the same length as the list of files, but may
392
contain None for ids that are to be autogenerated.
394
TODO: Perhaps have an option to add the ids even if the files do
397
TODO: Perhaps return the ids of the files? But then again it
398
is easy to retrieve them if they're needed.
400
TODO: Adding a directory should optionally recurse down and
401
add all non-ignored children. Perhaps do that in a
176
:todo: Perhaps have an option to add the ids even if the files do
179
:todo: Perhaps return the ids of the files? But then again it
180
is easy to retrieve them if they're needed.
182
:todo: Option to specify file id.
184
:todo: Adding a directory should optionally recurse down and
185
add all non-ignored children. Perhaps do that in a
188
>>> b = ScratchBranch(files=['foo'])
189
>>> 'foo' in b.unknowns()
194
>>> 'foo' in b.unknowns()
196
>>> bool(b.inventory.path2id('foo'))
202
Traceback (most recent call last):
204
BzrError: ('foo is already versioned', [])
206
>>> b.add(['nothere'])
207
Traceback (most recent call last):
208
BzrError: ('cannot add: not a regular file or directory: nothere', [])
404
from bzrlib.textui import show_status
405
211
# TODO: Re-adding a file that is removed in the working copy
406
212
# should probably put it back with the previous ID.
407
if isinstance(files, basestring):
408
assert(ids is None or isinstance(ids, basestring))
213
if isinstance(files, types.StringTypes):
414
ids = [None] * len(files)
416
assert(len(ids) == len(files))
420
inv = self.read_working_inventory()
421
for f,file_id in zip(files, ids):
422
if is_control_file(f):
423
raise BzrError("cannot add control file %s" % quotefn(f))
428
raise BzrError("cannot add top-level %r" % f)
430
fullpath = os.path.normpath(self.abspath(f))
433
kind = file_kind(fullpath)
435
# maybe something better?
436
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
438
if kind != 'file' and kind != 'directory':
439
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
442
file_id = gen_file_id(f)
443
inv.add_path(f, kind=kind, file_id=file_id)
446
print 'added', quotefn(f)
448
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
450
self._write_inventory(inv)
455
def print_file(self, file, revno):
456
"""Print `file` to stdout."""
459
tree = self.revision_tree(self.lookup_revision(revno))
460
# use inventory as it was in that revision
461
file_id = tree.inventory.path2id(file)
463
raise BzrError("%r is not present in revision %d" % (file, revno))
464
tree.print_file(file_id)
216
inv = self.read_working_inventory()
218
if is_control_file(f):
219
bailout("cannot add control file %s" % quotefn(f))
224
bailout("cannot add top-level %r" % f)
226
fullpath = os.path.normpath(self._rel(f))
230
elif isdir(fullpath):
233
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
236
parent_name = joinpath(fp[:-1])
237
mutter("lookup parent %r" % parent_name)
238
parent_id = inv.path2id(parent_name)
239
if parent_id == None:
240
bailout("cannot add: parent %r is not versioned"
245
file_id = _gen_file_id(fp[-1])
246
inv.add(InventoryEntry(file_id, fp[-1], kind=kind, parent_id=parent_id))
248
show_status('A', kind, quotefn(f))
250
mutter("add file %s file_id:{%s} kind=%r parent_id={%s}"
251
% (f, file_id, kind, parent_id))
252
self._write_inventory(inv)
469
256
def remove(self, files, verbose=False):
472
259
This does not remove their text. This does not run on
474
TODO: Refuse to remove modified files unless --force is given?
476
TODO: Do something useful with directories.
478
TODO: Should this remove the text or not? Tough call; not
261
:todo: Refuse to remove modified files unless --force is given?
263
>>> b = ScratchBranch(files=['foo'])
265
>>> b.inventory.has_filename('foo')
268
>>> b.working_tree().has_filename('foo')
270
>>> b.inventory.has_filename('foo')
273
>>> b = ScratchBranch(files=['foo'])
278
>>> b.inventory.has_filename('foo')
280
>>> b.basis_tree().has_filename('foo')
282
>>> b.working_tree().has_filename('foo')
285
:todo: Do something useful with directories.
287
:todo: Should this remove the text or not? Tough call; not
479
288
removing may be useful and the user can just use use rm, and
480
289
is the opposite of add. Removing it is consistent with most
481
290
other tools. Maybe an option.
483
from bzrlib.textui import show_status
484
292
## TODO: Normalize names
485
293
## TODO: Remove nested loops; better scalability
486
if isinstance(files, basestring):
295
if isinstance(files, types.StringTypes):
492
tree = self.working_tree()
495
# do this before any modifications
499
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
500
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
502
# having remove it, it must be either ignored or unknown
503
if tree.is_ignored(f):
507
show_status(new_status, inv[fid].kind, quotefn(f))
510
self._write_inventory(inv)
515
# FIXME: this doesn't need to be a branch method
516
def set_inventory(self, new_inventory_list):
517
from bzrlib.inventory import Inventory, InventoryEntry
519
for path, file_id, parent, kind in new_inventory_list:
520
name = os.path.basename(path)
523
inv.add(InventoryEntry(file_id, name, kind, parent))
298
inv = self.read_working_inventory()
300
# do this before any modifications
304
bailout("cannot remove unversioned file %s" % quotefn(f))
305
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
307
show_status('D', inv[fid].kind, quotefn(f))
524
310
self._write_inventory(inv)
543
329
return self.working_tree().unknowns()
546
def append_revision(self, revision_id):
547
from bzrlib.atomicfile import AtomicFile
549
mutter("add {%s} to revision-history" % revision_id)
550
rev_history = self.revision_history() + [revision_id]
552
f = AtomicFile(self.controlfilename('revision-history'))
554
for rev_id in rev_history:
332
def commit(self, message, timestamp=None, committer=None,
334
"""Commit working copy as a new revision.
336
The basic approach is to add all the file texts into the
337
store, then the inventory, then make a new revision pointing
338
to that inventory and store that.
340
This is not quite safe if the working copy changes during the
341
commit; for the moment that is simply not allowed. A better
342
approach is to make a temporary copy of the files before
343
computing their hashes, and then add those hashes in turn to
344
the inventory. This should mean at least that there are no
345
broken hash pointers. There is no way we can get a snapshot
346
of the whole directory at an instant. This would also have to
347
be robust against files disappearing, moving, etc. So the
348
whole thing is a bit hard.
350
:param timestamp: if not None, seconds-since-epoch for a
351
postdated/predated commit.
354
## TODO: Show branch names
356
# TODO: Don't commit if there are no changes, unless forced?
358
# First walk over the working inventory; and both update that
359
# and also build a new revision inventory. The revision
360
# inventory needs to hold the text-id, sha1 and size of the
361
# actual file versions committed in the revision. (These are
362
# not present in the working inventory.) We also need to
363
# detect missing/deleted files, and remove them from the
366
work_inv = self.read_working_inventory()
368
basis = self.basis_tree()
369
basis_inv = basis.inventory
371
for path, entry in work_inv.iter_entries():
372
## TODO: Cope with files that have gone missing.
374
## TODO: Check that the file kind has not changed from the previous
375
## revision of this file (if any).
380
file_id = entry.file_id
381
mutter('commit prep file %s, id %r ' % (p, file_id))
383
if not os.path.exists(p):
384
mutter(" file is missing, removing from inventory")
386
show_status('D', entry.kind, quotefn(path))
387
missing_ids.append(file_id)
390
# TODO: Handle files that have been deleted
392
# TODO: Maybe a special case for empty files? Seems a
393
# waste to store them many times.
397
if basis_inv.has_id(file_id):
398
old_kind = basis_inv[file_id].kind
399
if old_kind != entry.kind:
400
bailout("entry %r changed kind from %r to %r"
401
% (file_id, old_kind, entry.kind))
403
if entry.kind == 'directory':
405
bailout("%s is entered as directory but not a directory" % quotefn(p))
406
elif entry.kind == 'file':
408
bailout("%s is entered as file but is not a file" % quotefn(p))
410
content = file(p, 'rb').read()
412
entry.text_sha1 = sha_string(content)
413
entry.text_size = len(content)
415
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
417
and (old_ie.text_size == entry.text_size)
418
and (old_ie.text_sha1 == entry.text_sha1)):
419
## assert content == basis.get_file(file_id).read()
420
entry.text_id = basis_inv[file_id].text_id
421
mutter(' unchanged from previous text_id {%s}' %
425
entry.text_id = _gen_file_id(entry.name)
426
self.text_store.add(content, entry.text_id)
427
mutter(' stored with text_id {%s}' % entry.text_id)
431
elif (old_ie.name == entry.name
432
and old_ie.parent_id == entry.parent_id):
437
show_status(state, entry.kind, quotefn(path))
439
for file_id in missing_ids:
440
# have to do this later so we don't mess up the iterator.
441
# since parents may be removed before their children we
444
# FIXME: There's probably a better way to do this; perhaps
445
# the workingtree should know how to filter itself.
446
if work_inv.has_id(file_id):
447
del work_inv[file_id]
450
inv_id = rev_id = _gen_revision_id(time.time())
452
inv_tmp = tempfile.TemporaryFile()
453
inv.write_xml(inv_tmp)
455
self.inventory_store.add(inv_tmp, inv_id)
456
mutter('new inventory_id is {%s}' % inv_id)
458
self._write_inventory(work_inv)
460
if timestamp == None:
461
timestamp = time.time()
463
if committer == None:
464
committer = username()
466
mutter("building commit log message")
467
rev = Revision(timestamp=timestamp,
469
precursor = self.last_patch(),
474
rev_tmp = tempfile.TemporaryFile()
475
rev.write_xml(rev_tmp)
477
self.revision_store.add(rev_tmp, rev_id)
478
mutter("new revision_id is {%s}" % rev_id)
480
## XXX: Everything up to here can simply be orphaned if we abort
481
## the commit; it will leave junk files behind but that doesn't
484
## TODO: Read back the just-generated changeset, and make sure it
485
## applies and recreates the right state.
487
## TODO: Also calculate and store the inventory SHA1
488
mutter("committing patch r%d" % (self.revno() + 1))
490
mutter("append to revision-history")
491
self.controlfile('revision-history', 'at').write(rev_id + '\n')
561
496
def get_revision(self, revision_id):
562
497
"""Return the Revision object for a named revision"""
563
from bzrlib.revision import Revision
564
from bzrlib.xml import unpack_xml
568
if not revision_id or not isinstance(revision_id, basestring):
569
raise ValueError('invalid revision-id: %r' % revision_id)
570
r = unpack_xml(Revision, self.revision_store[revision_id])
498
r = Revision.read_xml(self.revision_store[revision_id])
574
499
assert r.revision_id == revision_id
578
def get_revision_sha1(self, revision_id):
579
"""Hash the stored value of a revision, and return it."""
580
# In the future, revision entries will be signed. At that
581
# point, it is probably best *not* to include the signature
582
# in the revision hash. Because that lets you re-sign
583
# the revision, (add signatures/remove signatures) and still
584
# have all hash pointers stay consistent.
585
# But for now, just hash the contents.
586
return sha_file(self.revision_store[revision_id])
589
503
def get_inventory(self, inventory_id):
590
504
"""Get Inventory object by hash.
592
TODO: Perhaps for this and similar methods, take a revision
506
:todo: Perhaps for this and similar methods, take a revision
593
507
parameter which can be either an integer revno or a
595
from bzrlib.inventory import Inventory
596
from bzrlib.xml import unpack_xml
598
return unpack_xml(Inventory, self.inventory_store[inventory_id])
601
def get_inventory_sha1(self, inventory_id):
602
"""Return the sha1 hash of the inventory entry
604
return sha_file(self.inventory_store[inventory_id])
509
i = Inventory.read_xml(self.inventory_store[inventory_id])
607
513
def get_revision_inventory(self, revision_id):
608
514
"""Return inventory of a past revision."""
609
515
if revision_id == None:
610
from bzrlib.inventory import Inventory
611
516
return Inventory()
613
518
return self.get_inventory(self.get_revision(revision_id).inventory_id)
619
524
>>> ScratchBranch().revision_history()
624
return [l.rstrip('\r\n') for l in
625
self.controlfile('revision-history', 'r').readlines()]
630
def common_ancestor(self, other, self_revno=None, other_revno=None):
633
>>> sb = ScratchBranch(files=['foo', 'foo~'])
634
>>> sb.common_ancestor(sb) == (None, None)
636
>>> commit.commit(sb, "Committing first revision", verbose=False)
637
>>> sb.common_ancestor(sb)[0]
639
>>> clone = sb.clone()
640
>>> commit.commit(sb, "Committing second revision", verbose=False)
641
>>> sb.common_ancestor(sb)[0]
643
>>> sb.common_ancestor(clone)[0]
645
>>> commit.commit(clone, "Committing divergent second revision",
647
>>> sb.common_ancestor(clone)[0]
649
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
651
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
653
>>> clone2 = sb.clone()
654
>>> sb.common_ancestor(clone2)[0]
656
>>> sb.common_ancestor(clone2, self_revno=1)[0]
658
>>> sb.common_ancestor(clone2, other_revno=1)[0]
661
my_history = self.revision_history()
662
other_history = other.revision_history()
663
if self_revno is None:
664
self_revno = len(my_history)
665
if other_revno is None:
666
other_revno = len(other_history)
667
indices = range(min((self_revno, other_revno)))
670
if my_history[r] == other_history[r]:
671
return r+1, my_history[r]
674
def enum_history(self, direction):
675
"""Return (revno, revision_id) for history of branch.
678
'forward' is from earliest to latest
679
'reverse' is from latest to earliest
681
rh = self.revision_history()
682
if direction == 'forward':
687
elif direction == 'reverse':
693
raise ValueError('invalid history direction', direction)
527
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
699
533
That is equivalent to the number of revisions committed to
536
>>> b = ScratchBranch()
539
>>> b.commit('no foo')
702
543
return len(self.revision_history())
705
546
def last_patch(self):
706
547
"""Return last patch hash, or None if no history.
549
>>> ScratchBranch().last_patch() == None
708
552
ph = self.revision_history()
715
def missing_revisions(self, other, stop_revision=None):
717
If self and other have not diverged, return a list of the revisions
718
present in other, but missing from self.
720
>>> from bzrlib.commit import commit
721
>>> bzrlib.trace.silent = True
722
>>> br1 = ScratchBranch()
723
>>> br2 = ScratchBranch()
724
>>> br1.missing_revisions(br2)
726
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
727
>>> br1.missing_revisions(br2)
729
>>> br2.missing_revisions(br1)
731
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
732
>>> br1.missing_revisions(br2)
734
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
735
>>> br1.missing_revisions(br2)
737
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
738
>>> br1.missing_revisions(br2)
739
Traceback (most recent call last):
740
DivergedBranches: These branches have diverged.
742
self_history = self.revision_history()
743
self_len = len(self_history)
744
other_history = other.revision_history()
745
other_len = len(other_history)
746
common_index = min(self_len, other_len) -1
747
if common_index >= 0 and \
748
self_history[common_index] != other_history[common_index]:
749
raise DivergedBranches(self, other)
751
if stop_revision is None:
752
stop_revision = other_len
753
elif stop_revision > other_len:
754
raise NoSuchRevision(self, stop_revision)
756
return other_history[self_len:stop_revision]
759
def update_revisions(self, other, stop_revision=None):
760
"""Pull in all new revisions from other branch.
762
>>> from bzrlib.commit import commit
763
>>> bzrlib.trace.silent = True
764
>>> br1 = ScratchBranch(files=['foo', 'bar'])
767
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
768
>>> br2 = ScratchBranch()
769
>>> br2.update_revisions(br1)
773
>>> br2.revision_history()
775
>>> br2.update_revisions(br1)
779
>>> br1.text_store.total_size() == br2.text_store.total_size()
782
from bzrlib.progress import ProgressBar
786
from sets import Set as set
790
pb.update('comparing histories')
791
revision_ids = self.missing_revisions(other, stop_revision)
793
if hasattr(other.revision_store, "prefetch"):
794
other.revision_store.prefetch(revision_ids)
795
if hasattr(other.inventory_store, "prefetch"):
796
inventory_ids = [other.get_revision(r).inventory_id
797
for r in revision_ids]
798
other.inventory_store.prefetch(inventory_ids)
803
for rev_id in revision_ids:
805
pb.update('fetching revision', i, len(revision_ids))
806
rev = other.get_revision(rev_id)
807
revisions.append(rev)
808
inv = other.get_inventory(str(rev.inventory_id))
809
for key, entry in inv.iter_entries():
810
if entry.text_id is None:
812
if entry.text_id not in self.text_store:
813
needed_texts.add(entry.text_id)
817
count = self.text_store.copy_multi(other.text_store, needed_texts)
818
print "Added %d texts." % count
819
inventory_ids = [ f.inventory_id for f in revisions ]
820
count = self.inventory_store.copy_multi(other.inventory_store,
822
print "Added %d inventories." % count
823
revision_ids = [ f.revision_id for f in revisions]
824
count = self.revision_store.copy_multi(other.revision_store,
826
for revision_id in revision_ids:
827
self.append_revision(revision_id)
828
print "Added %d revisions." % count
831
def commit(self, *args, **kw):
832
from bzrlib.commit import commit
833
commit(self, *args, **kw)
836
557
def lookup_revision(self, revno):
837
558
"""Return revision hash for revision number."""
883
def rename_one(self, from_rel, to_rel):
886
This can change the directory or the filename or both.
890
tree = self.working_tree()
892
if not tree.has_filename(from_rel):
893
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
894
if tree.has_filename(to_rel):
895
raise BzrError("can't rename: new working file %r already exists" % to_rel)
897
file_id = inv.path2id(from_rel)
899
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
901
if inv.path2id(to_rel):
902
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
904
to_dir, to_tail = os.path.split(to_rel)
905
to_dir_id = inv.path2id(to_dir)
906
if to_dir_id == None and to_dir != '':
907
raise BzrError("can't determine destination directory id for %r" % to_dir)
909
mutter("rename_one:")
910
mutter(" file_id {%s}" % file_id)
911
mutter(" from_rel %r" % from_rel)
912
mutter(" to_rel %r" % to_rel)
913
mutter(" to_dir %r" % to_dir)
914
mutter(" to_dir_id {%s}" % to_dir_id)
916
inv.rename(file_id, to_dir_id, to_tail)
918
print "%s => %s" % (from_rel, to_rel)
920
from_abs = self.abspath(from_rel)
921
to_abs = self.abspath(to_rel)
923
os.rename(from_abs, to_abs)
925
raise BzrError("failed to rename %r to %r: %s"
926
% (from_abs, to_abs, e[1]),
927
["rename rolled back"])
929
self._write_inventory(inv)
934
def move(self, from_paths, to_name):
937
to_name must exist as a versioned directory.
939
If to_name exists and is a directory, the files are moved into
940
it, keeping their old names. If it is a directory,
942
Note that to_name is only the last component of the new name;
943
this doesn't change the directory.
947
## TODO: Option to move IDs only
948
assert not isinstance(from_paths, basestring)
949
tree = self.working_tree()
951
to_abs = self.abspath(to_name)
952
if not isdir(to_abs):
953
raise BzrError("destination %r is not a directory" % to_abs)
954
if not tree.has_filename(to_name):
955
raise BzrError("destination %r not in working directory" % to_abs)
956
to_dir_id = inv.path2id(to_name)
957
if to_dir_id == None and to_name != '':
958
raise BzrError("destination %r is not a versioned directory" % to_name)
959
to_dir_ie = inv[to_dir_id]
960
if to_dir_ie.kind not in ('directory', 'root_directory'):
961
raise BzrError("destination %r is not a directory" % to_abs)
963
to_idpath = inv.get_idpath(to_dir_id)
966
if not tree.has_filename(f):
967
raise BzrError("%r does not exist in working tree" % f)
968
f_id = inv.path2id(f)
970
raise BzrError("%r is not versioned" % f)
971
name_tail = splitpath(f)[-1]
972
dest_path = appendpath(to_name, name_tail)
973
if tree.has_filename(dest_path):
974
raise BzrError("destination %r already exists" % dest_path)
975
if f_id in to_idpath:
976
raise BzrError("can't move %r to a subdirectory of itself" % f)
978
# OK, so there's a race here, it's possible that someone will
979
# create a file in this interval and then the rename might be
980
# left half-done. But we should have caught most problems.
983
name_tail = splitpath(f)[-1]
984
dest_path = appendpath(to_name, name_tail)
985
print "%s => %s" % (f, dest_path)
986
inv.rename(inv.path2id(f), to_dir_id, name_tail)
988
os.rename(self.abspath(f), self.abspath(dest_path))
990
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
991
["rename rolled back"])
993
self._write_inventory(inv)
998
def revert(self, filenames, old_tree=None, backups=True):
999
"""Restore selected files to the versions from a previous tree.
1002
If true (default) backups are made of files before
1005
from bzrlib.errors import NotVersionedError, BzrError
1006
from bzrlib.atomicfile import AtomicFile
1007
from bzrlib.osutils import backup_file
1009
inv = self.read_working_inventory()
1010
if old_tree is None:
1011
old_tree = self.basis_tree()
1012
old_inv = old_tree.inventory
1015
for fn in filenames:
1016
file_id = inv.path2id(fn)
1018
raise NotVersionedError("not a versioned file", fn)
1019
if not old_inv.has_id(file_id):
1020
raise BzrError("file not present in old tree", fn, file_id)
1021
nids.append((fn, file_id))
1023
# TODO: Rename back if it was previously at a different location
1025
# TODO: If given a directory, restore the entire contents from
1026
# the previous version.
1028
# TODO: Make a backup to a temporary file.
1030
# TODO: If the file previously didn't exist, delete it?
1031
for fn, file_id in nids:
1034
f = AtomicFile(fn, 'wb')
1036
f.write(old_tree.get_file(file_id).read())
610
def write_log(self, utc=False):
611
"""Write out human-readable log of commits to this branch
613
:param utc: If true, show dates in universal time, not local time."""
616
for p in self.revision_history():
618
print 'revno:', revno
619
## TODO: Show hash if --id is given.
620
##print 'revision-hash:', p
621
rev = self.get_revision(p)
622
print 'committer:', rev.committer
623
print 'timestamp: %s' % (format_date(rev.timestamp, utc))
625
## opportunistic consistency check, same as check_patch_chaining
626
if rev.precursor != precursor:
627
bailout("mismatched precursor!")
631
print ' (no message)'
633
for l in rev.message.split('\n'):
641
def show_status(branch, show_all=False):
642
"""Display single-line status for non-ignored working files.
644
The list is show sorted in order by file name.
646
>>> b = ScratchBranch(files=['foo', 'foo~'])
652
>>> b.commit("add foo")
655
:todo: Get state for single files.
657
:todo: Perhaps show a slash at the end of directory names.
661
# We have to build everything into a list first so that it can
662
# sorted by name, incorporating all the different sources.
664
# FIXME: Rather than getting things in random order and then sorting,
665
# just step through in order.
667
# Interesting case: the old ID for a file has been removed,
668
# but a new file has been created under that name.
670
old = branch.basis_tree()
671
old_inv = old.inventory
672
new = branch.working_tree()
673
new_inv = new.inventory
675
for fs, fid, oldname, newname, kind in diff_trees(old, new):
677
show_status(fs, kind,
678
oldname + ' => ' + newname)
679
elif fs == 'A' or fs == 'M':
680
show_status(fs, kind, newname)
682
show_status(fs, kind, oldname)
685
show_status(fs, kind, newname)
688
show_status(fs, kind, newname)
690
show_status(fs, kind, newname)
692
bailout("wierd file state %r" % ((fs, fid),))
1043
696
class ScratchBranch(Branch):
1047
700
>>> isdir(b.base)
1054
def __init__(self, files=[], dirs=[], base=None):
707
def __init__(self, files = []):
1055
708
"""Make a test branch.
1057
710
This creates a temporary directory and runs init-tree in it.
1059
712
If any files are listed, they are created in the working copy.
1061
from tempfile import mkdtemp
1066
Branch.__init__(self, base, init=init)
1068
os.mkdir(self.abspath(d))
714
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1071
716
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1076
>>> orig = ScratchBranch(files=["file1", "file2"])
1077
>>> clone = orig.clone()
1078
>>> os.path.samefile(orig.base, clone.base)
1080
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1083
from shutil import copytree
1084
from tempfile import mkdtemp
1087
copytree(self.base, base, symlinks=True)
1088
return ScratchBranch(base=base)
1090
719
def __del__(self):
1094
720
"""Destroy the test branch, removing the scratch directory."""
1095
from shutil import rmtree
1098
mutter("delete ScratchBranch %s" % self.base)
1101
# Work around for shutil.rmtree failing on Windows when
1102
# readonly files are encountered
1103
mutter("hit exception in destroying ScratchBranch: %s" % e)
1104
for root, dirs, files in os.walk(self.base, topdown=False):
1106
os.chmod(os.path.join(root, name), 0700)
721
shutil.rmtree(self.base)