15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
import traceback, socket, fnmatch, difflib, time
22
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
25
from inventory import Inventory
26
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
28
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout
35
from textui import show_status
36
from diff import diff_trees
26
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
39
## 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
43
def find_branch_root(f=None):
85
44
"""Find the branch root enclosing f, or pwd.
87
f may be a filename or a URL.
89
46
It is not necessary that f exists.
91
48
Basically we keep looking up until we find the control directory or
92
49
run into the root."""
95
52
elif hasattr(os.path, 'realpath'):
96
53
f = os.path.realpath(f)
98
55
f = os.path.abspath(f)
99
if not os.path.exists(f):
100
raise BzrError('%r does not exist' % f)
106
61
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
108
63
head, tail = os.path.split(f)
110
65
# reached the root, whatever that may be
111
raise BzrError('%r is not in a branch' % orig_f)
66
bailout('%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
71
######################################################################
132
class Branch(object):
133
75
"""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.
77
:todo: Perhaps use different stores for different classes of object,
78
so that we can keep track of how much space each one uses,
79
or garbage-collect them.
81
:todo: Add a RemoteBranch subclass. For the basic case of read-only
82
HTTP access this should be very easy by,
83
just redirecting controlfile access into HTTP requests.
84
We would need a RemoteStore working similarly.
86
:todo: Keep the on-disk branch locked while the object exists.
88
:todo: mkdir() method.
153
90
def __init__(self, base, init=False, find_root=True):
154
91
"""Create new branch object at a particular location.
156
base -- Base directory for the branch.
93
:param base: Base directory for the branch.
158
init -- If True, create new control files in a previously
95
:param init: If True, create new control files in a previously
159
96
unversioned directory. If False, the branch must already
162
find_root -- If true and init is false, find the root of the
99
:param find_root: If true and init is false, find the root of the
163
100
existing branch containing base.
165
102
In the test suite, creation of new trees is tested using the
166
103
`ScratchBranch` class.
168
from bzrlib.store import ImmutableStore
170
106
self.base = os.path.realpath(base)
171
107
self._make_control()
252
136
"""Return path relative to this branch of something inside it.
254
138
Raises an error if path is not in this branch."""
255
return _relpath(self.base, path)
139
rp = os.path.realpath(path)
141
if not rp.startswith(self.base):
142
bailout("path %r is not within branch %r" % (rp, self.base))
143
rp = rp[len(self.base):]
144
rp = rp.lstrip(os.sep)
258
148
def controlfilename(self, file_or_path):
259
149
"""Return location relative to branch."""
260
if isinstance(file_or_path, basestring):
150
if isinstance(file_or_path, types.StringTypes):
261
151
file_or_path = [file_or_path]
262
152
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
265
155
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)
156
"""Open a control file for this branch"""
157
return file(self.controlfilename(file_or_path), mode)
292
160
def _make_control(self):
293
from bzrlib.inventory import Inventory
294
from bzrlib.xml import pack_xml
296
161
os.mkdir(self.controlfilename([]))
297
162
self.controlfile('README', 'w').write(
298
163
"This is a Bazaar-NG control directory.\n"
299
"Do not change any files in this directory.\n")
164
"Do not change any files in this directory.")
300
165
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
301
166
for d in ('text-store', 'inventory-store', 'revision-store'):
302
167
os.mkdir(self.controlfilename(d))
303
168
for f in ('revision-history', 'merged-patches',
304
'pending-merged-patches', 'branch-name',
169
'pending-merged-patches', 'branch-name'):
307
170
self.controlfile(f, 'w').write('')
308
171
mutter('created control directory in ' + self.base)
310
pack_xml(Inventory(), self.controlfile('inventory','w'))
172
Inventory().write_xml(self.controlfile('inventory','w'))
313
175
def _check_format(self):
318
180
In the future, we might need different in-memory Branch
319
181
classes to support downlevel branches. But not yet.
321
# This ignores newlines so that we can open branches created
322
# on Windows from Linux and so on. I think it might be better
323
# to always make all internal files in unix format.
324
fmt = self.controlfile('branch-format', 'r').read()
325
fmt.replace('\r\n', '')
183
# read in binary mode to detect newline wierdness.
184
fmt = self.controlfile('branch-format', 'rb').read()
326
185
if fmt != BZR_BRANCH_FORMAT:
327
raise BzrError('sorry, branch format %r not supported' % fmt,
328
['use a different bzr version',
329
'or remove the .bzr directory and "bzr init" again'])
186
bailout('sorry, branch format %r not supported' % fmt,
187
['use a different bzr version',
188
'or remove the .bzr directory and "bzr init" again'])
333
191
def read_working_inventory(self):
334
192
"""Read the working inventory."""
335
from bzrlib.inventory import Inventory
336
from bzrlib.xml import unpack_xml
337
from time import time
341
# ElementTree does its own conversion from UTF-8, so open in
343
inv = unpack_xml(Inventory,
344
self.controlfile('inventory', 'rb'))
345
mutter("loaded inventory of %d items in %f"
346
% (len(inv), time() - before))
194
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
195
mutter("loaded inventory of %d items in %f"
196
% (len(inv), time.time() - before))
352
200
def _write_inventory(self, inv):
353
201
"""Update the working inventory.
355
203
That is to say, the inventory describing changes underway, that
356
204
will be committed to the next revision.
358
from bzrlib.atomicfile import AtomicFile
359
from bzrlib.xml import pack_xml
363
f = AtomicFile(self.controlfilename('inventory'), 'wb')
206
## TODO: factor out to atomicfile? is rename safe on windows?
207
## TODO: Maybe some kind of clean/dirty marker on inventory?
208
tmpfname = self.controlfilename('inventory.tmp')
209
tmpf = file(tmpfname, 'w')
212
os.rename(tmpfname, self.controlfilename('inventory'))
372
213
mutter('wrote working inventory')
375
216
inventory = property(read_working_inventory, _write_inventory, None,
376
217
"""Inventory for the working copy.""")
379
def add(self, files, verbose=False, ids=None):
220
def add(self, files, verbose=False):
380
221
"""Make files versioned.
382
Note that the command line normally calls smart_add instead.
384
223
This puts the files in the Added state, so that they will be
385
224
recorded by the next commit.
388
List of paths to add, relative to the base of the tree.
391
If set, use these instead of automatically generated ids.
392
Must be the same length as the list of files, but may
393
contain None for ids that are to be autogenerated.
395
TODO: Perhaps have an option to add the ids even if the files do
398
TODO: Perhaps return the ids of the files? But then again it
399
is easy to retrieve them if they're needed.
401
TODO: Adding a directory should optionally recurse down and
402
add all non-ignored children. Perhaps do that in a
226
:todo: Perhaps have an option to add the ids even if the files do
229
:todo: Perhaps return the ids of the files? But then again it
230
is easy to retrieve them if they're needed.
232
:todo: Option to specify file id.
234
:todo: Adding a directory should optionally recurse down and
235
add all non-ignored children. Perhaps do that in a
238
>>> b = ScratchBranch(files=['foo'])
239
>>> 'foo' in b.unknowns()
244
>>> 'foo' in b.unknowns()
246
>>> bool(b.inventory.path2id('foo'))
252
Traceback (most recent call last):
254
BzrError: ('foo is already versioned', [])
256
>>> b.add(['nothere'])
257
Traceback (most recent call last):
258
BzrError: ('cannot add: not a regular file or directory: nothere', [])
405
from bzrlib.textui import show_status
406
261
# TODO: Re-adding a file that is removed in the working copy
407
262
# should probably put it back with the previous ID.
408
if isinstance(files, basestring):
409
assert(ids is None or isinstance(ids, basestring))
263
if isinstance(files, types.StringTypes):
415
ids = [None] * len(files)
417
assert(len(ids) == len(files))
421
inv = self.read_working_inventory()
422
for f,file_id in zip(files, ids):
423
if is_control_file(f):
424
raise BzrError("cannot add control file %s" % quotefn(f))
429
raise BzrError("cannot add top-level %r" % f)
431
fullpath = os.path.normpath(self.abspath(f))
434
kind = file_kind(fullpath)
436
# maybe something better?
437
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
439
if kind != 'file' and kind != 'directory':
440
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
443
file_id = gen_file_id(f)
444
inv.add_path(f, kind=kind, file_id=file_id)
447
print 'added', quotefn(f)
449
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
451
self._write_inventory(inv)
456
def print_file(self, file, revno):
457
"""Print `file` to stdout."""
460
tree = self.revision_tree(self.lookup_revision(revno))
461
# use inventory as it was in that revision
462
file_id = tree.inventory.path2id(file)
464
raise BzrError("%r is not present in revision %d" % (file, revno))
465
tree.print_file(file_id)
266
inv = self.read_working_inventory()
268
if is_control_file(f):
269
bailout("cannot add control file %s" % quotefn(f))
274
bailout("cannot add top-level %r" % f)
276
fullpath = os.path.normpath(self.abspath(f))
279
kind = file_kind(fullpath)
281
# maybe something better?
282
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
284
if kind != 'file' and kind != 'directory':
285
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
287
file_id = gen_file_id(f)
288
inv.add_path(f, kind=kind, file_id=file_id)
291
show_status('A', kind, quotefn(f))
293
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
295
self._write_inventory(inv)
470
299
def remove(self, files, verbose=False):
473
302
This does not remove their text. This does not run on
475
TODO: Refuse to remove modified files unless --force is given?
477
TODO: Do something useful with directories.
479
TODO: Should this remove the text or not? Tough call; not
304
:todo: Refuse to remove modified files unless --force is given?
306
>>> b = ScratchBranch(files=['foo'])
308
>>> b.inventory.has_filename('foo')
311
>>> b.working_tree().has_filename('foo')
313
>>> b.inventory.has_filename('foo')
316
>>> b = ScratchBranch(files=['foo'])
321
>>> b.inventory.has_filename('foo')
323
>>> b.basis_tree().has_filename('foo')
325
>>> b.working_tree().has_filename('foo')
328
:todo: Do something useful with directories.
330
:todo: Should this remove the text or not? Tough call; not
480
331
removing may be useful and the user can just use use rm, and
481
332
is the opposite of add. Removing it is consistent with most
482
333
other tools. Maybe an option.
484
from bzrlib.textui import show_status
485
335
## TODO: Normalize names
486
336
## TODO: Remove nested loops; better scalability
487
if isinstance(files, basestring):
338
if isinstance(files, types.StringTypes):
493
tree = self.working_tree()
496
# do this before any modifications
500
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
501
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
503
# having remove it, it must be either ignored or unknown
504
if tree.is_ignored(f):
508
show_status(new_status, inv[fid].kind, quotefn(f))
511
self._write_inventory(inv)
516
# FIXME: this doesn't need to be a branch method
517
def set_inventory(self, new_inventory_list):
518
from bzrlib.inventory import Inventory, InventoryEntry
520
for path, file_id, parent, kind in new_inventory_list:
521
name = os.path.basename(path)
524
inv.add(InventoryEntry(file_id, name, kind, parent))
341
tree = self.working_tree()
344
# do this before any modifications
348
bailout("cannot remove unversioned file %s" % quotefn(f))
349
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
351
# having remove it, it must be either ignored or unknown
352
if tree.is_ignored(f):
356
show_status(new_status, inv[fid].kind, quotefn(f))
525
359
self._write_inventory(inv)
544
378
return self.working_tree().unknowns()
547
def append_revision(self, revision_id):
548
from bzrlib.atomicfile import AtomicFile
550
mutter("add {%s} to revision-history" % revision_id)
551
rev_history = self.revision_history() + [revision_id]
553
f = AtomicFile(self.controlfilename('revision-history'))
555
for rev_id in rev_history:
381
def commit(self, message, timestamp=None, timezone=None,
384
"""Commit working copy as a new revision.
386
The basic approach is to add all the file texts into the
387
store, then the inventory, then make a new revision pointing
388
to that inventory and store that.
390
This is not quite safe if the working copy changes during the
391
commit; for the moment that is simply not allowed. A better
392
approach is to make a temporary copy of the files before
393
computing their hashes, and then add those hashes in turn to
394
the inventory. This should mean at least that there are no
395
broken hash pointers. There is no way we can get a snapshot
396
of the whole directory at an instant. This would also have to
397
be robust against files disappearing, moving, etc. So the
398
whole thing is a bit hard.
400
:param timestamp: if not None, seconds-since-epoch for a
401
postdated/predated commit.
404
## TODO: Show branch names
406
# TODO: Don't commit if there are no changes, unless forced?
408
# First walk over the working inventory; and both update that
409
# and also build a new revision inventory. The revision
410
# inventory needs to hold the text-id, sha1 and size of the
411
# actual file versions committed in the revision. (These are
412
# not present in the working inventory.) We also need to
413
# detect missing/deleted files, and remove them from the
416
work_inv = self.read_working_inventory()
418
basis = self.basis_tree()
419
basis_inv = basis.inventory
421
for path, entry in work_inv.iter_entries():
422
## TODO: Cope with files that have gone missing.
424
## TODO: Check that the file kind has not changed from the previous
425
## revision of this file (if any).
429
p = self.abspath(path)
430
file_id = entry.file_id
431
mutter('commit prep file %s, id %r ' % (p, file_id))
433
if not os.path.exists(p):
434
mutter(" file is missing, removing from inventory")
436
show_status('D', entry.kind, quotefn(path))
437
missing_ids.append(file_id)
440
# TODO: Handle files that have been deleted
442
# TODO: Maybe a special case for empty files? Seems a
443
# waste to store them many times.
447
if basis_inv.has_id(file_id):
448
old_kind = basis_inv[file_id].kind
449
if old_kind != entry.kind:
450
bailout("entry %r changed kind from %r to %r"
451
% (file_id, old_kind, entry.kind))
453
if entry.kind == 'directory':
455
bailout("%s is entered as directory but not a directory" % quotefn(p))
456
elif entry.kind == 'file':
458
bailout("%s is entered as file but is not a file" % quotefn(p))
460
content = file(p, 'rb').read()
462
entry.text_sha1 = sha_string(content)
463
entry.text_size = len(content)
465
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
467
and (old_ie.text_size == entry.text_size)
468
and (old_ie.text_sha1 == entry.text_sha1)):
469
## assert content == basis.get_file(file_id).read()
470
entry.text_id = basis_inv[file_id].text_id
471
mutter(' unchanged from previous text_id {%s}' %
475
entry.text_id = gen_file_id(entry.name)
476
self.text_store.add(content, entry.text_id)
477
mutter(' stored with text_id {%s}' % entry.text_id)
481
elif (old_ie.name == entry.name
482
and old_ie.parent_id == entry.parent_id):
487
show_status(state, entry.kind, quotefn(path))
489
for file_id in missing_ids:
490
# have to do this later so we don't mess up the iterator.
491
# since parents may be removed before their children we
494
# FIXME: There's probably a better way to do this; perhaps
495
# the workingtree should know how to filter itself.
496
if work_inv.has_id(file_id):
497
del work_inv[file_id]
500
inv_id = rev_id = _gen_revision_id(time.time())
502
inv_tmp = tempfile.TemporaryFile()
503
inv.write_xml(inv_tmp)
505
self.inventory_store.add(inv_tmp, inv_id)
506
mutter('new inventory_id is {%s}' % inv_id)
508
self._write_inventory(work_inv)
510
if timestamp == None:
511
timestamp = time.time()
513
if committer == None:
514
committer = username()
517
timezone = local_time_offset()
519
mutter("building commit log message")
520
rev = Revision(timestamp=timestamp,
523
precursor = self.last_patch(),
528
rev_tmp = tempfile.TemporaryFile()
529
rev.write_xml(rev_tmp)
531
self.revision_store.add(rev_tmp, rev_id)
532
mutter("new revision_id is {%s}" % rev_id)
534
## XXX: Everything up to here can simply be orphaned if we abort
535
## the commit; it will leave junk files behind but that doesn't
538
## TODO: Read back the just-generated changeset, and make sure it
539
## applies and recreates the right state.
541
## TODO: Also calculate and store the inventory SHA1
542
mutter("committing patch r%d" % (self.revno() + 1))
544
mutter("append to revision-history")
545
f = self.controlfile('revision-history', 'at')
546
f.write(rev_id + '\n')
550
note("commited r%d" % self.revno())
562
553
def get_revision(self, revision_id):
563
554
"""Return the Revision object for a named revision"""
564
from bzrlib.revision import Revision
565
from bzrlib.xml import unpack_xml
569
if not revision_id or not isinstance(revision_id, basestring):
570
raise ValueError('invalid revision-id: %r' % revision_id)
571
r = unpack_xml(Revision, self.revision_store[revision_id])
555
r = Revision.read_xml(self.revision_store[revision_id])
575
556
assert r.revision_id == revision_id
579
def get_revision_sha1(self, revision_id):
580
"""Hash the stored value of a revision, and return it."""
581
# In the future, revision entries will be signed. At that
582
# point, it is probably best *not* to include the signature
583
# in the revision hash. Because that lets you re-sign
584
# the revision, (add signatures/remove signatures) and still
585
# have all hash pointers stay consistent.
586
# But for now, just hash the contents.
587
return sha_file(self.revision_store[revision_id])
590
560
def get_inventory(self, inventory_id):
591
561
"""Get Inventory object by hash.
593
TODO: Perhaps for this and similar methods, take a revision
563
:todo: Perhaps for this and similar methods, take a revision
594
564
parameter which can be either an integer revno or a
596
from bzrlib.inventory import Inventory
597
from bzrlib.xml import unpack_xml
599
return unpack_xml(Inventory, self.inventory_store[inventory_id])
602
def get_inventory_sha1(self, inventory_id):
603
"""Return the sha1 hash of the inventory entry
605
return sha_file(self.inventory_store[inventory_id])
566
i = Inventory.read_xml(self.inventory_store[inventory_id])
608
570
def get_revision_inventory(self, revision_id):
609
571
"""Return inventory of a past revision."""
610
572
if revision_id == None:
611
from bzrlib.inventory import Inventory
612
573
return Inventory()
614
575
return self.get_inventory(self.get_revision(revision_id).inventory_id)
620
581
>>> ScratchBranch().revision_history()
625
return [l.rstrip('\r\n') for l in
626
self.controlfile('revision-history', 'r').readlines()]
631
def common_ancestor(self, other, self_revno=None, other_revno=None):
634
>>> sb = ScratchBranch(files=['foo', 'foo~'])
635
>>> sb.common_ancestor(sb) == (None, None)
637
>>> commit.commit(sb, "Committing first revision", verbose=False)
638
>>> sb.common_ancestor(sb)[0]
640
>>> clone = sb.clone()
641
>>> commit.commit(sb, "Committing second revision", verbose=False)
642
>>> sb.common_ancestor(sb)[0]
644
>>> sb.common_ancestor(clone)[0]
646
>>> commit.commit(clone, "Committing divergent second revision",
648
>>> sb.common_ancestor(clone)[0]
650
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
652
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
654
>>> clone2 = sb.clone()
655
>>> sb.common_ancestor(clone2)[0]
657
>>> sb.common_ancestor(clone2, self_revno=1)[0]
659
>>> sb.common_ancestor(clone2, other_revno=1)[0]
662
my_history = self.revision_history()
663
other_history = other.revision_history()
664
if self_revno is None:
665
self_revno = len(my_history)
666
if other_revno is None:
667
other_revno = len(other_history)
668
indices = range(min((self_revno, other_revno)))
671
if my_history[r] == other_history[r]:
672
return r+1, my_history[r]
675
def enum_history(self, direction):
676
"""Return (revno, revision_id) for history of branch.
679
'forward' is from earliest to latest
680
'reverse' is from latest to earliest
682
rh = self.revision_history()
683
if direction == 'forward':
688
elif direction == 'reverse':
694
raise ValueError('invalid history direction', direction)
584
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
700
590
That is equivalent to the number of revisions committed to
593
>>> b = ScratchBranch()
596
>>> b.commit('no foo')
703
600
return len(self.revision_history())
706
603
def last_patch(self):
707
604
"""Return last patch hash, or None if no history.
606
>>> ScratchBranch().last_patch() == None
709
609
ph = self.revision_history()
716
def missing_revisions(self, other, stop_revision=None):
718
If self and other have not diverged, return a list of the revisions
719
present in other, but missing from self.
721
>>> from bzrlib.commit import commit
722
>>> bzrlib.trace.silent = True
723
>>> br1 = ScratchBranch()
724
>>> br2 = ScratchBranch()
725
>>> br1.missing_revisions(br2)
727
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
728
>>> br1.missing_revisions(br2)
730
>>> br2.missing_revisions(br1)
732
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
733
>>> br1.missing_revisions(br2)
735
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
736
>>> br1.missing_revisions(br2)
738
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
739
>>> br1.missing_revisions(br2)
740
Traceback (most recent call last):
741
DivergedBranches: These branches have diverged.
743
self_history = self.revision_history()
744
self_len = len(self_history)
745
other_history = other.revision_history()
746
other_len = len(other_history)
747
common_index = min(self_len, other_len) -1
748
if common_index >= 0 and \
749
self_history[common_index] != other_history[common_index]:
750
raise DivergedBranches(self, other)
752
if stop_revision is None:
753
stop_revision = other_len
754
elif stop_revision > other_len:
755
raise NoSuchRevision(self, stop_revision)
757
return other_history[self_len:stop_revision]
760
def update_revisions(self, other, stop_revision=None):
761
"""Pull in all new revisions from other branch.
763
>>> from bzrlib.commit import commit
764
>>> bzrlib.trace.silent = True
765
>>> br1 = ScratchBranch(files=['foo', 'bar'])
768
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
769
>>> br2 = ScratchBranch()
770
>>> br2.update_revisions(br1)
774
>>> br2.revision_history()
776
>>> br2.update_revisions(br1)
780
>>> br1.text_store.total_size() == br2.text_store.total_size()
783
from bzrlib.progress import ProgressBar
787
from sets import Set as set
791
pb.update('comparing histories')
792
revision_ids = self.missing_revisions(other, stop_revision)
794
if hasattr(other.revision_store, "prefetch"):
795
other.revision_store.prefetch(revision_ids)
796
if hasattr(other.inventory_store, "prefetch"):
797
inventory_ids = [other.get_revision(r).inventory_id
798
for r in revision_ids]
799
other.inventory_store.prefetch(inventory_ids)
804
for rev_id in revision_ids:
806
pb.update('fetching revision', i, len(revision_ids))
807
rev = other.get_revision(rev_id)
808
revisions.append(rev)
809
inv = other.get_inventory(str(rev.inventory_id))
810
for key, entry in inv.iter_entries():
811
if entry.text_id is None:
813
if entry.text_id not in self.text_store:
814
needed_texts.add(entry.text_id)
818
count = self.text_store.copy_multi(other.text_store, needed_texts)
819
print "Added %d texts." % count
820
inventory_ids = [ f.inventory_id for f in revisions ]
821
count = self.inventory_store.copy_multi(other.inventory_store,
823
print "Added %d inventories." % count
824
revision_ids = [ f.revision_id for f in revisions]
825
count = self.revision_store.copy_multi(other.revision_store,
827
for revision_id in revision_ids:
828
self.append_revision(revision_id)
829
print "Added %d revisions." % count
832
def commit(self, *args, **kw):
833
from bzrlib.commit import commit
834
commit(self, *args, **kw)
837
614
def lookup_revision(self, revno):
838
615
"""Return revision hash for revision number."""
884
def rename_one(self, from_rel, to_rel):
887
This can change the directory or the filename or both.
891
tree = self.working_tree()
893
if not tree.has_filename(from_rel):
894
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
895
if tree.has_filename(to_rel):
896
raise BzrError("can't rename: new working file %r already exists" % to_rel)
898
file_id = inv.path2id(from_rel)
900
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
902
if inv.path2id(to_rel):
903
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
905
to_dir, to_tail = os.path.split(to_rel)
906
to_dir_id = inv.path2id(to_dir)
907
if to_dir_id == None and to_dir != '':
908
raise BzrError("can't determine destination directory id for %r" % to_dir)
910
mutter("rename_one:")
911
mutter(" file_id {%s}" % file_id)
912
mutter(" from_rel %r" % from_rel)
913
mutter(" to_rel %r" % to_rel)
914
mutter(" to_dir %r" % to_dir)
915
mutter(" to_dir_id {%s}" % to_dir_id)
917
inv.rename(file_id, to_dir_id, to_tail)
919
print "%s => %s" % (from_rel, to_rel)
921
from_abs = self.abspath(from_rel)
922
to_abs = self.abspath(to_rel)
924
os.rename(from_abs, to_abs)
926
raise BzrError("failed to rename %r to %r: %s"
927
% (from_abs, to_abs, e[1]),
928
["rename rolled back"])
930
self._write_inventory(inv)
935
def move(self, from_paths, to_name):
938
to_name must exist as a versioned directory.
940
If to_name exists and is a directory, the files are moved into
941
it, keeping their old names. If it is a directory,
943
Note that to_name is only the last component of the new name;
944
this doesn't change the directory.
948
## TODO: Option to move IDs only
949
assert not isinstance(from_paths, basestring)
950
tree = self.working_tree()
952
to_abs = self.abspath(to_name)
953
if not isdir(to_abs):
954
raise BzrError("destination %r is not a directory" % to_abs)
955
if not tree.has_filename(to_name):
956
raise BzrError("destination %r not in working directory" % to_abs)
957
to_dir_id = inv.path2id(to_name)
958
if to_dir_id == None and to_name != '':
959
raise BzrError("destination %r is not a versioned directory" % to_name)
960
to_dir_ie = inv[to_dir_id]
961
if to_dir_ie.kind not in ('directory', 'root_directory'):
962
raise BzrError("destination %r is not a directory" % to_abs)
964
to_idpath = inv.get_idpath(to_dir_id)
967
if not tree.has_filename(f):
968
raise BzrError("%r does not exist in working tree" % f)
969
f_id = inv.path2id(f)
971
raise BzrError("%r is not versioned" % f)
972
name_tail = splitpath(f)[-1]
973
dest_path = appendpath(to_name, name_tail)
974
if tree.has_filename(dest_path):
975
raise BzrError("destination %r already exists" % dest_path)
976
if f_id in to_idpath:
977
raise BzrError("can't move %r to a subdirectory of itself" % f)
979
# OK, so there's a race here, it's possible that someone will
980
# create a file in this interval and then the rename might be
981
# left half-done. But we should have caught most problems.
984
name_tail = splitpath(f)[-1]
985
dest_path = appendpath(to_name, name_tail)
986
print "%s => %s" % (f, dest_path)
987
inv.rename(inv.path2id(f), to_dir_id, name_tail)
989
os.rename(self.abspath(f), self.abspath(dest_path))
991
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
992
["rename rolled back"])
994
self._write_inventory(inv)
999
def revert(self, filenames, old_tree=None, backups=True):
1000
"""Restore selected files to the versions from a previous tree.
1003
If true (default) backups are made of files before
1006
from bzrlib.errors import NotVersionedError, BzrError
1007
from bzrlib.atomicfile import AtomicFile
1008
from bzrlib.osutils import backup_file
667
def write_log(self, show_timezone='original'):
668
"""Write out human-readable log of commits to this branch
670
:param utc: If true, show dates in universal time, not local time."""
671
## TODO: Option to choose either original, utc or local timezone
674
for p in self.revision_history():
676
print 'revno:', revno
677
## TODO: Show hash if --id is given.
678
##print 'revision-hash:', p
679
rev = self.get_revision(p)
680
print 'committer:', rev.committer
681
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
684
## opportunistic consistency check, same as check_patch_chaining
685
if rev.precursor != precursor:
686
bailout("mismatched precursor!")
690
print ' (no message)'
692
for l in rev.message.split('\n'):
700
def show_status(branch, show_all=False):
701
"""Display single-line status for non-ignored working files.
703
The list is show sorted in order by file name.
705
>>> b = ScratchBranch(files=['foo', 'foo~'])
711
>>> b.commit("add foo")
713
>>> os.unlink(b.abspath('foo'))
1010
inv = self.read_working_inventory()
1011
if old_tree is None:
1012
old_tree = self.basis_tree()
1013
old_inv = old_tree.inventory
1016
for fn in filenames:
1017
file_id = inv.path2id(fn)
1019
raise NotVersionedError("not a versioned file", fn)
1020
if not old_inv.has_id(file_id):
1021
raise BzrError("file not present in old tree", fn, file_id)
1022
nids.append((fn, file_id))
1024
# TODO: Rename back if it was previously at a different location
1026
# TODO: If given a directory, restore the entire contents from
1027
# the previous version.
1029
# TODO: Make a backup to a temporary file.
1031
# TODO: If the file previously didn't exist, delete it?
1032
for fn, file_id in nids:
1035
f = AtomicFile(fn, 'wb')
1037
f.write(old_tree.get_file(file_id).read())
1043
def pending_merges(self):
1044
"""Return a list of pending merges.
1046
These are revisions that have been merged into the working
1047
directory but not yet committed.
718
:todo: Get state for single files.
720
:todo: Perhaps show a slash at the end of directory names.
1049
cfn = self.controlfilename('pending-merges')
1050
if not os.path.exists(cfn):
1053
for l in self.controlfile('pending-merges', 'r').readlines():
1054
p.append(l.rstrip('\n'))
1058
def add_pending_merge(self, revision_id):
1059
from bzrlib.revision import validate_revision_id
1061
validate_revision_id(revision_id)
1063
p = self.pending_merges()
1064
if revision_id in p:
1066
p.append(revision_id)
1067
self.set_pending_merges(p)
1070
def set_pending_merges(self, rev_list):
1071
from bzrlib.atomicfile import AtomicFile
1074
f = AtomicFile(self.controlfilename('pending-merges'))
724
# We have to build everything into a list first so that it can
725
# sorted by name, incorporating all the different sources.
727
# FIXME: Rather than getting things in random order and then sorting,
728
# just step through in order.
730
# Interesting case: the old ID for a file has been removed,
731
# but a new file has been created under that name.
733
old = branch.basis_tree()
734
old_inv = old.inventory
735
new = branch.working_tree()
736
new_inv = new.inventory
738
for fs, fid, oldname, newname, kind in diff_trees(old, new):
740
show_status(fs, kind,
741
oldname + ' => ' + newname)
742
elif fs == 'A' or fs == 'M':
743
show_status(fs, kind, newname)
745
show_status(fs, kind, oldname)
748
show_status(fs, kind, newname)
751
show_status(fs, kind, newname)
753
show_status(fs, kind, newname)
755
bailout("wierd file state %r" % ((fs, fid),))
1086
759
class ScratchBranch(Branch):