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
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
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
38
34
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
35
## 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.
43
def find_branch(f, **args):
44
if f and (f.startswith('http://') or f.startswith('https://')):
46
return remotebranch.RemoteBranch(f, **args)
48
return Branch(f, **args)
51
def find_cached_branch(f, cache_root, **args):
52
from remotebranch import RemoteBranch
53
br = find_branch(f, **args)
54
def cacheify(br, store_name):
55
from meta_store import CachedStore
56
cache_path = os.path.join(cache_root, store_name)
58
new_store = CachedStore(getattr(br, store_name), cache_path)
59
setattr(br, store_name, new_store)
61
if isinstance(br, RemoteBranch):
62
cacheify(br, 'inventory_store')
63
cacheify(br, 'text_store')
64
cacheify(br, 'revision_store')
68
def _relpath(base, path):
69
"""Return path relative to base, or raise exception.
71
The path may be either an absolute path or a path relative to the
72
current working directory.
74
Lifted out of Branch.relpath for ease of testing.
76
os.path.commonprefix (python2.4) has a bad bug that it works just
77
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
78
avoids that problem."""
79
rp = os.path.abspath(path)
83
while len(head) >= len(base):
86
head, tail = os.path.split(head)
90
from errors import NotBranchError
91
raise NotBranchError("path %r is not within branch %r" % (rp, base))
43
96
def find_branch_root(f=None):
44
97
"""Find the branch root enclosing f, or pwd.
99
f may be a filename or a URL.
46
101
It is not necessary that f exists.
48
103
Basically we keep looking up until we find the control directory or
49
104
run into the root."""
52
107
elif hasattr(os.path, 'realpath'):
53
108
f = os.path.realpath(f)
55
110
f = os.path.abspath(f)
111
if not os.path.exists(f):
112
raise BzrError('%r does not exist' % f)
61
118
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
63
120
head, tail = os.path.split(f)
65
122
# reached the root, whatever that may be
66
bailout('%r is not in a branch' % orig_f)
123
raise BzrError('%r is not in a branch' % orig_f)
126
class DivergedBranches(Exception):
127
def __init__(self, branch1, branch2):
128
self.branch1 = branch1
129
self.branch2 = branch2
130
Exception.__init__(self, "These branches have diverged.")
71
133
######################################################################
136
class Branch(object):
75
137
"""Branch holding a history of revisions.
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.
140
Base directory of the branch.
146
If _lock_mode is true, a positive count of the number of times the
150
Lock object from bzrlib.lock.
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
90
162
def __init__(self, base, init=False, find_root=True):
91
163
"""Create new branch object at a particular location.
93
:param base: Base directory for the branch.
165
base -- Base directory for the branch.
95
:param init: If True, create new control files in a previously
167
init -- If True, create new control files in a previously
96
168
unversioned directory. If False, the branch must already
99
:param find_root: If true and init is false, find the root of the
171
find_root -- If true and init is false, find the root of the
100
172
existing branch containing base.
102
174
In the test suite, creation of new trees is tested using the
103
175
`ScratchBranch` class.
177
from bzrlib.store import ImmutableStore
106
179
self.base = os.path.realpath(base)
107
180
self._make_control()
136
261
"""Return path relative to this branch of something inside it.
138
263
Raises an error if path is not in this branch."""
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)
264
return _relpath(self.base, path)
148
267
def controlfilename(self, file_or_path):
149
268
"""Return location relative to branch."""
150
if isinstance(file_or_path, types.StringTypes):
269
if isinstance(file_or_path, basestring):
151
270
file_or_path = [file_or_path]
152
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
155
274
def controlfile(self, file_or_path, mode='r'):
156
"""Open a control file for this branch"""
157
return file(self.controlfilename(file_or_path), mode)
275
"""Open a control file for this branch.
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
286
fn = self.controlfilename(file_or_path)
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
294
return codecs.open(fn, mode + 'b', 'utf-8',
297
raise BzrError("invalid controlfile mode %r" % mode)
160
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
161
305
os.mkdir(self.controlfilename([]))
162
306
self.controlfile('README', 'w').write(
163
307
"This is a Bazaar-NG control directory.\n"
164
"Do not change any files in this directory.")
308
"Do not change any files in this directory.\n")
165
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
166
310
for d in ('text-store', 'inventory-store', 'revision-store'):
167
311
os.mkdir(self.controlfilename(d))
168
312
for f in ('revision-history', 'merged-patches',
169
'pending-merged-patches', 'branch-name'):
313
'pending-merged-patches', 'branch-name',
170
316
self.controlfile(f, 'w').write('')
171
317
mutter('created control directory in ' + self.base)
172
Inventory().write_xml(self.controlfile('inventory','w'))
319
# if we want per-tree root ids then this is the place to set
320
# them; they're not needed for now and so ommitted for
322
pack_xml(Inventory(), self.controlfile('inventory','w'))
175
325
def _check_format(self):
180
330
In the future, we might need different in-memory Branch
181
331
classes to support downlevel branches. But not yet.
183
# read in binary mode to detect newline wierdness.
184
fmt = self.controlfile('branch-format', 'rb').read()
333
# This ignores newlines so that we can open branches created
334
# on Windows from Linux and so on. I think it might be better
335
# to always make all internal files in unix format.
336
fmt = self.controlfile('branch-format', 'r').read()
337
fmt.replace('\r\n', '')
185
338
if fmt != BZR_BRANCH_FORMAT:
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'])
339
raise BzrError('sorry, branch format %r not supported' % fmt,
340
['use a different bzr version',
341
'or remove the .bzr directory and "bzr init" again'])
343
def get_root_id(self):
344
"""Return the id of this branches root"""
345
inv = self.read_working_inventory()
346
return inv.root.file_id
348
def set_root_id(self, file_id):
349
inv = self.read_working_inventory()
350
orig_root_id = inv.root.file_id
351
del inv._byid[inv.root.file_id]
352
inv.root.file_id = file_id
353
inv._byid[inv.root.file_id] = inv.root
356
if entry.parent_id in (None, orig_root_id):
357
entry.parent_id = inv.root.file_id
358
self._write_inventory(inv)
191
360
def read_working_inventory(self):
192
361
"""Read the working inventory."""
194
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
195
mutter("loaded inventory of %d items in %f"
196
% (len(inv), time.time() - before))
362
from bzrlib.inventory import Inventory
363
from bzrlib.xml import unpack_xml
364
from time import time
368
# ElementTree does its own conversion from UTF-8, so open in
370
inv = unpack_xml(Inventory,
371
self.controlfile('inventory', 'rb'))
372
mutter("loaded inventory of %d items in %f"
373
% (len(inv), time() - before))
200
379
def _write_inventory(self, inv):
201
380
"""Update the working inventory.
203
382
That is to say, the inventory describing changes underway, that
204
383
will be committed to the next revision.
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'))
385
from bzrlib.atomicfile import AtomicFile
386
from bzrlib.xml import pack_xml
390
f = AtomicFile(self.controlfilename('inventory'), 'wb')
213
399
mutter('wrote working inventory')
216
402
inventory = property(read_working_inventory, _write_inventory, None,
217
403
"""Inventory for the working copy.""")
220
def add(self, files, verbose=False):
406
def add(self, files, verbose=False, ids=None):
221
407
"""Make files versioned.
409
Note that the command line normally calls smart_add instead.
223
411
This puts the files in the Added state, so that they will be
224
412
recorded by the next commit.
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', [])
415
List of paths to add, relative to the base of the tree.
418
If set, use these instead of automatically generated ids.
419
Must be the same length as the list of files, but may
420
contain None for ids that are to be autogenerated.
422
TODO: Perhaps have an option to add the ids even if the files do
425
TODO: Perhaps return the ids of the files? But then again it
426
is easy to retrieve them if they're needed.
428
TODO: Adding a directory should optionally recurse down and
429
add all non-ignored children. Perhaps do that in a
261
432
# TODO: Re-adding a file that is removed in the working copy
262
433
# should probably put it back with the previous ID.
263
if isinstance(files, types.StringTypes):
434
if isinstance(files, basestring):
435
assert(ids is None or isinstance(ids, basestring))
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)
441
ids = [None] * len(files)
443
assert(len(ids) == len(files))
447
inv = self.read_working_inventory()
448
for f,file_id in zip(files, ids):
449
if is_control_file(f):
450
raise BzrError("cannot add control file %s" % quotefn(f))
455
raise BzrError("cannot add top-level %r" % f)
457
fullpath = os.path.normpath(self.abspath(f))
460
kind = file_kind(fullpath)
462
# maybe something better?
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
465
if kind != 'file' and kind != 'directory':
466
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
469
file_id = gen_file_id(f)
470
inv.add_path(f, kind=kind, file_id=file_id)
473
print 'added', quotefn(f)
475
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
477
self._write_inventory(inv)
482
def print_file(self, file, revno):
483
"""Print `file` to stdout."""
486
tree = self.revision_tree(self.lookup_revision(revno))
487
# use inventory as it was in that revision
488
file_id = tree.inventory.path2id(file)
490
raise BzrError("%r is not present in revision %s" % (file, revno))
491
tree.print_file(file_id)
299
496
def remove(self, files, verbose=False):
302
499
This does not remove their text. This does not run on
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
501
TODO: Refuse to remove modified files unless --force is given?
503
TODO: Do something useful with directories.
505
TODO: Should this remove the text or not? Tough call; not
331
506
removing may be useful and the user can just use use rm, and
332
507
is the opposite of add. Removing it is consistent with most
333
508
other tools. Maybe an option.
335
510
## TODO: Normalize names
336
511
## TODO: Remove nested loops; better scalability
338
if isinstance(files, types.StringTypes):
512
if isinstance(files, basestring):
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))
518
tree = self.working_tree()
521
# do this before any modifications
525
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
526
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
528
# having remove it, it must be either ignored or unknown
529
if tree.is_ignored(f):
533
show_status(new_status, inv[fid].kind, quotefn(f))
536
self._write_inventory(inv)
541
# FIXME: this doesn't need to be a branch method
542
def set_inventory(self, new_inventory_list):
543
from bzrlib.inventory import Inventory, InventoryEntry
544
inv = Inventory(self.get_root_id())
545
for path, file_id, parent, kind in new_inventory_list:
546
name = os.path.basename(path)
549
inv.add(InventoryEntry(file_id, name, kind, parent))
359
550
self._write_inventory(inv)
378
569
return self.working_tree().unknowns()
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())
572
def append_revision(self, *revision_ids):
573
from bzrlib.atomicfile import AtomicFile
575
for revision_id in revision_ids:
576
mutter("add {%s} to revision-history" % revision_id)
578
rev_history = self.revision_history()
579
rev_history.extend(revision_ids)
581
f = AtomicFile(self.controlfilename('revision-history'))
583
for rev_id in rev_history:
590
def get_revision_xml(self, revision_id):
591
"""Return XML file object for revision object."""
592
if not revision_id or not isinstance(revision_id, basestring):
593
raise InvalidRevisionId(revision_id)
598
return self.revision_store[revision_id]
600
raise bzrlib.errors.NoSuchRevision(self, revision_id)
553
605
def get_revision(self, revision_id):
554
606
"""Return the Revision object for a named revision"""
555
r = Revision.read_xml(self.revision_store[revision_id])
607
xml_file = self.get_revision_xml(revision_id)
610
r = unpack_xml(Revision, xml_file)
611
except SyntaxError, e:
612
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
556
616
assert r.revision_id == revision_id
620
def get_revision_delta(self, revno):
621
"""Return the delta for one revision.
623
The delta is relative to its mainline predecessor, or the
624
empty tree for revision 1.
626
assert isinstance(revno, int)
627
rh = self.revision_history()
628
if not (1 <= revno <= len(rh)):
629
raise InvalidRevisionNumber(revno)
631
# revno is 1-based; list is 0-based
633
new_tree = self.revision_tree(rh[revno-1])
635
old_tree = EmptyTree()
637
old_tree = self.revision_tree(rh[revno-2])
639
return compare_trees(old_tree, new_tree)
643
def get_revision_sha1(self, revision_id):
644
"""Hash the stored value of a revision, and return it."""
645
# In the future, revision entries will be signed. At that
646
# point, it is probably best *not* to include the signature
647
# in the revision hash. Because that lets you re-sign
648
# the revision, (add signatures/remove signatures) and still
649
# have all hash pointers stay consistent.
650
# But for now, just hash the contents.
651
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
560
654
def get_inventory(self, inventory_id):
561
655
"""Get Inventory object by hash.
563
:todo: Perhaps for this and similar methods, take a revision
657
TODO: Perhaps for this and similar methods, take a revision
564
658
parameter which can be either an integer revno or a
566
i = Inventory.read_xml(self.inventory_store[inventory_id])
660
from bzrlib.inventory import Inventory
661
from bzrlib.xml import unpack_xml
663
return unpack_xml(Inventory, self.inventory_store[inventory_id])
666
def get_inventory_sha1(self, inventory_id):
667
"""Return the sha1 hash of the inventory entry
669
return sha_file(self.inventory_store[inventory_id])
570
672
def get_revision_inventory(self, revision_id):
571
673
"""Return inventory of a past revision."""
674
# bzr 0.0.6 imposes the constraint that the inventory_id
675
# must be the same as its revision, so this is trivial.
572
676
if revision_id == None:
677
from bzrlib.inventory import Inventory
678
return Inventory(self.get_root_id())
575
return self.get_inventory(self.get_revision(revision_id).inventory_id)
680
return self.get_inventory(revision_id)
578
683
def revision_history(self):
590
745
That is equivalent to the number of revisions committed to
593
>>> b = ScratchBranch()
596
>>> b.commit('no foo')
600
748
return len(self.revision_history())
603
751
def last_patch(self):
604
752
"""Return last patch hash, or None if no history.
606
>>> ScratchBranch().last_patch() == None
609
754
ph = self.revision_history()
614
def lookup_revision(self, revno):
615
"""Return revision hash for revision number."""
620
# list is 0-based; revisions are 1-based
621
return self.revision_history()[revno-1]
623
bailout("no such revision %s" % revno)
761
def missing_revisions(self, other, stop_revision=None):
763
If self and other have not diverged, return a list of the revisions
764
present in other, but missing from self.
766
>>> from bzrlib.commit import commit
767
>>> bzrlib.trace.silent = True
768
>>> br1 = ScratchBranch()
769
>>> br2 = ScratchBranch()
770
>>> br1.missing_revisions(br2)
772
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
773
>>> br1.missing_revisions(br2)
775
>>> br2.missing_revisions(br1)
777
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
778
>>> br1.missing_revisions(br2)
780
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
781
>>> br1.missing_revisions(br2)
783
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
784
>>> br1.missing_revisions(br2)
785
Traceback (most recent call last):
786
DivergedBranches: These branches have diverged.
788
self_history = self.revision_history()
789
self_len = len(self_history)
790
other_history = other.revision_history()
791
other_len = len(other_history)
792
common_index = min(self_len, other_len) -1
793
if common_index >= 0 and \
794
self_history[common_index] != other_history[common_index]:
795
raise DivergedBranches(self, other)
797
if stop_revision is None:
798
stop_revision = other_len
799
elif stop_revision > other_len:
800
raise NoSuchRevision(self, stop_revision)
802
return other_history[self_len:stop_revision]
805
def update_revisions(self, other, stop_revision=None):
806
"""Pull in all new revisions from other branch.
808
>>> from bzrlib.commit import commit
809
>>> bzrlib.trace.silent = True
810
>>> br1 = ScratchBranch(files=['foo', 'bar'])
813
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
814
>>> br2 = ScratchBranch()
815
>>> br2.update_revisions(br1)
819
>>> br2.revision_history()
821
>>> br2.update_revisions(br1)
825
>>> br1.text_store.total_size() == br2.text_store.total_size()
828
from bzrlib.progress import ProgressBar
832
pb.update('comparing histories')
833
revision_ids = self.missing_revisions(other, stop_revision)
835
if hasattr(other.revision_store, "prefetch"):
836
other.revision_store.prefetch(revision_ids)
837
if hasattr(other.inventory_store, "prefetch"):
838
inventory_ids = [other.get_revision(r).inventory_id
839
for r in revision_ids]
840
other.inventory_store.prefetch(inventory_ids)
845
for rev_id in revision_ids:
847
pb.update('fetching revision', i, len(revision_ids))
848
rev = other.get_revision(rev_id)
849
revisions.append(rev)
850
inv = other.get_inventory(str(rev.inventory_id))
851
for key, entry in inv.iter_entries():
852
if entry.text_id is None:
854
if entry.text_id not in self.text_store:
855
needed_texts.add(entry.text_id)
859
count = self.text_store.copy_multi(other.text_store, needed_texts)
860
print "Added %d texts." % count
861
inventory_ids = [ f.inventory_id for f in revisions ]
862
count = self.inventory_store.copy_multi(other.inventory_store,
864
print "Added %d inventories." % count
865
revision_ids = [ f.revision_id for f in revisions]
866
count = self.revision_store.copy_multi(other.revision_store,
868
for revision_id in revision_ids:
869
self.append_revision(revision_id)
870
print "Added %d revisions." % count
873
def commit(self, *args, **kw):
874
from bzrlib.commit import commit
875
commit(self, *args, **kw)
878
def lookup_revision(self, revision):
879
"""Return the revision identifier for a given revision information."""
880
revno, info = self.get_revision_info(revision)
883
def get_revision_info(self, revision):
884
"""Return (revno, revision id) for revision identifier.
886
revision can be an integer, in which case it is assumed to be revno (though
887
this will translate negative values into positive ones)
888
revision can also be a string, in which case it is parsed for something like
889
'date:' or 'revid:' etc.
894
try:# Convert to int if possible
895
revision = int(revision)
898
revs = self.revision_history()
899
if isinstance(revision, int):
902
# Mabye we should do this first, but we don't need it if revision == 0
904
revno = len(revs) + revision + 1
907
elif isinstance(revision, basestring):
908
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
909
if revision.startswith(prefix):
910
revno = func(self, revs, revision)
913
raise BzrError('No namespace registered for string: %r' % revision)
915
if revno is None or revno <= 0 or revno > len(revs):
916
raise BzrError("no such revision %s" % revision)
917
return revno, revs[revno-1]
919
def _namespace_revno(self, revs, revision):
920
"""Lookup a revision by revision number"""
921
assert revision.startswith('revno:')
923
return int(revision[6:])
926
REVISION_NAMESPACES['revno:'] = _namespace_revno
928
def _namespace_revid(self, revs, revision):
929
assert revision.startswith('revid:')
931
return revs.index(revision[6:]) + 1
934
REVISION_NAMESPACES['revid:'] = _namespace_revid
936
def _namespace_last(self, revs, revision):
937
assert revision.startswith('last:')
939
offset = int(revision[5:])
944
raise BzrError('You must supply a positive value for --revision last:XXX')
945
return len(revs) - offset + 1
946
REVISION_NAMESPACES['last:'] = _namespace_last
948
def _namespace_tag(self, revs, revision):
949
assert revision.startswith('tag:')
950
raise BzrError('tag: namespace registered, but not implemented.')
951
REVISION_NAMESPACES['tag:'] = _namespace_tag
953
def _namespace_date(self, revs, revision):
954
assert revision.startswith('date:')
956
# Spec for date revisions:
958
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
959
# it can also start with a '+/-/='. '+' says match the first
960
# entry after the given date. '-' is match the first entry before the date
961
# '=' is match the first entry after, but still on the given date.
963
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
964
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
965
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
966
# May 13th, 2005 at 0:00
968
# So the proper way of saying 'give me all entries for today' is:
969
# -r {date:+today}:{date:-tomorrow}
970
# The default is '=' when not supplied
973
if val[:1] in ('+', '-', '='):
974
match_style = val[:1]
977
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
978
if val.lower() == 'yesterday':
979
dt = today - datetime.timedelta(days=1)
980
elif val.lower() == 'today':
982
elif val.lower() == 'tomorrow':
983
dt = today + datetime.timedelta(days=1)
986
# This should be done outside the function to avoid recompiling it.
987
_date_re = re.compile(
988
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
990
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
992
m = _date_re.match(val)
993
if not m or (not m.group('date') and not m.group('time')):
994
raise BzrError('Invalid revision date %r' % revision)
997
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
999
year, month, day = today.year, today.month, today.day
1001
hour = int(m.group('hour'))
1002
minute = int(m.group('minute'))
1003
if m.group('second'):
1004
second = int(m.group('second'))
1008
hour, minute, second = 0,0,0
1010
dt = datetime.datetime(year=year, month=month, day=day,
1011
hour=hour, minute=minute, second=second)
1015
if match_style == '-':
1017
elif match_style == '=':
1018
last = dt + datetime.timedelta(days=1)
1021
for i in range(len(revs)-1, -1, -1):
1022
r = self.get_revision(revs[i])
1023
# TODO: Handle timezone.
1024
dt = datetime.datetime.fromtimestamp(r.timestamp)
1025
if first >= dt and (last is None or dt >= last):
1028
for i in range(len(revs)):
1029
r = self.get_revision(revs[i])
1030
# TODO: Handle timezone.
1031
dt = datetime.datetime.fromtimestamp(r.timestamp)
1032
if first <= dt and (last is None or dt <= last):
1034
REVISION_NAMESPACES['date:'] = _namespace_date
626
1036
def revision_tree(self, revision_id):
627
1037
"""Return Tree for a revision on this branch.
629
1039
`revision_id` may be None for the null revision, in which case
630
1040
an `EmptyTree` is returned."""
1041
# TODO: refactor this to use an existing revision object
1042
# so we don't need to read it in twice.
632
1043
if revision_id == None:
633
1044
return EmptyTree()
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'))
1069
def rename_one(self, from_rel, to_rel):
1072
This can change the directory or the filename or both.
1076
tree = self.working_tree()
1077
inv = tree.inventory
1078
if not tree.has_filename(from_rel):
1079
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1080
if tree.has_filename(to_rel):
1081
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1083
file_id = inv.path2id(from_rel)
1085
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1087
if inv.path2id(to_rel):
1088
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1090
to_dir, to_tail = os.path.split(to_rel)
1091
to_dir_id = inv.path2id(to_dir)
1092
if to_dir_id == None and to_dir != '':
1093
raise BzrError("can't determine destination directory id for %r" % to_dir)
1095
mutter("rename_one:")
1096
mutter(" file_id {%s}" % file_id)
1097
mutter(" from_rel %r" % from_rel)
1098
mutter(" to_rel %r" % to_rel)
1099
mutter(" to_dir %r" % to_dir)
1100
mutter(" to_dir_id {%s}" % to_dir_id)
1102
inv.rename(file_id, to_dir_id, to_tail)
1104
print "%s => %s" % (from_rel, to_rel)
1106
from_abs = self.abspath(from_rel)
1107
to_abs = self.abspath(to_rel)
1109
os.rename(from_abs, to_abs)
1111
raise BzrError("failed to rename %r to %r: %s"
1112
% (from_abs, to_abs, e[1]),
1113
["rename rolled back"])
1115
self._write_inventory(inv)
1120
def move(self, from_paths, to_name):
1123
to_name must exist as a versioned directory.
1125
If to_name exists and is a directory, the files are moved into
1126
it, keeping their old names. If it is a directory,
1128
Note that to_name is only the last component of the new name;
1129
this doesn't change the directory.
1133
## TODO: Option to move IDs only
1134
assert not isinstance(from_paths, basestring)
1135
tree = self.working_tree()
1136
inv = tree.inventory
1137
to_abs = self.abspath(to_name)
1138
if not isdir(to_abs):
1139
raise BzrError("destination %r is not a directory" % to_abs)
1140
if not tree.has_filename(to_name):
1141
raise BzrError("destination %r not in working directory" % to_abs)
1142
to_dir_id = inv.path2id(to_name)
1143
if to_dir_id == None and to_name != '':
1144
raise BzrError("destination %r is not a versioned directory" % to_name)
1145
to_dir_ie = inv[to_dir_id]
1146
if to_dir_ie.kind not in ('directory', 'root_directory'):
1147
raise BzrError("destination %r is not a directory" % to_abs)
1149
to_idpath = inv.get_idpath(to_dir_id)
1151
for f in from_paths:
1152
if not tree.has_filename(f):
1153
raise BzrError("%r does not exist in working tree" % f)
1154
f_id = inv.path2id(f)
1156
raise BzrError("%r is not versioned" % f)
1157
name_tail = splitpath(f)[-1]
1158
dest_path = appendpath(to_name, name_tail)
1159
if tree.has_filename(dest_path):
1160
raise BzrError("destination %r already exists" % dest_path)
1161
if f_id in to_idpath:
1162
raise BzrError("can't move %r to a subdirectory of itself" % f)
1164
# OK, so there's a race here, it's possible that someone will
1165
# create a file in this interval and then the rename might be
1166
# left half-done. But we should have caught most problems.
1168
for f in from_paths:
1169
name_tail = splitpath(f)[-1]
1170
dest_path = appendpath(to_name, name_tail)
1171
print "%s => %s" % (f, dest_path)
1172
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1174
os.rename(self.abspath(f), self.abspath(dest_path))
1176
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1177
["rename rolled back"])
1179
self._write_inventory(inv)
1184
def revert(self, filenames, old_tree=None, backups=True):
1185
"""Restore selected files to the versions from a previous tree.
1188
If true (default) backups are made of files before
1191
from bzrlib.errors import NotVersionedError, BzrError
1192
from bzrlib.atomicfile import AtomicFile
1193
from bzrlib.osutils import backup_file
718
:todo: Get state for single files.
720
:todo: Perhaps show a slash at the end of directory names.
1195
inv = self.read_working_inventory()
1196
if old_tree is None:
1197
old_tree = self.basis_tree()
1198
old_inv = old_tree.inventory
1201
for fn in filenames:
1202
file_id = inv.path2id(fn)
1204
raise NotVersionedError("not a versioned file", fn)
1205
if not old_inv.has_id(file_id):
1206
raise BzrError("file not present in old tree", fn, file_id)
1207
nids.append((fn, file_id))
1209
# TODO: Rename back if it was previously at a different location
1211
# TODO: If given a directory, restore the entire contents from
1212
# the previous version.
1214
# TODO: Make a backup to a temporary file.
1216
# TODO: If the file previously didn't exist, delete it?
1217
for fn, file_id in nids:
1220
f = AtomicFile(fn, 'wb')
1222
f.write(old_tree.get_file(file_id).read())
1228
def pending_merges(self):
1229
"""Return a list of pending merges.
1231
These are revisions that have been merged into the working
1232
directory but not yet committed.
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),))
1234
cfn = self.controlfilename('pending-merges')
1235
if not os.path.exists(cfn):
1238
for l in self.controlfile('pending-merges', 'r').readlines():
1239
p.append(l.rstrip('\n'))
1243
def add_pending_merge(self, revision_id):
1244
from bzrlib.revision import validate_revision_id
1246
validate_revision_id(revision_id)
1248
p = self.pending_merges()
1249
if revision_id in p:
1251
p.append(revision_id)
1252
self.set_pending_merges(p)
1255
def set_pending_merges(self, rev_list):
1256
from bzrlib.atomicfile import AtomicFile
1259
f = AtomicFile(self.controlfilename('pending-merges'))
759
1271
class ScratchBranch(Branch):