15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
from warnings import warn
23
import xml.sax.saxutils
24
from cStringIO import StringIO
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, \
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset, appendpath
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout, BzrError
35
from textui import show_status
36
from diff import diff_trees
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
28
import bzrlib.inventory as inventory
29
from bzrlib.trace import mutter, note
30
from bzrlib.osutils import (isdir, quotefn,
31
rename, splitpath, sha_file,
32
file_kind, abspath, normpath, pathjoin)
33
import bzrlib.errors as errors
34
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
35
NoSuchRevision, HistoryMissing, NotBranchError,
36
DivergedBranches, LockError, UnlistableStore,
37
UnlistableBranch, NoSuchFile, NotVersionedError,
39
from bzrlib.textui import show_status
40
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
43
from bzrlib.delta import compare_trees
44
from bzrlib.tree import EmptyTree, RevisionTree
45
from bzrlib.inventory import Inventory
46
from bzrlib.store import copy_all
47
from bzrlib.store.text import TextStore
48
from bzrlib.store.weave import WeaveStore
49
from bzrlib.testament import Testament
50
import bzrlib.transactions as transactions
51
from bzrlib.transport import Transport, get_transport
54
from config import TreeConfig
57
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
58
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
59
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
39
60
## TODO: Maybe include checks for common corruption of newlines, etc?
43
def find_branch_root(f=None):
44
"""Find the branch root enclosing f, or pwd.
46
It is not necessary that f exists.
48
Basically we keep looking up until we find the control directory or
52
elif hasattr(os.path, 'realpath'):
53
f = os.path.realpath(f)
55
f = os.path.abspath(f)
60
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
62
head, tail = os.path.split(f)
64
# reached the root, whatever that may be
65
raise BzrError('%r is not in a branch' % orig_f)
63
# TODO: Some operations like log might retrieve the same revisions
64
# repeatedly to calculate deltas. We could perhaps have a weakref
65
# cache in memory to make this faster. In general anything can be
66
# cached in memory between lock and unlock operations.
68
def find_branch(*ignored, **ignored_too):
69
# XXX: leave this here for about one release, then remove it
70
raise NotImplementedError('find_branch() is not supported anymore, '
71
'please use one of the new branch constructors')
74
def needs_read_lock(unbound):
75
"""Decorate unbound to take out and release a read lock."""
76
def decorated(self, *args, **kwargs):
79
return unbound(self, *args, **kwargs)
85
def needs_write_lock(unbound):
86
"""Decorate unbound to take out and release a write lock."""
87
def decorated(self, *args, **kwargs):
90
return unbound(self, *args, **kwargs)
70
95
######################################################################
74
99
"""Branch holding a history of revisions.
77
Base directory of the branch.
102
Base directory/url of the branch.
81
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
82
"""Create new branch object at a particular location.
84
base -- Base directory for the branch.
86
init -- If True, create new control files in a previously
87
unversioned directory. If False, the branch must already
90
find_root -- If true and init is false, find the root of the
91
existing branch containing base.
93
In the test suite, creation of new trees is tested using the
94
`ScratchBranch` class.
106
def __init__(self, *ignored, **ignored_too):
107
raise NotImplementedError('The Branch class is abstract')
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format.
113
Only local branches are supported."""
114
return BzrBranch(get_transport(base), relax_version_check=True)
118
"""Open an existing branch, rooted at 'base' (url)"""
119
t = get_transport(base)
120
mutter("trying to open %r with transport %r", base, t)
124
def open_containing(url):
125
"""Open an existing branch which contains url.
127
This probes for a branch at url, and searches upwards from there.
129
Basically we keep looking up until we find the control directory or
130
run into the root. If there isn't one, raises NotBranchError.
131
If there is one, it is returned, along with the unused portion of url.
97
self.base = os.path.realpath(base)
100
self.base = find_branch_root(base)
102
self.base = os.path.realpath(base)
103
if not isdir(self.controlfilename('.')):
104
bailout("not a bzr branch: %s" % quotefn(base),
105
['use "bzr init" to initialize a new working tree',
106
'current bzr can only operate from top-of-tree'])
110
self.text_store = ImmutableStore(self.controlfilename('text-store'))
111
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
112
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
116
return '%s(%r)' % (self.__class__.__name__, self.base)
123
def lock(self, mode='w'):
124
"""Lock the on-disk branch, excluding other processes."""
130
om = os.O_WRONLY | os.O_CREAT
135
raise BzrError("invalid locking mode %r" % mode)
133
t = get_transport(url)
138
lockfile = os.open(self.controlfilename('branch-lock'), om)
140
if e.errno == errno.ENOENT:
141
# might not exist on branches from <0.0.4
142
self.controlfile('branch-lock', 'w').close()
143
lockfile = os.open(self.controlfilename('branch-lock'), om)
147
fcntl.lockf(lockfile, lm)
149
fcntl.lockf(lockfile, fcntl.LOCK_UN)
151
self._lockmode = None
153
self._lockmode = mode
155
warning("please write a locking method for platform %r" % sys.platform)
157
self._lockmode = None
159
self._lockmode = mode
162
def _need_readlock(self):
163
if self._lockmode not in ['r', 'w']:
164
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
166
def _need_writelock(self):
167
if self._lockmode not in ['w']:
168
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
136
return BzrBranch(t), t.relpath(url)
137
except NotBranchError, e:
138
mutter('not a branch in: %r %s', t.base, e)
139
new_t = t.clone('..')
140
if new_t.base == t.base:
141
# reached the root, whatever that may be
142
raise NotBranchError(path=url)
146
def initialize(base):
147
"""Create a new branch, rooted at 'base' (url)"""
148
t = get_transport(base)
149
return BzrBranch(t, init=True)
151
def setup_caching(self, cache_root):
152
"""Subclasses that care about caching should override this, and set
153
up cached stores located under cache_root.
155
self.cache_root = cache_root
158
cfg = self.tree_config()
159
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
161
def _set_nick(self, nick):
162
cfg = self.tree_config()
163
cfg.set_option(nick, "nickname")
164
assert cfg.get_option("nickname") == nick
166
nick = property(_get_nick, _set_nick)
168
def push_stores(self, branch_to):
169
"""Copy the content of this branches store to branch_to."""
170
raise NotImplementedError('push_stores is abstract')
172
def get_transaction(self):
173
"""Return the current active transaction.
175
If no transaction is active, this returns a passthrough object
176
for which all data is immediately flushed and no caching happens.
178
raise NotImplementedError('get_transaction is abstract')
180
def lock_write(self):
181
raise NotImplementedError('lock_write is abstract')
184
raise NotImplementedError('lock_read is abstract')
187
raise NotImplementedError('unlock is abstract')
171
189
def abspath(self, name):
172
"""Return absolute filename for something in the branch"""
173
return os.path.join(self.base, name)
176
def relpath(self, path):
177
"""Return path relative to this branch of something inside it.
179
Raises an error if path is not in this branch."""
180
rp = os.path.realpath(path)
182
if not rp.startswith(self.base):
183
bailout("path %r is not within branch %r" % (rp, self.base))
184
rp = rp[len(self.base):]
185
rp = rp.lstrip(os.sep)
190
"""Return absolute filename for something in the branch
192
XXX: Robert Collins 20051017 what is this used for? why is it a branch
193
method and not a tree method.
195
raise NotImplementedError('abspath is abstract')
189
197
def controlfilename(self, file_or_path):
190
198
"""Return location relative to branch."""
191
if isinstance(file_or_path, types.StringTypes):
192
file_or_path = [file_or_path]
193
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
199
raise NotImplementedError('controlfilename is abstract')
196
201
def controlfile(self, file_or_path, mode='r'):
197
202
"""Open a control file for this branch.
200
205
and binary. binary files are untranslated byte streams. Text
201
206
control files are stored with Unix newlines and in UTF-8, even
202
207
if the platform or locale defaults are different.
205
fn = self.controlfilename(file_or_path)
207
if mode == 'rb' or mode == 'wb':
208
return file(fn, mode)
209
elif mode == 'r' or mode == 'w':
210
# open in binary mode anyhow so there's no newline translation;
211
# codecs uses line buffering by default; don't want that.
213
return codecs.open(fn, mode + 'b', 'utf-8',
216
raise BzrError("invalid controlfile mode %r" % mode)
220
def _make_control(self):
221
os.mkdir(self.controlfilename([]))
222
self.controlfile('README', 'w').write(
223
"This is a Bazaar-NG control directory.\n"
224
"Do not change any files in this directory.")
225
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
226
for d in ('text-store', 'inventory-store', 'revision-store'):
227
os.mkdir(self.controlfilename(d))
228
for f in ('revision-history', 'merged-patches',
229
'pending-merged-patches', 'branch-name',
231
self.controlfile(f, 'w').write('')
232
mutter('created control directory in ' + self.base)
233
Inventory().write_xml(self.controlfile('inventory','w'))
236
def _check_format(self):
237
"""Check this branch format is supported.
239
The current tool only supports the current unstable format.
241
In the future, we might need different in-memory Branch
242
classes to support downlevel branches. But not yet.
244
# This ignores newlines so that we can open branches created
245
# on Windows from Linux and so on. I think it might be better
246
# to always make all internal files in unix format.
247
fmt = self.controlfile('branch-format', 'r').read()
248
fmt.replace('\r\n', '')
249
if fmt != BZR_BRANCH_FORMAT:
250
bailout('sorry, branch format %r not supported' % fmt,
251
['use a different bzr version',
252
'or remove the .bzr directory and "bzr init" again'])
255
def read_working_inventory(self):
256
"""Read the working inventory."""
257
self._need_readlock()
259
# ElementTree does its own conversion from UTF-8, so open in
261
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
262
mutter("loaded inventory of %d items in %f"
263
% (len(inv), time.time() - before))
267
def _write_inventory(self, inv):
268
"""Update the working inventory.
270
That is to say, the inventory describing changes underway, that
271
will be committed to the next revision.
273
self._need_writelock()
274
## TODO: factor out to atomicfile? is rename safe on windows?
275
## TODO: Maybe some kind of clean/dirty marker on inventory?
276
tmpfname = self.controlfilename('inventory.tmp')
277
tmpf = file(tmpfname, 'wb')
280
inv_fname = self.controlfilename('inventory')
281
if sys.platform == 'win32':
283
os.rename(tmpfname, inv_fname)
284
mutter('wrote working inventory')
287
inventory = property(read_working_inventory, _write_inventory, None,
288
"""Inventory for the working copy.""")
291
def add(self, files, verbose=False):
292
"""Make files versioned.
294
Note that the command line normally calls smart_add instead.
296
This puts the files in the Added state, so that they will be
297
recorded by the next commit.
299
TODO: Perhaps have an option to add the ids even if the files do
302
TODO: Perhaps return the ids of the files? But then again it
303
is easy to retrieve them if they're needed.
305
TODO: Option to specify file id.
307
TODO: Adding a directory should optionally recurse down and
308
add all non-ignored children. Perhaps do that in a
311
>>> b = ScratchBranch(files=['foo'])
312
>>> 'foo' in b.unknowns()
317
>>> 'foo' in b.unknowns()
319
>>> bool(b.inventory.path2id('foo'))
325
Traceback (most recent call last):
327
BzrError: ('foo is already versioned', [])
329
>>> b.add(['nothere'])
330
Traceback (most recent call last):
331
BzrError: ('cannot add: not a regular file or directory: nothere', [])
333
self._need_writelock()
335
# TODO: Re-adding a file that is removed in the working copy
336
# should probably put it back with the previous ID.
337
if isinstance(files, types.StringTypes):
340
inv = self.read_working_inventory()
342
if is_control_file(f):
343
bailout("cannot add control file %s" % quotefn(f))
348
bailout("cannot add top-level %r" % f)
350
fullpath = os.path.normpath(self.abspath(f))
353
kind = file_kind(fullpath)
355
# maybe something better?
356
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
358
if kind != 'file' and kind != 'directory':
359
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
361
file_id = gen_file_id(f)
362
inv.add_path(f, kind=kind, file_id=file_id)
365
show_status('A', kind, quotefn(f))
367
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
369
self._write_inventory(inv)
372
def print_file(self, file, revno):
209
Controlfiles should almost never be opened in write mode but
210
rather should be atomically copied and replaced using atomicfile.
212
raise NotImplementedError('controlfile is abstract')
214
def put_controlfile(self, path, f, encode=True):
215
"""Write an entry as a controlfile.
217
:param path: The path to put the file, relative to the .bzr control
219
:param f: A file-like or string object whose contents should be copied.
220
:param encode: If true, encode the contents as utf-8
222
raise NotImplementedError('put_controlfile is abstract')
224
def put_controlfiles(self, files, encode=True):
225
"""Write several entries as controlfiles.
227
:param files: A list of [(path, file)] pairs, where the path is the directory
228
underneath the bzr control directory
229
:param encode: If true, encode the contents as utf-8
231
raise NotImplementedError('put_controlfiles is abstract')
233
def get_root_id(self):
234
"""Return the id of this branches root"""
235
raise NotImplementedError('get_root_id is abstract')
237
def set_root_id(self, file_id):
238
raise NotImplementedError('set_root_id is abstract')
240
def print_file(self, file, revision_id):
373
241
"""Print `file` to stdout."""
374
self._need_readlock()
375
tree = self.revision_tree(self.lookup_revision(revno))
376
# use inventory as it was in that revision
377
file_id = tree.inventory.path2id(file)
379
bailout("%r is not present in revision %d" % (file, revno))
380
tree.print_file(file_id)
383
def remove(self, files, verbose=False):
384
"""Mark nominated files for removal from the inventory.
386
This does not remove their text. This does not run on
388
TODO: Refuse to remove modified files unless --force is given?
390
>>> b = ScratchBranch(files=['foo'])
392
>>> b.inventory.has_filename('foo')
395
>>> b.working_tree().has_filename('foo')
397
>>> b.inventory.has_filename('foo')
400
>>> b = ScratchBranch(files=['foo'])
405
>>> b.inventory.has_filename('foo')
407
>>> b.basis_tree().has_filename('foo')
409
>>> b.working_tree().has_filename('foo')
412
TODO: Do something useful with directories.
414
TODO: Should this remove the text or not? Tough call; not
415
removing may be useful and the user can just use use rm, and
416
is the opposite of add. Removing it is consistent with most
417
other tools. Maybe an option.
419
## TODO: Normalize names
420
## TODO: Remove nested loops; better scalability
421
self._need_writelock()
423
if isinstance(files, types.StringTypes):
426
tree = self.working_tree()
429
# do this before any modifications
433
bailout("cannot remove unversioned file %s" % quotefn(f))
434
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
436
# having remove it, it must be either ignored or unknown
437
if tree.is_ignored(f):
441
show_status(new_status, inv[fid].kind, quotefn(f))
444
self._write_inventory(inv)
448
"""Return all unknown files.
450
These are files in the working directory that are not versioned or
451
control files or ignored.
453
>>> b = ScratchBranch(files=['foo', 'foo~'])
454
>>> list(b.unknowns())
457
>>> list(b.unknowns())
460
>>> list(b.unknowns())
463
return self.working_tree().unknowns()
466
def commit(self, message, timestamp=None, timezone=None,
469
"""Commit working copy as a new revision.
471
The basic approach is to add all the file texts into the
472
store, then the inventory, then make a new revision pointing
473
to that inventory and store that.
475
This is not quite safe if the working copy changes during the
476
commit; for the moment that is simply not allowed. A better
477
approach is to make a temporary copy of the files before
478
computing their hashes, and then add those hashes in turn to
479
the inventory. This should mean at least that there are no
480
broken hash pointers. There is no way we can get a snapshot
481
of the whole directory at an instant. This would also have to
482
be robust against files disappearing, moving, etc. So the
483
whole thing is a bit hard.
485
timestamp -- if not None, seconds-since-epoch for a
486
postdated/predated commit.
488
self._need_writelock()
490
## TODO: Show branch names
492
# TODO: Don't commit if there are no changes, unless forced?
494
# First walk over the working inventory; and both update that
495
# and also build a new revision inventory. The revision
496
# inventory needs to hold the text-id, sha1 and size of the
497
# actual file versions committed in the revision. (These are
498
# not present in the working inventory.) We also need to
499
# detect missing/deleted files, and remove them from the
502
work_inv = self.read_working_inventory()
504
basis = self.basis_tree()
505
basis_inv = basis.inventory
507
for path, entry in work_inv.iter_entries():
508
## TODO: Cope with files that have gone missing.
510
## TODO: Check that the file kind has not changed from the previous
511
## revision of this file (if any).
515
p = self.abspath(path)
516
file_id = entry.file_id
517
mutter('commit prep file %s, id %r ' % (p, file_id))
519
if not os.path.exists(p):
520
mutter(" file is missing, removing from inventory")
522
show_status('D', entry.kind, quotefn(path))
523
missing_ids.append(file_id)
526
# TODO: Handle files that have been deleted
528
# TODO: Maybe a special case for empty files? Seems a
529
# waste to store them many times.
533
if basis_inv.has_id(file_id):
534
old_kind = basis_inv[file_id].kind
535
if old_kind != entry.kind:
536
bailout("entry %r changed kind from %r to %r"
537
% (file_id, old_kind, entry.kind))
539
if entry.kind == 'directory':
541
bailout("%s is entered as directory but not a directory" % quotefn(p))
542
elif entry.kind == 'file':
544
bailout("%s is entered as file but is not a file" % quotefn(p))
546
content = file(p, 'rb').read()
548
entry.text_sha1 = sha_string(content)
549
entry.text_size = len(content)
551
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
553
and (old_ie.text_size == entry.text_size)
554
and (old_ie.text_sha1 == entry.text_sha1)):
555
## assert content == basis.get_file(file_id).read()
556
entry.text_id = basis_inv[file_id].text_id
557
mutter(' unchanged from previous text_id {%s}' %
561
entry.text_id = gen_file_id(entry.name)
562
self.text_store.add(content, entry.text_id)
563
mutter(' stored with text_id {%s}' % entry.text_id)
567
elif (old_ie.name == entry.name
568
and old_ie.parent_id == entry.parent_id):
573
show_status(state, entry.kind, quotefn(path))
575
for file_id in missing_ids:
576
# have to do this later so we don't mess up the iterator.
577
# since parents may be removed before their children we
580
# FIXME: There's probably a better way to do this; perhaps
581
# the workingtree should know how to filter itself.
582
if work_inv.has_id(file_id):
583
del work_inv[file_id]
586
inv_id = rev_id = _gen_revision_id(time.time())
588
inv_tmp = tempfile.TemporaryFile()
589
inv.write_xml(inv_tmp)
591
self.inventory_store.add(inv_tmp, inv_id)
592
mutter('new inventory_id is {%s}' % inv_id)
594
self._write_inventory(work_inv)
596
if timestamp == None:
597
timestamp = time.time()
599
if committer == None:
600
committer = username()
603
timezone = local_time_offset()
605
mutter("building commit log message")
606
rev = Revision(timestamp=timestamp,
609
precursor = self.last_patch(),
614
rev_tmp = tempfile.TemporaryFile()
615
rev.write_xml(rev_tmp)
617
self.revision_store.add(rev_tmp, rev_id)
618
mutter("new revision_id is {%s}" % rev_id)
620
## XXX: Everything up to here can simply be orphaned if we abort
621
## the commit; it will leave junk files behind but that doesn't
624
## TODO: Read back the just-generated changeset, and make sure it
625
## applies and recreates the right state.
627
## TODO: Also calculate and store the inventory SHA1
628
mutter("committing patch r%d" % (self.revno() + 1))
631
self.append_revision(rev_id)
634
note("commited r%d" % self.revno())
637
def append_revision(self, revision_id):
638
mutter("add {%s} to revision-history" % revision_id)
639
rev_history = self.revision_history()
641
tmprhname = self.controlfilename('revision-history.tmp')
642
rhname = self.controlfilename('revision-history')
644
f = file(tmprhname, 'wt')
645
rev_history.append(revision_id)
646
f.write('\n'.join(rev_history))
650
if sys.platform == 'win32':
652
os.rename(tmprhname, rhname)
242
raise NotImplementedError('print_file is abstract')
244
def append_revision(self, *revision_ids):
245
raise NotImplementedError('append_revision is abstract')
247
def set_revision_history(self, rev_history):
248
raise NotImplementedError('set_revision_history is abstract')
250
def has_revision(self, revision_id):
251
"""True if this branch has a copy of the revision.
253
This does not necessarily imply the revision is merge
254
or on the mainline."""
255
raise NotImplementedError('has_revision is abstract')
257
def get_revision_xml(self, revision_id):
258
raise NotImplementedError('get_revision_xml is abstract')
656
260
def get_revision(self, revision_id):
657
261
"""Return the Revision object for a named revision"""
658
self._need_readlock()
659
r = Revision.read_xml(self.revision_store[revision_id])
660
assert r.revision_id == revision_id
664
def get_inventory(self, inventory_id):
665
"""Get Inventory object by hash.
667
TODO: Perhaps for this and similar methods, take a revision
668
parameter which can be either an integer revno or a
670
self._need_readlock()
671
i = Inventory.read_xml(self.inventory_store[inventory_id])
262
raise NotImplementedError('get_revision is abstract')
264
def get_revision_delta(self, revno):
265
"""Return the delta for one revision.
267
The delta is relative to its mainline predecessor, or the
268
empty tree for revision 1.
270
assert isinstance(revno, int)
271
rh = self.revision_history()
272
if not (1 <= revno <= len(rh)):
273
raise InvalidRevisionNumber(revno)
275
# revno is 1-based; list is 0-based
277
new_tree = self.revision_tree(rh[revno-1])
279
old_tree = EmptyTree()
281
old_tree = self.revision_tree(rh[revno-2])
283
return compare_trees(old_tree, new_tree)
285
def get_revision_sha1(self, revision_id):
286
"""Hash the stored value of a revision, and return it."""
287
raise NotImplementedError('get_revision_sha1 is abstract')
289
def get_ancestry(self, revision_id):
290
"""Return a list of revision-ids integrated by a revision.
292
This currently returns a list, but the ordering is not guaranteed:
295
raise NotImplementedError('get_ancestry is abstract')
297
def get_inventory(self, revision_id):
298
"""Get Inventory object by hash."""
299
raise NotImplementedError('get_inventory is abstract')
301
def get_inventory_xml(self, revision_id):
302
"""Get inventory XML as a file object."""
303
raise NotImplementedError('get_inventory_xml is abstract')
305
def get_inventory_sha1(self, revision_id):
306
"""Return the sha1 hash of the inventory entry."""
307
raise NotImplementedError('get_inventory_sha1 is abstract')
675
309
def get_revision_inventory(self, revision_id):
676
310
"""Return inventory of a past revision."""
677
self._need_readlock()
678
if revision_id == None:
681
return self.get_inventory(self.get_revision(revision_id).inventory_id)
311
raise NotImplementedError('get_revision_inventory is abstract')
684
313
def revision_history(self):
685
"""Return sequence of revision hashes on to this branch.
687
>>> ScratchBranch().revision_history()
690
self._need_readlock()
691
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
694
def enum_history(self, direction):
695
"""Return (revno, revision_id) for history of branch.
698
'forward' is from earliest to latest
699
'reverse' is from latest to earliest
701
rh = self.revision_history()
702
if direction == 'forward':
707
elif direction == 'reverse':
713
raise BzrError('invalid history direction %r' % direction)
314
"""Return sequence of revision hashes on to this branch."""
315
raise NotImplementedError('revision_history is abstract')
717
318
"""Return current revision number for this branch.
719
320
That is equivalent to the number of revisions committed to
722
>>> b = ScratchBranch()
725
>>> b.commit('no foo')
729
323
return len(self.revision_history())
732
def last_patch(self):
733
"""Return last patch hash, or None if no history.
735
>>> ScratchBranch().last_patch() == None
325
def last_revision(self):
326
"""Return last patch hash, or None if no history."""
738
327
ph = self.revision_history()
745
def lookup_revision(self, revno):
746
"""Return revision hash for revision number."""
333
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
334
"""Return a list of new revisions that would perfectly fit.
336
If self and other have not diverged, return a list of the revisions
337
present in other, but missing from self.
339
>>> from bzrlib.commit import commit
340
>>> bzrlib.trace.silent = True
341
>>> br1 = ScratchBranch()
342
>>> br2 = ScratchBranch()
343
>>> br1.missing_revisions(br2)
345
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
346
>>> br1.missing_revisions(br2)
348
>>> br2.missing_revisions(br1)
350
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
351
>>> br1.missing_revisions(br2)
353
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
354
>>> br1.missing_revisions(br2)
356
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
357
>>> br1.missing_revisions(br2)
358
Traceback (most recent call last):
359
DivergedBranches: These branches have diverged. Try merge.
361
self_history = self.revision_history()
362
self_len = len(self_history)
363
other_history = other.revision_history()
364
other_len = len(other_history)
365
common_index = min(self_len, other_len) -1
366
if common_index >= 0 and \
367
self_history[common_index] != other_history[common_index]:
368
raise DivergedBranches(self, other)
370
if stop_revision is None:
371
stop_revision = other_len
373
assert isinstance(stop_revision, int)
374
if stop_revision > other_len:
375
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
376
return other_history[self_len:stop_revision]
378
def update_revisions(self, other, stop_revision=None):
379
"""Pull in new perfect-fit revisions."""
380
raise NotImplementedError('update_revisions is abstract')
382
def pullable_revisions(self, other, stop_revision):
383
raise NotImplementedError('pullable_revisions is abstract')
385
def revision_id_to_revno(self, revision_id):
386
"""Given a revision id, return its revno"""
387
if revision_id is None:
389
history = self.revision_history()
391
return history.index(revision_id) + 1
393
raise bzrlib.errors.NoSuchRevision(self, revision_id)
395
def get_rev_id(self, revno, history=None):
396
"""Find the revision id of the specified revno."""
751
# list is 0-based; revisions are 1-based
752
return self.revision_history()[revno-1]
754
raise BzrError("no such revision %s" % revno)
400
history = self.revision_history()
401
elif revno <= 0 or revno > len(history):
402
raise bzrlib.errors.NoSuchRevision(self, revno)
403
return history[revno - 1]
757
405
def revision_tree(self, revision_id):
758
406
"""Return Tree for a revision on this branch.
760
408
`revision_id` may be None for the null revision, in which case
761
409
an `EmptyTree` is returned."""
762
self._need_readlock()
763
if revision_id == None:
766
inv = self.get_revision_inventory(revision_id)
767
return RevisionTree(self.text_store, inv)
410
raise NotImplementedError('revision_tree is abstract')
770
412
def working_tree(self):
771
"""Return a `Tree` for the working copy."""
772
return WorkingTree(self.base, self.read_working_inventory())
413
"""Return a `Tree` for the working copy if this is a local branch."""
414
raise NotImplementedError('working_tree is abstract')
416
def pull(self, source, overwrite=False):
417
raise NotImplementedError('pull is abstract')
775
419
def basis_tree(self):
776
420
"""Return `Tree` object for last revision.
778
422
If there are no revisions yet, return an `EmptyTree`.
780
>>> b = ScratchBranch(files=['foo'])
781
>>> b.basis_tree().has_filename('foo')
783
>>> b.working_tree().has_filename('foo')
786
>>> b.commit('add foo')
787
>>> b.basis_tree().has_filename('foo')
790
r = self.last_patch()
794
return RevisionTree(self.text_store, self.get_revision_inventory(r))
424
return self.revision_tree(self.last_revision())
798
426
def rename_one(self, from_rel, to_rel):
799
427
"""Rename one file.
801
429
This can change the directory or the filename or both.
803
self._need_writelock()
804
tree = self.working_tree()
806
if not tree.has_filename(from_rel):
807
bailout("can't rename: old working file %r does not exist" % from_rel)
808
if tree.has_filename(to_rel):
809
bailout("can't rename: new working file %r already exists" % to_rel)
811
file_id = inv.path2id(from_rel)
813
bailout("can't rename: old name %r is not versioned" % from_rel)
815
if inv.path2id(to_rel):
816
bailout("can't rename: new name %r is already versioned" % to_rel)
818
to_dir, to_tail = os.path.split(to_rel)
819
to_dir_id = inv.path2id(to_dir)
820
if to_dir_id == None and to_dir != '':
821
bailout("can't determine destination directory id for %r" % to_dir)
823
mutter("rename_one:")
824
mutter(" file_id {%s}" % file_id)
825
mutter(" from_rel %r" % from_rel)
826
mutter(" to_rel %r" % to_rel)
827
mutter(" to_dir %r" % to_dir)
828
mutter(" to_dir_id {%s}" % to_dir_id)
830
inv.rename(file_id, to_dir_id, to_tail)
832
print "%s => %s" % (from_rel, to_rel)
834
from_abs = self.abspath(from_rel)
835
to_abs = self.abspath(to_rel)
837
os.rename(from_abs, to_abs)
839
bailout("failed to rename %r to %r: %s"
840
% (from_abs, to_abs, e[1]),
841
["rename rolled back"])
843
self._write_inventory(inv)
431
raise NotImplementedError('rename_one is abstract')
847
433
def move(self, from_paths, to_name):
855
441
Note that to_name is only the last component of the new name;
856
442
this doesn't change the directory.
858
self._need_writelock()
859
## TODO: Option to move IDs only
860
assert not isinstance(from_paths, basestring)
861
tree = self.working_tree()
863
to_abs = self.abspath(to_name)
864
if not isdir(to_abs):
865
bailout("destination %r is not a directory" % to_abs)
866
if not tree.has_filename(to_name):
867
bailout("destination %r not in working directory" % to_abs)
868
to_dir_id = inv.path2id(to_name)
869
if to_dir_id == None and to_name != '':
870
bailout("destination %r is not a versioned directory" % to_name)
871
to_dir_ie = inv[to_dir_id]
872
if to_dir_ie.kind not in ('directory', 'root_directory'):
873
bailout("destination %r is not a directory" % to_abs)
875
to_idpath = Set(inv.get_idpath(to_dir_id))
878
if not tree.has_filename(f):
879
bailout("%r does not exist in working tree" % f)
880
f_id = inv.path2id(f)
882
bailout("%r is not versioned" % f)
883
name_tail = splitpath(f)[-1]
884
dest_path = appendpath(to_name, name_tail)
885
if tree.has_filename(dest_path):
886
bailout("destination %r already exists" % dest_path)
887
if f_id in to_idpath:
888
bailout("can't move %r to a subdirectory of itself" % f)
890
# OK, so there's a race here, it's possible that someone will
891
# create a file in this interval and then the rename might be
892
# left half-done. But we should have caught most problems.
895
name_tail = splitpath(f)[-1]
896
dest_path = appendpath(to_name, name_tail)
897
print "%s => %s" % (f, dest_path)
898
inv.rename(inv.path2id(f), to_dir_id, name_tail)
900
os.rename(self.abspath(f), self.abspath(dest_path))
902
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
903
["rename rolled back"])
905
self._write_inventory(inv)
909
def show_status(self, show_all=False):
910
"""Display single-line status for non-ignored working files.
912
The list is show sorted in order by file name.
914
>>> b = ScratchBranch(files=['foo', 'foo~'])
920
>>> b.commit("add foo")
922
>>> os.unlink(b.abspath('foo'))
926
TODO: Get state for single files.
928
self._need_readlock()
930
# We have to build everything into a list first so that it can
931
# sorted by name, incorporating all the different sources.
933
# FIXME: Rather than getting things in random order and then sorting,
934
# just step through in order.
936
# Interesting case: the old ID for a file has been removed,
937
# but a new file has been created under that name.
939
old = self.basis_tree()
940
new = self.working_tree()
942
for fs, fid, oldname, newname, kind in diff_trees(old, new):
944
show_status(fs, kind,
945
oldname + ' => ' + newname)
946
elif fs == 'A' or fs == 'M':
947
show_status(fs, kind, newname)
949
show_status(fs, kind, oldname)
952
show_status(fs, kind, newname)
955
show_status(fs, kind, newname)
957
show_status(fs, kind, newname)
444
This returns a list of (from_path, to_path) pairs for each
447
raise NotImplementedError('move is abstract')
449
def get_parent(self):
450
"""Return the parent location of the branch.
452
This is the default location for push/pull/missing. The usual
453
pattern is that the user can override it by specifying a
456
raise NotImplementedError('get_parent is abstract')
458
def get_push_location(self):
459
"""Return the None or the location to push this branch to."""
460
raise NotImplementedError('get_push_location is abstract')
462
def set_push_location(self, location):
463
"""Set a new push location for this branch."""
464
raise NotImplementedError('set_push_location is abstract')
466
def set_parent(self, url):
467
raise NotImplementedError('set_parent is abstract')
469
def check_revno(self, revno):
471
Check whether a revno corresponds to any revision.
472
Zero (the NULL revision) is considered valid.
475
self.check_real_revno(revno)
477
def check_real_revno(self, revno):
479
Check whether a revno corresponds to a real revision.
480
Zero (the NULL revision) is considered invalid
482
if revno < 1 or revno > self.revno():
483
raise InvalidRevisionNumber(revno)
485
def sign_revision(self, revision_id, gpg_strategy):
486
raise NotImplementedError('sign_revision is abstract')
488
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
489
raise NotImplementedError('store_revision_signature is abstract')
491
def fileid_involved_between_revs(self, from_revid, to_revid):
492
""" This function returns the file_id(s) involved in the
493
changes between the from_revid revision and the to_revid
496
raise NotImplementedError('fileid_involved_between_revs is abstract')
498
def fileid_involved(self, last_revid=None):
499
""" This function returns the file_id(s) involved in the
500
changes up to the revision last_revid
501
If no parametr is passed, then all file_id[s] present in the
502
repository are returned
504
raise NotImplementedError('fileid_involved is abstract')
506
def fileid_involved_by_set(self, changes):
507
""" This function returns the file_id(s) involved in the
508
changes present in the set 'changes'
510
raise NotImplementedError('fileid_involved_by_set is abstract')
512
def fileid_involved_between_revs(self, from_revid, to_revid):
513
""" This function returns the file_id(s) involved in the
514
changes between the from_revid revision and the to_revid
517
raise NotImplementedError('fileid_involved_between_revs is abstract')
519
def fileid_involved(self, last_revid=None):
520
""" This function returns the file_id(s) involved in the
521
changes up to the revision last_revid
522
If no parametr is passed, then all file_id[s] present in the
523
repository are returned
525
raise NotImplementedError('fileid_involved is abstract')
527
def fileid_involved_by_set(self, changes):
528
""" This function returns the file_id(s) involved in the
529
changes present in the set 'changes'
531
raise NotImplementedError('fileid_involved_by_set is abstract')
534
class BzrBranch(Branch):
535
"""A branch stored in the actual filesystem.
537
Note that it's "local" in the context of the filesystem; it doesn't
538
really matter if it's on an nfs/smb/afs/coda/... share, as long as
539
it's writable, and can be accessed via the normal filesystem API.
545
If _lock_mode is true, a positive count of the number of times the
549
Lock object from bzrlib.lock.
551
# We actually expect this class to be somewhat short-lived; part of its
552
# purpose is to try to isolate what bits of the branch logic are tied to
553
# filesystem access, so that in a later step, we can extricate them to
554
# a separarte ("storage") class.
558
_inventory_weave = None
559
# If set to False (by a plugin, etc) BzrBranch will not set the
560
# mode on created files or directories
561
_set_file_mode = True
564
# Map some sort of prefix into a namespace
565
# stuff like "revno:10", "revid:", etc.
566
# This should match a prefix with a function which accepts
567
REVISION_NAMESPACES = {}
569
def push_stores(self, branch_to):
570
"""See Branch.push_stores."""
571
if (self._branch_format != branch_to._branch_format
572
or self._branch_format != 4):
573
from bzrlib.fetch import greedy_fetch
574
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
575
self, self._branch_format, branch_to, branch_to._branch_format)
576
greedy_fetch(to_branch=branch_to, from_branch=self,
577
revision=self.last_revision())
580
store_pairs = ((self.text_store, branch_to.text_store),
581
(self.inventory_store, branch_to.inventory_store),
582
(self.revision_store, branch_to.revision_store))
584
for from_store, to_store in store_pairs:
585
copy_all(from_store, to_store)
586
except UnlistableStore:
587
raise UnlistableBranch(from_store)
589
def __init__(self, transport, init=False,
590
relax_version_check=False):
591
"""Create new branch object at a particular location.
593
transport -- A Transport object, defining how to access files.
595
init -- If True, create new control files in a previously
596
unversioned directory. If False, the branch must already
599
relax_version_check -- If true, the usual check for the branch
600
version is not applied. This is intended only for
601
upgrade/recovery type use; it's not guaranteed that
602
all operations will work on old format branches.
604
In the test suite, creation of new trees is tested using the
605
`ScratchBranch` class.
607
assert isinstance(transport, Transport), \
608
"%r is not a Transport" % transport
609
self._transport = transport
612
self._check_format(relax_version_check)
615
def get_store(name, compressed=True, prefixed=False):
616
relpath = self._rel_controlfilename(unicode(name))
617
store = TextStore(self._transport.clone(relpath),
618
dir_mode=self._dir_mode,
619
file_mode=self._file_mode,
621
compressed=compressed)
624
def get_weave(name, prefixed=False):
625
relpath = self._rel_controlfilename(unicode(name))
626
ws = WeaveStore(self._transport.clone(relpath),
628
dir_mode=self._dir_mode,
629
file_mode=self._file_mode)
630
if self._transport.should_cache():
631
ws.enable_cache = True
634
if self._branch_format == 4:
635
self.inventory_store = get_store('inventory-store')
636
self.text_store = get_store('text-store')
637
self.revision_store = get_store('revision-store')
638
elif self._branch_format == 5:
639
self.control_weaves = get_weave(u'')
640
self.weave_store = get_weave(u'weaves')
641
self.revision_store = get_store(u'revision-store', compressed=False)
642
elif self._branch_format == 6:
643
self.control_weaves = get_weave(u'')
644
self.weave_store = get_weave(u'weaves', prefixed=True)
645
self.revision_store = get_store(u'revision-store', compressed=False,
647
self.revision_store.register_suffix('sig')
648
self._transaction = None
651
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
656
if self._lock_mode or self._lock:
657
# XXX: This should show something every time, and be suitable for
658
# headless operation and embedding
659
warn("branch %r was not explicitly unlocked" % self)
662
# TODO: It might be best to do this somewhere else,
663
# but it is nice for a Branch object to automatically
664
# cache it's information.
665
# Alternatively, we could have the Transport objects cache requests
666
# See the earlier discussion about how major objects (like Branch)
667
# should never expect their __del__ function to run.
668
if hasattr(self, 'cache_root') and self.cache_root is not None:
670
shutil.rmtree(self.cache_root)
673
self.cache_root = None
677
return self._transport.base
680
base = property(_get_base, doc="The URL for the root of this branch.")
682
def _finish_transaction(self):
683
"""Exit the current transaction."""
684
if self._transaction is None:
685
raise errors.LockError('Branch %s is not in a transaction' %
687
transaction = self._transaction
688
self._transaction = None
691
def get_transaction(self):
692
"""See Branch.get_transaction."""
693
if self._transaction is None:
694
return transactions.PassThroughTransaction()
696
return self._transaction
698
def _set_transaction(self, new_transaction):
699
"""Set a new active transaction."""
700
if self._transaction is not None:
701
raise errors.LockError('Branch %s is in a transaction already.' %
703
self._transaction = new_transaction
705
def lock_write(self):
706
#mutter("lock write: %s (%s)", self, self._lock_count)
707
# TODO: Upgrade locking to support using a Transport,
708
# and potentially a remote locking protocol
710
if self._lock_mode != 'w':
711
raise LockError("can't upgrade to a write lock from %r" %
713
self._lock_count += 1
715
self._lock = self._transport.lock_write(
716
self._rel_controlfilename('branch-lock'))
717
self._lock_mode = 'w'
719
self._set_transaction(transactions.PassThroughTransaction())
722
#mutter("lock read: %s (%s)", self, self._lock_count)
724
assert self._lock_mode in ('r', 'w'), \
725
"invalid lock mode %r" % self._lock_mode
726
self._lock_count += 1
728
self._lock = self._transport.lock_read(
729
self._rel_controlfilename('branch-lock'))
730
self._lock_mode = 'r'
732
self._set_transaction(transactions.ReadOnlyTransaction())
733
# 5K may be excessive, but hey, its a knob.
734
self.get_transaction().set_cache_size(5000)
737
#mutter("unlock: %s (%s)", self, self._lock_count)
738
if not self._lock_mode:
739
raise LockError('branch %r is not locked' % (self))
741
if self._lock_count > 1:
742
self._lock_count -= 1
744
self._finish_transaction()
747
self._lock_mode = self._lock_count = None
749
def abspath(self, name):
750
"""See Branch.abspath."""
751
return self._transport.abspath(name)
753
def _rel_controlfilename(self, file_or_path):
754
if not isinstance(file_or_path, basestring):
755
file_or_path = u'/'.join(file_or_path)
756
if file_or_path == '':
758
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
760
def controlfilename(self, file_or_path):
761
"""See Branch.controlfilename."""
762
return self._transport.abspath(self._rel_controlfilename(file_or_path))
764
def controlfile(self, file_or_path, mode='r'):
765
"""See Branch.controlfile."""
768
relpath = self._rel_controlfilename(file_or_path)
769
#TODO: codecs.open() buffers linewise, so it was overloaded with
770
# a much larger buffer, do we need to do the same for getreader/getwriter?
772
return self._transport.get(relpath)
774
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
776
# XXX: Do we really want errors='replace'? Perhaps it should be
777
# an error, or at least reported, if there's incorrectly-encoded
778
# data inside a file.
779
# <https://launchpad.net/products/bzr/+bug/3823>
780
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
782
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
784
raise BzrError("invalid controlfile mode %r" % mode)
786
def put_controlfile(self, path, f, encode=True):
787
"""See Branch.put_controlfile."""
788
self.put_controlfiles([(path, f)], encode=encode)
790
def put_controlfiles(self, files, encode=True):
791
"""See Branch.put_controlfiles."""
794
for path, f in files:
796
if isinstance(f, basestring):
797
f = f.encode('utf-8', 'replace')
799
f = codecs.getwriter('utf-8')(f, errors='replace')
800
path = self._rel_controlfilename(path)
801
ctrl_files.append((path, f))
802
self._transport.put_multi(ctrl_files, mode=self._file_mode)
804
def _find_modes(self, path=None):
805
"""Determine the appropriate modes for files and directories."""
808
path = self._rel_controlfilename('')
809
st = self._transport.stat(path)
810
except errors.TransportNotPossible:
811
self._dir_mode = 0755
812
self._file_mode = 0644
814
self._dir_mode = st.st_mode & 07777
815
# Remove the sticky and execute bits for files
816
self._file_mode = self._dir_mode & ~07111
817
if not self._set_dir_mode:
818
self._dir_mode = None
819
if not self._set_file_mode:
820
self._file_mode = None
822
def _make_control(self):
823
from bzrlib.inventory import Inventory
824
from bzrlib.weavefile import write_weave_v5
825
from bzrlib.weave import Weave
827
# Create an empty inventory
829
# if we want per-tree root ids then this is the place to set
830
# them; they're not needed for now and so ommitted for
832
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
833
empty_inv = sio.getvalue()
835
bzrlib.weavefile.write_weave_v5(Weave(), sio)
836
empty_weave = sio.getvalue()
838
cfn = self._rel_controlfilename
839
# Since we don't have a .bzr directory, inherit the
840
# mode from the root directory
841
self._find_modes(u'.')
843
dirs = ['', 'revision-store', 'weaves']
845
"This is a Bazaar-NG control directory.\n"
846
"Do not change any files in this directory.\n"),
847
('branch-format', BZR_BRANCH_FORMAT_6),
848
('revision-history', ''),
851
('pending-merges', ''),
852
('inventory', empty_inv),
853
('inventory.weave', empty_weave),
855
self._transport.mkdir_multi([cfn(d) for d in dirs], mode=self._dir_mode)
856
self.put_controlfiles(files)
857
mutter('created control directory in ' + self._transport.base)
859
def _check_format(self, relax_version_check):
860
"""Check this branch format is supported.
862
The format level is stored, as an integer, in
863
self._branch_format for code that needs to check it later.
865
In the future, we might need different in-memory Branch
866
classes to support downlevel branches. But not yet.
869
fmt = self.controlfile('branch-format', 'r').read()
871
raise NotBranchError(path=self.base)
872
mutter("got branch format %r", fmt)
873
if fmt == BZR_BRANCH_FORMAT_6:
874
self._branch_format = 6
875
elif fmt == BZR_BRANCH_FORMAT_5:
876
self._branch_format = 5
877
elif fmt == BZR_BRANCH_FORMAT_4:
878
self._branch_format = 4
880
if (not relax_version_check
881
and self._branch_format not in (5, 6)):
882
raise errors.UnsupportedFormatError(
883
'sorry, branch format %r not supported' % fmt,
884
['use a different bzr version',
885
'or remove the .bzr directory'
886
' and "bzr init" again'])
889
def get_root_id(self):
890
"""See Branch.get_root_id."""
891
inv = self.get_inventory(self.last_revision())
892
return inv.root.file_id
895
def print_file(self, file, revision_id):
896
"""See Branch.print_file."""
897
tree = self.revision_tree(revision_id)
898
# use inventory as it was in that revision
899
file_id = tree.inventory.path2id(file)
902
revno = self.revision_id_to_revno(revision_id)
903
except errors.NoSuchRevision:
904
# TODO: This should not be BzrError,
905
# but NoSuchFile doesn't fit either
906
raise BzrError('%r is not present in revision %s'
907
% (file, revision_id))
959
bailout("weird file state %r" % ((fs, fid),))
963
class ScratchBranch(Branch):
909
raise BzrError('%r is not present in revision %s'
911
tree.print_file(file_id)
914
def append_revision(self, *revision_ids):
915
"""See Branch.append_revision."""
916
for revision_id in revision_ids:
917
mutter("add {%s} to revision-history" % revision_id)
918
rev_history = self.revision_history()
919
rev_history.extend(revision_ids)
920
self.set_revision_history(rev_history)
923
def set_revision_history(self, rev_history):
924
"""See Branch.set_revision_history."""
925
old_revision = self.last_revision()
926
new_revision = rev_history[-1]
927
self.put_controlfile('revision-history', '\n'.join(rev_history))
929
self.working_tree().set_last_revision(new_revision, old_revision)
930
except NoWorkingTree:
931
mutter('Unable to set_last_revision without a working tree.')
933
def has_revision(self, revision_id):
934
"""See Branch.has_revision."""
935
return (revision_id is None
936
or self.revision_store.has_id(revision_id))
939
def _get_revision_xml_file(self, revision_id):
940
if not revision_id or not isinstance(revision_id, basestring):
941
raise InvalidRevisionId(revision_id=revision_id, branch=self)
943
return self.revision_store.get(revision_id)
944
except (IndexError, KeyError):
945
raise bzrlib.errors.NoSuchRevision(self, revision_id)
947
def get_revision_xml(self, revision_id):
948
"""See Branch.get_revision_xml."""
949
return self._get_revision_xml_file(revision_id).read()
951
def get_revision(self, revision_id):
952
"""See Branch.get_revision."""
953
xml_file = self._get_revision_xml_file(revision_id)
956
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
957
except SyntaxError, e:
958
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
962
assert r.revision_id == revision_id
965
def get_revision_sha1(self, revision_id):
966
"""See Branch.get_revision_sha1."""
967
# In the future, revision entries will be signed. At that
968
# point, it is probably best *not* to include the signature
969
# in the revision hash. Because that lets you re-sign
970
# the revision, (add signatures/remove signatures) and still
971
# have all hash pointers stay consistent.
972
# But for now, just hash the contents.
973
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
975
def get_ancestry(self, revision_id):
976
"""See Branch.get_ancestry."""
977
if revision_id is None:
979
w = self._get_inventory_weave()
980
return [None] + map(w.idx_to_name,
981
w.inclusions([w.lookup(revision_id)]))
983
def _get_inventory_weave(self):
984
return self.control_weaves.get_weave('inventory',
985
self.get_transaction())
987
def get_inventory(self, revision_id):
988
"""See Branch.get_inventory."""
989
xml = self.get_inventory_xml(revision_id)
990
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
992
def get_inventory_xml(self, revision_id):
993
"""See Branch.get_inventory_xml."""
995
assert isinstance(revision_id, basestring), type(revision_id)
996
iw = self._get_inventory_weave()
997
return iw.get_text(iw.lookup(revision_id))
999
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
1001
def get_inventory_sha1(self, revision_id):
1002
"""See Branch.get_inventory_sha1."""
1003
return self.get_revision(revision_id).inventory_sha1
1005
def get_revision_inventory(self, revision_id):
1006
"""See Branch.get_revision_inventory."""
1007
# TODO: Unify this with get_inventory()
1008
# bzr 0.0.6 and later imposes the constraint that the inventory_id
1009
# must be the same as its revision, so this is trivial.
1010
if revision_id == None:
1011
# This does not make sense: if there is no revision,
1012
# then it is the current tree inventory surely ?!
1013
# and thus get_root_id() is something that looks at the last
1014
# commit on the branch, and the get_root_id is an inventory check.
1015
raise NotImplementedError
1016
# return Inventory(self.get_root_id())
1018
return self.get_inventory(revision_id)
1021
def revision_history(self):
1022
"""See Branch.revision_history."""
1023
transaction = self.get_transaction()
1024
history = transaction.map.find_revision_history()
1025
if history is not None:
1026
mutter("cache hit for revision-history in %s", self)
1027
return list(history)
1028
history = [l.rstrip('\r\n') for l in
1029
self.controlfile('revision-history', 'r').readlines()]
1030
transaction.map.add_revision_history(history)
1031
# this call is disabled because revision_history is
1032
# not really an object yet, and the transaction is for objects.
1033
# transaction.register_clean(history, precious=True)
1034
return list(history)
1036
def update_revisions(self, other, stop_revision=None):
1037
"""See Branch.update_revisions."""
1038
from bzrlib.fetch import greedy_fetch
1039
if stop_revision is None:
1040
stop_revision = other.last_revision()
1041
### Should this be checking is_ancestor instead of revision_history?
1042
if (stop_revision is not None and
1043
stop_revision in self.revision_history()):
1045
greedy_fetch(to_branch=self, from_branch=other,
1046
revision=stop_revision)
1047
pullable_revs = self.pullable_revisions(other, stop_revision)
1048
if len(pullable_revs) > 0:
1049
self.append_revision(*pullable_revs)
1051
def pullable_revisions(self, other, stop_revision):
1052
"""See Branch.pullable_revisions."""
1053
other_revno = other.revision_id_to_revno(stop_revision)
1055
return self.missing_revisions(other, other_revno)
1056
except DivergedBranches, e:
1058
pullable_revs = get_intervening_revisions(self.last_revision(),
1059
stop_revision, self)
1060
assert self.last_revision() not in pullable_revs
1061
return pullable_revs
1062
except bzrlib.errors.NotAncestor:
1063
if is_ancestor(self.last_revision(), stop_revision, self):
1068
def revision_tree(self, revision_id):
1069
"""See Branch.revision_tree."""
1070
# TODO: refactor this to use an existing revision object
1071
# so we don't need to read it in twice.
1072
if revision_id == None or revision_id == NULL_REVISION:
1075
inv = self.get_revision_inventory(revision_id)
1076
return RevisionTree(self, inv, revision_id)
1078
def basis_tree(self):
1079
"""See Branch.basis_tree."""
1081
revision_id = self.revision_history()[-1]
1082
xml = self.working_tree().read_basis_inventory(revision_id)
1083
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1084
return RevisionTree(self, inv, revision_id)
1085
except (IndexError, NoSuchFile, NoWorkingTree), e:
1086
return self.revision_tree(self.last_revision())
1088
def working_tree(self):
1089
"""See Branch.working_tree."""
1090
from bzrlib.workingtree import WorkingTree
1091
if self._transport.base.find('://') != -1:
1092
raise NoWorkingTree(self.base)
1093
return WorkingTree(self.base, branch=self)
1096
def pull(self, source, overwrite=False):
1097
"""See Branch.pull."""
1100
old_count = len(self.revision_history())
1102
self.update_revisions(source)
1103
except DivergedBranches:
1107
self.set_revision_history(source.revision_history())
1108
new_count = len(self.revision_history())
1109
return new_count - old_count
1113
def get_parent(self):
1114
"""See Branch.get_parent."""
1116
_locs = ['parent', 'pull', 'x-pull']
1119
return self.controlfile(l, 'r').read().strip('\n')
1124
def get_push_location(self):
1125
"""See Branch.get_push_location."""
1126
config = bzrlib.config.BranchConfig(self)
1127
push_loc = config.get_user_option('push_location')
1130
def set_push_location(self, location):
1131
"""See Branch.set_push_location."""
1132
config = bzrlib.config.LocationConfig(self.base)
1133
config.set_user_option('push_location', location)
1136
def set_parent(self, url):
1137
"""See Branch.set_parent."""
1138
# TODO: Maybe delete old location files?
1139
from bzrlib.atomicfile import AtomicFile
1140
f = AtomicFile(self.controlfilename('parent'))
1147
def tree_config(self):
1148
return TreeConfig(self)
1150
def sign_revision(self, revision_id, gpg_strategy):
1151
"""See Branch.sign_revision."""
1152
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1153
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1156
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1157
"""See Branch.store_revision_signature."""
1158
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1161
def fileid_involved_between_revs(self, from_revid, to_revid):
1162
"""Find file_id(s) which are involved in the changes between revisions.
1164
This determines the set of revisions which are involved, and then
1165
finds all file ids affected by those revisions.
1167
# TODO: jam 20060119 This code assumes that w.inclusions will
1168
# always be correct. But because of the presence of ghosts
1169
# it is possible to be wrong.
1170
# One specific example from Robert Collins:
1171
# Two branches, with revisions ABC, and AD
1172
# C is a ghost merge of D.
1173
# Inclusions doesn't recognize D as an ancestor.
1174
# If D is ever merged in the future, the weave
1175
# won't be fixed, because AD never saw revision C
1176
# to cause a conflict which would force a reweave.
1177
w = self._get_inventory_weave()
1178
from_set = set(w.inclusions([w.lookup(from_revid)]))
1179
to_set = set(w.inclusions([w.lookup(to_revid)]))
1180
included = to_set.difference(from_set)
1181
changed = map(w.idx_to_name, included)
1182
return self._fileid_involved_by_set(changed)
1184
def fileid_involved(self, last_revid=None):
1185
"""Find all file_ids modified in the ancestry of last_revid.
1187
:param last_revid: If None, last_revision() will be used.
1189
w = self._get_inventory_weave()
1191
changed = set(w._names)
1193
included = w.inclusions([w.lookup(last_revid)])
1194
changed = map(w.idx_to_name, included)
1195
return self._fileid_involved_by_set(changed)
1197
def fileid_involved_by_set(self, changes):
1198
"""Find all file_ids modified by the set of revisions passed in.
1200
:param changes: A set() of revision ids
1202
# TODO: jam 20060119 This line does *nothing*, remove it.
1203
# or better yet, change _fileid_involved_by_set so
1204
# that it takes the inventory weave, rather than
1205
# pulling it out by itself.
1206
w = self._get_inventory_weave()
1207
return self._fileid_involved_by_set(changes)
1209
def _fileid_involved_by_set(self, changes):
1210
"""Find the set of file-ids affected by the set of revisions.
1212
:param changes: A set() of revision ids.
1213
:return: A set() of file ids.
1215
This peaks at the Weave, interpreting each line, looking to
1216
see if it mentions one of the revisions. And if so, includes
1217
the file id mentioned.
1218
This expects both the Weave format, and the serialization
1219
to have a single line per file/directory, and to have
1220
fileid="" and revision="" on that line.
1222
assert self._branch_format in (5, 6), \
1223
"fileid_involved only supported for branches which store inventory as xml"
1225
w = self._get_inventory_weave()
1227
for line in w._weave:
1229
# it is ugly, but it is due to the weave structure
1230
if not isinstance(line, basestring): continue
1232
start = line.find('file_id="')+9
1233
if start < 9: continue
1234
end = line.find('"', start)
1236
file_id = xml.sax.saxutils.unescape(line[start:end])
1238
# check if file_id is already present
1239
if file_id in file_ids: continue
1241
start = line.find('revision="')+10
1242
if start < 10: continue
1243
end = line.find('"', start)
1245
revision_id = xml.sax.saxutils.unescape(line[start:end])
1247
if revision_id in changes:
1248
file_ids.add(file_id)
1253
class ScratchBranch(BzrBranch):
964
1254
"""Special test class: a branch that cleans up after itself.
966
1256
>>> b = ScratchBranch()
967
1257
>>> isdir(b.base)
1260
>>> b._transport.__del__()
974
def __init__(self, files=[], dirs=[]):
1265
def __init__(self, files=[], dirs=[], transport=None):
975
1266
"""Make a test branch.
977
1268
This creates a temporary directory and runs init-tree in it.
979
1270
If any files are listed, they are created in the working copy.
981
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1272
if transport is None:
1273
transport = bzrlib.transport.local.ScratchTransport()
1274
super(ScratchBranch, self).__init__(transport, init=True)
1276
super(ScratchBranch, self).__init__(transport)
983
os.mkdir(self.abspath(d))
1279
self._transport.mkdir(d)
986
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
993
"""Destroy the test branch, removing the scratch directory."""
995
mutter("delete ScratchBranch %s" % self.base)
996
shutil.rmtree(self.base)
998
# Work around for shutil.rmtree failing on Windows when
999
# readonly files are encountered
1000
mutter("hit exception in destroying ScratchBranch: %s" % e)
1001
for root, dirs, files in os.walk(self.base, topdown=False):
1003
os.chmod(os.path.join(root, name), 0700)
1004
shutil.rmtree(self.base)
1282
self._transport.put(f, 'content of %s' % f)
1287
>>> orig = ScratchBranch(files=["file1", "file2"])
1288
>>> clone = orig.clone()
1289
>>> if os.name != 'nt':
1290
... os.path.samefile(orig.base, clone.base)
1292
... orig.base == clone.base
1295
>>> os.path.isfile(pathjoin(clone.base, "file1"))
1298
from shutil import copytree
1299
from bzrlib.osutils import mkdtemp
1302
copytree(self.base, base, symlinks=True)
1303
return ScratchBranch(
1304
transport=bzrlib.transport.local.ScratchTransport(base))
1009
1307
######################################################################