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, appendpath
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
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
29
from bzrlib.textui import show_status
30
from bzrlib.revision import Revision
31
from bzrlib.xml import unpack_xml
32
from bzrlib.delta import compare_trees
33
from bzrlib.tree import EmptyTree, RevisionTree
38
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
39
## TODO: Maybe include checks for common corruption of newlines, etc?
42
# TODO: Some operations like log might retrieve the same revisions
43
# repeatedly to calculate deltas. We could perhaps have a weakref
44
# cache in memory to make this faster.
46
# TODO: please move the revision-string syntax stuff out of the branch
47
# object; it's clutter
50
def find_branch(f, **args):
51
if f and (f.startswith('http://') or f.startswith('https://')):
53
return remotebranch.RemoteBranch(f, **args)
55
return Branch(f, **args)
58
def find_cached_branch(f, cache_root, **args):
59
from remotebranch import RemoteBranch
60
br = find_branch(f, **args)
61
def cacheify(br, store_name):
62
from meta_store import CachedStore
63
cache_path = os.path.join(cache_root, store_name)
65
new_store = CachedStore(getattr(br, store_name), cache_path)
66
setattr(br, store_name, new_store)
68
if isinstance(br, RemoteBranch):
69
cacheify(br, 'inventory_store')
70
cacheify(br, 'text_store')
71
cacheify(br, 'revision_store')
75
def _relpath(base, path):
76
"""Return path relative to base, or raise exception.
78
The path may be either an absolute path or a path relative to the
79
current working directory.
81
Lifted out of Branch.relpath for ease of testing.
83
os.path.commonprefix (python2.4) has a bad bug that it works just
84
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
85
avoids that problem."""
86
rp = os.path.abspath(path)
90
while len(head) >= len(base):
93
head, tail = os.path.split(head)
97
from errors import NotBranchError
98
raise NotBranchError("path %r is not within branch %r" % (rp, base))
100
return os.sep.join(s)
43
103
def find_branch_root(f=None):
44
104
"""Find the branch root enclosing f, or pwd.
106
f may be a filename or a URL.
46
108
It is not necessary that f exists.
48
110
Basically we keep looking up until we find the control directory or
111
run into the root. If there isn't one, raises NotBranchError.
52
115
elif hasattr(os.path, 'realpath'):
53
116
f = os.path.realpath(f)
55
118
f = os.path.abspath(f)
119
if not os.path.exists(f):
120
raise BzrError('%r does not exist' % f)
61
126
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
63
128
head, tail = os.path.split(f)
65
130
# reached the root, whatever that may be
66
bailout('%r is not in a branch' % orig_f)
131
raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
136
# XXX: move into bzrlib.errors; subclass BzrError
137
class DivergedBranches(Exception):
138
def __init__(self, branch1, branch2):
139
self.branch1 = branch1
140
self.branch2 = branch2
141
Exception.__init__(self, "These branches have diverged.")
71
144
######################################################################
147
class Branch(object):
75
148
"""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.
151
Base directory of the branch.
157
If _lock_mode is true, a positive count of the number of times the
161
Lock object from bzrlib.lock.
168
# Map some sort of prefix into a namespace
169
# stuff like "revno:10", "revid:", etc.
170
# This should match a prefix with a function which accepts
171
REVISION_NAMESPACES = {}
90
173
def __init__(self, base, init=False, find_root=True):
91
174
"""Create new branch object at a particular location.
93
:param base: Base directory for the branch.
176
base -- Base directory for the branch.
95
:param init: If True, create new control files in a previously
178
init -- If True, create new control files in a previously
96
179
unversioned directory. If False, the branch must already
99
:param find_root: If true and init is false, find the root of the
182
find_root -- If true and init is false, find the root of the
100
183
existing branch containing base.
102
185
In the test suite, creation of new trees is tested using the
103
186
`ScratchBranch` class.
188
from bzrlib.store import ImmutableStore
106
190
self.base = os.path.realpath(base)
107
191
self._make_control()
136
272
"""Return path relative to this branch of something inside it.
138
274
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)
275
return _relpath(self.base, path)
148
278
def controlfilename(self, file_or_path):
149
279
"""Return location relative to branch."""
150
if isinstance(file_or_path, types.StringTypes):
280
if isinstance(file_or_path, basestring):
151
281
file_or_path = [file_or_path]
152
282
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
155
285
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)
286
"""Open a control file for this branch.
288
There are two classes of file in the control directory: text
289
and binary. binary files are untranslated byte streams. Text
290
control files are stored with Unix newlines and in UTF-8, even
291
if the platform or locale defaults are different.
293
Controlfiles should almost never be opened in write mode but
294
rather should be atomically copied and replaced using atomicfile.
297
fn = self.controlfilename(file_or_path)
299
if mode == 'rb' or mode == 'wb':
300
return file(fn, mode)
301
elif mode == 'r' or mode == 'w':
302
# open in binary mode anyhow so there's no newline translation;
303
# codecs uses line buffering by default; don't want that.
305
return codecs.open(fn, mode + 'b', 'utf-8',
308
raise BzrError("invalid controlfile mode %r" % mode)
160
312
def _make_control(self):
313
from bzrlib.inventory import Inventory
314
from bzrlib.xml import pack_xml
161
316
os.mkdir(self.controlfilename([]))
162
317
self.controlfile('README', 'w').write(
163
318
"This is a Bazaar-NG control directory.\n"
164
"Do not change any files in this directory.")
165
self.controlfile('branch-format', 'wb').write(BZR_BRANCH_FORMAT)
319
"Do not change any files in this directory.\n")
320
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
166
321
for d in ('text-store', 'inventory-store', 'revision-store'):
167
322
os.mkdir(self.controlfilename(d))
168
323
for f in ('revision-history', 'merged-patches',
169
'pending-merged-patches', 'branch-name'):
324
'pending-merged-patches', 'branch-name',
170
327
self.controlfile(f, 'w').write('')
171
328
mutter('created control directory in ' + self.base)
172
Inventory().write_xml(self.controlfile('inventory','w'))
330
# if we want per-tree root ids then this is the place to set
331
# them; they're not needed for now and so ommitted for
333
pack_xml(Inventory(), self.controlfile('inventory','w'))
175
336
def _check_format(self):
183
344
# This ignores newlines so that we can open branches created
184
345
# on Windows from Linux and so on. I think it might be better
185
346
# to always make all internal files in unix format.
186
fmt = self.controlfile('branch-format', 'rb').read()
347
fmt = self.controlfile('branch-format', 'r').read()
187
348
fmt.replace('\r\n', '')
188
349
if fmt != BZR_BRANCH_FORMAT:
189
bailout('sorry, branch format %r not supported' % fmt,
190
['use a different bzr version',
191
'or remove the .bzr directory and "bzr init" again'])
350
raise BzrError('sorry, branch format %r not supported' % fmt,
351
['use a different bzr version',
352
'or remove the .bzr directory and "bzr init" again'])
354
def get_root_id(self):
355
"""Return the id of this branches root"""
356
inv = self.read_working_inventory()
357
return inv.root.file_id
359
def set_root_id(self, file_id):
360
inv = self.read_working_inventory()
361
orig_root_id = inv.root.file_id
362
del inv._byid[inv.root.file_id]
363
inv.root.file_id = file_id
364
inv._byid[inv.root.file_id] = inv.root
367
if entry.parent_id in (None, orig_root_id):
368
entry.parent_id = inv.root.file_id
369
self._write_inventory(inv)
194
371
def read_working_inventory(self):
195
372
"""Read the working inventory."""
197
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
198
mutter("loaded inventory of %d items in %f"
199
% (len(inv), time.time() - before))
373
from bzrlib.inventory import Inventory
374
from bzrlib.xml import unpack_xml
375
from time import time
379
# ElementTree does its own conversion from UTF-8, so open in
381
inv = unpack_xml(Inventory,
382
self.controlfile('inventory', 'rb'))
383
mutter("loaded inventory of %d items in %f"
384
% (len(inv), time() - before))
203
390
def _write_inventory(self, inv):
204
391
"""Update the working inventory.
206
393
That is to say, the inventory describing changes underway, that
207
394
will be committed to the next revision.
209
## TODO: factor out to atomicfile? is rename safe on windows?
210
## TODO: Maybe some kind of clean/dirty marker on inventory?
211
tmpfname = self.controlfilename('inventory.tmp')
212
tmpf = file(tmpfname, 'w')
215
inv_fname = self.controlfilename('inventory')
216
if sys.platform == 'win32':
218
os.rename(tmpfname, inv_fname)
396
from bzrlib.atomicfile import AtomicFile
397
from bzrlib.xml import pack_xml
401
f = AtomicFile(self.controlfilename('inventory'), 'wb')
219
410
mutter('wrote working inventory')
222
413
inventory = property(read_working_inventory, _write_inventory, None,
223
414
"""Inventory for the working copy.""")
226
def add(self, files, verbose=False):
417
def add(self, files, verbose=False, ids=None):
227
418
"""Make files versioned.
420
Note that the command line normally calls smart_add instead.
229
422
This puts the files in the Added state, so that they will be
230
423
recorded by the next commit.
232
:todo: Perhaps have an option to add the ids even if the files do
235
:todo: Perhaps return the ids of the files? But then again it
236
is easy to retrieve them if they're needed.
238
:todo: Option to specify file id.
240
:todo: Adding a directory should optionally recurse down and
241
add all non-ignored children. Perhaps do that in a
244
>>> b = ScratchBranch(files=['foo'])
245
>>> 'foo' in b.unknowns()
250
>>> 'foo' in b.unknowns()
252
>>> bool(b.inventory.path2id('foo'))
258
Traceback (most recent call last):
260
BzrError: ('foo is already versioned', [])
262
>>> b.add(['nothere'])
263
Traceback (most recent call last):
264
BzrError: ('cannot add: not a regular file or directory: nothere', [])
426
List of paths to add, relative to the base of the tree.
429
If set, use these instead of automatically generated ids.
430
Must be the same length as the list of files, but may
431
contain None for ids that are to be autogenerated.
433
TODO: Perhaps have an option to add the ids even if the files do
436
TODO: Perhaps return the ids of the files? But then again it
437
is easy to retrieve them if they're needed.
439
TODO: Adding a directory should optionally recurse down and
440
add all non-ignored children. Perhaps do that in a
267
443
# TODO: Re-adding a file that is removed in the working copy
268
444
# should probably put it back with the previous ID.
269
if isinstance(files, types.StringTypes):
445
if isinstance(files, basestring):
446
assert(ids is None or isinstance(ids, basestring))
272
inv = self.read_working_inventory()
274
if is_control_file(f):
275
bailout("cannot add control file %s" % quotefn(f))
280
bailout("cannot add top-level %r" % f)
282
fullpath = os.path.normpath(self.abspath(f))
285
kind = file_kind(fullpath)
287
# maybe something better?
288
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
290
if kind != 'file' and kind != 'directory':
291
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
293
file_id = gen_file_id(f)
294
inv.add_path(f, kind=kind, file_id=file_id)
297
show_status('A', kind, quotefn(f))
299
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
301
self._write_inventory(inv)
452
ids = [None] * len(files)
454
assert(len(ids) == len(files))
458
inv = self.read_working_inventory()
459
for f,file_id in zip(files, ids):
460
if is_control_file(f):
461
raise BzrError("cannot add control file %s" % quotefn(f))
466
raise BzrError("cannot add top-level %r" % f)
468
fullpath = os.path.normpath(self.abspath(f))
471
kind = file_kind(fullpath)
473
# maybe something better?
474
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
476
if kind != 'file' and kind != 'directory':
477
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
480
file_id = gen_file_id(f)
481
inv.add_path(f, kind=kind, file_id=file_id)
484
print 'added', quotefn(f)
486
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
488
self._write_inventory(inv)
493
def print_file(self, file, revno):
494
"""Print `file` to stdout."""
497
tree = self.revision_tree(self.lookup_revision(revno))
498
# use inventory as it was in that revision
499
file_id = tree.inventory.path2id(file)
501
raise BzrError("%r is not present in revision %s" % (file, revno))
502
tree.print_file(file_id)
305
507
def remove(self, files, verbose=False):
308
510
This does not remove their text. This does not run on
310
:todo: Refuse to remove modified files unless --force is given?
312
>>> b = ScratchBranch(files=['foo'])
314
>>> b.inventory.has_filename('foo')
317
>>> b.working_tree().has_filename('foo')
319
>>> b.inventory.has_filename('foo')
322
>>> b = ScratchBranch(files=['foo'])
327
>>> b.inventory.has_filename('foo')
329
>>> b.basis_tree().has_filename('foo')
331
>>> b.working_tree().has_filename('foo')
334
:todo: Do something useful with directories.
336
:todo: Should this remove the text or not? Tough call; not
512
TODO: Refuse to remove modified files unless --force is given?
514
TODO: Do something useful with directories.
516
TODO: Should this remove the text or not? Tough call; not
337
517
removing may be useful and the user can just use use rm, and
338
518
is the opposite of add. Removing it is consistent with most
339
519
other tools. Maybe an option.
341
521
## TODO: Normalize names
342
522
## TODO: Remove nested loops; better scalability
344
if isinstance(files, types.StringTypes):
523
if isinstance(files, basestring):
347
tree = self.working_tree()
350
# do this before any modifications
354
bailout("cannot remove unversioned file %s" % quotefn(f))
355
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
357
# having remove it, it must be either ignored or unknown
358
if tree.is_ignored(f):
362
show_status(new_status, inv[fid].kind, quotefn(f))
529
tree = self.working_tree()
532
# do this before any modifications
536
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
537
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
539
# having remove it, it must be either ignored or unknown
540
if tree.is_ignored(f):
544
show_status(new_status, inv[fid].kind, quotefn(f))
547
self._write_inventory(inv)
552
# FIXME: this doesn't need to be a branch method
553
def set_inventory(self, new_inventory_list):
554
from bzrlib.inventory import Inventory, InventoryEntry
555
inv = Inventory(self.get_root_id())
556
for path, file_id, parent, kind in new_inventory_list:
557
name = os.path.basename(path)
560
inv.add(InventoryEntry(file_id, name, kind, parent))
365
561
self._write_inventory(inv)
384
580
return self.working_tree().unknowns()
387
def commit(self, message, timestamp=None, timezone=None,
390
"""Commit working copy as a new revision.
392
The basic approach is to add all the file texts into the
393
store, then the inventory, then make a new revision pointing
394
to that inventory and store that.
396
This is not quite safe if the working copy changes during the
397
commit; for the moment that is simply not allowed. A better
398
approach is to make a temporary copy of the files before
399
computing their hashes, and then add those hashes in turn to
400
the inventory. This should mean at least that there are no
401
broken hash pointers. There is no way we can get a snapshot
402
of the whole directory at an instant. This would also have to
403
be robust against files disappearing, moving, etc. So the
404
whole thing is a bit hard.
406
:param timestamp: if not None, seconds-since-epoch for a
407
postdated/predated commit.
410
## TODO: Show branch names
412
# TODO: Don't commit if there are no changes, unless forced?
414
# First walk over the working inventory; and both update that
415
# and also build a new revision inventory. The revision
416
# inventory needs to hold the text-id, sha1 and size of the
417
# actual file versions committed in the revision. (These are
418
# not present in the working inventory.) We also need to
419
# detect missing/deleted files, and remove them from the
422
work_inv = self.read_working_inventory()
424
basis = self.basis_tree()
425
basis_inv = basis.inventory
427
for path, entry in work_inv.iter_entries():
428
## TODO: Cope with files that have gone missing.
430
## TODO: Check that the file kind has not changed from the previous
431
## revision of this file (if any).
435
p = self.abspath(path)
436
file_id = entry.file_id
437
mutter('commit prep file %s, id %r ' % (p, file_id))
439
if not os.path.exists(p):
440
mutter(" file is missing, removing from inventory")
442
show_status('D', entry.kind, quotefn(path))
443
missing_ids.append(file_id)
446
# TODO: Handle files that have been deleted
448
# TODO: Maybe a special case for empty files? Seems a
449
# waste to store them many times.
453
if basis_inv.has_id(file_id):
454
old_kind = basis_inv[file_id].kind
455
if old_kind != entry.kind:
456
bailout("entry %r changed kind from %r to %r"
457
% (file_id, old_kind, entry.kind))
459
if entry.kind == 'directory':
461
bailout("%s is entered as directory but not a directory" % quotefn(p))
462
elif entry.kind == 'file':
464
bailout("%s is entered as file but is not a file" % quotefn(p))
466
content = file(p, 'rb').read()
468
entry.text_sha1 = sha_string(content)
469
entry.text_size = len(content)
471
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
473
and (old_ie.text_size == entry.text_size)
474
and (old_ie.text_sha1 == entry.text_sha1)):
475
## assert content == basis.get_file(file_id).read()
476
entry.text_id = basis_inv[file_id].text_id
477
mutter(' unchanged from previous text_id {%s}' %
481
entry.text_id = gen_file_id(entry.name)
482
self.text_store.add(content, entry.text_id)
483
mutter(' stored with text_id {%s}' % entry.text_id)
487
elif (old_ie.name == entry.name
488
and old_ie.parent_id == entry.parent_id):
493
show_status(state, entry.kind, quotefn(path))
495
for file_id in missing_ids:
496
# have to do this later so we don't mess up the iterator.
497
# since parents may be removed before their children we
500
# FIXME: There's probably a better way to do this; perhaps
501
# the workingtree should know how to filter itself.
502
if work_inv.has_id(file_id):
503
del work_inv[file_id]
506
inv_id = rev_id = _gen_revision_id(time.time())
508
inv_tmp = tempfile.TemporaryFile()
509
inv.write_xml(inv_tmp)
511
self.inventory_store.add(inv_tmp, inv_id)
512
mutter('new inventory_id is {%s}' % inv_id)
514
self._write_inventory(work_inv)
516
if timestamp == None:
517
timestamp = time.time()
519
if committer == None:
520
committer = username()
523
timezone = local_time_offset()
525
mutter("building commit log message")
526
rev = Revision(timestamp=timestamp,
529
precursor = self.last_patch(),
534
rev_tmp = tempfile.TemporaryFile()
535
rev.write_xml(rev_tmp)
537
self.revision_store.add(rev_tmp, rev_id)
538
mutter("new revision_id is {%s}" % rev_id)
540
## XXX: Everything up to here can simply be orphaned if we abort
541
## the commit; it will leave junk files behind but that doesn't
544
## TODO: Read back the just-generated changeset, and make sure it
545
## applies and recreates the right state.
547
## TODO: Also calculate and store the inventory SHA1
548
mutter("committing patch r%d" % (self.revno() + 1))
550
mutter("append to revision-history")
551
f = self.controlfile('revision-history', 'at')
552
f.write(rev_id + '\n')
556
note("commited r%d" % self.revno())
583
def append_revision(self, *revision_ids):
584
from bzrlib.atomicfile import AtomicFile
586
for revision_id in revision_ids:
587
mutter("add {%s} to revision-history" % revision_id)
589
rev_history = self.revision_history()
590
rev_history.extend(revision_ids)
592
f = AtomicFile(self.controlfilename('revision-history'))
594
for rev_id in rev_history:
601
def get_revision_xml(self, revision_id):
602
"""Return XML file object for revision object."""
603
if not revision_id or not isinstance(revision_id, basestring):
604
raise InvalidRevisionId(revision_id)
609
return self.revision_store[revision_id]
611
raise bzrlib.errors.NoSuchRevision(self, revision_id)
559
616
def get_revision(self, revision_id):
560
617
"""Return the Revision object for a named revision"""
561
r = Revision.read_xml(self.revision_store[revision_id])
618
xml_file = self.get_revision_xml(revision_id)
621
r = unpack_xml(Revision, xml_file)
622
except SyntaxError, e:
623
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
562
627
assert r.revision_id == revision_id
631
def get_revision_delta(self, revno):
632
"""Return the delta for one revision.
634
The delta is relative to its mainline predecessor, or the
635
empty tree for revision 1.
637
assert isinstance(revno, int)
638
rh = self.revision_history()
639
if not (1 <= revno <= len(rh)):
640
raise InvalidRevisionNumber(revno)
642
# revno is 1-based; list is 0-based
644
new_tree = self.revision_tree(rh[revno-1])
646
old_tree = EmptyTree()
648
old_tree = self.revision_tree(rh[revno-2])
650
return compare_trees(old_tree, new_tree)
654
def get_revision_sha1(self, revision_id):
655
"""Hash the stored value of a revision, and return it."""
656
# In the future, revision entries will be signed. At that
657
# point, it is probably best *not* to include the signature
658
# in the revision hash. Because that lets you re-sign
659
# the revision, (add signatures/remove signatures) and still
660
# have all hash pointers stay consistent.
661
# But for now, just hash the contents.
662
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
566
665
def get_inventory(self, inventory_id):
567
666
"""Get Inventory object by hash.
569
:todo: Perhaps for this and similar methods, take a revision
668
TODO: Perhaps for this and similar methods, take a revision
570
669
parameter which can be either an integer revno or a
572
i = Inventory.read_xml(self.inventory_store[inventory_id])
671
from bzrlib.inventory import Inventory
672
from bzrlib.xml import unpack_xml
674
return unpack_xml(Inventory, self.get_inventory_xml(inventory_id))
677
def get_inventory_xml(self, inventory_id):
678
"""Get inventory XML as a file object."""
679
return self.inventory_store[inventory_id]
682
def get_inventory_sha1(self, inventory_id):
683
"""Return the sha1 hash of the inventory entry
685
return sha_file(self.get_inventory_xml(inventory_id))
576
688
def get_revision_inventory(self, revision_id):
577
689
"""Return inventory of a past revision."""
690
# bzr 0.0.6 imposes the constraint that the inventory_id
691
# must be the same as its revision, so this is trivial.
578
692
if revision_id == None:
693
from bzrlib.inventory import Inventory
694
return Inventory(self.get_root_id())
581
return self.get_inventory(self.get_revision(revision_id).inventory_id)
696
return self.get_inventory(revision_id)
584
699
def revision_history(self):
596
761
That is equivalent to the number of revisions committed to
599
>>> b = ScratchBranch()
602
>>> b.commit('no foo')
606
764
return len(self.revision_history())
609
767
def last_patch(self):
610
768
"""Return last patch hash, or None if no history.
612
>>> ScratchBranch().last_patch() == None
615
770
ph = self.revision_history()
620
def lookup_revision(self, revno):
621
"""Return revision hash for revision number."""
626
# list is 0-based; revisions are 1-based
627
return self.revision_history()[revno-1]
629
bailout("no such revision %s" % revno)
777
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
779
If self and other have not diverged, return a list of the revisions
780
present in other, but missing from self.
782
>>> from bzrlib.commit import commit
783
>>> bzrlib.trace.silent = True
784
>>> br1 = ScratchBranch()
785
>>> br2 = ScratchBranch()
786
>>> br1.missing_revisions(br2)
788
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
789
>>> br1.missing_revisions(br2)
791
>>> br2.missing_revisions(br1)
793
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
794
>>> br1.missing_revisions(br2)
796
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
797
>>> br1.missing_revisions(br2)
799
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
800
>>> br1.missing_revisions(br2)
801
Traceback (most recent call last):
802
DivergedBranches: These branches have diverged.
804
self_history = self.revision_history()
805
self_len = len(self_history)
806
other_history = other.revision_history()
807
other_len = len(other_history)
808
common_index = min(self_len, other_len) -1
809
if common_index >= 0 and \
810
self_history[common_index] != other_history[common_index]:
811
raise DivergedBranches(self, other)
813
if stop_revision is None:
814
stop_revision = other_len
815
elif stop_revision > other_len:
816
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
818
return other_history[self_len:stop_revision]
821
def update_revisions(self, other, stop_revision=None):
822
"""Pull in all new revisions from other branch.
824
from bzrlib.fetch import greedy_fetch
826
pb = bzrlib.ui.ui_factory.progress_bar()
827
pb.update('comparing histories')
829
revision_ids = self.missing_revisions(other, stop_revision)
831
if len(revision_ids) > 0:
832
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
835
self.append_revision(*revision_ids)
836
## note("Added %d revisions." % count)
839
def install_revisions(self, other, revision_ids, pb):
840
if hasattr(other.revision_store, "prefetch"):
841
other.revision_store.prefetch(revision_ids)
842
if hasattr(other.inventory_store, "prefetch"):
843
inventory_ids = [other.get_revision(r).inventory_id
844
for r in revision_ids]
845
other.inventory_store.prefetch(inventory_ids)
848
pb = bzrlib.ui.ui_factory.progress_bar()
855
for i, rev_id in enumerate(revision_ids):
856
pb.update('fetching revision', i+1, len(revision_ids))
858
rev = other.get_revision(rev_id)
859
except bzrlib.errors.NoSuchRevision:
863
revisions.append(rev)
864
inv = other.get_inventory(str(rev.inventory_id))
865
for key, entry in inv.iter_entries():
866
if entry.text_id is None:
868
if entry.text_id not in self.text_store:
869
needed_texts.add(entry.text_id)
873
count, cp_fail = self.text_store.copy_multi(other.text_store,
875
print "Added %d texts." % count
876
inventory_ids = [ f.inventory_id for f in revisions ]
877
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
879
print "Added %d inventories." % count
880
revision_ids = [ f.revision_id for f in revisions]
882
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
885
assert len(cp_fail) == 0
886
return count, failures
889
def commit(self, *args, **kw):
890
from bzrlib.commit import commit
891
commit(self, *args, **kw)
894
def lookup_revision(self, revision):
895
"""Return the revision identifier for a given revision information."""
896
revno, info = self.get_revision_info(revision)
900
def revision_id_to_revno(self, revision_id):
901
"""Given a revision id, return its revno"""
902
history = self.revision_history()
904
return history.index(revision_id) + 1
906
raise bzrlib.errors.NoSuchRevision(self, revision_id)
909
def get_revision_info(self, revision):
910
"""Return (revno, revision id) for revision identifier.
912
revision can be an integer, in which case it is assumed to be revno (though
913
this will translate negative values into positive ones)
914
revision can also be a string, in which case it is parsed for something like
915
'date:' or 'revid:' etc.
920
try:# Convert to int if possible
921
revision = int(revision)
924
revs = self.revision_history()
925
if isinstance(revision, int):
928
# Mabye we should do this first, but we don't need it if revision == 0
930
revno = len(revs) + revision + 1
933
elif isinstance(revision, basestring):
934
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
935
if revision.startswith(prefix):
936
revno = func(self, revs, revision)
939
raise BzrError('No namespace registered for string: %r' % revision)
941
if revno is None or revno <= 0 or revno > len(revs):
942
raise BzrError("no such revision %s" % revision)
943
return revno, revs[revno-1]
945
def _namespace_revno(self, revs, revision):
946
"""Lookup a revision by revision number"""
947
assert revision.startswith('revno:')
949
return int(revision[6:])
952
REVISION_NAMESPACES['revno:'] = _namespace_revno
954
def _namespace_revid(self, revs, revision):
955
assert revision.startswith('revid:')
957
return revs.index(revision[6:]) + 1
960
REVISION_NAMESPACES['revid:'] = _namespace_revid
962
def _namespace_last(self, revs, revision):
963
assert revision.startswith('last:')
965
offset = int(revision[5:])
970
raise BzrError('You must supply a positive value for --revision last:XXX')
971
return len(revs) - offset + 1
972
REVISION_NAMESPACES['last:'] = _namespace_last
974
def _namespace_tag(self, revs, revision):
975
assert revision.startswith('tag:')
976
raise BzrError('tag: namespace registered, but not implemented.')
977
REVISION_NAMESPACES['tag:'] = _namespace_tag
979
def _namespace_date(self, revs, revision):
980
assert revision.startswith('date:')
982
# Spec for date revisions:
984
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
985
# it can also start with a '+/-/='. '+' says match the first
986
# entry after the given date. '-' is match the first entry before the date
987
# '=' is match the first entry after, but still on the given date.
989
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
990
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
991
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
992
# May 13th, 2005 at 0:00
994
# So the proper way of saying 'give me all entries for today' is:
995
# -r {date:+today}:{date:-tomorrow}
996
# The default is '=' when not supplied
999
if val[:1] in ('+', '-', '='):
1000
match_style = val[:1]
1003
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1004
if val.lower() == 'yesterday':
1005
dt = today - datetime.timedelta(days=1)
1006
elif val.lower() == 'today':
1008
elif val.lower() == 'tomorrow':
1009
dt = today + datetime.timedelta(days=1)
1012
# This should be done outside the function to avoid recompiling it.
1013
_date_re = re.compile(
1014
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1016
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1018
m = _date_re.match(val)
1019
if not m or (not m.group('date') and not m.group('time')):
1020
raise BzrError('Invalid revision date %r' % revision)
1023
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1025
year, month, day = today.year, today.month, today.day
1027
hour = int(m.group('hour'))
1028
minute = int(m.group('minute'))
1029
if m.group('second'):
1030
second = int(m.group('second'))
1034
hour, minute, second = 0,0,0
1036
dt = datetime.datetime(year=year, month=month, day=day,
1037
hour=hour, minute=minute, second=second)
1041
if match_style == '-':
1043
elif match_style == '=':
1044
last = dt + datetime.timedelta(days=1)
1047
for i in range(len(revs)-1, -1, -1):
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):
1054
for i in range(len(revs)):
1055
r = self.get_revision(revs[i])
1056
# TODO: Handle timezone.
1057
dt = datetime.datetime.fromtimestamp(r.timestamp)
1058
if first <= dt and (last is None or dt <= last):
1060
REVISION_NAMESPACES['date:'] = _namespace_date
632
1062
def revision_tree(self, revision_id):
633
1063
"""Return Tree for a revision on this branch.
635
1065
`revision_id` may be None for the null revision, in which case
636
1066
an `EmptyTree` is returned."""
1067
# TODO: refactor this to use an existing revision object
1068
# so we don't need to read it in twice.
638
1069
if revision_id == None:
639
1070
return EmptyTree()
673
def write_log(self, show_timezone='original'):
674
"""Write out human-readable log of commits to this branch
676
:param utc: If true, show dates in universal time, not local time."""
677
## TODO: Option to choose either original, utc or local timezone
680
for p in self.revision_history():
682
print 'revno:', revno
683
## TODO: Show hash if --id is given.
684
##print 'revision-hash:', p
685
rev = self.get_revision(p)
686
print 'committer:', rev.committer
687
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
690
## opportunistic consistency check, same as check_patch_chaining
691
if rev.precursor != precursor:
692
bailout("mismatched precursor!")
696
print ' (no message)'
698
for l in rev.message.split('\n'):
705
1095
def rename_one(self, from_rel, to_rel):
706
tree = self.working_tree()
708
if not tree.has_filename(from_rel):
709
bailout("can't rename: old working file %r does not exist" % from_rel)
710
if tree.has_filename(to_rel):
711
bailout("can't rename: new working file %r already exists" % to_rel)
713
file_id = inv.path2id(from_rel)
715
bailout("can't rename: old name %r is not versioned" % from_rel)
717
if inv.path2id(to_rel):
718
bailout("can't rename: new name %r is already versioned" % to_rel)
720
to_dir, to_tail = os.path.split(to_rel)
721
to_dir_id = inv.path2id(to_dir)
722
if to_dir_id == None and to_dir != '':
723
bailout("can't determine destination directory id for %r" % to_dir)
725
mutter("rename_one:")
726
mutter(" file_id {%s}" % file_id)
727
mutter(" from_rel %r" % from_rel)
728
mutter(" to_rel %r" % to_rel)
729
mutter(" to_dir %r" % to_dir)
730
mutter(" to_dir_id {%s}" % to_dir_id)
732
inv.rename(file_id, to_dir_id, to_tail)
733
os.rename(self.abspath(from_rel), self.abspath(to_rel))
735
self._write_inventory(inv)
739
def rename(self, from_paths, to_name):
1098
This can change the directory or the filename or both.
1102
tree = self.working_tree()
1103
inv = tree.inventory
1104
if not tree.has_filename(from_rel):
1105
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1106
if tree.has_filename(to_rel):
1107
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1109
file_id = inv.path2id(from_rel)
1111
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1113
if inv.path2id(to_rel):
1114
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1116
to_dir, to_tail = os.path.split(to_rel)
1117
to_dir_id = inv.path2id(to_dir)
1118
if to_dir_id == None and to_dir != '':
1119
raise BzrError("can't determine destination directory id for %r" % to_dir)
1121
mutter("rename_one:")
1122
mutter(" file_id {%s}" % file_id)
1123
mutter(" from_rel %r" % from_rel)
1124
mutter(" to_rel %r" % to_rel)
1125
mutter(" to_dir %r" % to_dir)
1126
mutter(" to_dir_id {%s}" % to_dir_id)
1128
inv.rename(file_id, to_dir_id, to_tail)
1130
print "%s => %s" % (from_rel, to_rel)
1132
from_abs = self.abspath(from_rel)
1133
to_abs = self.abspath(to_rel)
1135
os.rename(from_abs, to_abs)
1137
raise BzrError("failed to rename %r to %r: %s"
1138
% (from_abs, to_abs, e[1]),
1139
["rename rolled back"])
1141
self._write_inventory(inv)
1146
def move(self, from_paths, to_name):
740
1147
"""Rename files.
1149
to_name must exist as a versioned directory.
742
1151
If to_name exists and is a directory, the files are moved into
743
1152
it, keeping their old names. If it is a directory,
745
1154
Note that to_name is only the last component of the new name;
746
1155
this doesn't change the directory.
748
## TODO: Option to move IDs only
749
assert not isinstance(from_paths, basestring)
750
tree = self.working_tree()
752
dest_dir = isdir(self.abspath(to_name))
754
# TODO: Wind back properly if some can't be moved?
755
dest_dir_id = inv.path2id(to_name)
756
if not dest_dir_id and to_name != '':
757
bailout("destination %r is not a versioned directory" % to_name)
1159
## TODO: Option to move IDs only
1160
assert not isinstance(from_paths, basestring)
1161
tree = self.working_tree()
1162
inv = tree.inventory
1163
to_abs = self.abspath(to_name)
1164
if not isdir(to_abs):
1165
raise BzrError("destination %r is not a directory" % to_abs)
1166
if not tree.has_filename(to_name):
1167
raise BzrError("destination %r not in working directory" % to_abs)
1168
to_dir_id = inv.path2id(to_name)
1169
if to_dir_id == None and to_name != '':
1170
raise BzrError("destination %r is not a versioned directory" % to_name)
1171
to_dir_ie = inv[to_dir_id]
1172
if to_dir_ie.kind not in ('directory', 'root_directory'):
1173
raise BzrError("destination %r is not a directory" % to_abs)
1175
to_idpath = inv.get_idpath(to_dir_id)
1177
for f in from_paths:
1178
if not tree.has_filename(f):
1179
raise BzrError("%r does not exist in working tree" % f)
1180
f_id = inv.path2id(f)
1182
raise BzrError("%r is not versioned" % f)
1183
name_tail = splitpath(f)[-1]
1184
dest_path = appendpath(to_name, name_tail)
1185
if tree.has_filename(dest_path):
1186
raise BzrError("destination %r already exists" % dest_path)
1187
if f_id in to_idpath:
1188
raise BzrError("can't move %r to a subdirectory of itself" % f)
1190
# OK, so there's a race here, it's possible that someone will
1191
# create a file in this interval and then the rename might be
1192
# left half-done. But we should have caught most problems.
758
1194
for f in from_paths:
759
1195
name_tail = splitpath(f)[-1]
760
1196
dest_path = appendpath(to_name, name_tail)
761
1197
print "%s => %s" % (f, dest_path)
762
inv.rename(inv.path2id(f), dest_dir_id, name_tail)
763
os.rename(self.abspath(f), self.abspath(dest_path))
1198
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1200
os.rename(self.abspath(f), self.abspath(dest_path))
1202
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1203
["rename rolled back"])
764
1205
self._write_inventory(inv)
766
if len(from_paths) != 1:
767
bailout("when moving multiple files, destination must be a directory")
768
bailout("rename to non-directory %r not implemented sorry" % to_name)
772
def show_status(branch, show_all=False):
773
"""Display single-line status for non-ignored working files.
775
The list is show sorted in order by file name.
777
>>> b = ScratchBranch(files=['foo', 'foo~'])
783
>>> b.commit("add foo")
785
>>> os.unlink(b.abspath('foo'))
1210
def revert(self, filenames, old_tree=None, backups=True):
1211
"""Restore selected files to the versions from a previous tree.
1214
If true (default) backups are made of files before
1217
from bzrlib.errors import NotVersionedError, BzrError
1218
from bzrlib.atomicfile import AtomicFile
1219
from bzrlib.osutils import backup_file
790
:todo: Get state for single files.
792
:todo: Perhaps show a slash at the end of directory names.
1221
inv = self.read_working_inventory()
1222
if old_tree is None:
1223
old_tree = self.basis_tree()
1224
old_inv = old_tree.inventory
1227
for fn in filenames:
1228
file_id = inv.path2id(fn)
1230
raise NotVersionedError("not a versioned file", fn)
1231
if not old_inv.has_id(file_id):
1232
raise BzrError("file not present in old tree", fn, file_id)
1233
nids.append((fn, file_id))
1235
# TODO: Rename back if it was previously at a different location
1237
# TODO: If given a directory, restore the entire contents from
1238
# the previous version.
1240
# TODO: Make a backup to a temporary file.
1242
# TODO: If the file previously didn't exist, delete it?
1243
for fn, file_id in nids:
1246
f = AtomicFile(fn, 'wb')
1248
f.write(old_tree.get_file(file_id).read())
1254
def pending_merges(self):
1255
"""Return a list of pending merges.
1257
These are revisions that have been merged into the working
1258
directory but not yet committed.
796
# We have to build everything into a list first so that it can
797
# sorted by name, incorporating all the different sources.
799
# FIXME: Rather than getting things in random order and then sorting,
800
# just step through in order.
802
# Interesting case: the old ID for a file has been removed,
803
# but a new file has been created under that name.
805
old = branch.basis_tree()
806
old_inv = old.inventory
807
new = branch.working_tree()
808
new_inv = new.inventory
810
for fs, fid, oldname, newname, kind in diff_trees(old, new):
812
show_status(fs, kind,
813
oldname + ' => ' + newname)
814
elif fs == 'A' or fs == 'M':
815
show_status(fs, kind, newname)
817
show_status(fs, kind, oldname)
820
show_status(fs, kind, newname)
823
show_status(fs, kind, newname)
825
show_status(fs, kind, newname)
827
bailout("wierd file state %r" % ((fs, fid),))
1260
cfn = self.controlfilename('pending-merges')
1261
if not os.path.exists(cfn):
1264
for l in self.controlfile('pending-merges', 'r').readlines():
1265
p.append(l.rstrip('\n'))
1269
def add_pending_merge(self, revision_id):
1270
from bzrlib.revision import validate_revision_id
1272
validate_revision_id(revision_id)
1274
p = self.pending_merges()
1275
if revision_id in p:
1277
p.append(revision_id)
1278
self.set_pending_merges(p)
1281
def set_pending_merges(self, rev_list):
1282
from bzrlib.atomicfile import AtomicFile
1285
f = AtomicFile(self.controlfilename('pending-merges'))
831
1297
class ScratchBranch(Branch):