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
22
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
sha_file, appendpath, file_kind
26
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
28
from bzrlib.textui import show_status
29
from bzrlib.revision import Revision
30
from bzrlib.xml import unpack_xml
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
33
from bzrlib.progress import ProgressBar
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, appendpath
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout, BzrError
35
from textui import show_status
36
from diff import diff_trees
36
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
37
39
## TODO: Maybe include checks for common corruption of newlines, etc?
40
# TODO: Some operations like log might retrieve the same revisions
41
# repeatedly to calculate deltas. We could perhaps have a weakref
42
# cache in memory to make this faster.
44
# TODO: please move the revision-string syntax stuff out of the branch
45
# object; it's clutter
48
def find_branch(f, **args):
49
if f and (f.startswith('http://') or f.startswith('https://')):
51
return remotebranch.RemoteBranch(f, **args)
53
return Branch(f, **args)
56
def find_cached_branch(f, cache_root, **args):
57
from remotebranch import RemoteBranch
58
br = find_branch(f, **args)
59
def cacheify(br, store_name):
60
from meta_store import CachedStore
61
cache_path = os.path.join(cache_root, store_name)
63
new_store = CachedStore(getattr(br, store_name), cache_path)
64
setattr(br, store_name, new_store)
66
if isinstance(br, RemoteBranch):
67
cacheify(br, 'inventory_store')
68
cacheify(br, 'text_store')
69
cacheify(br, 'revision_store')
73
def _relpath(base, path):
74
"""Return path relative to base, or raise exception.
76
The path may be either an absolute path or a path relative to the
77
current working directory.
79
Lifted out of Branch.relpath for ease of testing.
81
os.path.commonprefix (python2.4) has a bad bug that it works just
82
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
83
avoids that problem."""
84
rp = os.path.abspath(path)
88
while len(head) >= len(base):
91
head, tail = os.path.split(head)
95
from errors import NotBranchError
96
raise NotBranchError("path %r is not within branch %r" % (rp, base))
101
43
def find_branch_root(f=None):
102
44
"""Find the branch root enclosing f, or pwd.
104
f may be a filename or a URL.
106
46
It is not necessary that f exists.
108
48
Basically we keep looking up until we find the control directory or
128
65
raise BzrError('%r is not in a branch' % orig_f)
131
class DivergedBranches(Exception):
132
def __init__(self, branch1, branch2):
133
self.branch1 = branch1
134
self.branch2 = branch2
135
Exception.__init__(self, "These branches have diverged.")
138
70
######################################################################
141
class Branch(object):
142
74
"""Branch holding a history of revisions.
145
Base directory of the branch.
151
If _lock_mode is true, a positive count of the number of times the
155
Lock object from bzrlib.lock.
76
:todo: Perhaps use different stores for different classes of object,
77
so that we can keep track of how much space each one uses,
78
or garbage-collect them.
80
:todo: Add a RemoteBranch subclass. For the basic case of read-only
81
HTTP access this should be very easy by,
82
just redirecting controlfile access into HTTP requests.
83
We would need a RemoteStore working similarly.
85
:todo: Keep the on-disk branch locked while the object exists.
87
:todo: mkdir() method.
162
# Map some sort of prefix into a namespace
163
# stuff like "revno:10", "revid:", etc.
164
# This should match a prefix with a function which accepts
165
REVISION_NAMESPACES = {}
167
89
def __init__(self, base, init=False, find_root=True):
168
90
"""Create new branch object at a particular location.
170
base -- Base directory for the branch.
92
:param base: Base directory for the branch.
172
init -- If True, create new control files in a previously
94
:param init: If True, create new control files in a previously
173
95
unversioned directory. If False, the branch must already
176
find_root -- If true and init is false, find the root of the
98
:param find_root: If true and init is false, find the root of the
177
99
existing branch containing base.
179
101
In the test suite, creation of new trees is tested using the
180
102
`ScratchBranch` class.
182
from bzrlib.store import ImmutableStore
184
105
self.base = os.path.realpath(base)
185
106
self._make_control()
266
135
"""Return path relative to this branch of something inside it.
268
137
Raises an error if path is not in this branch."""
269
return _relpath(self.base, path)
138
rp = os.path.realpath(path)
140
if not rp.startswith(self.base):
141
bailout("path %r is not within branch %r" % (rp, self.base))
142
rp = rp[len(self.base):]
143
rp = rp.lstrip(os.sep)
272
147
def controlfilename(self, file_or_path):
273
148
"""Return location relative to branch."""
274
if isinstance(file_or_path, basestring):
149
if isinstance(file_or_path, types.StringTypes):
275
150
file_or_path = [file_or_path]
276
151
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
279
154
def controlfile(self, file_or_path, mode='r'):
280
"""Open a control file for this branch.
282
There are two classes of file in the control directory: text
283
and binary. binary files are untranslated byte streams. Text
284
control files are stored with Unix newlines and in UTF-8, even
285
if the platform or locale defaults are different.
287
Controlfiles should almost never be opened in write mode but
288
rather should be atomically copied and replaced using atomicfile.
291
fn = self.controlfilename(file_or_path)
293
if mode == 'rb' or mode == 'wb':
294
return file(fn, mode)
295
elif mode == 'r' or mode == 'w':
296
# open in binary mode anyhow so there's no newline translation;
297
# codecs uses line buffering by default; don't want that.
299
return codecs.open(fn, mode + 'b', 'utf-8',
302
raise BzrError("invalid controlfile mode %r" % mode)
155
"""Open a control file for this branch"""
156
return file(self.controlfilename(file_or_path), mode)
306
159
def _make_control(self):
307
from bzrlib.inventory import Inventory
308
from bzrlib.xml import pack_xml
310
160
os.mkdir(self.controlfilename([]))
311
161
self.controlfile('README', 'w').write(
312
162
"This is a Bazaar-NG control directory.\n"
313
"Do not change any files in this directory.\n")
314
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
163
"Do not change any files in this directory.")
164
self.controlfile('branch-format', 'wb').write(BZR_BRANCH_FORMAT)
315
165
for d in ('text-store', 'inventory-store', 'revision-store'):
316
166
os.mkdir(self.controlfilename(d))
317
167
for f in ('revision-history', 'merged-patches',
318
'pending-merged-patches', 'branch-name',
168
'pending-merged-patches', 'branch-name'):
321
169
self.controlfile(f, 'w').write('')
322
170
mutter('created control directory in ' + self.base)
324
# if we want per-tree root ids then this is the place to set
325
# them; they're not needed for now and so ommitted for
327
pack_xml(Inventory(), self.controlfile('inventory','w'))
171
Inventory().write_xml(self.controlfile('inventory','w'))
330
174
def _check_format(self):
338
182
# This ignores newlines so that we can open branches created
339
183
# on Windows from Linux and so on. I think it might be better
340
184
# to always make all internal files in unix format.
341
fmt = self.controlfile('branch-format', 'r').read()
185
fmt = self.controlfile('branch-format', 'rb').read()
342
186
fmt.replace('\r\n', '')
343
187
if fmt != BZR_BRANCH_FORMAT:
344
raise BzrError('sorry, branch format %r not supported' % fmt,
345
['use a different bzr version',
346
'or remove the .bzr directory and "bzr init" again'])
348
def get_root_id(self):
349
"""Return the id of this branches root"""
350
inv = self.read_working_inventory()
351
return inv.root.file_id
353
def set_root_id(self, file_id):
354
inv = self.read_working_inventory()
355
orig_root_id = inv.root.file_id
356
del inv._byid[inv.root.file_id]
357
inv.root.file_id = file_id
358
inv._byid[inv.root.file_id] = inv.root
361
if entry.parent_id in (None, orig_root_id):
362
entry.parent_id = inv.root.file_id
363
self._write_inventory(inv)
188
bailout('sorry, branch format %r not supported' % fmt,
189
['use a different bzr version',
190
'or remove the .bzr directory and "bzr init" again'])
365
193
def read_working_inventory(self):
366
194
"""Read the working inventory."""
367
from bzrlib.inventory import Inventory
368
from bzrlib.xml import unpack_xml
369
from time import time
373
# ElementTree does its own conversion from UTF-8, so open in
375
inv = unpack_xml(Inventory,
376
self.controlfile('inventory', 'rb'))
377
mutter("loaded inventory of %d items in %f"
378
% (len(inv), time() - before))
196
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
197
mutter("loaded inventory of %d items in %f"
198
% (len(inv), time.time() - before))
384
202
def _write_inventory(self, inv):
385
203
"""Update the working inventory.
387
205
That is to say, the inventory describing changes underway, that
388
206
will be committed to the next revision.
390
from bzrlib.atomicfile import AtomicFile
391
from bzrlib.xml import pack_xml
395
f = AtomicFile(self.controlfilename('inventory'), 'wb')
208
## TODO: factor out to atomicfile? is rename safe on windows?
209
## TODO: Maybe some kind of clean/dirty marker on inventory?
210
tmpfname = self.controlfilename('inventory.tmp')
211
tmpf = file(tmpfname, 'w')
214
inv_fname = self.controlfilename('inventory')
215
if sys.platform == 'win32':
217
os.rename(tmpfname, inv_fname)
404
218
mutter('wrote working inventory')
407
221
inventory = property(read_working_inventory, _write_inventory, None,
408
222
"""Inventory for the working copy.""")
411
def add(self, files, verbose=False, ids=None):
225
def add(self, files, verbose=False):
412
226
"""Make files versioned.
414
Note that the command line normally calls smart_add instead.
416
228
This puts the files in the Added state, so that they will be
417
229
recorded by the next commit.
420
List of paths to add, relative to the base of the tree.
423
If set, use these instead of automatically generated ids.
424
Must be the same length as the list of files, but may
425
contain None for ids that are to be autogenerated.
427
TODO: Perhaps have an option to add the ids even if the files do
430
TODO: Perhaps return the ids of the files? But then again it
431
is easy to retrieve them if they're needed.
433
TODO: Adding a directory should optionally recurse down and
434
add all non-ignored children. Perhaps do that in a
231
:todo: Perhaps have an option to add the ids even if the files do
234
:todo: Perhaps return the ids of the files? But then again it
235
is easy to retrieve them if they're needed.
237
:todo: Option to specify file id.
239
:todo: Adding a directory should optionally recurse down and
240
add all non-ignored children. Perhaps do that in a
243
>>> b = ScratchBranch(files=['foo'])
244
>>> 'foo' in b.unknowns()
249
>>> 'foo' in b.unknowns()
251
>>> bool(b.inventory.path2id('foo'))
257
Traceback (most recent call last):
259
BzrError: ('foo is already versioned', [])
261
>>> b.add(['nothere'])
262
Traceback (most recent call last):
263
BzrError: ('cannot add: not a regular file or directory: nothere', [])
437
266
# TODO: Re-adding a file that is removed in the working copy
438
267
# should probably put it back with the previous ID.
439
if isinstance(files, basestring):
440
assert(ids is None or isinstance(ids, basestring))
268
if isinstance(files, types.StringTypes):
446
ids = [None] * len(files)
448
assert(len(ids) == len(files))
452
inv = self.read_working_inventory()
453
for f,file_id in zip(files, ids):
454
if is_control_file(f):
455
raise BzrError("cannot add control file %s" % quotefn(f))
460
raise BzrError("cannot add top-level %r" % f)
462
fullpath = os.path.normpath(self.abspath(f))
465
kind = file_kind(fullpath)
467
# maybe something better?
468
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
470
if kind != 'file' and kind != 'directory':
471
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
474
file_id = gen_file_id(f)
475
inv.add_path(f, kind=kind, file_id=file_id)
478
print 'added', quotefn(f)
480
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
482
self._write_inventory(inv)
271
inv = self.read_working_inventory()
273
if is_control_file(f):
274
bailout("cannot add control file %s" % quotefn(f))
279
bailout("cannot add top-level %r" % f)
281
fullpath = os.path.normpath(self.abspath(f))
284
kind = file_kind(fullpath)
286
# maybe something better?
287
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
289
if kind != 'file' and kind != 'directory':
290
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
292
file_id = gen_file_id(f)
293
inv.add_path(f, kind=kind, file_id=file_id)
296
show_status('A', kind, quotefn(f))
298
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
300
self._write_inventory(inv)
487
303
def print_file(self, file, revno):
488
304
"""Print `file` to stdout."""
491
tree = self.revision_tree(self.lookup_revision(revno))
492
# use inventory as it was in that revision
493
file_id = tree.inventory.path2id(file)
495
raise BzrError("%r is not present in revision %s" % (file, revno))
496
tree.print_file(file_id)
305
tree = self.revision_tree(self.lookup_revision(revno))
306
# use inventory as it was in that revision
307
file_id = tree.inventory.path2id(file)
309
bailout("%r is not present in revision %d" % (file, revno))
310
tree.print_file(file_id)
501
313
def remove(self, files, verbose=False):
502
314
"""Mark nominated files for removal from the inventory.
504
316
This does not remove their text. This does not run on
506
TODO: Refuse to remove modified files unless --force is given?
508
TODO: Do something useful with directories.
510
TODO: Should this remove the text or not? Tough call; not
318
:todo: Refuse to remove modified files unless --force is given?
320
>>> b = ScratchBranch(files=['foo'])
322
>>> b.inventory.has_filename('foo')
325
>>> b.working_tree().has_filename('foo')
327
>>> b.inventory.has_filename('foo')
330
>>> b = ScratchBranch(files=['foo'])
335
>>> b.inventory.has_filename('foo')
337
>>> b.basis_tree().has_filename('foo')
339
>>> b.working_tree().has_filename('foo')
342
:todo: Do something useful with directories.
344
:todo: Should this remove the text or not? Tough call; not
511
345
removing may be useful and the user can just use use rm, and
512
346
is the opposite of add. Removing it is consistent with most
513
347
other tools. Maybe an option.
515
349
## TODO: Normalize names
516
350
## TODO: Remove nested loops; better scalability
517
if isinstance(files, basestring):
352
if isinstance(files, types.StringTypes):
523
tree = self.working_tree()
526
# do this before any modifications
530
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
531
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
533
# having remove it, it must be either ignored or unknown
534
if tree.is_ignored(f):
538
show_status(new_status, inv[fid].kind, quotefn(f))
541
self._write_inventory(inv)
546
# FIXME: this doesn't need to be a branch method
547
def set_inventory(self, new_inventory_list):
548
from bzrlib.inventory import Inventory, InventoryEntry
549
inv = Inventory(self.get_root_id())
550
for path, file_id, parent, kind in new_inventory_list:
551
name = os.path.basename(path)
554
inv.add(InventoryEntry(file_id, name, kind, parent))
355
tree = self.working_tree()
358
# do this before any modifications
362
bailout("cannot remove unversioned file %s" % quotefn(f))
363
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
365
# having remove it, it must be either ignored or unknown
366
if tree.is_ignored(f):
370
show_status(new_status, inv[fid].kind, quotefn(f))
555
373
self._write_inventory(inv)
574
392
return self.working_tree().unknowns()
577
def append_revision(self, *revision_ids):
578
from bzrlib.atomicfile import AtomicFile
580
for revision_id in revision_ids:
581
mutter("add {%s} to revision-history" % revision_id)
583
rev_history = self.revision_history()
584
rev_history.extend(revision_ids)
586
f = AtomicFile(self.controlfilename('revision-history'))
588
for rev_id in rev_history:
595
def get_revision_xml(self, revision_id):
596
"""Return XML file object for revision object."""
597
if not revision_id or not isinstance(revision_id, basestring):
598
raise InvalidRevisionId(revision_id)
603
return self.revision_store[revision_id]
605
raise bzrlib.errors.NoSuchRevision(self, revision_id)
395
def commit(self, message, timestamp=None, timezone=None,
398
"""Commit working copy as a new revision.
400
The basic approach is to add all the file texts into the
401
store, then the inventory, then make a new revision pointing
402
to that inventory and store that.
404
This is not quite safe if the working copy changes during the
405
commit; for the moment that is simply not allowed. A better
406
approach is to make a temporary copy of the files before
407
computing their hashes, and then add those hashes in turn to
408
the inventory. This should mean at least that there are no
409
broken hash pointers. There is no way we can get a snapshot
410
of the whole directory at an instant. This would also have to
411
be robust against files disappearing, moving, etc. So the
412
whole thing is a bit hard.
414
:param timestamp: if not None, seconds-since-epoch for a
415
postdated/predated commit.
418
## TODO: Show branch names
420
# TODO: Don't commit if there are no changes, unless forced?
422
# First walk over the working inventory; and both update that
423
# and also build a new revision inventory. The revision
424
# inventory needs to hold the text-id, sha1 and size of the
425
# actual file versions committed in the revision. (These are
426
# not present in the working inventory.) We also need to
427
# detect missing/deleted files, and remove them from the
430
work_inv = self.read_working_inventory()
432
basis = self.basis_tree()
433
basis_inv = basis.inventory
435
for path, entry in work_inv.iter_entries():
436
## TODO: Cope with files that have gone missing.
438
## TODO: Check that the file kind has not changed from the previous
439
## revision of this file (if any).
443
p = self.abspath(path)
444
file_id = entry.file_id
445
mutter('commit prep file %s, id %r ' % (p, file_id))
447
if not os.path.exists(p):
448
mutter(" file is missing, removing from inventory")
450
show_status('D', entry.kind, quotefn(path))
451
missing_ids.append(file_id)
454
# TODO: Handle files that have been deleted
456
# TODO: Maybe a special case for empty files? Seems a
457
# waste to store them many times.
461
if basis_inv.has_id(file_id):
462
old_kind = basis_inv[file_id].kind
463
if old_kind != entry.kind:
464
bailout("entry %r changed kind from %r to %r"
465
% (file_id, old_kind, entry.kind))
467
if entry.kind == 'directory':
469
bailout("%s is entered as directory but not a directory" % quotefn(p))
470
elif entry.kind == 'file':
472
bailout("%s is entered as file but is not a file" % quotefn(p))
474
content = file(p, 'rb').read()
476
entry.text_sha1 = sha_string(content)
477
entry.text_size = len(content)
479
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
481
and (old_ie.text_size == entry.text_size)
482
and (old_ie.text_sha1 == entry.text_sha1)):
483
## assert content == basis.get_file(file_id).read()
484
entry.text_id = basis_inv[file_id].text_id
485
mutter(' unchanged from previous text_id {%s}' %
489
entry.text_id = gen_file_id(entry.name)
490
self.text_store.add(content, entry.text_id)
491
mutter(' stored with text_id {%s}' % entry.text_id)
495
elif (old_ie.name == entry.name
496
and old_ie.parent_id == entry.parent_id):
501
show_status(state, entry.kind, quotefn(path))
503
for file_id in missing_ids:
504
# have to do this later so we don't mess up the iterator.
505
# since parents may be removed before their children we
508
# FIXME: There's probably a better way to do this; perhaps
509
# the workingtree should know how to filter itself.
510
if work_inv.has_id(file_id):
511
del work_inv[file_id]
514
inv_id = rev_id = _gen_revision_id(time.time())
516
inv_tmp = tempfile.TemporaryFile()
517
inv.write_xml(inv_tmp)
519
self.inventory_store.add(inv_tmp, inv_id)
520
mutter('new inventory_id is {%s}' % inv_id)
522
self._write_inventory(work_inv)
524
if timestamp == None:
525
timestamp = time.time()
527
if committer == None:
528
committer = username()
531
timezone = local_time_offset()
533
mutter("building commit log message")
534
rev = Revision(timestamp=timestamp,
537
precursor = self.last_patch(),
542
rev_tmp = tempfile.TemporaryFile()
543
rev.write_xml(rev_tmp)
545
self.revision_store.add(rev_tmp, rev_id)
546
mutter("new revision_id is {%s}" % rev_id)
548
## XXX: Everything up to here can simply be orphaned if we abort
549
## the commit; it will leave junk files behind but that doesn't
552
## TODO: Read back the just-generated changeset, and make sure it
553
## applies and recreates the right state.
555
## TODO: Also calculate and store the inventory SHA1
556
mutter("committing patch r%d" % (self.revno() + 1))
558
mutter("append to revision-history")
559
f = self.controlfile('revision-history', 'at')
560
f.write(rev_id + '\n')
564
note("commited r%d" % self.revno())
610
567
def get_revision(self, revision_id):
611
568
"""Return the Revision object for a named revision"""
612
xml_file = self.get_revision_xml(revision_id)
615
r = unpack_xml(Revision, xml_file)
616
except SyntaxError, e:
617
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
569
r = Revision.read_xml(self.revision_store[revision_id])
621
570
assert r.revision_id == revision_id
625
def get_revision_delta(self, revno):
626
"""Return the delta for one revision.
628
The delta is relative to its mainline predecessor, or the
629
empty tree for revision 1.
631
assert isinstance(revno, int)
632
rh = self.revision_history()
633
if not (1 <= revno <= len(rh)):
634
raise InvalidRevisionNumber(revno)
636
# revno is 1-based; list is 0-based
638
new_tree = self.revision_tree(rh[revno-1])
640
old_tree = EmptyTree()
642
old_tree = self.revision_tree(rh[revno-2])
644
return compare_trees(old_tree, new_tree)
648
def get_revision_sha1(self, revision_id):
649
"""Hash the stored value of a revision, and return it."""
650
# In the future, revision entries will be signed. At that
651
# point, it is probably best *not* to include the signature
652
# in the revision hash. Because that lets you re-sign
653
# the revision, (add signatures/remove signatures) and still
654
# have all hash pointers stay consistent.
655
# But for now, just hash the contents.
656
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
659
574
def get_inventory(self, inventory_id):
660
575
"""Get Inventory object by hash.
662
TODO: Perhaps for this and similar methods, take a revision
577
:todo: Perhaps for this and similar methods, take a revision
663
578
parameter which can be either an integer revno or a
665
from bzrlib.inventory import Inventory
666
from bzrlib.xml import unpack_xml
668
return unpack_xml(Inventory, self.get_inventory_xml(inventory_id))
671
def get_inventory_xml(self, inventory_id):
672
"""Get inventory XML as a file object."""
673
return self.inventory_store[inventory_id]
676
def get_inventory_sha1(self, inventory_id):
677
"""Return the sha1 hash of the inventory entry
679
return sha_file(self.get_inventory_xml(inventory_id))
580
i = Inventory.read_xml(self.inventory_store[inventory_id])
682
584
def get_revision_inventory(self, revision_id):
683
585
"""Return inventory of a past revision."""
684
# bzr 0.0.6 imposes the constraint that the inventory_id
685
# must be the same as its revision, so this is trivial.
686
586
if revision_id == None:
687
from bzrlib.inventory import Inventory
688
return Inventory(self.get_root_id())
690
return self.get_inventory(revision_id)
589
return self.get_inventory(self.get_revision(revision_id).inventory_id)
693
592
def revision_history(self):
755
604
That is equivalent to the number of revisions committed to
607
>>> b = ScratchBranch()
610
>>> b.commit('no foo')
758
614
return len(self.revision_history())
761
617
def last_patch(self):
762
618
"""Return last patch hash, or None if no history.
620
>>> ScratchBranch().last_patch() == None
764
623
ph = self.revision_history()
771
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
773
If self and other have not diverged, return a list of the revisions
774
present in other, but missing from self.
776
>>> from bzrlib.commit import commit
777
>>> bzrlib.trace.silent = True
778
>>> br1 = ScratchBranch()
779
>>> br2 = ScratchBranch()
780
>>> br1.missing_revisions(br2)
782
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
783
>>> br1.missing_revisions(br2)
785
>>> br2.missing_revisions(br1)
787
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
788
>>> br1.missing_revisions(br2)
790
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
791
>>> br1.missing_revisions(br2)
793
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
794
>>> br1.missing_revisions(br2)
795
Traceback (most recent call last):
796
DivergedBranches: These branches have diverged.
798
self_history = self.revision_history()
799
self_len = len(self_history)
800
other_history = other.revision_history()
801
other_len = len(other_history)
802
common_index = min(self_len, other_len) -1
803
if common_index >= 0 and \
804
self_history[common_index] != other_history[common_index]:
805
raise DivergedBranches(self, other)
807
if stop_revision is None:
808
stop_revision = other_len
809
elif stop_revision > other_len:
810
raise NoSuchRevision(self, stop_revision)
812
return other_history[self_len:stop_revision]
815
def update_revisions(self, other, stop_revision=None):
816
"""Pull in all new revisions from other branch.
818
>>> from bzrlib.commit import commit
819
>>> bzrlib.trace.silent = True
820
>>> br1 = ScratchBranch(files=['foo', 'bar'])
823
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
824
>>> br2 = ScratchBranch()
825
>>> br2.update_revisions(br1)
829
>>> br2.revision_history()
831
>>> br2.update_revisions(br1)
833
>>> br1.text_store.total_size() == br2.text_store.total_size()
836
from bzrlib.fetch import greedy_fetch
838
pb.update('comparing histories')
839
revision_ids = self.missing_revisions(other, stop_revision)
840
if len(revision_ids) > 0:
841
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
844
self.append_revision(*revision_ids)
845
print "Added %d revisions." % count
847
def install_revisions(self, other, revision_ids, pb=None):
850
if hasattr(other.revision_store, "prefetch"):
851
other.revision_store.prefetch(revision_ids)
852
if hasattr(other.inventory_store, "prefetch"):
853
inventory_ids = [other.get_revision(r).inventory_id
854
for r in revision_ids]
855
other.inventory_store.prefetch(inventory_ids)
861
for i, rev_id in enumerate(revision_ids):
862
pb.update('fetching revision', i+1, len(revision_ids))
864
rev = other.get_revision(rev_id)
865
except bzrlib.errors.NoSuchRevision:
868
revisions.append(rev)
869
inv = other.get_inventory(str(rev.inventory_id))
870
for key, entry in inv.iter_entries():
871
if entry.text_id is None:
873
if entry.text_id not in self.text_store:
874
needed_texts.add(entry.text_id)
878
count, cp_fail = self.text_store.copy_multi(other.text_store,
880
print "Added %d texts." % count
881
inventory_ids = [ f.inventory_id for f in revisions ]
882
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
884
print "Added %d inventories." % count
885
revision_ids = [ f.revision_id for f in revisions]
886
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
889
assert len(cp_fail) == 0
890
return count, failures
892
def commit(self, *args, **kw):
893
from bzrlib.commit import commit
894
commit(self, *args, **kw)
897
def lookup_revision(self, revision):
898
"""Return the revision identifier for a given revision information."""
899
revno, info = self.get_revision_info(revision)
902
def get_revision_info(self, revision):
903
"""Return (revno, revision id) for revision identifier.
905
revision can be an integer, in which case it is assumed to be revno (though
906
this will translate negative values into positive ones)
907
revision can also be a string, in which case it is parsed for something like
908
'date:' or 'revid:' etc.
913
try:# Convert to int if possible
914
revision = int(revision)
917
revs = self.revision_history()
918
if isinstance(revision, int):
921
# Mabye we should do this first, but we don't need it if revision == 0
923
revno = len(revs) + revision + 1
926
elif isinstance(revision, basestring):
927
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
928
if revision.startswith(prefix):
929
revno = func(self, revs, revision)
932
raise BzrError('No namespace registered for string: %r' % revision)
934
if revno is None or revno <= 0 or revno > len(revs):
935
raise BzrError("no such revision %s" % revision)
936
return revno, revs[revno-1]
938
def _namespace_revno(self, revs, revision):
939
"""Lookup a revision by revision number"""
940
assert revision.startswith('revno:')
942
return int(revision[6:])
945
REVISION_NAMESPACES['revno:'] = _namespace_revno
947
def _namespace_revid(self, revs, revision):
948
assert revision.startswith('revid:')
950
return revs.index(revision[6:]) + 1
953
REVISION_NAMESPACES['revid:'] = _namespace_revid
955
def _namespace_last(self, revs, revision):
956
assert revision.startswith('last:')
958
offset = int(revision[5:])
963
raise BzrError('You must supply a positive value for --revision last:XXX')
964
return len(revs) - offset + 1
965
REVISION_NAMESPACES['last:'] = _namespace_last
967
def _namespace_tag(self, revs, revision):
968
assert revision.startswith('tag:')
969
raise BzrError('tag: namespace registered, but not implemented.')
970
REVISION_NAMESPACES['tag:'] = _namespace_tag
972
def _namespace_date(self, revs, revision):
973
assert revision.startswith('date:')
975
# Spec for date revisions:
977
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
978
# it can also start with a '+/-/='. '+' says match the first
979
# entry after the given date. '-' is match the first entry before the date
980
# '=' is match the first entry after, but still on the given date.
982
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
983
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
984
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
985
# May 13th, 2005 at 0:00
987
# So the proper way of saying 'give me all entries for today' is:
988
# -r {date:+today}:{date:-tomorrow}
989
# The default is '=' when not supplied
992
if val[:1] in ('+', '-', '='):
993
match_style = val[:1]
996
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
997
if val.lower() == 'yesterday':
998
dt = today - datetime.timedelta(days=1)
999
elif val.lower() == 'today':
1001
elif val.lower() == 'tomorrow':
1002
dt = today + datetime.timedelta(days=1)
1005
# This should be done outside the function to avoid recompiling it.
1006
_date_re = re.compile(
1007
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1009
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1011
m = _date_re.match(val)
1012
if not m or (not m.group('date') and not m.group('time')):
1013
raise BzrError('Invalid revision date %r' % revision)
1016
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1018
year, month, day = today.year, today.month, today.day
1020
hour = int(m.group('hour'))
1021
minute = int(m.group('minute'))
1022
if m.group('second'):
1023
second = int(m.group('second'))
1027
hour, minute, second = 0,0,0
1029
dt = datetime.datetime(year=year, month=month, day=day,
1030
hour=hour, minute=minute, second=second)
1034
if match_style == '-':
1036
elif match_style == '=':
1037
last = dt + datetime.timedelta(days=1)
1040
for i in range(len(revs)-1, -1, -1):
1041
r = self.get_revision(revs[i])
1042
# TODO: Handle timezone.
1043
dt = datetime.datetime.fromtimestamp(r.timestamp)
1044
if first >= dt and (last is None or dt >= last):
1047
for i in range(len(revs)):
1048
r = self.get_revision(revs[i])
1049
# TODO: Handle timezone.
1050
dt = datetime.datetime.fromtimestamp(r.timestamp)
1051
if first <= dt and (last is None or dt <= last):
1053
REVISION_NAMESPACES['date:'] = _namespace_date
630
def lookup_revision(self, revno):
631
"""Return revision hash for revision number."""
636
# list is 0-based; revisions are 1-based
637
return self.revision_history()[revno-1]
639
raise BzrError("no such revision %s" % revno)
1055
642
def revision_tree(self, revision_id):
1056
643
"""Return Tree for a revision on this branch.
1058
645
`revision_id` may be None for the null revision, in which case
1059
646
an `EmptyTree` is returned."""
1060
# TODO: refactor this to use an existing revision object
1061
# so we don't need to read it in twice.
1062
648
if revision_id == None:
1063
649
return EmptyTree()
683
def write_log(self, show_timezone='original'):
684
"""Write out human-readable log of commits to this branch
686
:param utc: If true, show dates in universal time, not local time."""
687
## TODO: Option to choose either original, utc or local timezone
690
for p in self.revision_history():
692
print 'revno:', revno
693
## TODO: Show hash if --id is given.
694
##print 'revision-hash:', p
695
rev = self.get_revision(p)
696
print 'committer:', rev.committer
697
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
700
## opportunistic consistency check, same as check_patch_chaining
701
if rev.precursor != precursor:
702
bailout("mismatched precursor!")
706
print ' (no message)'
708
for l in rev.message.split('\n'):
1088
715
def rename_one(self, from_rel, to_rel):
1091
This can change the directory or the filename or both.
716
tree = self.working_tree()
718
if not tree.has_filename(from_rel):
719
bailout("can't rename: old working file %r does not exist" % from_rel)
720
if tree.has_filename(to_rel):
721
bailout("can't rename: new working file %r already exists" % to_rel)
723
file_id = inv.path2id(from_rel)
725
bailout("can't rename: old name %r is not versioned" % from_rel)
727
if inv.path2id(to_rel):
728
bailout("can't rename: new name %r is already versioned" % to_rel)
730
to_dir, to_tail = os.path.split(to_rel)
731
to_dir_id = inv.path2id(to_dir)
732
if to_dir_id == None and to_dir != '':
733
bailout("can't determine destination directory id for %r" % to_dir)
735
mutter("rename_one:")
736
mutter(" file_id {%s}" % file_id)
737
mutter(" from_rel %r" % from_rel)
738
mutter(" to_rel %r" % to_rel)
739
mutter(" to_dir %r" % to_dir)
740
mutter(" to_dir_id {%s}" % to_dir_id)
742
inv.rename(file_id, to_dir_id, to_tail)
744
print "%s => %s" % (from_rel, to_rel)
746
from_abs = self.abspath(from_rel)
747
to_abs = self.abspath(to_rel)
1095
tree = self.working_tree()
1096
inv = tree.inventory
1097
if not tree.has_filename(from_rel):
1098
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1099
if tree.has_filename(to_rel):
1100
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1102
file_id = inv.path2id(from_rel)
1104
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1106
if inv.path2id(to_rel):
1107
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1109
to_dir, to_tail = os.path.split(to_rel)
1110
to_dir_id = inv.path2id(to_dir)
1111
if to_dir_id == None and to_dir != '':
1112
raise BzrError("can't determine destination directory id for %r" % to_dir)
1114
mutter("rename_one:")
1115
mutter(" file_id {%s}" % file_id)
1116
mutter(" from_rel %r" % from_rel)
1117
mutter(" to_rel %r" % to_rel)
1118
mutter(" to_dir %r" % to_dir)
1119
mutter(" to_dir_id {%s}" % to_dir_id)
1121
inv.rename(file_id, to_dir_id, to_tail)
1123
print "%s => %s" % (from_rel, to_rel)
1125
from_abs = self.abspath(from_rel)
1126
to_abs = self.abspath(to_rel)
1128
os.rename(from_abs, to_abs)
1130
raise BzrError("failed to rename %r to %r: %s"
1131
% (from_abs, to_abs, e[1]),
1132
["rename rolled back"])
1134
self._write_inventory(inv)
749
os.rename(from_abs, to_abs)
751
bailout("failed to rename %r to %r: %s"
752
% (from_abs, to_abs, e[1]),
753
["rename rolled back"])
755
self._write_inventory(inv)
1139
759
def move(self, from_paths, to_name):
1147
767
Note that to_name is only the last component of the new name;
1148
768
this doesn't change the directory.
1152
## TODO: Option to move IDs only
1153
assert not isinstance(from_paths, basestring)
1154
tree = self.working_tree()
1155
inv = tree.inventory
1156
to_abs = self.abspath(to_name)
1157
if not isdir(to_abs):
1158
raise BzrError("destination %r is not a directory" % to_abs)
1159
if not tree.has_filename(to_name):
1160
raise BzrError("destination %r not in working directory" % to_abs)
1161
to_dir_id = inv.path2id(to_name)
1162
if to_dir_id == None and to_name != '':
1163
raise BzrError("destination %r is not a versioned directory" % to_name)
1164
to_dir_ie = inv[to_dir_id]
1165
if to_dir_ie.kind not in ('directory', 'root_directory'):
1166
raise BzrError("destination %r is not a directory" % to_abs)
1168
to_idpath = inv.get_idpath(to_dir_id)
1170
for f in from_paths:
1171
if not tree.has_filename(f):
1172
raise BzrError("%r does not exist in working tree" % f)
1173
f_id = inv.path2id(f)
1175
raise BzrError("%r is not versioned" % f)
1176
name_tail = splitpath(f)[-1]
1177
dest_path = appendpath(to_name, name_tail)
1178
if tree.has_filename(dest_path):
1179
raise BzrError("destination %r already exists" % dest_path)
1180
if f_id in to_idpath:
1181
raise BzrError("can't move %r to a subdirectory of itself" % f)
1183
# OK, so there's a race here, it's possible that someone will
1184
# create a file in this interval and then the rename might be
1185
# left half-done. But we should have caught most problems.
1187
for f in from_paths:
1188
name_tail = splitpath(f)[-1]
1189
dest_path = appendpath(to_name, name_tail)
1190
print "%s => %s" % (f, dest_path)
1191
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1193
os.rename(self.abspath(f), self.abspath(dest_path))
1195
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1196
["rename rolled back"])
1198
self._write_inventory(inv)
1203
def revert(self, filenames, old_tree=None, backups=True):
1204
"""Restore selected files to the versions from a previous tree.
1207
If true (default) backups are made of files before
1210
from bzrlib.errors import NotVersionedError, BzrError
1211
from bzrlib.atomicfile import AtomicFile
1212
from bzrlib.osutils import backup_file
770
## TODO: Option to move IDs only
771
assert not isinstance(from_paths, basestring)
772
tree = self.working_tree()
774
to_abs = self.abspath(to_name)
775
if not isdir(to_abs):
776
bailout("destination %r is not a directory" % to_abs)
777
if not tree.has_filename(to_name):
778
bailout("destination %r not in working directory" % to_abs)
779
to_dir_id = inv.path2id(to_name)
780
if to_dir_id == None and to_name != '':
781
bailout("destination %r is not a versioned directory" % to_name)
782
to_dir_ie = inv[to_dir_id]
783
if to_dir_ie.kind not in ('directory', 'root_directory'):
784
bailout("destination %r is not a directory" % to_abs)
786
to_idpath = Set(inv.get_idpath(to_dir_id))
789
if not tree.has_filename(f):
790
bailout("%r does not exist in working tree" % f)
791
f_id = inv.path2id(f)
793
bailout("%r is not versioned" % f)
794
name_tail = splitpath(f)[-1]
795
dest_path = appendpath(to_name, name_tail)
796
if tree.has_filename(dest_path):
797
bailout("destination %r already exists" % dest_path)
798
if f_id in to_idpath:
799
bailout("can't move %r to a subdirectory of itself" % f)
801
# OK, so there's a race here, it's possible that someone will
802
# create a file in this interval and then the rename might be
803
# left half-done. But we should have caught most problems.
806
name_tail = splitpath(f)[-1]
807
dest_path = appendpath(to_name, name_tail)
808
print "%s => %s" % (f, dest_path)
809
inv.rename(inv.path2id(f), to_dir_id, name_tail)
811
os.rename(self.abspath(f), self.abspath(dest_path))
813
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
814
["rename rolled back"])
816
self._write_inventory(inv)
820
def show_status(self, show_all=False):
821
"""Display single-line status for non-ignored working files.
823
The list is show sorted in order by file name.
825
>>> b = ScratchBranch(files=['foo', 'foo~'])
831
>>> b.commit("add foo")
833
>>> os.unlink(b.abspath('foo'))
1214
inv = self.read_working_inventory()
1215
if old_tree is None:
1216
old_tree = self.basis_tree()
1217
old_inv = old_tree.inventory
1220
for fn in filenames:
1221
file_id = inv.path2id(fn)
1223
raise NotVersionedError("not a versioned file", fn)
1224
if not old_inv.has_id(file_id):
1225
raise BzrError("file not present in old tree", fn, file_id)
1226
nids.append((fn, file_id))
1228
# TODO: Rename back if it was previously at a different location
1230
# TODO: If given a directory, restore the entire contents from
1231
# the previous version.
1233
# TODO: Make a backup to a temporary file.
1235
# TODO: If the file previously didn't exist, delete it?
1236
for fn, file_id in nids:
1239
f = AtomicFile(fn, 'wb')
1241
f.write(old_tree.get_file(file_id).read())
1247
def pending_merges(self):
1248
"""Return a list of pending merges.
1250
These are revisions that have been merged into the working
1251
directory but not yet committed.
838
:todo: Get state for single files.
840
:todo: Perhaps show a slash at the end of directory names.
1253
cfn = self.controlfilename('pending-merges')
1254
if not os.path.exists(cfn):
1257
for l in self.controlfile('pending-merges', 'r').readlines():
1258
p.append(l.rstrip('\n'))
1262
def add_pending_merge(self, revision_id):
1263
from bzrlib.revision import validate_revision_id
1265
validate_revision_id(revision_id)
1267
p = self.pending_merges()
1268
if revision_id in p:
1270
p.append(revision_id)
1271
self.set_pending_merges(p)
1274
def set_pending_merges(self, rev_list):
1275
from bzrlib.atomicfile import AtomicFile
1278
f = AtomicFile(self.controlfilename('pending-merges'))
844
# We have to build everything into a list first so that it can
845
# sorted by name, incorporating all the different sources.
847
# FIXME: Rather than getting things in random order and then sorting,
848
# just step through in order.
850
# Interesting case: the old ID for a file has been removed,
851
# but a new file has been created under that name.
853
old = self.basis_tree()
854
new = self.working_tree()
856
for fs, fid, oldname, newname, kind in diff_trees(old, new):
858
show_status(fs, kind,
859
oldname + ' => ' + newname)
860
elif fs == 'A' or fs == 'M':
861
show_status(fs, kind, newname)
863
show_status(fs, kind, oldname)
866
show_status(fs, kind, newname)
869
show_status(fs, kind, newname)
871
show_status(fs, kind, newname)
873
bailout("wierd file state %r" % ((fs, fid),))
1290
877
class ScratchBranch(Branch):