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
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
34
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
35
39
## TODO: Maybe include checks for common corruption of newlines, etc?
38
# TODO: Some operations like log might retrieve the same revisions
39
# repeatedly to calculate deltas. We could perhaps have a weakref
40
# cache in memory to make this faster.
42
# TODO: please move the revision-string syntax stuff out of the branch
43
# object; it's clutter
46
def find_branch(f, **args):
47
if f and (f.startswith('http://') or f.startswith('https://')):
49
return remotebranch.RemoteBranch(f, **args)
51
return Branch(f, **args)
54
def find_cached_branch(f, cache_root, **args):
55
from remotebranch import RemoteBranch
56
br = find_branch(f, **args)
57
def cacheify(br, store_name):
58
from meta_store import CachedStore
59
cache_path = os.path.join(cache_root, store_name)
61
new_store = CachedStore(getattr(br, store_name), cache_path)
62
setattr(br, store_name, new_store)
64
if isinstance(br, RemoteBranch):
65
cacheify(br, 'inventory_store')
66
cacheify(br, 'text_store')
67
cacheify(br, 'revision_store')
71
def _relpath(base, path):
72
"""Return path relative to base, or raise exception.
74
The path may be either an absolute path or a path relative to the
75
current working directory.
77
Lifted out of Branch.relpath for ease of testing.
79
os.path.commonprefix (python2.4) has a bad bug that it works just
80
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
81
avoids that problem."""
82
rp = os.path.abspath(path)
86
while len(head) >= len(base):
89
head, tail = os.path.split(head)
93
from errors import NotBranchError
94
raise NotBranchError("path %r is not within branch %r" % (rp, base))
99
43
def find_branch_root(f=None):
100
44
"""Find the branch root enclosing f, or pwd.
102
f may be a filename or a URL.
104
46
It is not necessary that f exists.
106
48
Basically we keep looking up until we find the control directory or
107
49
run into the root."""
110
52
elif hasattr(os.path, 'realpath'):
111
53
f = os.path.realpath(f)
113
55
f = os.path.abspath(f)
114
if not os.path.exists(f):
115
raise BzrError('%r does not exist' % f)
121
61
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
123
63
head, tail = os.path.split(f)
125
65
# reached the root, whatever that may be
126
raise BzrError('%r is not in a branch' % orig_f)
66
bailout('%r is not in a branch' % orig_f)
129
class DivergedBranches(Exception):
130
def __init__(self, branch1, branch2):
131
self.branch1 = branch1
132
self.branch2 = branch2
133
Exception.__init__(self, "These branches have diverged.")
136
71
######################################################################
139
class Branch(object):
140
75
"""Branch holding a history of revisions.
143
Base directory of the branch.
149
If _lock_mode is true, a positive count of the number of times the
153
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.
160
# Map some sort of prefix into a namespace
161
# stuff like "revno:10", "revid:", etc.
162
# This should match a prefix with a function which accepts
163
REVISION_NAMESPACES = {}
165
90
def __init__(self, base, init=False, find_root=True):
166
91
"""Create new branch object at a particular location.
168
base -- Base directory for the branch.
93
:param base: Base directory for the branch.
170
init -- If True, create new control files in a previously
95
:param init: If True, create new control files in a previously
171
96
unversioned directory. If False, the branch must already
174
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
175
100
existing branch containing base.
177
102
In the test suite, creation of new trees is tested using the
178
103
`ScratchBranch` class.
180
from bzrlib.store import ImmutableStore
182
106
self.base = os.path.realpath(base)
183
107
self._make_control()
264
136
"""Return path relative to this branch of something inside it.
266
138
Raises an error if path is not in this branch."""
267
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)
270
148
def controlfilename(self, file_or_path):
271
149
"""Return location relative to branch."""
272
if isinstance(file_or_path, basestring):
150
if isinstance(file_or_path, types.StringTypes):
273
151
file_or_path = [file_or_path]
274
152
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
277
155
def controlfile(self, file_or_path, mode='r'):
278
"""Open a control file for this branch.
280
There are two classes of file in the control directory: text
281
and binary. binary files are untranslated byte streams. Text
282
control files are stored with Unix newlines and in UTF-8, even
283
if the platform or locale defaults are different.
285
Controlfiles should almost never be opened in write mode but
286
rather should be atomically copied and replaced using atomicfile.
289
fn = self.controlfilename(file_or_path)
291
if mode == 'rb' or mode == 'wb':
292
return file(fn, mode)
293
elif mode == 'r' or mode == 'w':
294
# open in binary mode anyhow so there's no newline translation;
295
# codecs uses line buffering by default; don't want that.
297
return codecs.open(fn, mode + 'b', 'utf-8',
300
raise BzrError("invalid controlfile mode %r" % mode)
156
"""Open a control file for this branch"""
157
return file(self.controlfilename(file_or_path), mode)
304
160
def _make_control(self):
305
from bzrlib.inventory import Inventory
306
from bzrlib.xml import pack_xml
308
161
os.mkdir(self.controlfilename([]))
309
162
self.controlfile('README', 'w').write(
310
163
"This is a Bazaar-NG control directory.\n"
311
"Do not change any files in this directory.\n")
164
"Do not change any files in this directory.")
312
165
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
313
166
for d in ('text-store', 'inventory-store', 'revision-store'):
314
167
os.mkdir(self.controlfilename(d))
315
168
for f in ('revision-history', 'merged-patches',
316
'pending-merged-patches', 'branch-name',
169
'pending-merged-patches', 'branch-name'):
319
170
self.controlfile(f, 'w').write('')
320
171
mutter('created control directory in ' + self.base)
322
# if we want per-tree root ids then this is the place to set
323
# them; they're not needed for now and so ommitted for
325
pack_xml(Inventory(), self.controlfile('inventory','w'))
172
Inventory().write_xml(self.controlfile('inventory','w'))
328
175
def _check_format(self):
333
180
In the future, we might need different in-memory Branch
334
181
classes to support downlevel branches. But not yet.
336
# This ignores newlines so that we can open branches created
337
# on Windows from Linux and so on. I think it might be better
338
# to always make all internal files in unix format.
339
fmt = self.controlfile('branch-format', 'r').read()
340
fmt.replace('\r\n', '')
183
# read in binary mode to detect newline wierdness.
184
fmt = self.controlfile('branch-format', 'rb').read()
341
185
if fmt != BZR_BRANCH_FORMAT:
342
raise BzrError('sorry, branch format %r not supported' % fmt,
343
['use a different bzr version',
344
'or remove the .bzr directory and "bzr init" again'])
346
def get_root_id(self):
347
"""Return the id of this branches root"""
348
inv = self.read_working_inventory()
349
return inv.root.file_id
351
def set_root_id(self, file_id):
352
inv = self.read_working_inventory()
353
orig_root_id = inv.root.file_id
354
del inv._byid[inv.root.file_id]
355
inv.root.file_id = file_id
356
inv._byid[inv.root.file_id] = inv.root
359
if entry.parent_id in (None, orig_root_id):
360
entry.parent_id = inv.root.file_id
361
self._write_inventory(inv)
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'])
363
191
def read_working_inventory(self):
364
192
"""Read the working inventory."""
365
from bzrlib.inventory import Inventory
366
from bzrlib.xml import unpack_xml
367
from time import time
371
# ElementTree does its own conversion from UTF-8, so open in
373
inv = unpack_xml(Inventory,
374
self.controlfile('inventory', 'rb'))
375
mutter("loaded inventory of %d items in %f"
376
% (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))
382
200
def _write_inventory(self, inv):
383
201
"""Update the working inventory.
385
203
That is to say, the inventory describing changes underway, that
386
204
will be committed to the next revision.
388
from bzrlib.atomicfile import AtomicFile
389
from bzrlib.xml import pack_xml
393
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'))
402
213
mutter('wrote working inventory')
405
216
inventory = property(read_working_inventory, _write_inventory, None,
406
217
"""Inventory for the working copy.""")
409
def add(self, files, verbose=False, ids=None):
220
def add(self, files, verbose=False):
410
221
"""Make files versioned.
412
Note that the command line normally calls smart_add instead.
414
223
This puts the files in the Added state, so that they will be
415
224
recorded by the next commit.
418
List of paths to add, relative to the base of the tree.
421
If set, use these instead of automatically generated ids.
422
Must be the same length as the list of files, but may
423
contain None for ids that are to be autogenerated.
425
TODO: Perhaps have an option to add the ids even if the files do
428
TODO: Perhaps return the ids of the files? But then again it
429
is easy to retrieve them if they're needed.
431
TODO: Adding a directory should optionally recurse down and
432
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', [])
435
261
# TODO: Re-adding a file that is removed in the working copy
436
262
# should probably put it back with the previous ID.
437
if isinstance(files, basestring):
438
assert(ids is None or isinstance(ids, basestring))
263
if isinstance(files, types.StringTypes):
444
ids = [None] * len(files)
446
assert(len(ids) == len(files))
450
inv = self.read_working_inventory()
451
for f,file_id in zip(files, ids):
452
if is_control_file(f):
453
raise BzrError("cannot add control file %s" % quotefn(f))
458
raise BzrError("cannot add top-level %r" % f)
460
fullpath = os.path.normpath(self.abspath(f))
463
kind = file_kind(fullpath)
465
# maybe something better?
466
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
468
if kind != 'file' and kind != 'directory':
469
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
472
file_id = gen_file_id(f)
473
inv.add_path(f, kind=kind, file_id=file_id)
476
print 'added', quotefn(f)
478
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
480
self._write_inventory(inv)
485
def print_file(self, file, revno):
486
"""Print `file` to stdout."""
489
tree = self.revision_tree(self.lookup_revision(revno))
490
# use inventory as it was in that revision
491
file_id = tree.inventory.path2id(file)
493
raise BzrError("%r is not present in revision %s" % (file, revno))
494
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)
499
299
def remove(self, files, verbose=False):
502
302
This does not remove their text. This does not run on
504
TODO: Refuse to remove modified files unless --force is given?
506
TODO: Do something useful with directories.
508
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
509
331
removing may be useful and the user can just use use rm, and
510
332
is the opposite of add. Removing it is consistent with most
511
333
other tools. Maybe an option.
513
335
## TODO: Normalize names
514
336
## TODO: Remove nested loops; better scalability
515
if isinstance(files, basestring):
338
if isinstance(files, types.StringTypes):
521
tree = self.working_tree()
524
# do this before any modifications
528
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
529
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
531
# having remove it, it must be either ignored or unknown
532
if tree.is_ignored(f):
536
show_status(new_status, inv[fid].kind, quotefn(f))
539
self._write_inventory(inv)
544
# FIXME: this doesn't need to be a branch method
545
def set_inventory(self, new_inventory_list):
546
from bzrlib.inventory import Inventory, InventoryEntry
547
inv = Inventory(self.get_root_id())
548
for path, file_id, parent, kind in new_inventory_list:
549
name = os.path.basename(path)
552
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))
553
359
self._write_inventory(inv)
572
378
return self.working_tree().unknowns()
575
def append_revision(self, *revision_ids):
576
from bzrlib.atomicfile import AtomicFile
578
for revision_id in revision_ids:
579
mutter("add {%s} to revision-history" % revision_id)
581
rev_history = self.revision_history()
582
rev_history.extend(revision_ids)
584
f = AtomicFile(self.controlfilename('revision-history'))
586
for rev_id in rev_history:
593
def get_revision_xml(self, revision_id):
594
"""Return XML file object for revision object."""
595
if not revision_id or not isinstance(revision_id, basestring):
596
raise InvalidRevisionId(revision_id)
601
return self.revision_store[revision_id]
603
raise bzrlib.errors.NoSuchRevision(self, revision_id)
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
self.controlfile('revision-history', 'at').write(rev_id + '\n')
608
550
def get_revision(self, revision_id):
609
551
"""Return the Revision object for a named revision"""
610
xml_file = self.get_revision_xml(revision_id)
613
r = unpack_xml(Revision, xml_file)
614
except SyntaxError, e:
615
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
552
r = Revision.read_xml(self.revision_store[revision_id])
619
553
assert r.revision_id == revision_id
623
def get_revision_delta(self, revno):
624
"""Return the delta for one revision.
626
The delta is relative to its mainline predecessor, or the
627
empty tree for revision 1.
629
assert isinstance(revno, int)
630
rh = self.revision_history()
631
if not (1 <= revno <= len(rh)):
632
raise InvalidRevisionNumber(revno)
634
# revno is 1-based; list is 0-based
636
new_tree = self.revision_tree(rh[revno-1])
638
old_tree = EmptyTree()
640
old_tree = self.revision_tree(rh[revno-2])
642
return compare_trees(old_tree, new_tree)
646
def get_revision_sha1(self, revision_id):
647
"""Hash the stored value of a revision, and return it."""
648
# In the future, revision entries will be signed. At that
649
# point, it is probably best *not* to include the signature
650
# in the revision hash. Because that lets you re-sign
651
# the revision, (add signatures/remove signatures) and still
652
# have all hash pointers stay consistent.
653
# But for now, just hash the contents.
654
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
657
557
def get_inventory(self, inventory_id):
658
558
"""Get Inventory object by hash.
660
TODO: Perhaps for this and similar methods, take a revision
560
:todo: Perhaps for this and similar methods, take a revision
661
561
parameter which can be either an integer revno or a
663
from bzrlib.inventory import Inventory
664
from bzrlib.xml import unpack_xml
666
return unpack_xml(Inventory, self.get_inventory_xml(inventory_id))
669
def get_inventory_xml(self, inventory_id):
670
"""Get inventory XML as a file object."""
671
return self.inventory_store[inventory_id]
674
def get_inventory_sha1(self, inventory_id):
675
"""Return the sha1 hash of the inventory entry
677
return sha_file(self.get_inventory_xml(inventory_id))
563
i = Inventory.read_xml(self.inventory_store[inventory_id])
680
567
def get_revision_inventory(self, revision_id):
681
568
"""Return inventory of a past revision."""
682
# bzr 0.0.6 imposes the constraint that the inventory_id
683
# must be the same as its revision, so this is trivial.
684
569
if revision_id == None:
685
from bzrlib.inventory import Inventory
686
return Inventory(self.get_root_id())
688
return self.get_inventory(revision_id)
572
return self.get_inventory(self.get_revision(revision_id).inventory_id)
691
575
def revision_history(self):
753
587
That is equivalent to the number of revisions committed to
590
>>> b = ScratchBranch()
593
>>> b.commit('no foo')
756
597
return len(self.revision_history())
759
600
def last_patch(self):
760
601
"""Return last patch hash, or None if no history.
603
>>> ScratchBranch().last_patch() == None
762
606
ph = self.revision_history()
769
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
771
If self and other have not diverged, return a list of the revisions
772
present in other, but missing from self.
774
>>> from bzrlib.commit import commit
775
>>> bzrlib.trace.silent = True
776
>>> br1 = ScratchBranch()
777
>>> br2 = ScratchBranch()
778
>>> br1.missing_revisions(br2)
780
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
781
>>> br1.missing_revisions(br2)
783
>>> br2.missing_revisions(br1)
785
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
786
>>> br1.missing_revisions(br2)
788
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
789
>>> br1.missing_revisions(br2)
791
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
792
>>> br1.missing_revisions(br2)
793
Traceback (most recent call last):
794
DivergedBranches: These branches have diverged.
796
self_history = self.revision_history()
797
self_len = len(self_history)
798
other_history = other.revision_history()
799
other_len = len(other_history)
800
common_index = min(self_len, other_len) -1
801
if common_index >= 0 and \
802
self_history[common_index] != other_history[common_index]:
803
raise DivergedBranches(self, other)
805
if stop_revision is None:
806
stop_revision = other_len
807
elif stop_revision > other_len:
808
raise NoSuchRevision(self, stop_revision)
810
return other_history[self_len:stop_revision]
813
def update_revisions(self, other, stop_revision=None, revision_ids=None):
814
"""Pull in all new revisions from other branch.
816
>>> from bzrlib.commit import commit
817
>>> bzrlib.trace.silent = True
818
>>> br1 = ScratchBranch(files=['foo', 'bar'])
821
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
822
>>> br2 = ScratchBranch()
823
>>> br2.update_revisions(br1)
827
>>> br2.revision_history()
829
>>> br2.update_revisions(br1)
833
>>> br1.text_store.total_size() == br2.text_store.total_size()
836
from bzrlib.progress import ProgressBar
840
pb.update('comparing histories')
841
if revision_ids is None:
842
revision_ids = self.missing_revisions(other, stop_revision)
844
if hasattr(other.revision_store, "prefetch"):
845
other.revision_store.prefetch(revision_ids)
846
if hasattr(other.inventory_store, "prefetch"):
847
inventory_ids = [other.get_revision(r).inventory_id
848
for r in revision_ids]
849
other.inventory_store.prefetch(inventory_ids)
854
for rev_id in revision_ids:
856
pb.update('fetching revision', i, len(revision_ids))
857
rev = other.get_revision(rev_id)
858
revisions.append(rev)
859
inv = other.get_inventory(str(rev.inventory_id))
860
for key, entry in inv.iter_entries():
861
if entry.text_id is None:
863
if entry.text_id not in self.text_store:
864
needed_texts.add(entry.text_id)
868
count = self.text_store.copy_multi(other.text_store, needed_texts)
869
print "Added %d texts." % count
870
inventory_ids = [ f.inventory_id for f in revisions ]
871
count = self.inventory_store.copy_multi(other.inventory_store,
873
print "Added %d inventories." % count
874
revision_ids = [ f.revision_id for f in revisions]
875
count = self.revision_store.copy_multi(other.revision_store,
877
for revision_id in revision_ids:
878
self.append_revision(revision_id)
879
print "Added %d revisions." % count
882
def commit(self, *args, **kw):
883
from bzrlib.commit import commit
884
commit(self, *args, **kw)
887
def lookup_revision(self, revision):
888
"""Return the revision identifier for a given revision information."""
889
revno, info = self.get_revision_info(revision)
892
def get_revision_info(self, revision):
893
"""Return (revno, revision id) for revision identifier.
895
revision can be an integer, in which case it is assumed to be revno (though
896
this will translate negative values into positive ones)
897
revision can also be a string, in which case it is parsed for something like
898
'date:' or 'revid:' etc.
903
try:# Convert to int if possible
904
revision = int(revision)
907
revs = self.revision_history()
908
if isinstance(revision, int):
911
# Mabye we should do this first, but we don't need it if revision == 0
913
revno = len(revs) + revision + 1
916
elif isinstance(revision, basestring):
917
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
918
if revision.startswith(prefix):
919
revno = func(self, revs, revision)
922
raise BzrError('No namespace registered for string: %r' % revision)
924
if revno is None or revno <= 0 or revno > len(revs):
925
raise BzrError("no such revision %s" % revision)
926
return revno, revs[revno-1]
928
def _namespace_revno(self, revs, revision):
929
"""Lookup a revision by revision number"""
930
assert revision.startswith('revno:')
932
return int(revision[6:])
935
REVISION_NAMESPACES['revno:'] = _namespace_revno
937
def _namespace_revid(self, revs, revision):
938
assert revision.startswith('revid:')
940
return revs.index(revision[6:]) + 1
943
REVISION_NAMESPACES['revid:'] = _namespace_revid
945
def _namespace_last(self, revs, revision):
946
assert revision.startswith('last:')
948
offset = int(revision[5:])
953
raise BzrError('You must supply a positive value for --revision last:XXX')
954
return len(revs) - offset + 1
955
REVISION_NAMESPACES['last:'] = _namespace_last
957
def _namespace_tag(self, revs, revision):
958
assert revision.startswith('tag:')
959
raise BzrError('tag: namespace registered, but not implemented.')
960
REVISION_NAMESPACES['tag:'] = _namespace_tag
962
def _namespace_date(self, revs, revision):
963
assert revision.startswith('date:')
965
# Spec for date revisions:
967
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
968
# it can also start with a '+/-/='. '+' says match the first
969
# entry after the given date. '-' is match the first entry before the date
970
# '=' is match the first entry after, but still on the given date.
972
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
973
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
974
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
975
# May 13th, 2005 at 0:00
977
# So the proper way of saying 'give me all entries for today' is:
978
# -r {date:+today}:{date:-tomorrow}
979
# The default is '=' when not supplied
982
if val[:1] in ('+', '-', '='):
983
match_style = val[:1]
986
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
987
if val.lower() == 'yesterday':
988
dt = today - datetime.timedelta(days=1)
989
elif val.lower() == 'today':
991
elif val.lower() == 'tomorrow':
992
dt = today + datetime.timedelta(days=1)
995
# This should be done outside the function to avoid recompiling it.
996
_date_re = re.compile(
997
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
999
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1001
m = _date_re.match(val)
1002
if not m or (not m.group('date') and not m.group('time')):
1003
raise BzrError('Invalid revision date %r' % revision)
1006
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1008
year, month, day = today.year, today.month, today.day
1010
hour = int(m.group('hour'))
1011
minute = int(m.group('minute'))
1012
if m.group('second'):
1013
second = int(m.group('second'))
1017
hour, minute, second = 0,0,0
1019
dt = datetime.datetime(year=year, month=month, day=day,
1020
hour=hour, minute=minute, second=second)
1024
if match_style == '-':
1026
elif match_style == '=':
1027
last = dt + datetime.timedelta(days=1)
1030
for i in range(len(revs)-1, -1, -1):
1031
r = self.get_revision(revs[i])
1032
# TODO: Handle timezone.
1033
dt = datetime.datetime.fromtimestamp(r.timestamp)
1034
if first >= dt and (last is None or dt >= last):
1037
for i in range(len(revs)):
1038
r = self.get_revision(revs[i])
1039
# TODO: Handle timezone.
1040
dt = datetime.datetime.fromtimestamp(r.timestamp)
1041
if first <= dt and (last is None or dt <= last):
1043
REVISION_NAMESPACES['date:'] = _namespace_date
611
def lookup_revision(self, revno):
612
"""Return revision hash for revision number."""
617
# list is 0-based; revisions are 1-based
618
return self.revision_history()[revno-1]
620
bailout("no such revision %s" % revno)
1045
623
def revision_tree(self, revision_id):
1046
624
"""Return Tree for a revision on this branch.
1048
626
`revision_id` may be None for the null revision, in which case
1049
627
an `EmptyTree` is returned."""
1050
# TODO: refactor this to use an existing revision object
1051
# so we don't need to read it in twice.
1052
629
if revision_id == None:
1053
630
return EmptyTree()
1078
def rename_one(self, from_rel, to_rel):
1081
This can change the directory or the filename or both.
1085
tree = self.working_tree()
1086
inv = tree.inventory
1087
if not tree.has_filename(from_rel):
1088
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1089
if tree.has_filename(to_rel):
1090
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1092
file_id = inv.path2id(from_rel)
1094
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1096
if inv.path2id(to_rel):
1097
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1099
to_dir, to_tail = os.path.split(to_rel)
1100
to_dir_id = inv.path2id(to_dir)
1101
if to_dir_id == None and to_dir != '':
1102
raise BzrError("can't determine destination directory id for %r" % to_dir)
1104
mutter("rename_one:")
1105
mutter(" file_id {%s}" % file_id)
1106
mutter(" from_rel %r" % from_rel)
1107
mutter(" to_rel %r" % to_rel)
1108
mutter(" to_dir %r" % to_dir)
1109
mutter(" to_dir_id {%s}" % to_dir_id)
1111
inv.rename(file_id, to_dir_id, to_tail)
1113
print "%s => %s" % (from_rel, to_rel)
1115
from_abs = self.abspath(from_rel)
1116
to_abs = self.abspath(to_rel)
1118
os.rename(from_abs, to_abs)
1120
raise BzrError("failed to rename %r to %r: %s"
1121
% (from_abs, to_abs, e[1]),
1122
["rename rolled back"])
1124
self._write_inventory(inv)
1129
def move(self, from_paths, to_name):
1132
to_name must exist as a versioned directory.
1134
If to_name exists and is a directory, the files are moved into
1135
it, keeping their old names. If it is a directory,
1137
Note that to_name is only the last component of the new name;
1138
this doesn't change the directory.
1142
## TODO: Option to move IDs only
1143
assert not isinstance(from_paths, basestring)
1144
tree = self.working_tree()
1145
inv = tree.inventory
1146
to_abs = self.abspath(to_name)
1147
if not isdir(to_abs):
1148
raise BzrError("destination %r is not a directory" % to_abs)
1149
if not tree.has_filename(to_name):
1150
raise BzrError("destination %r not in working directory" % to_abs)
1151
to_dir_id = inv.path2id(to_name)
1152
if to_dir_id == None and to_name != '':
1153
raise BzrError("destination %r is not a versioned directory" % to_name)
1154
to_dir_ie = inv[to_dir_id]
1155
if to_dir_ie.kind not in ('directory', 'root_directory'):
1156
raise BzrError("destination %r is not a directory" % to_abs)
1158
to_idpath = inv.get_idpath(to_dir_id)
1160
for f in from_paths:
1161
if not tree.has_filename(f):
1162
raise BzrError("%r does not exist in working tree" % f)
1163
f_id = inv.path2id(f)
1165
raise BzrError("%r is not versioned" % f)
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
if tree.has_filename(dest_path):
1169
raise BzrError("destination %r already exists" % dest_path)
1170
if f_id in to_idpath:
1171
raise BzrError("can't move %r to a subdirectory of itself" % f)
1173
# OK, so there's a race here, it's possible that someone will
1174
# create a file in this interval and then the rename might be
1175
# left half-done. But we should have caught most problems.
1177
for f in from_paths:
1178
name_tail = splitpath(f)[-1]
1179
dest_path = appendpath(to_name, name_tail)
1180
print "%s => %s" % (f, dest_path)
1181
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1183
os.rename(self.abspath(f), self.abspath(dest_path))
1185
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1186
["rename rolled back"])
1188
self._write_inventory(inv)
1193
def revert(self, filenames, old_tree=None, backups=True):
1194
"""Restore selected files to the versions from a previous tree.
1197
If true (default) backups are made of files before
1200
from bzrlib.errors import NotVersionedError, BzrError
1201
from bzrlib.atomicfile import AtomicFile
1202
from bzrlib.osutils import backup_file
664
def write_log(self, show_timezone='original'):
665
"""Write out human-readable log of commits to this branch
667
:param utc: If true, show dates in universal time, not local time."""
668
## TODO: Option to choose either original, utc or local timezone
671
for p in self.revision_history():
673
print 'revno:', revno
674
## TODO: Show hash if --id is given.
675
##print 'revision-hash:', p
676
rev = self.get_revision(p)
677
print 'committer:', rev.committer
678
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
681
## opportunistic consistency check, same as check_patch_chaining
682
if rev.precursor != precursor:
683
bailout("mismatched precursor!")
687
print ' (no message)'
689
for l in rev.message.split('\n'):
697
def show_status(branch, show_all=False):
698
"""Display single-line status for non-ignored working files.
700
The list is show sorted in order by file name.
702
>>> b = ScratchBranch(files=['foo', 'foo~'])
708
>>> b.commit("add foo")
710
>>> os.unlink(b.abspath('foo'))
1204
inv = self.read_working_inventory()
1205
if old_tree is None:
1206
old_tree = self.basis_tree()
1207
old_inv = old_tree.inventory
1210
for fn in filenames:
1211
file_id = inv.path2id(fn)
1213
raise NotVersionedError("not a versioned file", fn)
1214
if not old_inv.has_id(file_id):
1215
raise BzrError("file not present in old tree", fn, file_id)
1216
nids.append((fn, file_id))
1218
# TODO: Rename back if it was previously at a different location
1220
# TODO: If given a directory, restore the entire contents from
1221
# the previous version.
1223
# TODO: Make a backup to a temporary file.
1225
# TODO: If the file previously didn't exist, delete it?
1226
for fn, file_id in nids:
1229
f = AtomicFile(fn, 'wb')
1231
f.write(old_tree.get_file(file_id).read())
1237
def pending_merges(self):
1238
"""Return a list of pending merges.
1240
These are revisions that have been merged into the working
1241
directory but not yet committed.
715
:todo: Get state for single files.
717
:todo: Perhaps show a slash at the end of directory names.
1243
cfn = self.controlfilename('pending-merges')
1244
if not os.path.exists(cfn):
1247
for l in self.controlfile('pending-merges', 'r').readlines():
1248
p.append(l.rstrip('\n'))
1252
def add_pending_merge(self, revision_id):
1253
from bzrlib.revision import validate_revision_id
1255
validate_revision_id(revision_id)
1257
p = self.pending_merges()
1258
if revision_id in p:
1260
p.append(revision_id)
1261
self.set_pending_merges(p)
1264
def set_pending_merges(self, rev_list):
1265
from bzrlib.atomicfile import AtomicFile
1268
f = AtomicFile(self.controlfilename('pending-merges'))
721
# We have to build everything into a list first so that it can
722
# sorted by name, incorporating all the different sources.
724
# FIXME: Rather than getting things in random order and then sorting,
725
# just step through in order.
727
# Interesting case: the old ID for a file has been removed,
728
# but a new file has been created under that name.
730
old = branch.basis_tree()
731
old_inv = old.inventory
732
new = branch.working_tree()
733
new_inv = new.inventory
735
for fs, fid, oldname, newname, kind in diff_trees(old, new):
737
show_status(fs, kind,
738
oldname + ' => ' + newname)
739
elif fs == 'A' or fs == 'M':
740
show_status(fs, kind, newname)
742
show_status(fs, kind, oldname)
745
show_status(fs, kind, newname)
748
show_status(fs, kind, newname)
750
show_status(fs, kind, newname)
752
bailout("wierd file state %r" % ((fs, fid),))
1280
756
class ScratchBranch(Branch):