1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from cStringIO import StringIO
21
from warnings import warn
22
from cStringIO import StringIO
26
from bzrlib.inventory import InventoryEntry
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
30
rename, splitpath, sha_file, appendpath,
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError)
37
from bzrlib.textui import show_status
38
from bzrlib.revision import Revision, is_ancestor, get_intervening_revisions
40
from bzrlib.delta import compare_trees
41
from bzrlib.tree import EmptyTree, RevisionTree
42
from bzrlib.inventory import Inventory
43
from bzrlib.store import copy_all
44
from bzrlib.store.compressed_text import CompressedTextStore
45
from bzrlib.store.text import TextStore
46
from bzrlib.store.weave import WeaveStore
47
from bzrlib.testament import Testament
48
import bzrlib.transactions as transactions
49
from bzrlib.transport import Transport, get_transport
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
35
revision as _mod_revision,
43
from bzrlib.config import BranchConfig, TransportConfig
44
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
45
from bzrlib.tag import (
51
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
52
from bzrlib.hooks import HookPoint, Hooks
53
from bzrlib.inter import InterObject
54
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
55
from bzrlib import registry
56
from bzrlib.symbol_versioning import (
60
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
54
63
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
55
64
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
56
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
57
## TODO: Maybe include checks for common corruption of newlines, etc?
60
# TODO: Some operations like log might retrieve the same revisions
61
# repeatedly to calculate deltas. We could perhaps have a weakref
62
# cache in memory to make this faster. In general anything can be
63
# cached in memory between lock and unlock operations.
65
def find_branch(*ignored, **ignored_too):
66
# XXX: leave this here for about one release, then remove it
67
raise NotImplementedError('find_branch() is not supported anymore, '
68
'please use one of the new branch constructors')
71
def needs_read_lock(unbound):
72
"""Decorate unbound to take out and release a read lock."""
73
def decorated(self, *args, **kwargs):
76
return unbound(self, *args, **kwargs)
82
def needs_write_lock(unbound):
83
"""Decorate unbound to take out and release a write lock."""
84
def decorated(self, *args, **kwargs):
87
return unbound(self, *args, **kwargs)
92
######################################################################
65
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
68
class Branch(controldir.ControlComponent):
96
69
"""Branch holding a history of revisions.
99
Base directory/url of the branch.
72
Base directory/url of the branch; using control_url and
73
control_transport is more standardized.
75
hooks: An instance of BranchHooks.
77
# this is really an instance variable - FIXME move it there
82
def control_transport(self):
83
return self._transport
86
def user_transport(self):
87
return self.bzrdir.user_transport
103
89
def __init__(self, *ignored, **ignored_too):
104
raise NotImplementedError('The Branch class is abstract')
107
def open_downlevel(base):
108
"""Open a branch which may be of an old format.
110
Only local branches are supported."""
111
return _Branch(get_transport(base), relax_version_check=True)
115
"""Open an existing branch, rooted at 'base' (url)"""
116
t = get_transport(base)
117
mutter("trying to open %r with transport %r", base, t)
121
def open_containing(url):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._partial_revision_history_cache = []
95
self._last_revision_info_cache = None
96
self._merge_sorted_revisions_cache = None
98
hooks = Branch.hooks['open']
102
def _open_hook(self):
103
"""Called by init to allow simpler extension of the base class."""
105
def _activate_fallback_location(self, url):
106
"""Activate the branch/repository from url as a fallback repository."""
107
repo = self._get_fallback_repository(url)
108
if repo.has_same_location(self.repository):
109
raise errors.UnstackableLocationError(self.user_url, url)
110
self.repository.add_fallback_repository(repo)
112
def break_lock(self):
113
"""Break a lock if one is present from another instance.
115
Uses the ui factory to ask for confirmation if the lock may be from
118
This will probe the repository for its lock as well.
120
self.control_files.break_lock()
121
self.repository.break_lock()
122
master = self.get_master_branch()
123
if master is not None:
126
def _check_stackable_repo(self):
127
if not self.repository._format.supports_external_lookups:
128
raise errors.UnstackableRepositoryFormat(self.repository._format,
129
self.repository.base)
131
def _extend_partial_history(self, stop_index=None, stop_revision=None):
132
"""Extend the partial history to include a given index
134
If a stop_index is supplied, stop when that index has been reached.
135
If a stop_revision is supplied, stop when that revision is
136
encountered. Otherwise, stop when the beginning of history is
139
:param stop_index: The index which should be present. When it is
140
present, history extension will stop.
141
:param stop_revision: The revision id which should be present. When
142
it is encountered, history extension will stop.
144
if len(self._partial_revision_history_cache) == 0:
145
self._partial_revision_history_cache = [self.last_revision()]
146
repository._iter_for_revno(
147
self.repository, self._partial_revision_history_cache,
148
stop_index=stop_index, stop_revision=stop_revision)
149
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
150
self._partial_revision_history_cache.pop()
152
def _get_check_refs(self):
153
"""Get the references needed for check().
157
revid = self.last_revision()
158
return [('revision-existence', revid), ('lefthand-distance', revid)]
161
def open(base, _unsupported=False, possible_transports=None):
162
"""Open the branch rooted at base.
164
For instance, if the branch is at URL/.bzr/branch,
165
Branch.open(URL) -> a Branch instance.
167
control = bzrdir.BzrDir.open(base, _unsupported,
168
possible_transports=possible_transports)
169
return control.open_branch(unsupported=_unsupported)
172
def open_from_transport(transport, name=None, _unsupported=False):
173
"""Open the branch rooted at transport"""
174
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
175
return control.open_branch(name=name, unsupported=_unsupported)
178
def open_containing(url, possible_transports=None):
122
179
"""Open an existing branch which contains url.
124
181
This probes for a branch at url, and searches upwards from there.
126
183
Basically we keep looking up until we find the control directory or
127
184
run into the root. If there isn't one, raises NotBranchError.
185
If there is one and it is either an unrecognised format or an unsupported
186
format, UnknownFormatError or UnsupportedFormatError are raised.
128
187
If there is one, it is returned, along with the unused portion of url.
130
t = get_transport(url)
133
return _Branch(t), t.relpath(url)
134
except NotBranchError:
136
new_t = t.clone('..')
137
if new_t.base == t.base:
138
# reached the root, whatever that may be
139
raise NotBranchError(path=url)
143
def initialize(base):
144
"""Create a new branch, rooted at 'base' (url)"""
145
t = get_transport(base)
146
return _Branch(t, init=True)
148
def setup_caching(self, cache_root):
149
"""Subclasses that care about caching should override this, and set
150
up cached stores located under cache_root.
152
self.cache_root = cache_root
155
class _Branch(Branch):
156
"""A branch stored in the actual filesystem.
158
Note that it's "local" in the context of the filesystem; it doesn't
159
really matter if it's on an nfs/smb/afs/coda/... share, as long as
160
it's writable, and can be accessed via the normal filesystem API.
166
If _lock_mode is true, a positive count of the number of times the
170
Lock object from bzrlib.lock.
172
# We actually expect this class to be somewhat short-lived; part of its
173
# purpose is to try to isolate what bits of the branch logic are tied to
174
# filesystem access, so that in a later step, we can extricate them to
175
# a separarte ("storage") class.
179
_inventory_weave = None
181
# Map some sort of prefix into a namespace
182
# stuff like "revno:10", "revid:", etc.
183
# This should match a prefix with a function which accepts
184
REVISION_NAMESPACES = {}
186
def push_stores(self, branch_to):
187
"""Copy the content of this branches store to branch_to."""
188
if (self._branch_format != branch_to._branch_format
189
or self._branch_format != 4):
190
from bzrlib.fetch import greedy_fetch
191
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
192
self, self._branch_format, branch_to, branch_to._branch_format)
193
greedy_fetch(to_branch=branch_to, from_branch=self,
194
revision=self.last_revision())
197
store_pairs = ((self.text_store, branch_to.text_store),
198
(self.inventory_store, branch_to.inventory_store),
199
(self.revision_store, branch_to.revision_store))
201
for from_store, to_store in store_pairs:
202
copy_all(from_store, to_store)
203
except UnlistableStore:
204
raise UnlistableBranch(from_store)
206
def __init__(self, transport, init=False,
207
relax_version_check=False):
208
"""Create new branch object at a particular location.
210
transport -- A Transport object, defining how to access files.
211
(If a string, transport.transport() will be used to
212
create a Transport object)
214
init -- If True, create new control files in a previously
215
unversioned directory. If False, the branch must already
218
relax_version_check -- If true, the usual check for the branch
219
version is not applied. This is intended only for
220
upgrade/recovery type use; it's not guaranteed that
221
all operations will work on old format branches.
223
In the test suite, creation of new trees is tested using the
224
`ScratchBranch` class.
226
assert isinstance(transport, Transport), \
227
"%r is not a Transport" % transport
228
self._transport = transport
231
self._check_format(relax_version_check)
233
def get_store(name, compressed=True, prefixed=False):
234
# FIXME: This approach of assuming stores are all entirely compressed
235
# or entirely uncompressed is tidy, but breaks upgrade from
236
# some existing branches where there's a mixture; we probably
237
# still want the option to look for both.
238
relpath = self._rel_controlfilename(name)
240
store = CompressedTextStore(self._transport.clone(relpath),
243
store = TextStore(self._transport.clone(relpath),
245
#if self._transport.should_cache():
246
# cache_path = os.path.join(self.cache_root, name)
247
# os.mkdir(cache_path)
248
# store = bzrlib.store.CachedStore(store, cache_path)
250
def get_weave(name, prefixed=False):
251
relpath = self._rel_controlfilename(name)
252
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
253
if self._transport.should_cache():
254
ws.enable_cache = True
257
if self._branch_format == 4:
258
self.inventory_store = get_store('inventory-store')
259
self.text_store = get_store('text-store')
260
self.revision_store = get_store('revision-store')
261
elif self._branch_format == 5:
262
self.control_weaves = get_weave('')
263
self.weave_store = get_weave('weaves')
264
self.revision_store = get_store('revision-store', compressed=False)
265
elif self._branch_format == 6:
266
self.control_weaves = get_weave('')
267
self.weave_store = get_weave('weaves', prefixed=True)
268
self.revision_store = get_store('revision-store', compressed=False,
270
self.revision_store.register_suffix('sig')
271
self._transaction = None
274
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
281
if self._lock_mode or self._lock:
282
# XXX: This should show something every time, and be suitable for
283
# headless operation and embedding
284
warn("branch %r was not explicitly unlocked" % self)
287
# TODO: It might be best to do this somewhere else,
288
# but it is nice for a Branch object to automatically
289
# cache it's information.
290
# Alternatively, we could have the Transport objects cache requests
291
# See the earlier discussion about how major objects (like Branch)
292
# should never expect their __del__ function to run.
293
if hasattr(self, 'cache_root') and self.cache_root is not None:
296
shutil.rmtree(self.cache_root)
299
self.cache_root = None
303
return self._transport.base
306
base = property(_get_base, doc="The URL for the root of this branch.")
308
def _finish_transaction(self):
309
"""Exit the current transaction."""
310
if self._transaction is None:
311
raise errors.LockError('Branch %s is not in a transaction' %
313
transaction = self._transaction
314
self._transaction = None
317
def get_transaction(self):
318
"""Return the current active transaction.
320
If no transaction is active, this returns a passthrough object
321
for which all data is immedaitely flushed and no caching happens.
323
if self._transaction is None:
324
return transactions.PassThroughTransaction()
326
return self._transaction
328
def _set_transaction(self, new_transaction):
329
"""Set a new active transaction."""
330
if self._transaction is not None:
331
raise errors.LockError('Branch %s is in a transaction already.' %
333
self._transaction = new_transaction
335
def lock_write(self):
336
mutter("lock write: %s (%s)", self, self._lock_count)
337
# TODO: Upgrade locking to support using a Transport,
338
# and potentially a remote locking protocol
340
if self._lock_mode != 'w':
341
raise LockError("can't upgrade to a write lock from %r" %
343
self._lock_count += 1
345
self._lock = self._transport.lock_write(
346
self._rel_controlfilename('branch-lock'))
347
self._lock_mode = 'w'
349
self._set_transaction(transactions.PassThroughTransaction())
189
control, relpath = bzrdir.BzrDir.open_containing(url,
191
return control.open_branch(), relpath
193
def _push_should_merge_tags(self):
194
"""Should _basic_push merge this branch's tags into the target?
196
The default implementation returns False if this branch has no tags,
197
and True the rest of the time. Subclasses may override this.
199
return self.supports_tags() and self.tags.get_tag_dict()
201
def get_config(self):
202
"""Get a bzrlib.config.BranchConfig for this Branch.
204
This can then be used to get and set configuration options for the
207
:return: A bzrlib.config.BranchConfig.
209
return BranchConfig(self)
211
def _get_config(self):
212
"""Get the concrete config for just the config in this branch.
214
This is not intended for client use; see Branch.get_config for the
219
:return: An object supporting get_option and set_option.
221
raise NotImplementedError(self._get_config)
223
def _get_fallback_repository(self, url):
224
"""Get the repository we fallback to at url."""
225
url = urlutils.join(self.base, url)
226
a_branch = Branch.open(url,
227
possible_transports=[self.bzrdir.root_transport])
228
return a_branch.repository
230
def _get_tags_bytes(self):
231
"""Get the bytes of a serialised tags dict.
233
Note that not all branches support tags, nor do all use the same tags
234
logic: this method is specific to BasicTags. Other tag implementations
235
may use the same method name and behave differently, safely, because
236
of the double-dispatch via
237
format.make_tags->tags_instance->get_tags_dict.
239
:return: The bytes of the tags file.
240
:seealso: Branch._set_tags_bytes.
242
return self._transport.get_bytes('tags')
244
def _get_nick(self, local=False, possible_transports=None):
245
config = self.get_config()
246
# explicit overrides master, but don't look for master if local is True
247
if not local and not config.has_explicit_nickname():
249
master = self.get_master_branch(possible_transports)
250
if master and self.user_url == master.user_url:
251
raise errors.RecursiveBind(self.user_url)
252
if master is not None:
253
# return the master branch value
255
except errors.RecursiveBind, e:
257
except errors.BzrError, e:
258
# Silently fall back to local implicit nick if the master is
260
mutter("Could not connect to bound branch, "
261
"falling back to local nick.\n " + str(e))
262
return config.get_nickname()
264
def _set_nick(self, nick):
265
self.get_config().set_user_option('nickname', nick, warn_masked=True)
267
nick = property(_get_nick, _set_nick)
270
raise NotImplementedError(self.is_locked)
272
def _lefthand_history(self, revision_id, last_rev=None,
274
if 'evil' in debug.debug_flags:
275
mutter_callsite(4, "_lefthand_history scales with history.")
276
# stop_revision must be a descendant of last_revision
277
graph = self.repository.get_graph()
278
if last_rev is not None:
279
if not graph.is_ancestor(last_rev, revision_id):
280
# our previous tip is not merged into stop_revision
281
raise errors.DivergedBranches(self, other_branch)
282
# make a new revision history from the graph
283
parents_map = graph.get_parent_map([revision_id])
284
if revision_id not in parents_map:
285
raise errors.NoSuchRevision(self, revision_id)
286
current_rev_id = revision_id
288
check_not_reserved_id = _mod_revision.check_not_reserved_id
289
# Do not include ghosts or graph origin in revision_history
290
while (current_rev_id in parents_map and
291
len(parents_map[current_rev_id]) > 0):
292
check_not_reserved_id(current_rev_id)
293
new_history.append(current_rev_id)
294
current_rev_id = parents_map[current_rev_id][0]
295
parents_map = graph.get_parent_map([current_rev_id])
296
new_history.reverse()
299
def lock_write(self, token=None):
300
"""Lock the branch for write operations.
302
:param token: A token to permit reacquiring a previously held and
304
:return: A BranchWriteLockResult.
306
raise NotImplementedError(self.lock_write)
351
308
def lock_read(self):
352
mutter("lock read: %s (%s)", self, self._lock_count)
354
assert self._lock_mode in ('r', 'w'), \
355
"invalid lock mode %r" % self._lock_mode
356
self._lock_count += 1
358
self._lock = self._transport.lock_read(
359
self._rel_controlfilename('branch-lock'))
360
self._lock_mode = 'r'
362
self._set_transaction(transactions.ReadOnlyTransaction())
363
# 5K may be excessive, but hey, its a knob.
364
self.get_transaction().set_cache_size(5000)
309
"""Lock the branch for read operations.
311
:return: A bzrlib.lock.LogicalLockResult.
313
raise NotImplementedError(self.lock_read)
366
315
def unlock(self):
367
mutter("unlock: %s (%s)", self, self._lock_count)
368
if not self._lock_mode:
369
raise LockError('branch %r is not locked' % (self))
371
if self._lock_count > 1:
372
self._lock_count -= 1
374
self._finish_transaction()
377
self._lock_mode = self._lock_count = None
379
def abspath(self, name):
380
"""Return absolute filename for something in the branch
382
XXX: Robert Collins 20051017 what is this used for? why is it a branch
383
method and not a tree method.
385
return self._transport.abspath(name)
387
def _rel_controlfilename(self, file_or_path):
388
if not isinstance(file_or_path, basestring):
389
file_or_path = '/'.join(file_or_path)
390
if file_or_path == '':
392
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
394
def controlfilename(self, file_or_path):
395
"""Return location relative to branch."""
396
return self._transport.abspath(self._rel_controlfilename(file_or_path))
399
def controlfile(self, file_or_path, mode='r'):
400
"""Open a control file for this branch.
402
There are two classes of file in the control directory: text
403
and binary. binary files are untranslated byte streams. Text
404
control files are stored with Unix newlines and in UTF-8, even
405
if the platform or locale defaults are different.
407
Controlfiles should almost never be opened in write mode but
408
rather should be atomically copied and replaced using atomicfile.
412
relpath = self._rel_controlfilename(file_or_path)
413
#TODO: codecs.open() buffers linewise, so it was overloaded with
414
# a much larger buffer, do we need to do the same for getreader/getwriter?
416
return self._transport.get(relpath)
418
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
420
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
422
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
424
raise BzrError("invalid controlfile mode %r" % mode)
426
def put_controlfile(self, path, f, encode=True):
427
"""Write an entry as a controlfile.
429
:param path: The path to put the file, relative to the .bzr control
431
:param f: A file-like or string object whose contents should be copied.
432
:param encode: If true, encode the contents as utf-8
434
self.put_controlfiles([(path, f)], encode=encode)
436
def put_controlfiles(self, files, encode=True):
437
"""Write several entries as controlfiles.
439
:param files: A list of [(path, file)] pairs, where the path is the directory
440
underneath the bzr control directory
441
:param encode: If true, encode the contents as utf-8
445
for path, f in files:
447
if isinstance(f, basestring):
448
f = f.encode('utf-8', 'replace')
316
raise NotImplementedError(self.unlock)
318
def peek_lock_mode(self):
319
"""Return lock mode for the Branch: 'r', 'w' or None"""
320
raise NotImplementedError(self.peek_lock_mode)
322
def get_physical_lock_status(self):
323
raise NotImplementedError(self.get_physical_lock_status)
326
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
327
"""Return the revision_id for a dotted revno.
329
:param revno: a tuple like (1,) or (1,1,2)
330
:param _cache_reverse: a private parameter enabling storage
331
of the reverse mapping in a top level cache. (This should
332
only be done in selective circumstances as we want to
333
avoid having the mapping cached multiple times.)
334
:return: the revision_id
335
:raises errors.NoSuchRevision: if the revno doesn't exist
337
rev_id = self._do_dotted_revno_to_revision_id(revno)
339
self._partial_revision_id_to_revno_cache[rev_id] = revno
342
def _do_dotted_revno_to_revision_id(self, revno):
343
"""Worker function for dotted_revno_to_revision_id.
345
Subclasses should override this if they wish to
346
provide a more efficient implementation.
349
return self.get_rev_id(revno[0])
350
revision_id_to_revno = self.get_revision_id_to_revno_map()
351
revision_ids = [revision_id for revision_id, this_revno
352
in revision_id_to_revno.iteritems()
353
if revno == this_revno]
354
if len(revision_ids) == 1:
355
return revision_ids[0]
357
revno_str = '.'.join(map(str, revno))
358
raise errors.NoSuchRevision(self, revno_str)
361
def revision_id_to_dotted_revno(self, revision_id):
362
"""Given a revision id, return its dotted revno.
364
:return: a tuple like (1,) or (400,1,3).
366
return self._do_revision_id_to_dotted_revno(revision_id)
368
def _do_revision_id_to_dotted_revno(self, revision_id):
369
"""Worker function for revision_id_to_revno."""
370
# Try the caches if they are loaded
371
result = self._partial_revision_id_to_revno_cache.get(revision_id)
372
if result is not None:
374
if self._revision_id_to_revno_cache:
375
result = self._revision_id_to_revno_cache.get(revision_id)
377
raise errors.NoSuchRevision(self, revision_id)
378
# Try the mainline as it's optimised
380
revno = self.revision_id_to_revno(revision_id)
382
except errors.NoSuchRevision:
383
# We need to load and use the full revno map after all
384
result = self.get_revision_id_to_revno_map().get(revision_id)
386
raise errors.NoSuchRevision(self, revision_id)
390
def get_revision_id_to_revno_map(self):
391
"""Return the revision_id => dotted revno map.
393
This will be regenerated on demand, but will be cached.
395
:return: A dictionary mapping revision_id => dotted revno.
396
This dictionary should not be modified by the caller.
398
if self._revision_id_to_revno_cache is not None:
399
mapping = self._revision_id_to_revno_cache
401
mapping = self._gen_revno_map()
402
self._cache_revision_id_to_revno(mapping)
403
# TODO: jam 20070417 Since this is being cached, should we be returning
405
# I would rather not, and instead just declare that users should not
406
# modify the return value.
409
def _gen_revno_map(self):
410
"""Create a new mapping from revision ids to dotted revnos.
412
Dotted revnos are generated based on the current tip in the revision
414
This is the worker function for get_revision_id_to_revno_map, which
415
just caches the return value.
417
:return: A dictionary mapping revision_id => dotted revno.
419
revision_id_to_revno = dict((rev_id, revno)
420
for rev_id, depth, revno, end_of_merge
421
in self.iter_merge_sorted_revisions())
422
return revision_id_to_revno
425
def iter_merge_sorted_revisions(self, start_revision_id=None,
426
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
427
"""Walk the revisions for a branch in merge sorted order.
429
Merge sorted order is the output from a merge-aware,
430
topological sort, i.e. all parents come before their
431
children going forward; the opposite for reverse.
433
:param start_revision_id: the revision_id to begin walking from.
434
If None, the branch tip is used.
435
:param stop_revision_id: the revision_id to terminate the walk
436
after. If None, the rest of history is included.
437
:param stop_rule: if stop_revision_id is not None, the precise rule
438
to use for termination:
439
* 'exclude' - leave the stop revision out of the result (default)
440
* 'include' - the stop revision is the last item in the result
441
* 'with-merges' - include the stop revision and all of its
442
merged revisions in the result
443
* 'with-merges-without-common-ancestry' - filter out revisions
444
that are in both ancestries
445
:param direction: either 'reverse' or 'forward':
446
* reverse means return the start_revision_id first, i.e.
447
start at the most recent revision and go backwards in history
448
* forward returns tuples in the opposite order to reverse.
449
Note in particular that forward does *not* do any intelligent
450
ordering w.r.t. depth as some clients of this API may like.
451
(If required, that ought to be done at higher layers.)
453
:return: an iterator over (revision_id, depth, revno, end_of_merge)
456
* revision_id: the unique id of the revision
457
* depth: How many levels of merging deep this node has been
459
* revno_sequence: This field provides a sequence of
460
revision numbers for all revisions. The format is:
461
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
462
branch that the revno is on. From left to right the REVNO numbers
463
are the sequence numbers within that branch of the revision.
464
* end_of_merge: When True the next node (earlier in history) is
465
part of a different merge.
467
# Note: depth and revno values are in the context of the branch so
468
# we need the full graph to get stable numbers, regardless of the
470
if self._merge_sorted_revisions_cache is None:
471
last_revision = self.last_revision()
472
known_graph = self.repository.get_known_graph_ancestry(
474
self._merge_sorted_revisions_cache = known_graph.merge_sort(
476
filtered = self._filter_merge_sorted_revisions(
477
self._merge_sorted_revisions_cache, start_revision_id,
478
stop_revision_id, stop_rule)
479
# Make sure we don't return revisions that are not part of the
480
# start_revision_id ancestry.
481
filtered = self._filter_start_non_ancestors(filtered)
482
if direction == 'reverse':
484
if direction == 'forward':
485
return reversed(list(filtered))
487
raise ValueError('invalid direction %r' % direction)
489
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
490
start_revision_id, stop_revision_id, stop_rule):
491
"""Iterate over an inclusive range of sorted revisions."""
492
rev_iter = iter(merge_sorted_revisions)
493
if start_revision_id is not None:
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
if rev_id != start_revision_id:
450
f = codecs.getwriter('utf-8')(f, errors='replace')
451
path = self._rel_controlfilename(path)
452
ctrl_files.append((path, f))
453
self._transport.put_multi(ctrl_files)
455
def _make_control(self):
456
from bzrlib.inventory import Inventory
457
from bzrlib.weavefile import write_weave_v5
458
from bzrlib.weave import Weave
460
# Create an empty inventory
462
# if we want per-tree root ids then this is the place to set
463
# them; they're not needed for now and so ommitted for
465
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
466
empty_inv = sio.getvalue()
468
bzrlib.weavefile.write_weave_v5(Weave(), sio)
469
empty_weave = sio.getvalue()
471
dirs = [[], 'revision-store', 'weaves']
473
"This is a Bazaar-NG control directory.\n"
474
"Do not change any files in this directory.\n"),
475
('branch-format', BZR_BRANCH_FORMAT_6),
476
('revision-history', ''),
479
('pending-merges', ''),
480
('inventory', empty_inv),
481
('inventory.weave', empty_weave),
482
('ancestry.weave', empty_weave)
484
cfn = self._rel_controlfilename
485
self._transport.mkdir_multi([cfn(d) for d in dirs])
486
self.put_controlfiles(files)
487
mutter('created control directory in ' + self._transport.base)
489
def _check_format(self, relax_version_check):
490
"""Check this branch format is supported.
492
The format level is stored, as an integer, in
493
self._branch_format for code that needs to check it later.
495
In the future, we might need different in-memory Branch
496
classes to support downlevel branches. But not yet.
499
fmt = self.controlfile('branch-format', 'r').read()
501
raise NotBranchError(path=self.base)
502
mutter("got branch format %r", fmt)
503
if fmt == BZR_BRANCH_FORMAT_6:
504
self._branch_format = 6
505
elif fmt == BZR_BRANCH_FORMAT_5:
506
self._branch_format = 5
507
elif fmt == BZR_BRANCH_FORMAT_4:
508
self._branch_format = 4
510
if (not relax_version_check
511
and self._branch_format not in (5, 6)):
512
raise errors.UnsupportedFormatError(
513
'sorry, branch format %r not supported' % fmt,
514
['use a different bzr version',
515
'or remove the .bzr directory'
516
' and "bzr init" again'])
518
def get_root_id(self):
519
"""Return the id of this branches root"""
520
inv = self.read_working_inventory()
521
return inv.root.file_id
523
def set_root_id(self, file_id):
524
inv = self.read_working_inventory()
525
orig_root_id = inv.root.file_id
526
del inv._byid[inv.root.file_id]
527
inv.root.file_id = file_id
528
inv._byid[inv.root.file_id] = inv.root
531
if entry.parent_id in (None, orig_root_id):
532
entry.parent_id = inv.root.file_id
533
self._write_inventory(inv)
536
def read_working_inventory(self):
537
"""Read the working inventory."""
538
# ElementTree does its own conversion from UTF-8, so open in
540
f = self.controlfile('inventory', 'rb')
541
return bzrlib.xml5.serializer_v5.read_inventory(f)
544
def _write_inventory(self, inv):
545
"""Update the working inventory.
547
That is to say, the inventory describing changes underway, that
548
will be committed to the next revision.
550
from cStringIO import StringIO
552
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
554
# Transport handles atomicity
555
self.put_controlfile('inventory', sio)
557
mutter('wrote working inventory')
559
inventory = property(read_working_inventory, _write_inventory, None,
560
"""Inventory for the working copy.""")
563
def add(self, files, ids=None):
564
"""Make files versioned.
566
Note that the command line normally calls smart_add instead,
567
which can automatically recurse.
569
This puts the files in the Added state, so that they will be
570
recorded by the next commit.
573
List of paths to add, relative to the base of the tree.
576
If set, use these instead of automatically generated ids.
577
Must be the same length as the list of files, but may
578
contain None for ids that are to be autogenerated.
580
TODO: Perhaps have an option to add the ids even if the files do
583
TODO: Perhaps yield the ids and paths as they're added.
585
# TODO: Re-adding a file that is removed in the working copy
586
# should probably put it back with the previous ID.
587
if isinstance(files, basestring):
588
assert(ids is None or isinstance(ids, basestring))
594
ids = [None] * len(files)
596
assert(len(ids) == len(files))
598
inv = self.read_working_inventory()
599
for f,file_id in zip(files, ids):
600
if is_control_file(f):
601
raise BzrError("cannot add control file %s" % quotefn(f))
606
raise BzrError("cannot add top-level %r" % f)
608
fullpath = os.path.normpath(self.abspath(f))
611
kind = file_kind(fullpath)
613
# maybe something better?
614
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
616
if not InventoryEntry.versionable_kind(kind):
617
raise BzrError('cannot add: not a versionable file ('
618
'i.e. regular file, symlink or directory): %s' % quotefn(f))
621
file_id = gen_file_id(f)
622
inv.add_path(f, kind=kind, file_id=file_id)
624
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
626
self._write_inventory(inv)
629
def print_file(self, file, revno):
630
"""Print `file` to stdout."""
631
tree = self.revision_tree(self.get_rev_id(revno))
632
# use inventory as it was in that revision
633
file_id = tree.inventory.path2id(file)
635
raise BzrError("%r is not present in revision %s" % (file, revno))
636
tree.print_file(file_id)
638
# FIXME: this doesn't need to be a branch method
639
def set_inventory(self, new_inventory_list):
640
from bzrlib.inventory import Inventory, InventoryEntry
641
inv = Inventory(self.get_root_id())
642
for path, file_id, parent, kind in new_inventory_list:
643
name = os.path.basename(path)
646
# fixme, there should be a factory function inv,add_??
647
if kind == 'directory':
648
inv.add(inventory.InventoryDirectory(file_id, name, parent))
650
inv.add(inventory.InventoryFile(file_id, name, parent))
651
elif kind == 'symlink':
652
inv.add(inventory.InventoryLink(file_id, name, parent))
499
# The decision to include the start or not
500
# depends on the stop_rule if a stop is provided
501
# so pop this node back into the iterator
502
rev_iter = chain(iter([node]), rev_iter)
504
if stop_revision_id is None:
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
yield (rev_id, node.merge_depth, node.revno,
510
elif stop_rule == 'exclude':
511
for node in rev_iter:
512
rev_id = node.key[-1]
513
if rev_id == stop_revision_id:
515
yield (rev_id, node.merge_depth, node.revno,
517
elif stop_rule == 'include':
518
for node in rev_iter:
519
rev_id = node.key[-1]
520
yield (rev_id, node.merge_depth, node.revno,
522
if rev_id == stop_revision_id:
524
elif stop_rule == 'with-merges-without-common-ancestry':
525
# We want to exclude all revisions that are already part of the
526
# stop_revision_id ancestry.
527
graph = self.repository.get_graph()
528
ancestors = graph.find_unique_ancestors(start_revision_id,
530
for node in rev_iter:
531
rev_id = node.key[-1]
532
if rev_id not in ancestors:
534
yield (rev_id, node.merge_depth, node.revno,
536
elif stop_rule == 'with-merges':
537
stop_rev = self.repository.get_revision(stop_revision_id)
538
if stop_rev.parent_ids:
539
left_parent = stop_rev.parent_ids[0]
654
raise BzrError("unknown kind %r" % kind)
655
self._write_inventory(inv)
658
"""Return all unknown files.
660
These are files in the working directory that are not versioned or
661
control files or ignored.
663
>>> from bzrlib.workingtree import WorkingTree
664
>>> b = ScratchBranch(files=['foo', 'foo~'])
665
>>> map(str, b.unknowns())
668
>>> list(b.unknowns())
670
>>> WorkingTree(b.base, b).remove('foo')
671
>>> list(b.unknowns())
674
return self.working_tree().unknowns()
677
def append_revision(self, *revision_ids):
678
for revision_id in revision_ids:
679
mutter("add {%s} to revision-history" % revision_id)
680
rev_history = self.revision_history()
681
rev_history.extend(revision_ids)
682
self.set_revision_history(rev_history)
685
def set_revision_history(self, rev_history):
686
self.put_controlfile('revision-history', '\n'.join(rev_history))
688
def has_revision(self, revision_id):
689
"""True if this branch has a copy of the revision.
691
This does not necessarily imply the revision is merge
692
or on the mainline."""
693
return (revision_id is None
694
or self.revision_store.has_id(revision_id))
697
def get_revision_xml_file(self, revision_id):
698
"""Return XML file object for revision object."""
699
if not revision_id or not isinstance(revision_id, basestring):
700
raise InvalidRevisionId(revision_id)
702
return self.revision_store.get(revision_id)
703
except (IndexError, KeyError):
704
raise bzrlib.errors.NoSuchRevision(self, revision_id)
707
get_revision_xml = get_revision_xml_file
709
def get_revision_xml(self, revision_id):
710
return self.get_revision_xml_file(revision_id).read()
713
def get_revision(self, revision_id):
714
"""Return the Revision object for a named revision"""
715
xml_file = self.get_revision_xml_file(revision_id)
718
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
719
except SyntaxError, e:
720
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
724
assert r.revision_id == revision_id
541
left_parent = _mod_revision.NULL_REVISION
542
# left_parent is the actual revision we want to stop logging at,
543
# since we want to show the merged revisions after the stop_rev too
544
reached_stop_revision_id = False
545
revision_id_whitelist = []
546
for node in rev_iter:
547
rev_id = node.key[-1]
548
if rev_id == left_parent:
549
# reached the left parent after the stop_revision
551
if (not reached_stop_revision_id or
552
rev_id in revision_id_whitelist):
553
yield (rev_id, node.merge_depth, node.revno,
555
if reached_stop_revision_id or rev_id == stop_revision_id:
556
# only do the merged revs of rev_id from now on
557
rev = self.repository.get_revision(rev_id)
559
reached_stop_revision_id = True
560
revision_id_whitelist.extend(rev.parent_ids)
562
raise ValueError('invalid stop_rule %r' % stop_rule)
564
def _filter_start_non_ancestors(self, rev_iter):
565
# If we started from a dotted revno, we want to consider it as a tip
566
# and don't want to yield revisions that are not part of its
567
# ancestry. Given the order guaranteed by the merge sort, we will see
568
# uninteresting descendants of the first parent of our tip before the
570
first = rev_iter.next()
571
(rev_id, merge_depth, revno, end_of_merge) = first
574
# We start at a mainline revision so by definition, all others
575
# revisions in rev_iter are ancestors
576
for node in rev_iter:
581
pmap = self.repository.get_parent_map([rev_id])
582
parents = pmap.get(rev_id, [])
584
whitelist.update(parents)
586
# If there is no parents, there is nothing of interest left
588
# FIXME: It's hard to test this scenario here as this code is never
589
# called in that case. -- vila 20100322
592
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
594
if rev_id in whitelist:
595
pmap = self.repository.get_parent_map([rev_id])
596
parents = pmap.get(rev_id, [])
597
whitelist.remove(rev_id)
598
whitelist.update(parents)
600
# We've reached the mainline, there is nothing left to
604
# A revision that is not part of the ancestry of our
607
yield (rev_id, merge_depth, revno, end_of_merge)
609
def leave_lock_in_place(self):
610
"""Tell this branch object not to release the physical lock when this
613
If lock_write doesn't return a token, then this method is not supported.
615
self.control_files.leave_in_place()
617
def dont_leave_lock_in_place(self):
618
"""Tell this branch object to release the physical lock when this
619
object is unlocked, even if it didn't originally acquire it.
621
If lock_write doesn't return a token, then this method is not supported.
623
self.control_files.dont_leave_in_place()
625
def bind(self, other):
626
"""Bind the local branch the other branch.
628
:param other: The branch to bind to
631
raise errors.UpgradeRequired(self.user_url)
633
def set_append_revisions_only(self, enabled):
634
if not self._format.supports_set_append_revisions_only():
635
raise errors.UpgradeRequired(self.user_url)
640
self.get_config().set_user_option('append_revisions_only', value,
643
def set_reference_info(self, file_id, tree_path, branch_location):
644
"""Set the branch location to use for a tree reference."""
645
raise errors.UnsupportedOperation(self.set_reference_info, self)
647
def get_reference_info(self, file_id):
648
"""Get the tree_path and branch_location for a tree reference."""
649
raise errors.UnsupportedOperation(self.get_reference_info, self)
652
def fetch(self, from_branch, last_revision=None, pb=None):
653
"""Copy revisions from from_branch into this branch.
655
:param from_branch: Where to copy from.
656
:param last_revision: What revision to stop at (None for at the end
658
:param pb: An optional progress bar to use.
661
if self.base == from_branch.base:
664
symbol_versioning.warn(
665
symbol_versioning.deprecated_in((1, 14, 0))
666
% "pb parameter to fetch()")
667
from_branch.lock_read()
669
if last_revision is None:
670
last_revision = from_branch.last_revision()
671
last_revision = _mod_revision.ensure_null(last_revision)
672
return self.repository.fetch(from_branch.repository,
673
revision_id=last_revision,
678
def get_bound_location(self):
679
"""Return the URL of the branch we are bound to.
681
Older format branches cannot bind, please be sure to use a metadir
686
def get_old_bound_location(self):
687
"""Return the URL of the branch we used to be bound to
689
raise errors.UpgradeRequired(self.user_url)
691
def get_commit_builder(self, parents, config=None, timestamp=None,
692
timezone=None, committer=None, revprops=None,
694
"""Obtain a CommitBuilder for this branch.
696
:param parents: Revision ids of the parents of the new revision.
697
:param config: Optional configuration to use.
698
:param timestamp: Optional timestamp recorded for commit.
699
:param timezone: Optional timezone for timestamp.
700
:param committer: Optional committer to set for commit.
701
:param revprops: Optional dictionary of revision properties.
702
:param revision_id: Optional revision id.
706
config = self.get_config()
708
return self.repository.get_commit_builder(self, parents, config,
709
timestamp, timezone, committer, revprops, revision_id)
711
def get_master_branch(self, possible_transports=None):
712
"""Return the branch we are bound to.
714
:return: Either a Branch, or None
727
718
def get_revision_delta(self, revno):
728
719
"""Return the delta for one revision.
868
993
common_index = min(self_len, other_len) -1
869
994
if common_index >= 0 and \
870
995
self_history[common_index] != other_history[common_index]:
871
raise DivergedBranches(self, other)
996
raise errors.DivergedBranches(self, other)
873
998
if stop_revision is None:
874
999
stop_revision = other_len
876
assert isinstance(stop_revision, int)
877
1001
if stop_revision > other_len:
878
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
1002
raise errors.NoSuchRevision(self, stop_revision)
879
1003
return other_history[self_len:stop_revision]
881
def update_revisions(self, other, stop_revision=None):
882
"""Pull in new perfect-fit revisions."""
883
# FIXME: If the branches have diverged, but the latest
884
# revision in this branch is completely merged into the other,
885
# then we should still be able to pull.
886
from bzrlib.fetch import greedy_fetch
887
if stop_revision is None:
888
stop_revision = other.last_revision()
889
### Should this be checking is_ancestor instead of revision_history?
890
if (stop_revision is not None and
891
stop_revision in self.revision_history()):
893
greedy_fetch(to_branch=self, from_branch=other,
894
revision=stop_revision)
895
pullable_revs = self.pullable_revisions(other, stop_revision)
896
if len(pullable_revs) > 0:
897
self.append_revision(*pullable_revs)
899
def pullable_revisions(self, other, stop_revision):
900
other_revno = other.revision_id_to_revno(stop_revision)
902
return self.missing_revisions(other, other_revno)
903
except DivergedBranches, e:
905
pullable_revs = get_intervening_revisions(self.last_revision(),
907
assert self.last_revision() not in pullable_revs
909
except bzrlib.errors.NotAncestor:
910
if is_ancestor(self.last_revision(), stop_revision, self):
915
def commit(self, *args, **kw):
916
from bzrlib.commit import Commit
917
Commit().commit(self, *args, **kw)
1005
def update_revisions(self, other, stop_revision=None, overwrite=False,
1007
"""Pull in new perfect-fit revisions.
1009
:param other: Another Branch to pull from
1010
:param stop_revision: Updated until the given revision
1011
:param overwrite: Always set the branch pointer, rather than checking
1012
to see if it is a proper descendant.
1013
:param graph: A Graph object that can be used to query history
1014
information. This can be None.
1017
return InterBranch.get(other, self).update_revisions(stop_revision,
1020
def import_last_revision_info(self, source_repo, revno, revid):
1021
"""Set the last revision info, importing from another repo if necessary.
1023
This is used by the bound branch code to upload a revision to
1024
the master branch first before updating the tip of the local branch.
1026
:param source_repo: Source repository to optionally fetch from
1027
:param revno: Revision number of the new tip
1028
:param revid: Revision id of the new tip
1030
if not self.repository.has_same_location(source_repo):
1031
self.repository.fetch(source_repo, revision_id=revid)
1032
self.set_last_revision_info(revno, revid)
919
1034
def revision_id_to_revno(self, revision_id):
920
1035
"""Given a revision id, return its revno"""
921
if revision_id is None:
1036
if _mod_revision.is_null(revision_id):
923
1038
history = self.revision_history()
925
1040
return history.index(revision_id) + 1
926
1041
except ValueError:
927
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1042
raise errors.NoSuchRevision(self, revision_id)
929
1045
def get_rev_id(self, revno, history=None):
930
1046
"""Find the revision id of the specified revno."""
934
history = self.revision_history()
935
elif revno <= 0 or revno > len(history):
936
raise bzrlib.errors.NoSuchRevision(self, revno)
937
return history[revno - 1]
939
def revision_tree(self, revision_id):
940
"""Return Tree for a revision on this branch.
942
`revision_id` may be None for the null revision, in which case
943
an `EmptyTree` is returned."""
944
# TODO: refactor this to use an existing revision object
945
# so we don't need to read it in twice.
946
if revision_id == None:
949
inv = self.get_revision_inventory(revision_id)
950
return RevisionTree(self.weave_store, inv, revision_id)
952
def working_tree(self):
953
"""Return a `Tree` for the working copy."""
954
from bzrlib.workingtree import WorkingTree
955
# TODO: In the future, perhaps WorkingTree should utilize Transport
956
# RobertCollins 20051003 - I don't think it should - working trees are
957
# much more complex to keep consistent than our careful .bzr subset.
958
# instead, we should say that working trees are local only, and optimise
960
return WorkingTree(self.base, branch=self)
1048
return _mod_revision.NULL_REVISION
1049
last_revno, last_revid = self.last_revision_info()
1050
if revno == last_revno:
1052
if revno <= 0 or revno > last_revno:
1053
raise errors.NoSuchRevision(self, revno)
1054
distance_from_last = last_revno - revno
1055
if len(self._partial_revision_history_cache) <= distance_from_last:
1056
self._extend_partial_history(distance_from_last)
1057
return self._partial_revision_history_cache[distance_from_last]
1059
def pull(self, source, overwrite=False, stop_revision=None,
1060
possible_transports=None, *args, **kwargs):
1061
"""Mirror source into this branch.
1063
This branch is considered to be 'local', having low latency.
1065
:returns: PullResult instance
1067
return InterBranch.get(source, self).pull(overwrite=overwrite,
1068
stop_revision=stop_revision,
1069
possible_transports=possible_transports, *args, **kwargs)
1071
def push(self, target, overwrite=False, stop_revision=None, *args,
1073
"""Mirror this branch into target.
1075
This branch is considered to be 'local', having low latency.
1077
return InterBranch.get(self, target).push(overwrite, stop_revision,
1080
def lossy_push(self, target, stop_revision=None):
1081
"""Push deltas into another branch.
1083
:note: This does not, like push, retain the revision ids from
1084
the source branch and will, rather than adding bzr-specific
1085
metadata, push only those semantics of the revision that can be
1086
natively represented by this branch' VCS.
1088
:param target: Target branch
1089
:param stop_revision: Revision to push, defaults to last revision.
1090
:return: BranchPushResult with an extra member revidmap:
1091
A dictionary mapping revision ids from the target branch
1092
to new revision ids in the target branch, for each
1093
revision that was pushed.
1095
inter = InterBranch.get(self, target)
1096
lossy_push = getattr(inter, "lossy_push", None)
1097
if lossy_push is None:
1098
raise errors.LossyPushToSameVCS(self, target)
1099
return lossy_push(stop_revision)
963
1101
def basis_tree(self):
964
"""Return `Tree` object for last revision.
966
If there are no revisions yet, return an `EmptyTree`.
968
return self.revision_tree(self.last_revision())
971
def rename_one(self, from_rel, to_rel):
974
This can change the directory or the filename or both.
976
tree = self.working_tree()
978
if not tree.has_filename(from_rel):
979
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
980
if tree.has_filename(to_rel):
981
raise BzrError("can't rename: new working file %r already exists" % to_rel)
983
file_id = inv.path2id(from_rel)
985
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
987
if inv.path2id(to_rel):
988
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
990
to_dir, to_tail = os.path.split(to_rel)
991
to_dir_id = inv.path2id(to_dir)
992
if to_dir_id == None and to_dir != '':
993
raise BzrError("can't determine destination directory id for %r" % to_dir)
995
mutter("rename_one:")
996
mutter(" file_id {%s}" % file_id)
997
mutter(" from_rel %r" % from_rel)
998
mutter(" to_rel %r" % to_rel)
999
mutter(" to_dir %r" % to_dir)
1000
mutter(" to_dir_id {%s}" % to_dir_id)
1002
inv.rename(file_id, to_dir_id, to_tail)
1004
from_abs = self.abspath(from_rel)
1005
to_abs = self.abspath(to_rel)
1007
rename(from_abs, to_abs)
1009
raise BzrError("failed to rename %r to %r: %s"
1010
% (from_abs, to_abs, e[1]),
1011
["rename rolled back"])
1013
self._write_inventory(inv)
1016
def move(self, from_paths, to_name):
1019
to_name must exist as a versioned directory.
1021
If to_name exists and is a directory, the files are moved into
1022
it, keeping their old names. If it is a directory,
1024
Note that to_name is only the last component of the new name;
1025
this doesn't change the directory.
1027
This returns a list of (from_path, to_path) pairs for each
1028
entry that is moved.
1031
## TODO: Option to move IDs only
1032
assert not isinstance(from_paths, basestring)
1033
tree = self.working_tree()
1034
inv = tree.inventory
1035
to_abs = self.abspath(to_name)
1036
if not isdir(to_abs):
1037
raise BzrError("destination %r is not a directory" % to_abs)
1038
if not tree.has_filename(to_name):
1039
raise BzrError("destination %r not in working directory" % to_abs)
1040
to_dir_id = inv.path2id(to_name)
1041
if to_dir_id == None and to_name != '':
1042
raise BzrError("destination %r is not a versioned directory" % to_name)
1043
to_dir_ie = inv[to_dir_id]
1044
if to_dir_ie.kind not in ('directory', 'root_directory'):
1045
raise BzrError("destination %r is not a directory" % to_abs)
1047
to_idpath = inv.get_idpath(to_dir_id)
1049
for f in from_paths:
1050
if not tree.has_filename(f):
1051
raise BzrError("%r does not exist in working tree" % f)
1052
f_id = inv.path2id(f)
1054
raise BzrError("%r is not versioned" % f)
1055
name_tail = splitpath(f)[-1]
1056
dest_path = appendpath(to_name, name_tail)
1057
if tree.has_filename(dest_path):
1058
raise BzrError("destination %r already exists" % dest_path)
1059
if f_id in to_idpath:
1060
raise BzrError("can't move %r to a subdirectory of itself" % f)
1062
# OK, so there's a race here, it's possible that someone will
1063
# create a file in this interval and then the rename might be
1064
# left half-done. But we should have caught most problems.
1066
for f in from_paths:
1067
name_tail = splitpath(f)[-1]
1068
dest_path = appendpath(to_name, name_tail)
1069
result.append((f, dest_path))
1070
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1072
rename(self.abspath(f), self.abspath(dest_path))
1074
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1075
["rename rolled back"])
1077
self._write_inventory(inv)
1081
def revert(self, filenames, old_tree=None, backups=True):
1082
"""Restore selected files to the versions from a previous tree.
1085
If true (default) backups are made of files before
1088
from bzrlib.atomicfile import AtomicFile
1089
from bzrlib.osutils import backup_file
1091
inv = self.read_working_inventory()
1092
if old_tree is None:
1093
old_tree = self.basis_tree()
1094
old_inv = old_tree.inventory
1097
for fn in filenames:
1098
file_id = inv.path2id(fn)
1100
raise NotVersionedError(path=fn)
1101
if not old_inv.has_id(file_id):
1102
raise BzrError("file not present in old tree", fn, file_id)
1103
nids.append((fn, file_id))
1105
# TODO: Rename back if it was previously at a different location
1107
# TODO: If given a directory, restore the entire contents from
1108
# the previous version.
1110
# TODO: Make a backup to a temporary file.
1112
# TODO: If the file previously didn't exist, delete it?
1113
for fn, file_id in nids:
1116
f = AtomicFile(fn, 'wb')
1118
f.write(old_tree.get_file(file_id).read())
1124
def pending_merges(self):
1125
"""Return a list of pending merges.
1127
These are revisions that have been merged into the working
1128
directory but not yet committed.
1130
cfn = self._rel_controlfilename('pending-merges')
1131
if not self._transport.has(cfn):
1134
for l in self.controlfile('pending-merges', 'r').readlines():
1135
p.append(l.rstrip('\n'))
1139
def add_pending_merge(self, *revision_ids):
1140
# TODO: Perhaps should check at this point that the
1141
# history of the revision is actually present?
1142
p = self.pending_merges()
1144
for rev_id in revision_ids:
1150
self.set_pending_merges(p)
1153
def set_pending_merges(self, rev_list):
1154
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1102
"""Return `Tree` object for last revision."""
1103
return self.repository.revision_tree(self.last_revision())
1156
1105
def get_parent(self):
1157
1106
"""Return the parent location of the branch.
1159
This is the default location for push/pull/missing. The usual
1160
pattern is that the user can override it by specifying a
1164
_locs = ['parent', 'pull', 'x-pull']
1167
return self.controlfile(l, 'r').read().strip('\n')
1169
if e.errno != errno.ENOENT:
1108
This is the default location for pull/missing. The usual
1109
pattern is that the user can override it by specifying a
1112
parent = self._get_parent_location()
1115
# This is an old-format absolute path to a local branch
1116
# turn it into a url
1117
if parent.startswith('/'):
1118
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1120
return urlutils.join(self.base[:-1], parent)
1121
except errors.InvalidURLJoin, e:
1122
raise errors.InaccessibleParent(parent, self.user_url)
1124
def _get_parent_location(self):
1125
raise NotImplementedError(self._get_parent_location)
1127
def _set_config_location(self, name, url, config=None,
1128
make_relative=False):
1130
config = self.get_config()
1134
url = urlutils.relative_url(self.base, url)
1135
config.set_user_option(name, url, warn_masked=True)
1137
def _get_config_location(self, name, config=None):
1139
config = self.get_config()
1140
location = config.get_user_option(name)
1145
def get_child_submit_format(self):
1146
"""Return the preferred format of submissions to this branch."""
1147
return self.get_config().get_user_option("child_submit_format")
1149
def get_submit_branch(self):
1150
"""Return the submit location of the branch.
1152
This is the default location for bundle. The usual
1153
pattern is that the user can override it by specifying a
1156
return self.get_config().get_user_option('submit_branch')
1158
def set_submit_branch(self, location):
1159
"""Return the submit location of the branch.
1161
This is the default location for bundle. The usual
1162
pattern is that the user can override it by specifying a
1165
self.get_config().set_user_option('submit_branch', location,
1168
def get_public_branch(self):
1169
"""Return the public location of the branch.
1171
This is used by merge directives.
1173
return self._get_config_location('public_branch')
1175
def set_public_branch(self, location):
1176
"""Return the submit location of the branch.
1178
This is the default location for bundle. The usual
1179
pattern is that the user can override it by specifying a
1182
self._set_config_location('public_branch', location)
1184
def get_push_location(self):
1185
"""Return the None or the location to push this branch to."""
1186
push_loc = self.get_config().get_user_option('push_location')
1189
def set_push_location(self, location):
1190
"""Set a new push location for this branch."""
1191
raise NotImplementedError(self.set_push_location)
1193
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1194
"""Run the post_change_branch_tip hooks."""
1195
hooks = Branch.hooks['post_change_branch_tip']
1198
new_revno, new_revid = self.last_revision_info()
1199
params = ChangeBranchTipParams(
1200
self, old_revno, new_revno, old_revid, new_revid)
1204
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1205
"""Run the pre_change_branch_tip hooks."""
1206
hooks = Branch.hooks['pre_change_branch_tip']
1209
old_revno, old_revid = self.last_revision_info()
1210
params = ChangeBranchTipParams(
1211
self, old_revno, new_revno, old_revid, new_revid)
1217
"""Synchronise this branch with the master branch if any.
1219
:return: None or the last_revision pivoted out during the update.
1174
def set_parent(self, url):
1175
# TODO: Maybe delete old location files?
1176
from bzrlib.atomicfile import AtomicFile
1177
f = AtomicFile(self.controlfilename('parent'))
1184
1223
def check_revno(self, revno):
1186
1225
Check whether a revno corresponds to any revision.
1190
1229
self.check_real_revno(revno)
1192
1231
def check_real_revno(self, revno):
1194
1233
Check whether a revno corresponds to a real revision.
1195
1234
Zero (the NULL revision) is considered invalid
1197
1236
if revno < 1 or revno > self.revno():
1198
raise InvalidRevisionNumber(revno)
1200
def sign_revision(self, revision_id, gpg_strategy):
1201
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1202
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1237
raise errors.InvalidRevisionNumber(revno)
1240
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1241
"""Clone this branch into to_bzrdir preserving all semantic values.
1243
Most API users will want 'create_clone_on_transport', which creates a
1244
new bzrdir and branch on the fly.
1246
revision_id: if not None, the revision history in the new branch will
1247
be truncated to end with revision_id.
1249
result = to_bzrdir.create_branch()
1252
if repository_policy is not None:
1253
repository_policy.configure_branch(result)
1254
self.copy_content_into(result, revision_id=revision_id)
1260
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1261
"""Create a new line of development from the branch, into to_bzrdir.
1263
to_bzrdir controls the branch format.
1265
revision_id: if not None, the revision history in the new branch will
1266
be truncated to end with revision_id.
1268
if (repository_policy is not None and
1269
repository_policy.requires_stacking()):
1270
to_bzrdir._format.require_stacking(_skip_repo=True)
1271
result = to_bzrdir.create_branch()
1274
if repository_policy is not None:
1275
repository_policy.configure_branch(result)
1276
self.copy_content_into(result, revision_id=revision_id)
1277
result.set_parent(self.bzrdir.root_transport.base)
1282
def _synchronize_history(self, destination, revision_id):
1283
"""Synchronize last revision and revision history between branches.
1285
This version is most efficient when the destination is also a
1286
BzrBranch6, but works for BzrBranch5, as long as the destination's
1287
repository contains all the lefthand ancestors of the intended
1288
last_revision. If not, set_last_revision_info will fail.
1290
:param destination: The branch to copy the history into
1291
:param revision_id: The revision-id to truncate history at. May
1292
be None to copy complete history.
1294
source_revno, source_revision_id = self.last_revision_info()
1295
if revision_id is None:
1296
revno, revision_id = source_revno, source_revision_id
1298
graph = self.repository.get_graph()
1300
revno = graph.find_distance_to_null(revision_id,
1301
[(source_revision_id, source_revno)])
1302
except errors.GhostRevisionsHaveNoRevno:
1303
# Default to 1, if we can't find anything else
1305
destination.set_last_revision_info(revno, revision_id)
1307
def copy_content_into(self, destination, revision_id=None):
1308
"""Copy the content of self into destination.
1310
revision_id: if not None, the revision history in the new branch will
1311
be truncated to end with revision_id.
1313
return InterBranch.get(self, destination).copy_content_into(
1314
revision_id=revision_id)
1316
def update_references(self, target):
1317
if not getattr(self._format, 'supports_reference_locations', False):
1319
reference_dict = self._get_all_reference_info()
1320
if len(reference_dict) == 0:
1322
old_base = self.base
1323
new_base = target.base
1324
target_reference_dict = target._get_all_reference_info()
1325
for file_id, (tree_path, branch_location) in (
1326
reference_dict.items()):
1327
branch_location = urlutils.rebase_url(branch_location,
1329
target_reference_dict.setdefault(
1330
file_id, (tree_path, branch_location))
1331
target._set_all_reference_info(target_reference_dict)
1334
def check(self, refs):
1335
"""Check consistency of the branch.
1337
In particular this checks that revisions given in the revision-history
1338
do actually match up in the revision graph, and that they're all
1339
present in the repository.
1341
Callers will typically also want to check the repository.
1343
:param refs: Calculated refs for this branch as specified by
1344
branch._get_check_refs()
1345
:return: A BranchCheckResult.
1347
result = BranchCheckResult(self)
1348
last_revno, last_revision_id = self.last_revision_info()
1349
actual_revno = refs[('lefthand-distance', last_revision_id)]
1350
if actual_revno != last_revno:
1351
result.errors.append(errors.BzrCheckError(
1352
'revno does not match len(mainline) %s != %s' % (
1353
last_revno, actual_revno)))
1354
# TODO: We should probably also check that self.revision_history
1355
# matches the repository for older branch formats.
1356
# If looking for the code that cross-checks repository parents against
1357
# the iter_reverse_revision_history output, that is now a repository
1361
def _get_checkout_format(self):
1362
"""Return the most suitable metadir for a checkout of this branch.
1363
Weaves are used if this branch's repository uses weaves.
1365
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1366
from bzrlib.repofmt import weaverepo
1367
format = bzrdir.BzrDirMetaFormat1()
1368
format.repository_format = weaverepo.RepositoryFormat7()
1370
format = self.repository.bzrdir.checkout_metadir()
1371
format.set_branch_format(self._format)
1374
def create_clone_on_transport(self, to_transport, revision_id=None,
1375
stacked_on=None, create_prefix=False, use_existing_dir=False):
1376
"""Create a clone of this branch and its bzrdir.
1378
:param to_transport: The transport to clone onto.
1379
:param revision_id: The revision id to use as tip in the new branch.
1380
If None the tip is obtained from this branch.
1381
:param stacked_on: An optional URL to stack the clone on.
1382
:param create_prefix: Create any missing directories leading up to
1384
:param use_existing_dir: Use an existing directory if one exists.
1386
# XXX: Fix the bzrdir API to allow getting the branch back from the
1387
# clone call. Or something. 20090224 RBC/spiv.
1388
# XXX: Should this perhaps clone colocated branches as well,
1389
# rather than just the default branch? 20100319 JRV
1390
if revision_id is None:
1391
revision_id = self.last_revision()
1392
dir_to = self.bzrdir.clone_on_transport(to_transport,
1393
revision_id=revision_id, stacked_on=stacked_on,
1394
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1395
return dir_to.open_branch()
1397
def create_checkout(self, to_location, revision_id=None,
1398
lightweight=False, accelerator_tree=None,
1400
"""Create a checkout of a branch.
1402
:param to_location: The url to produce the checkout at
1403
:param revision_id: The revision to check out
1404
:param lightweight: If True, produce a lightweight checkout, otherwise,
1405
produce a bound branch (heavyweight checkout)
1406
:param accelerator_tree: A tree which can be used for retrieving file
1407
contents more quickly than the revision tree, i.e. a workingtree.
1408
The revision tree will be used for cases where accelerator_tree's
1409
content is different.
1410
:param hardlink: If true, hard-link files from accelerator_tree,
1412
:return: The tree of the created checkout
1414
t = transport.get_transport(to_location)
1417
format = self._get_checkout_format()
1418
checkout = format.initialize_on_transport(t)
1419
from_branch = BranchReferenceFormat().initialize(checkout,
1422
format = self._get_checkout_format()
1423
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
to_location, force_new_tree=False, format=format)
1425
checkout = checkout_branch.bzrdir
1426
checkout_branch.bind(self)
1427
# pull up to the specified revision_id to set the initial
1428
# branch tip correctly, and seed it with history.
1429
checkout_branch.pull(self, stop_revision=revision_id)
1431
tree = checkout.create_workingtree(revision_id,
1432
from_branch=from_branch,
1433
accelerator_tree=accelerator_tree,
1435
basis_tree = tree.basis_tree()
1436
basis_tree.lock_read()
1438
for path, file_id in basis_tree.iter_references():
1439
reference_parent = self.reference_parent(file_id, path)
1440
reference_parent.create_checkout(tree.abspath(path),
1441
basis_tree.get_reference_revision(file_id, path),
1204
1447
@needs_write_lock
1205
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1206
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1210
class ScratchBranch(_Branch):
1211
"""Special test class: a branch that cleans up after itself.
1213
>>> b = ScratchBranch()
1217
>>> b._transport.__del__()
1448
def reconcile(self, thorough=True):
1449
"""Make sure the data stored in this branch is consistent."""
1450
from bzrlib.reconcile import BranchReconciler
1451
reconciler = BranchReconciler(self, thorough=thorough)
1452
reconciler.reconcile()
1455
def reference_parent(self, file_id, path, possible_transports=None):
1456
"""Return the parent branch for a tree-reference file_id
1457
:param file_id: The file_id of the tree reference
1458
:param path: The path of the file_id in the tree
1459
:return: A branch associated with the file_id
1461
# FIXME should provide multiple branches, based on config
1462
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1463
possible_transports=possible_transports)
1465
def supports_tags(self):
1466
return self._format.supports_tags()
1468
def automatic_tag_name(self, revision_id):
1469
"""Try to automatically find the tag name for a revision.
1471
:param revision_id: Revision id of the revision.
1472
:return: A tag name or None if no tag name could be determined.
1474
for hook in Branch.hooks['automatic_tag_name']:
1475
ret = hook(self, revision_id)
1480
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1482
"""Ensure that revision_b is a descendant of revision_a.
1484
This is a helper function for update_revisions.
1486
:raises: DivergedBranches if revision_b has diverged from revision_a.
1487
:returns: True if revision_b is a descendant of revision_a.
1489
relation = self._revision_relations(revision_a, revision_b, graph)
1490
if relation == 'b_descends_from_a':
1492
elif relation == 'diverged':
1493
raise errors.DivergedBranches(self, other_branch)
1494
elif relation == 'a_descends_from_b':
1497
raise AssertionError("invalid relation: %r" % (relation,))
1499
def _revision_relations(self, revision_a, revision_b, graph):
1500
"""Determine the relationship between two revisions.
1502
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1504
heads = graph.heads([revision_a, revision_b])
1505
if heads == set([revision_b]):
1506
return 'b_descends_from_a'
1507
elif heads == set([revision_a, revision_b]):
1508
# These branches have diverged
1510
elif heads == set([revision_a]):
1511
return 'a_descends_from_b'
1513
raise AssertionError("invalid heads: %r" % (heads,))
1516
class BranchFormat(object):
1517
"""An encapsulation of the initialization and open routines for a format.
1519
Formats provide three things:
1520
* An initialization routine,
1524
Formats are placed in an dict by their format string for reference
1525
during branch opening. It's not required that these be instances, they
1526
can be classes themselves with class methods - it simply depends on
1527
whether state is needed for a given format or not.
1529
Once a format is deprecated, just deprecate the initialize and open
1530
methods on the format class. Do not deprecate the object, as the
1531
object will be created every time regardless.
1222
def __init__(self, files=[], dirs=[], transport=None):
1223
"""Make a test branch.
1225
This creates a temporary directory and runs init-tree in it.
1227
If any files are listed, they are created in the working copy.
1229
if transport is None:
1230
transport = bzrlib.transport.local.ScratchTransport()
1231
super(ScratchBranch, self).__init__(transport, init=True)
1233
super(ScratchBranch, self).__init__(transport)
1236
self._transport.mkdir(d)
1239
self._transport.put(f, 'content of %s' % f)
1244
>>> orig = ScratchBranch(files=["file1", "file2"])
1245
>>> clone = orig.clone()
1246
>>> if os.name != 'nt':
1247
... os.path.samefile(orig.base, clone.base)
1249
... orig.base == clone.base
1252
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1255
from shutil import copytree
1256
from tempfile import mkdtemp
1259
copytree(self.base, base, symlinks=True)
1260
return ScratchBranch(
1261
transport=bzrlib.transport.local.ScratchTransport(base))
1534
_default_format = None
1535
"""The default format used for new branches."""
1538
"""The known formats."""
1540
can_set_append_revisions_only = True
1542
def __eq__(self, other):
1543
return self.__class__ is other.__class__
1545
def __ne__(self, other):
1546
return not (self == other)
1549
def find_format(klass, a_bzrdir, name=None):
1550
"""Return the format for the branch object in a_bzrdir."""
1552
transport = a_bzrdir.get_branch_transport(None, name=name)
1553
format_string = transport.get_bytes("format")
1554
format = klass._formats[format_string]
1555
if isinstance(format, MetaDirBranchFormatFactory):
1558
except errors.NoSuchFile:
1559
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1561
raise errors.UnknownFormatError(format=format_string, kind='branch')
1564
def get_default_format(klass):
1565
"""Return the current default format."""
1566
return klass._default_format
1569
def get_formats(klass):
1570
"""Get all the known formats.
1572
Warning: This triggers a load of all lazy registered formats: do not
1573
use except when that is desireed.
1576
for fmt in klass._formats.values():
1577
if isinstance(fmt, MetaDirBranchFormatFactory):
1582
def get_reference(self, a_bzrdir, name=None):
1583
"""Get the target reference of the branch in a_bzrdir.
1585
format probing must have been completed before calling
1586
this method - it is assumed that the format of the branch
1587
in a_bzrdir is correct.
1589
:param a_bzrdir: The bzrdir to get the branch data from.
1590
:param name: Name of the colocated branch to fetch
1591
:return: None if the branch is not a reference branch.
1596
def set_reference(self, a_bzrdir, name, to_branch):
1597
"""Set the target reference of the branch in a_bzrdir.
1599
format probing must have been completed before calling
1600
this method - it is assumed that the format of the branch
1601
in a_bzrdir is correct.
1603
:param a_bzrdir: The bzrdir to set the branch reference for.
1604
:param name: Name of colocated branch to set, None for default
1605
:param to_branch: branch that the checkout is to reference
1607
raise NotImplementedError(self.set_reference)
1609
def get_format_string(self):
1610
"""Return the ASCII format string that identifies this format."""
1611
raise NotImplementedError(self.get_format_string)
1613
def get_format_description(self):
1614
"""Return the short format description for this format."""
1615
raise NotImplementedError(self.get_format_description)
1617
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1618
hooks = Branch.hooks['post_branch_init']
1621
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1625
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1626
lock_type='metadir', set_format=True):
1627
"""Initialize a branch in a bzrdir, with specified files
1629
:param a_bzrdir: The bzrdir to initialize the branch in
1630
:param utf8_files: The files to create as a list of
1631
(filename, content) tuples
1632
:param name: Name of colocated branch to create, if any
1633
:param set_format: If True, set the format with
1634
self.get_format_string. (BzrBranch4 has its format set
1636
:return: a branch in this format
1638
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1639
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1641
'metadir': ('lock', lockdir.LockDir),
1642
'branch4': ('branch-lock', lockable_files.TransportLock),
1644
lock_name, lock_class = lock_map[lock_type]
1645
control_files = lockable_files.LockableFiles(branch_transport,
1646
lock_name, lock_class)
1647
control_files.create_lock()
1649
control_files.lock_write()
1650
except errors.LockContention:
1651
if lock_type != 'branch4':
1657
utf8_files += [('format', self.get_format_string())]
1659
for (filename, content) in utf8_files:
1660
branch_transport.put_bytes(
1662
mode=a_bzrdir._get_file_mode())
1665
control_files.unlock()
1666
branch = self.open(a_bzrdir, name, _found=True)
1667
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1670
def initialize(self, a_bzrdir, name=None):
1671
"""Create a branch of this format in a_bzrdir.
1673
:param name: Name of the colocated branch to create.
1675
raise NotImplementedError(self.initialize)
1677
def is_supported(self):
1678
"""Is this format supported?
1680
Supported formats can be initialized and opened.
1681
Unsupported formats may not support initialization or committing or
1682
some other features depending on the reason for not being supported.
1686
def make_tags(self, branch):
1687
"""Create a tags object for branch.
1689
This method is on BranchFormat, because BranchFormats are reflected
1690
over the wire via network_name(), whereas full Branch instances require
1691
multiple VFS method calls to operate at all.
1693
The default implementation returns a disabled-tags instance.
1695
Note that it is normal for branch to be a RemoteBranch when using tags
1698
return DisabledTags(branch)
1700
def network_name(self):
1701
"""A simple byte string uniquely identifying this format for RPC calls.
1703
MetaDir branch formats use their disk format string to identify the
1704
repository over the wire. All in one formats such as bzr < 0.8, and
1705
foreign formats like svn/git and hg should use some marker which is
1706
unique and immutable.
1708
raise NotImplementedError(self.network_name)
1710
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1711
"""Return the branch object for a_bzrdir
1713
:param a_bzrdir: A BzrDir that contains a branch.
1714
:param name: Name of colocated branch to open
1715
:param _found: a private parameter, do not use it. It is used to
1716
indicate if format probing has already be done.
1717
:param ignore_fallbacks: when set, no fallback branches will be opened
1718
(if there are any). Default is to open fallbacks.
1720
raise NotImplementedError(self.open)
1723
def register_format(klass, format):
1724
"""Register a metadir format.
1726
See MetaDirBranchFormatFactory for the ability to register a format
1727
without loading the code the format needs until it is actually used.
1729
klass._formats[format.get_format_string()] = format
1730
# Metadir formats have a network name of their format string, and get
1731
# registered as factories.
1732
if isinstance(format, MetaDirBranchFormatFactory):
1733
network_format_registry.register(format.get_format_string(), format)
1735
network_format_registry.register(format.get_format_string(),
1739
def set_default_format(klass, format):
1740
klass._default_format = format
1742
def supports_set_append_revisions_only(self):
1743
"""True if this format supports set_append_revisions_only."""
1746
def supports_stacking(self):
1747
"""True if this format records a stacked-on branch."""
1751
def unregister_format(klass, format):
1752
del klass._formats[format.get_format_string()]
1755
return self.get_format_description().rstrip()
1757
def supports_tags(self):
1758
"""True if this format supports tags stored in the branch"""
1759
return False # by default
1762
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1763
"""A factory for a BranchFormat object, permitting simple lazy registration.
1765
While none of the built in BranchFormats are lazy registered yet,
1766
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1767
use it, and the bzr-loom plugin uses it as well (see
1768
bzrlib.plugins.loom.formats).
1771
def __init__(self, format_string, module_name, member_name):
1772
"""Create a MetaDirBranchFormatFactory.
1774
:param format_string: The format string the format has.
1775
:param module_name: Module to load the format class from.
1776
:param member_name: Attribute name within the module for the format class.
1778
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1779
self._format_string = format_string
1781
def get_format_string(self):
1782
"""See BranchFormat.get_format_string."""
1783
return self._format_string
1786
"""Used for network_format_registry support."""
1787
return self.get_obj()()
1790
class BranchHooks(Hooks):
1791
"""A dictionary mapping hook name to a list of callables for branch hooks.
1793
e.g. ['set_rh'] Is the list of items to be called when the
1794
set_revision_history function is invoked.
1798
"""Create the default hooks.
1800
These are all empty initially, because by default nothing should get
1803
Hooks.__init__(self)
1804
self.create_hook(HookPoint('set_rh',
1805
"Invoked whenever the revision history has been set via "
1806
"set_revision_history. The api signature is (branch, "
1807
"revision_history), and the branch will be write-locked. "
1808
"The set_rh hook can be expensive for bzr to trigger, a better "
1809
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1810
self.create_hook(HookPoint('open',
1811
"Called with the Branch object that has been opened after a "
1812
"branch is opened.", (1, 8), None))
1813
self.create_hook(HookPoint('post_push',
1814
"Called after a push operation completes. post_push is called "
1815
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1816
"bzr client.", (0, 15), None))
1817
self.create_hook(HookPoint('post_pull',
1818
"Called after a pull operation completes. post_pull is called "
1819
"with a bzrlib.branch.PullResult object and only runs in the "
1820
"bzr client.", (0, 15), None))
1821
self.create_hook(HookPoint('pre_commit',
1822
"Called after a commit is calculated but before it is "
1823
"completed. pre_commit is called with (local, master, old_revno, "
1824
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1825
"). old_revid is NULL_REVISION for the first commit to a branch, "
1826
"tree_delta is a TreeDelta object describing changes from the "
1827
"basis revision. hooks MUST NOT modify this delta. "
1828
" future_tree is an in-memory tree obtained from "
1829
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1830
"tree.", (0,91), None))
1831
self.create_hook(HookPoint('post_commit',
1832
"Called in the bzr client after a commit has completed. "
1833
"post_commit is called with (local, master, old_revno, old_revid, "
1834
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1835
"commit to a branch.", (0, 15), None))
1836
self.create_hook(HookPoint('post_uncommit',
1837
"Called in the bzr client after an uncommit completes. "
1838
"post_uncommit is called with (local, master, old_revno, "
1839
"old_revid, new_revno, new_revid) where local is the local branch "
1840
"or None, master is the target branch, and an empty branch "
1841
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1842
self.create_hook(HookPoint('pre_change_branch_tip',
1843
"Called in bzr client and server before a change to the tip of a "
1844
"branch is made. pre_change_branch_tip is called with a "
1845
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1846
"commit, uncommit will all trigger this hook.", (1, 6), None))
1847
self.create_hook(HookPoint('post_change_branch_tip',
1848
"Called in bzr client and server after a change to the tip of a "
1849
"branch is made. post_change_branch_tip is called with a "
1850
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1851
"commit, uncommit will all trigger this hook.", (1, 4), None))
1852
self.create_hook(HookPoint('transform_fallback_location',
1853
"Called when a stacked branch is activating its fallback "
1854
"locations. transform_fallback_location is called with (branch, "
1855
"url), and should return a new url. Returning the same url "
1856
"allows it to be used as-is, returning a different one can be "
1857
"used to cause the branch to stack on a closer copy of that "
1858
"fallback_location. Note that the branch cannot have history "
1859
"accessing methods called on it during this hook because the "
1860
"fallback locations have not been activated. When there are "
1861
"multiple hooks installed for transform_fallback_location, "
1862
"all are called with the url returned from the previous hook."
1863
"The order is however undefined.", (1, 9), None))
1864
self.create_hook(HookPoint('automatic_tag_name',
1865
"Called to determine an automatic tag name for a revision. "
1866
"automatic_tag_name is called with (branch, revision_id) and "
1867
"should return a tag name or None if no tag name could be "
1868
"determined. The first non-None tag name returned will be used.",
1870
self.create_hook(HookPoint('post_branch_init',
1871
"Called after new branch initialization completes. "
1872
"post_branch_init is called with a "
1873
"bzrlib.branch.BranchInitHookParams. "
1874
"Note that init, branch and checkout (both heavyweight and "
1875
"lightweight) will all trigger this hook.", (2, 2), None))
1876
self.create_hook(HookPoint('post_switch',
1877
"Called after a checkout switches branch. "
1878
"post_switch is called with a "
1879
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1883
# install the default hooks into the Branch class.
1884
Branch.hooks = BranchHooks()
1887
class ChangeBranchTipParams(object):
1888
"""Object holding parameters passed to *_change_branch_tip hooks.
1890
There are 5 fields that hooks may wish to access:
1892
:ivar branch: the branch being changed
1893
:ivar old_revno: revision number before the change
1894
:ivar new_revno: revision number after the change
1895
:ivar old_revid: revision id before the change
1896
:ivar new_revid: revision id after the change
1898
The revid fields are strings. The revno fields are integers.
1901
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1902
"""Create a group of ChangeBranchTip parameters.
1904
:param branch: The branch being changed.
1905
:param old_revno: Revision number before the change.
1906
:param new_revno: Revision number after the change.
1907
:param old_revid: Tip revision id before the change.
1908
:param new_revid: Tip revision id after the change.
1910
self.branch = branch
1911
self.old_revno = old_revno
1912
self.new_revno = new_revno
1913
self.old_revid = old_revid
1914
self.new_revid = new_revid
1916
def __eq__(self, other):
1917
return self.__dict__ == other.__dict__
1920
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1921
self.__class__.__name__, self.branch,
1922
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1925
class BranchInitHookParams(object):
1926
"""Object holding parameters passed to *_branch_init hooks.
1928
There are 4 fields that hooks may wish to access:
1930
:ivar format: the branch format
1931
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1932
:ivar name: name of colocated branch, if any (or None)
1933
:ivar branch: the branch created
1935
Note that for lightweight checkouts, the bzrdir and format fields refer to
1936
the checkout, hence they are different from the corresponding fields in
1937
branch, which refer to the original branch.
1940
def __init__(self, format, a_bzrdir, name, branch):
1941
"""Create a group of BranchInitHook parameters.
1943
:param format: the branch format
1944
:param a_bzrdir: the BzrDir where the branch will be/has been
1946
:param name: name of colocated branch, if any (or None)
1947
:param branch: the branch created
1949
Note that for lightweight checkouts, the bzrdir and format fields refer
1950
to the checkout, hence they are different from the corresponding fields
1951
in branch, which refer to the original branch.
1953
self.format = format
1954
self.bzrdir = a_bzrdir
1956
self.branch = branch
1958
def __eq__(self, other):
1959
return self.__dict__ == other.__dict__
1962
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1965
class SwitchHookParams(object):
1966
"""Object holding parameters passed to *_switch hooks.
1968
There are 4 fields that hooks may wish to access:
1970
:ivar control_dir: BzrDir of the checkout to change
1971
:ivar to_branch: branch that the checkout is to reference
1972
:ivar force: skip the check for local commits in a heavy checkout
1973
:ivar revision_id: revision ID to switch to (or None)
1976
def __init__(self, control_dir, to_branch, force, revision_id):
1977
"""Create a group of SwitchHook parameters.
1979
:param control_dir: BzrDir of the checkout to change
1980
:param to_branch: branch that the checkout is to reference
1981
:param force: skip the check for local commits in a heavy checkout
1982
:param revision_id: revision ID to switch to (or None)
1984
self.control_dir = control_dir
1985
self.to_branch = to_branch
1987
self.revision_id = revision_id
1989
def __eq__(self, other):
1990
return self.__dict__ == other.__dict__
1993
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1994
self.control_dir, self.to_branch,
1998
class BzrBranchFormat4(BranchFormat):
1999
"""Bzr branch format 4.
2002
- a revision-history file.
2003
- a branch-lock lock file [ to be shared with the bzrdir ]
2006
def get_format_description(self):
2007
"""See BranchFormat.get_format_description()."""
2008
return "Branch format 4"
2010
def initialize(self, a_bzrdir, name=None):
2011
"""Create a branch of this format in a_bzrdir."""
2012
utf8_files = [('revision-history', ''),
2013
('branch-name', ''),
2015
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
2016
lock_type='branch4', set_format=False)
2019
super(BzrBranchFormat4, self).__init__()
2020
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2022
def network_name(self):
2023
"""The network name for this format is the control dirs disk label."""
2024
return self._matchingbzrdir.get_format_string()
2026
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2027
"""See BranchFormat.open()."""
2029
# we are being called directly and must probe.
2030
raise NotImplementedError
2031
return BzrBranch(_format=self,
2032
_control_files=a_bzrdir._control_files,
2035
_repository=a_bzrdir.open_repository())
2038
return "Bazaar-NG branch format 4"
2041
class BranchFormatMetadir(BranchFormat):
2042
"""Common logic for meta-dir based branch formats."""
2044
def _branch_class(self):
2045
"""What class to instantiate on open calls."""
2046
raise NotImplementedError(self._branch_class)
2048
def network_name(self):
2049
"""A simple byte string uniquely identifying this format for RPC calls.
2051
Metadir branch formats use their format string.
2053
return self.get_format_string()
2055
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2056
"""See BranchFormat.open()."""
2058
format = BranchFormat.find_format(a_bzrdir, name=name)
2059
if format.__class__ != self.__class__:
2060
raise AssertionError("wrong format %r found for %r" %
2062
transport = a_bzrdir.get_branch_transport(None, name=name)
2064
control_files = lockable_files.LockableFiles(transport, 'lock',
2066
return self._branch_class()(_format=self,
2067
_control_files=control_files,
2070
_repository=a_bzrdir.find_repository(),
2071
ignore_fallbacks=ignore_fallbacks)
2072
except errors.NoSuchFile:
2073
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2076
super(BranchFormatMetadir, self).__init__()
2077
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2078
self._matchingbzrdir.set_branch_format(self)
2080
def supports_tags(self):
2084
class BzrBranchFormat5(BranchFormatMetadir):
2085
"""Bzr branch format 5.
2088
- a revision-history file.
2090
- a lock dir guarding the branch itself
2091
- all of this stored in a branch/ subdirectory
2092
- works with shared repositories.
2094
This format is new in bzr 0.8.
2097
def _branch_class(self):
2100
def get_format_string(self):
2101
"""See BranchFormat.get_format_string()."""
2102
return "Bazaar-NG branch format 5\n"
2104
def get_format_description(self):
2105
"""See BranchFormat.get_format_description()."""
2106
return "Branch format 5"
2108
def initialize(self, a_bzrdir, name=None):
2109
"""Create a branch of this format in a_bzrdir."""
2110
utf8_files = [('revision-history', ''),
2111
('branch-name', ''),
2113
return self._initialize_helper(a_bzrdir, utf8_files, name)
2115
def supports_tags(self):
2119
class BzrBranchFormat6(BranchFormatMetadir):
2120
"""Branch format with last-revision and tags.
2122
Unlike previous formats, this has no explicit revision history. Instead,
2123
this just stores the last-revision, and the left-hand history leading
2124
up to there is the history.
2126
This format was introduced in bzr 0.15
2127
and became the default in 0.91.
2130
def _branch_class(self):
2133
def get_format_string(self):
2134
"""See BranchFormat.get_format_string()."""
2135
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2137
def get_format_description(self):
2138
"""See BranchFormat.get_format_description()."""
2139
return "Branch format 6"
2141
def initialize(self, a_bzrdir, name=None):
2142
"""Create a branch of this format in a_bzrdir."""
2143
utf8_files = [('last-revision', '0 null:\n'),
2144
('branch.conf', ''),
2147
return self._initialize_helper(a_bzrdir, utf8_files, name)
2149
def make_tags(self, branch):
2150
"""See bzrlib.branch.BranchFormat.make_tags()."""
2151
return BasicTags(branch)
2153
def supports_set_append_revisions_only(self):
2157
class BzrBranchFormat8(BranchFormatMetadir):
2158
"""Metadir format supporting storing locations of subtree branches."""
2160
def _branch_class(self):
2163
def get_format_string(self):
2164
"""See BranchFormat.get_format_string()."""
2165
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2167
def get_format_description(self):
2168
"""See BranchFormat.get_format_description()."""
2169
return "Branch format 8"
2171
def initialize(self, a_bzrdir, name=None):
2172
"""Create a branch of this format in a_bzrdir."""
2173
utf8_files = [('last-revision', '0 null:\n'),
2174
('branch.conf', ''),
2178
return self._initialize_helper(a_bzrdir, utf8_files, name)
2181
super(BzrBranchFormat8, self).__init__()
2182
self._matchingbzrdir.repository_format = \
2183
RepositoryFormatKnitPack5RichRoot()
2185
def make_tags(self, branch):
2186
"""See bzrlib.branch.BranchFormat.make_tags()."""
2187
return BasicTags(branch)
2189
def supports_set_append_revisions_only(self):
2192
def supports_stacking(self):
2195
supports_reference_locations = True
2198
class BzrBranchFormat7(BzrBranchFormat8):
2199
"""Branch format with last-revision, tags, and a stacked location pointer.
2201
The stacked location pointer is passed down to the repository and requires
2202
a repository format with supports_external_lookups = True.
2204
This format was introduced in bzr 1.6.
2207
def initialize(self, a_bzrdir, name=None):
2208
"""Create a branch of this format in a_bzrdir."""
2209
utf8_files = [('last-revision', '0 null:\n'),
2210
('branch.conf', ''),
2213
return self._initialize_helper(a_bzrdir, utf8_files, name)
2215
def _branch_class(self):
2218
def get_format_string(self):
2219
"""See BranchFormat.get_format_string()."""
2220
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2222
def get_format_description(self):
2223
"""See BranchFormat.get_format_description()."""
2224
return "Branch format 7"
2226
def supports_set_append_revisions_only(self):
2229
supports_reference_locations = False
2232
class BranchReferenceFormat(BranchFormat):
2233
"""Bzr branch reference format.
2235
Branch references are used in implementing checkouts, they
2236
act as an alias to the real branch which is at some other url.
2243
def get_format_string(self):
2244
"""See BranchFormat.get_format_string()."""
2245
return "Bazaar-NG Branch Reference Format 1\n"
2247
def get_format_description(self):
2248
"""See BranchFormat.get_format_description()."""
2249
return "Checkout reference format 1"
2251
def get_reference(self, a_bzrdir, name=None):
2252
"""See BranchFormat.get_reference()."""
2253
transport = a_bzrdir.get_branch_transport(None, name=name)
2254
return transport.get_bytes('location')
2256
def set_reference(self, a_bzrdir, name, to_branch):
2257
"""See BranchFormat.set_reference()."""
2258
transport = a_bzrdir.get_branch_transport(None, name=name)
2259
location = transport.put_bytes('location', to_branch.base)
2261
def initialize(self, a_bzrdir, name=None, target_branch=None):
2262
"""Create a branch of this format in a_bzrdir."""
2263
if target_branch is None:
2264
# this format does not implement branch itself, thus the implicit
2265
# creation contract must see it as uninitializable
2266
raise errors.UninitializableFormat(self)
2267
mutter('creating branch reference in %s', a_bzrdir.user_url)
2268
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2269
branch_transport.put_bytes('location',
2270
target_branch.bzrdir.user_url)
2271
branch_transport.put_bytes('format', self.get_format_string())
2273
a_bzrdir, name, _found=True,
2274
possible_transports=[target_branch.bzrdir.root_transport])
2275
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2279
super(BranchReferenceFormat, self).__init__()
2280
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2281
self._matchingbzrdir.set_branch_format(self)
2283
def _make_reference_clone_function(format, a_branch):
2284
"""Create a clone() routine for a branch dynamically."""
2285
def clone(to_bzrdir, revision_id=None,
2286
repository_policy=None):
2287
"""See Branch.clone()."""
2288
return format.initialize(to_bzrdir, target_branch=a_branch)
2289
# cannot obey revision_id limits when cloning a reference ...
2290
# FIXME RBC 20060210 either nuke revision_id for clone, or
2291
# emit some sort of warning/error to the caller ?!
2294
def open(self, a_bzrdir, name=None, _found=False, location=None,
2295
possible_transports=None, ignore_fallbacks=False):
2296
"""Return the branch that the branch reference in a_bzrdir points at.
2298
:param a_bzrdir: A BzrDir that contains a branch.
2299
:param name: Name of colocated branch to open, if any
2300
:param _found: a private parameter, do not use it. It is used to
2301
indicate if format probing has already be done.
2302
:param ignore_fallbacks: when set, no fallback branches will be opened
2303
(if there are any). Default is to open fallbacks.
2304
:param location: The location of the referenced branch. If
2305
unspecified, this will be determined from the branch reference in
2307
:param possible_transports: An optional reusable transports list.
2310
format = BranchFormat.find_format(a_bzrdir, name=name)
2311
if format.__class__ != self.__class__:
2312
raise AssertionError("wrong format %r found for %r" %
2314
if location is None:
2315
location = self.get_reference(a_bzrdir, name)
2316
real_bzrdir = bzrdir.BzrDir.open(
2317
location, possible_transports=possible_transports)
2318
result = real_bzrdir.open_branch(name=name,
2319
ignore_fallbacks=ignore_fallbacks)
2320
# this changes the behaviour of result.clone to create a new reference
2321
# rather than a copy of the content of the branch.
2322
# I did not use a proxy object because that needs much more extensive
2323
# testing, and we are only changing one behaviour at the moment.
2324
# If we decide to alter more behaviours - i.e. the implicit nickname
2325
# then this should be refactored to introduce a tested proxy branch
2326
# and a subclass of that for use in overriding clone() and ....
2328
result.clone = self._make_reference_clone_function(result)
2332
network_format_registry = registry.FormatRegistry()
2333
"""Registry of formats indexed by their network name.
2335
The network name for a branch format is an identifier that can be used when
2336
referring to formats with smart server operations. See
2337
BranchFormat.network_name() for more detail.
2341
# formats which have no format string are not discoverable
2342
# and not independently creatable, so are not registered.
2343
__format5 = BzrBranchFormat5()
2344
__format6 = BzrBranchFormat6()
2345
__format7 = BzrBranchFormat7()
2346
__format8 = BzrBranchFormat8()
2347
BranchFormat.register_format(__format5)
2348
BranchFormat.register_format(BranchReferenceFormat())
2349
BranchFormat.register_format(__format6)
2350
BranchFormat.register_format(__format7)
2351
BranchFormat.register_format(__format8)
2352
BranchFormat.set_default_format(__format7)
2353
_legacy_formats = [BzrBranchFormat4(),
2355
network_format_registry.register(
2356
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2359
class BranchWriteLockResult(LogicalLockResult):
2360
"""The result of write locking a branch.
2362
:ivar branch_token: The token obtained from the underlying branch lock, or
2364
:ivar unlock: A callable which will unlock the lock.
2367
def __init__(self, unlock, branch_token):
2368
LogicalLockResult.__init__(self, unlock)
2369
self.branch_token = branch_token
2372
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2376
class BzrBranch(Branch, _RelockDebugMixin):
2377
"""A branch stored in the actual filesystem.
2379
Note that it's "local" in the context of the filesystem; it doesn't
2380
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2381
it's writable, and can be accessed via the normal filesystem API.
2383
:ivar _transport: Transport for file operations on this branch's
2384
control files, typically pointing to the .bzr/branch directory.
2385
:ivar repository: Repository for this branch.
2386
:ivar base: The url of the base directory for this branch; the one
2387
containing the .bzr directory.
2388
:ivar name: Optional colocated branch name as it exists in the control
2392
def __init__(self, _format=None,
2393
_control_files=None, a_bzrdir=None, name=None,
2394
_repository=None, ignore_fallbacks=False):
2395
"""Create new branch object at a particular location."""
2396
if a_bzrdir is None:
2397
raise ValueError('a_bzrdir must be supplied')
2399
self.bzrdir = a_bzrdir
2400
self._base = self.bzrdir.transport.clone('..').base
2402
# XXX: We should be able to just do
2403
# self.base = self.bzrdir.root_transport.base
2404
# but this does not quite work yet -- mbp 20080522
2405
self._format = _format
2406
if _control_files is None:
2407
raise ValueError('BzrBranch _control_files is None')
2408
self.control_files = _control_files
2409
self._transport = _control_files._transport
2410
self.repository = _repository
2411
Branch.__init__(self)
2414
if self.name is None:
2415
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2417
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2422
def _get_base(self):
2423
"""Returns the directory containing the control directory."""
2426
base = property(_get_base, doc="The URL for the root of this branch.")
2428
def _get_config(self):
2429
return TransportConfig(self._transport, 'branch.conf')
2431
def is_locked(self):
2432
return self.control_files.is_locked()
2434
def lock_write(self, token=None):
2435
"""Lock the branch for write operations.
2437
:param token: A token to permit reacquiring a previously held and
2439
:return: A BranchWriteLockResult.
2441
if not self.is_locked():
2442
self._note_lock('w')
2443
# All-in-one needs to always unlock/lock.
2444
repo_control = getattr(self.repository, 'control_files', None)
2445
if self.control_files == repo_control or not self.is_locked():
2446
self.repository._warn_if_deprecated(self)
2447
self.repository.lock_write()
2452
return BranchWriteLockResult(self.unlock,
2453
self.control_files.lock_write(token=token))
2456
self.repository.unlock()
2459
def lock_read(self):
2460
"""Lock the branch for read operations.
2462
:return: A bzrlib.lock.LogicalLockResult.
2464
if not self.is_locked():
2465
self._note_lock('r')
2466
# All-in-one needs to always unlock/lock.
2467
repo_control = getattr(self.repository, 'control_files', None)
2468
if self.control_files == repo_control or not self.is_locked():
2469
self.repository._warn_if_deprecated(self)
2470
self.repository.lock_read()
2475
self.control_files.lock_read()
2476
return LogicalLockResult(self.unlock)
2479
self.repository.unlock()
2482
@only_raises(errors.LockNotHeld, errors.LockBroken)
2485
self.control_files.unlock()
2487
# All-in-one needs to always unlock/lock.
2488
repo_control = getattr(self.repository, 'control_files', None)
2489
if (self.control_files == repo_control or
2490
not self.control_files.is_locked()):
2491
self.repository.unlock()
2492
if not self.control_files.is_locked():
2493
# we just released the lock
2494
self._clear_cached_state()
2496
def peek_lock_mode(self):
2497
if self.control_files._lock_count == 0:
2500
return self.control_files._lock_mode
2502
def get_physical_lock_status(self):
2503
return self.control_files.get_physical_lock_status()
2506
def print_file(self, file, revision_id):
2507
"""See Branch.print_file."""
2508
return self.repository.print_file(file, revision_id)
2510
def _write_revision_history(self, history):
2511
"""Factored out of set_revision_history.
2513
This performs the actual writing to disk.
2514
It is intended to be called by BzrBranch5.set_revision_history."""
2515
self._transport.put_bytes(
2516
'revision-history', '\n'.join(history),
2517
mode=self.bzrdir._get_file_mode())
2520
def set_revision_history(self, rev_history):
2521
"""See Branch.set_revision_history."""
2522
if 'evil' in debug.debug_flags:
2523
mutter_callsite(3, "set_revision_history scales with history.")
2524
check_not_reserved_id = _mod_revision.check_not_reserved_id
2525
for rev_id in rev_history:
2526
check_not_reserved_id(rev_id)
2527
if Branch.hooks['post_change_branch_tip']:
2528
# Don't calculate the last_revision_info() if there are no hooks
2530
old_revno, old_revid = self.last_revision_info()
2531
if len(rev_history) == 0:
2532
revid = _mod_revision.NULL_REVISION
2534
revid = rev_history[-1]
2535
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2536
self._write_revision_history(rev_history)
2537
self._clear_cached_state()
2538
self._cache_revision_history(rev_history)
2539
for hook in Branch.hooks['set_rh']:
2540
hook(self, rev_history)
2541
if Branch.hooks['post_change_branch_tip']:
2542
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2544
def _synchronize_history(self, destination, revision_id):
2545
"""Synchronize last revision and revision history between branches.
2547
This version is most efficient when the destination is also a
2548
BzrBranch5, but works for BzrBranch6 as long as the revision
2549
history is the true lefthand parent history, and all of the revisions
2550
are in the destination's repository. If not, set_revision_history
2553
:param destination: The branch to copy the history into
2554
:param revision_id: The revision-id to truncate history at. May
2555
be None to copy complete history.
2557
if not isinstance(destination._format, BzrBranchFormat5):
2558
super(BzrBranch, self)._synchronize_history(
2559
destination, revision_id)
2561
if revision_id == _mod_revision.NULL_REVISION:
2564
new_history = self.revision_history()
2565
if revision_id is not None and new_history != []:
2567
new_history = new_history[:new_history.index(revision_id) + 1]
2569
rev = self.repository.get_revision(revision_id)
2570
new_history = rev.get_history(self.repository)[1:]
2571
destination.set_revision_history(new_history)
2574
def set_last_revision_info(self, revno, revision_id):
2575
"""Set the last revision of this branch.
2577
The caller is responsible for checking that the revno is correct
2578
for this revision id.
2580
It may be possible to set the branch last revision to an id not
2581
present in the repository. However, branches can also be
2582
configured to check constraints on history, in which case this may not
2585
revision_id = _mod_revision.ensure_null(revision_id)
2586
# this old format stores the full history, but this api doesn't
2587
# provide it, so we must generate, and might as well check it's
2589
history = self._lefthand_history(revision_id)
2590
if len(history) != revno:
2591
raise AssertionError('%d != %d' % (len(history), revno))
2592
self.set_revision_history(history)
2594
def _gen_revision_history(self):
2595
history = self._transport.get_bytes('revision-history').split('\n')
2596
if history[-1:] == ['']:
2597
# There shouldn't be a trailing newline, but just in case.
2602
def generate_revision_history(self, revision_id, last_rev=None,
2604
"""Create a new revision history that will finish with revision_id.
2606
:param revision_id: the new tip to use.
2607
:param last_rev: The previous last_revision. If not None, then this
2608
must be a ancestory of revision_id, or DivergedBranches is raised.
2609
:param other_branch: The other branch that DivergedBranches should
2610
raise with respect to.
2612
self.set_revision_history(self._lefthand_history(revision_id,
2613
last_rev, other_branch))
2615
def basis_tree(self):
2616
"""See Branch.basis_tree."""
2617
return self.repository.revision_tree(self.last_revision())
2619
def _get_parent_location(self):
2620
_locs = ['parent', 'pull', 'x-pull']
2623
return self._transport.get_bytes(l).strip('\n')
2624
except errors.NoSuchFile:
2628
def _basic_push(self, target, overwrite, stop_revision):
2629
"""Basic implementation of push without bound branches or hooks.
2631
Must be called with source read locked and target write locked.
2633
result = BranchPushResult()
2634
result.source_branch = self
2635
result.target_branch = target
2636
result.old_revno, result.old_revid = target.last_revision_info()
2637
self.update_references(target)
2638
if result.old_revid != self.last_revision():
2639
# We assume that during 'push' this repository is closer than
2641
graph = self.repository.get_graph(target.repository)
2642
target.update_revisions(self, stop_revision,
2643
overwrite=overwrite, graph=graph)
2644
if self._push_should_merge_tags():
2645
result.tag_conflicts = self.tags.merge_to(target.tags,
2647
result.new_revno, result.new_revid = target.last_revision_info()
2650
def get_stacked_on_url(self):
2651
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2653
def set_push_location(self, location):
2654
"""See Branch.set_push_location."""
2655
self.get_config().set_user_option(
2656
'push_location', location,
2657
store=_mod_config.STORE_LOCATION_NORECURSE)
2659
def _set_parent_location(self, url):
2661
self._transport.delete('parent')
2663
self._transport.put_bytes('parent', url + '\n',
2664
mode=self.bzrdir._get_file_mode())
2667
class BzrBranch5(BzrBranch):
2668
"""A format 5 branch. This supports new features over plain branches.
2670
It has support for a master_branch which is the data for bound branches.
2673
def get_bound_location(self):
2675
return self._transport.get_bytes('bound')[:-1]
2676
except errors.NoSuchFile:
2680
def get_master_branch(self, possible_transports=None):
2681
"""Return the branch we are bound to.
2683
:return: Either a Branch, or None
2685
This could memoise the branch, but if thats done
2686
it must be revalidated on each new lock.
2687
So for now we just don't memoise it.
2688
# RBC 20060304 review this decision.
2690
bound_loc = self.get_bound_location()
2694
return Branch.open(bound_loc,
2695
possible_transports=possible_transports)
2696
except (errors.NotBranchError, errors.ConnectionError), e:
2697
raise errors.BoundBranchConnectionFailure(
2701
def set_bound_location(self, location):
2702
"""Set the target where this branch is bound to.
2704
:param location: URL to the target branch
2707
self._transport.put_bytes('bound', location+'\n',
2708
mode=self.bzrdir._get_file_mode())
2711
self._transport.delete('bound')
2712
except errors.NoSuchFile:
2717
def bind(self, other):
2718
"""Bind this branch to the branch other.
2720
This does not push or pull data between the branches, though it does
2721
check for divergence to raise an error when the branches are not
2722
either the same, or one a prefix of the other. That behaviour may not
2723
be useful, so that check may be removed in future.
2725
:param other: The branch to bind to
2728
# TODO: jam 20051230 Consider checking if the target is bound
2729
# It is debatable whether you should be able to bind to
2730
# a branch which is itself bound.
2731
# Committing is obviously forbidden,
2732
# but binding itself may not be.
2733
# Since we *have* to check at commit time, we don't
2734
# *need* to check here
2736
# we want to raise diverged if:
2737
# last_rev is not in the other_last_rev history, AND
2738
# other_last_rev is not in our history, and do it without pulling
2740
self.set_bound_location(other.base)
2744
"""If bound, unbind"""
2745
return self.set_bound_location(None)
2748
def update(self, possible_transports=None):
2749
"""Synchronise this branch with the master branch if any.
2751
:return: None or the last_revision that was pivoted out during the
2754
master = self.get_master_branch(possible_transports)
2755
if master is not None:
2756
old_tip = _mod_revision.ensure_null(self.last_revision())
2757
self.pull(master, overwrite=True)
2758
if self.repository.get_graph().is_ancestor(old_tip,
2759
_mod_revision.ensure_null(self.last_revision())):
2765
class BzrBranch8(BzrBranch5):
2766
"""A branch that stores tree-reference locations."""
2768
def _open_hook(self):
2769
if self._ignore_fallbacks:
2772
url = self.get_stacked_on_url()
2773
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2774
errors.UnstackableBranchFormat):
2777
for hook in Branch.hooks['transform_fallback_location']:
2778
url = hook(self, url)
2780
hook_name = Branch.hooks.get_hook_name(hook)
2781
raise AssertionError(
2782
"'transform_fallback_location' hook %s returned "
2783
"None, not a URL." % hook_name)
2784
self._activate_fallback_location(url)
2786
def __init__(self, *args, **kwargs):
2787
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2788
super(BzrBranch8, self).__init__(*args, **kwargs)
2789
self._last_revision_info_cache = None
2790
self._reference_info = None
2792
def _clear_cached_state(self):
2793
super(BzrBranch8, self)._clear_cached_state()
2794
self._last_revision_info_cache = None
2795
self._reference_info = None
2797
def _last_revision_info(self):
2798
revision_string = self._transport.get_bytes('last-revision')
2799
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2800
revision_id = cache_utf8.get_cached_utf8(revision_id)
2802
return revno, revision_id
2804
def _write_last_revision_info(self, revno, revision_id):
2805
"""Simply write out the revision id, with no checks.
2807
Use set_last_revision_info to perform this safely.
2809
Does not update the revision_history cache.
2810
Intended to be called by set_last_revision_info and
2811
_write_revision_history.
2813
revision_id = _mod_revision.ensure_null(revision_id)
2814
out_string = '%d %s\n' % (revno, revision_id)
2815
self._transport.put_bytes('last-revision', out_string,
2816
mode=self.bzrdir._get_file_mode())
2819
def set_last_revision_info(self, revno, revision_id):
2820
revision_id = _mod_revision.ensure_null(revision_id)
2821
old_revno, old_revid = self.last_revision_info()
2822
if self._get_append_revisions_only():
2823
self._check_history_violation(revision_id)
2824
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2825
self._write_last_revision_info(revno, revision_id)
2826
self._clear_cached_state()
2827
self._last_revision_info_cache = revno, revision_id
2828
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2830
def _synchronize_history(self, destination, revision_id):
2831
"""Synchronize last revision and revision history between branches.
2833
:see: Branch._synchronize_history
2835
# XXX: The base Branch has a fast implementation of this method based
2836
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2837
# that uses set_revision_history. This class inherits from BzrBranch5,
2838
# but wants the fast implementation, so it calls
2839
# Branch._synchronize_history directly.
2840
Branch._synchronize_history(self, destination, revision_id)
2842
def _check_history_violation(self, revision_id):
2843
last_revision = _mod_revision.ensure_null(self.last_revision())
2844
if _mod_revision.is_null(last_revision):
2846
if last_revision not in self._lefthand_history(revision_id):
2847
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2849
def _gen_revision_history(self):
2850
"""Generate the revision history from last revision
2852
last_revno, last_revision = self.last_revision_info()
2853
self._extend_partial_history(stop_index=last_revno-1)
2854
return list(reversed(self._partial_revision_history_cache))
2856
def _write_revision_history(self, history):
2857
"""Factored out of set_revision_history.
2859
This performs the actual writing to disk, with format-specific checks.
2860
It is intended to be called by BzrBranch5.set_revision_history.
2862
if len(history) == 0:
2863
last_revision = 'null:'
2865
if history != self._lefthand_history(history[-1]):
2866
raise errors.NotLefthandHistory(history)
2867
last_revision = history[-1]
2868
if self._get_append_revisions_only():
2869
self._check_history_violation(last_revision)
2870
self._write_last_revision_info(len(history), last_revision)
2873
def _set_parent_location(self, url):
2874
"""Set the parent branch"""
2875
self._set_config_location('parent_location', url, make_relative=True)
2878
def _get_parent_location(self):
2879
"""Set the parent branch"""
2880
return self._get_config_location('parent_location')
2883
def _set_all_reference_info(self, info_dict):
2884
"""Replace all reference info stored in a branch.
2886
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2889
writer = rio.RioWriter(s)
2890
for key, (tree_path, branch_location) in info_dict.iteritems():
2891
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2892
branch_location=branch_location)
2893
writer.write_stanza(stanza)
2894
self._transport.put_bytes('references', s.getvalue())
2895
self._reference_info = info_dict
2898
def _get_all_reference_info(self):
2899
"""Return all the reference info stored in a branch.
2901
:return: A dict of {file_id: (tree_path, branch_location)}
2903
if self._reference_info is not None:
2904
return self._reference_info
2905
rio_file = self._transport.get('references')
2907
stanzas = rio.read_stanzas(rio_file)
2908
info_dict = dict((s['file_id'], (s['tree_path'],
2909
s['branch_location'])) for s in stanzas)
2912
self._reference_info = info_dict
2915
def set_reference_info(self, file_id, tree_path, branch_location):
2916
"""Set the branch location to use for a tree reference.
2918
:param file_id: The file-id of the tree reference.
2919
:param tree_path: The path of the tree reference in the tree.
2920
:param branch_location: The location of the branch to retrieve tree
2923
info_dict = self._get_all_reference_info()
2924
info_dict[file_id] = (tree_path, branch_location)
2925
if None in (tree_path, branch_location):
2926
if tree_path is not None:
2927
raise ValueError('tree_path must be None when branch_location'
2929
if branch_location is not None:
2930
raise ValueError('branch_location must be None when tree_path'
2932
del info_dict[file_id]
2933
self._set_all_reference_info(info_dict)
2935
def get_reference_info(self, file_id):
2936
"""Get the tree_path and branch_location for a tree reference.
2938
:return: a tuple of (tree_path, branch_location)
2940
return self._get_all_reference_info().get(file_id, (None, None))
2942
def reference_parent(self, file_id, path, possible_transports=None):
2943
"""Return the parent branch for a tree-reference file_id.
2945
:param file_id: The file_id of the tree reference
2946
:param path: The path of the file_id in the tree
2947
:return: A branch associated with the file_id
2949
branch_location = self.get_reference_info(file_id)[1]
2950
if branch_location is None:
2951
return Branch.reference_parent(self, file_id, path,
2952
possible_transports)
2953
branch_location = urlutils.join(self.user_url, branch_location)
2954
return Branch.open(branch_location,
2955
possible_transports=possible_transports)
2957
def set_push_location(self, location):
2958
"""See Branch.set_push_location."""
2959
self._set_config_location('push_location', location)
2961
def set_bound_location(self, location):
2962
"""See Branch.set_push_location."""
2964
config = self.get_config()
2965
if location is None:
2966
if config.get_user_option('bound') != 'True':
2969
config.set_user_option('bound', 'False', warn_masked=True)
2972
self._set_config_location('bound_location', location,
2974
config.set_user_option('bound', 'True', warn_masked=True)
2977
def _get_bound_location(self, bound):
2978
"""Return the bound location in the config file.
2980
Return None if the bound parameter does not match"""
2981
config = self.get_config()
2982
config_bound = (config.get_user_option('bound') == 'True')
2983
if config_bound != bound:
2985
return self._get_config_location('bound_location', config=config)
2987
def get_bound_location(self):
2988
"""See Branch.set_push_location."""
2989
return self._get_bound_location(True)
2991
def get_old_bound_location(self):
2992
"""See Branch.get_old_bound_location"""
2993
return self._get_bound_location(False)
2995
def get_stacked_on_url(self):
2996
# you can always ask for the URL; but you might not be able to use it
2997
# if the repo can't support stacking.
2998
## self._check_stackable_repo()
2999
stacked_url = self._get_config_location('stacked_on_location')
3000
if stacked_url is None:
3001
raise errors.NotStacked(self)
3004
def _get_append_revisions_only(self):
3005
return self.get_config(
3006
).get_user_option_as_bool('append_revisions_only')
3009
def generate_revision_history(self, revision_id, last_rev=None,
3011
"""See BzrBranch5.generate_revision_history"""
3012
history = self._lefthand_history(revision_id, last_rev, other_branch)
3013
revno = len(history)
3014
self.set_last_revision_info(revno, revision_id)
3017
def get_rev_id(self, revno, history=None):
3018
"""Find the revision id of the specified revno."""
3020
return _mod_revision.NULL_REVISION
3022
last_revno, last_revision_id = self.last_revision_info()
3023
if revno <= 0 or revno > last_revno:
3024
raise errors.NoSuchRevision(self, revno)
3026
if history is not None:
3027
return history[revno - 1]
3029
index = last_revno - revno
3030
if len(self._partial_revision_history_cache) <= index:
3031
self._extend_partial_history(stop_index=index)
3032
if len(self._partial_revision_history_cache) > index:
3033
return self._partial_revision_history_cache[index]
3035
raise errors.NoSuchRevision(self, revno)
3038
def revision_id_to_revno(self, revision_id):
3039
"""Given a revision id, return its revno"""
3040
if _mod_revision.is_null(revision_id):
3043
index = self._partial_revision_history_cache.index(revision_id)
3045
self._extend_partial_history(stop_revision=revision_id)
3046
index = len(self._partial_revision_history_cache) - 1
3047
if self._partial_revision_history_cache[index] != revision_id:
3048
raise errors.NoSuchRevision(self, revision_id)
3049
return self.revno() - index
3052
class BzrBranch7(BzrBranch8):
3053
"""A branch with support for a fallback repository."""
3055
def set_reference_info(self, file_id, tree_path, branch_location):
3056
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3058
def get_reference_info(self, file_id):
3059
Branch.get_reference_info(self, file_id)
3061
def reference_parent(self, file_id, path, possible_transports=None):
3062
return Branch.reference_parent(self, file_id, path,
3063
possible_transports)
3066
class BzrBranch6(BzrBranch7):
3067
"""See BzrBranchFormat6 for the capabilities of this branch.
3069
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3073
def get_stacked_on_url(self):
3074
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1264
3077
######################################################################
1268
def is_control_file(filename):
1269
## FIXME: better check
1270
filename = os.path.normpath(filename)
1271
while filename != '':
1272
head, tail = os.path.split(filename)
1273
## mutter('check %r for control file' % ((head, tail), ))
1274
if tail == bzrlib.BZRDIR:
1276
if filename == head:
1283
def gen_file_id(name):
1284
"""Return new file id.
1286
This should probably generate proper UUIDs, but for the moment we
1287
cope with just randomness because running uuidgen every time is
1290
from binascii import hexlify
1291
from time import time
1293
# get last component
1294
idx = name.rfind('/')
1296
name = name[idx+1 : ]
1297
idx = name.rfind('\\')
1299
name = name[idx+1 : ]
1301
# make it not a hidden file
1302
name = name.lstrip('.')
1304
# remove any wierd characters; we don't escape them but rather
1305
# just pull them out
1306
name = re.sub(r'[^\w.]', '', name)
1308
s = hexlify(rand_bytes(8))
1309
return '-'.join((name, compact_date(time()), s))
1313
"""Return a new tree-root file id."""
1314
return gen_file_id('TREE_ROOT')
3078
# results of operations
3081
class _Result(object):
3083
def _show_tag_conficts(self, to_file):
3084
if not getattr(self, 'tag_conflicts', None):
3086
to_file.write('Conflicting tags:\n')
3087
for name, value1, value2 in self.tag_conflicts:
3088
to_file.write(' %s\n' % (name, ))
3091
class PullResult(_Result):
3092
"""Result of a Branch.pull operation.
3094
:ivar old_revno: Revision number before pull.
3095
:ivar new_revno: Revision number after pull.
3096
:ivar old_revid: Tip revision id before pull.
3097
:ivar new_revid: Tip revision id after pull.
3098
:ivar source_branch: Source (local) branch object. (read locked)
3099
:ivar master_branch: Master branch of the target, or the target if no
3101
:ivar local_branch: target branch if there is a Master, else None
3102
:ivar target_branch: Target/destination branch object. (write locked)
3103
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3106
@deprecated_method(deprecated_in((2, 3, 0)))
3108
"""Return the relative change in revno.
3110
:deprecated: Use `new_revno` and `old_revno` instead.
3112
return self.new_revno - self.old_revno
3114
def report(self, to_file):
3116
if self.old_revid == self.new_revid:
3117
to_file.write('No revisions to pull.\n')
3119
to_file.write('Now on revision %d.\n' % self.new_revno)
3120
self._show_tag_conficts(to_file)
3123
class BranchPushResult(_Result):
3124
"""Result of a Branch.push operation.
3126
:ivar old_revno: Revision number (eg 10) of the target before push.
3127
:ivar new_revno: Revision number (eg 12) of the target after push.
3128
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3130
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3132
:ivar source_branch: Source branch object that the push was from. This is
3133
read locked, and generally is a local (and thus low latency) branch.
3134
:ivar master_branch: If target is a bound branch, the master branch of
3135
target, or target itself. Always write locked.
3136
:ivar target_branch: The direct Branch where data is being sent (write
3138
:ivar local_branch: If the target is a bound branch this will be the
3139
target, otherwise it will be None.
3142
@deprecated_method(deprecated_in((2, 3, 0)))
3144
"""Return the relative change in revno.
3146
:deprecated: Use `new_revno` and `old_revno` instead.
3148
return self.new_revno - self.old_revno
3150
def report(self, to_file):
3151
"""Write a human-readable description of the result."""
3152
if self.old_revid == self.new_revid:
3153
note('No new revisions to push.')
3155
note('Pushed up to revision %d.' % self.new_revno)
3156
self._show_tag_conficts(to_file)
3159
class BranchCheckResult(object):
3160
"""Results of checking branch consistency.
3165
def __init__(self, branch):
3166
self.branch = branch
3169
def report_results(self, verbose):
3170
"""Report the check results via trace.note.
3172
:param verbose: Requests more detailed display of what was checked,
3175
note('checked branch %s format %s', self.branch.user_url,
3176
self.branch._format)
3177
for error in self.errors:
3178
note('found error:%s', error)
3181
class Converter5to6(object):
3182
"""Perform an in-place upgrade of format 5 to format 6"""
3184
def convert(self, branch):
3185
# Data for 5 and 6 can peacefully coexist.
3186
format = BzrBranchFormat6()
3187
new_branch = format.open(branch.bzrdir, _found=True)
3189
# Copy source data into target
3190
new_branch._write_last_revision_info(*branch.last_revision_info())
3191
new_branch.set_parent(branch.get_parent())
3192
new_branch.set_bound_location(branch.get_bound_location())
3193
new_branch.set_push_location(branch.get_push_location())
3195
# New branch has no tags by default
3196
new_branch.tags._set_tag_dict({})
3198
# Copying done; now update target format
3199
new_branch._transport.put_bytes('format',
3200
format.get_format_string(),
3201
mode=new_branch.bzrdir._get_file_mode())
3203
# Clean up old files
3204
new_branch._transport.delete('revision-history')
3206
branch.set_parent(None)
3207
except errors.NoSuchFile:
3209
branch.set_bound_location(None)
3212
class Converter6to7(object):
3213
"""Perform an in-place upgrade of format 6 to format 7"""
3215
def convert(self, branch):
3216
format = BzrBranchFormat7()
3217
branch._set_config_location('stacked_on_location', '')
3218
# update target format
3219
branch._transport.put_bytes('format', format.get_format_string())
3222
class Converter7to8(object):
3223
"""Perform an in-place upgrade of format 6 to format 7"""
3225
def convert(self, branch):
3226
format = BzrBranchFormat8()
3227
branch._transport.put_bytes('references', '')
3228
# update target format
3229
branch._transport.put_bytes('format', format.get_format_string())
3232
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3233
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3236
_run_with_write_locked_target will attempt to release the lock it acquires.
3238
If an exception is raised by callable, then that exception *will* be
3239
propagated, even if the unlock attempt raises its own error. Thus
3240
_run_with_write_locked_target should be preferred to simply doing::
3244
return callable(*args, **kwargs)
3249
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3250
# should share code?
3253
result = callable(*args, **kwargs)
3255
exc_info = sys.exc_info()
3259
raise exc_info[0], exc_info[1], exc_info[2]
3265
class InterBranch(InterObject):
3266
"""This class represents operations taking place between two branches.
3268
Its instances have methods like pull() and push() and contain
3269
references to the source and target repositories these operations
3270
can be carried out on.
3274
"""The available optimised InterBranch types."""
3277
def _get_branch_formats_to_test(klass):
3278
"""Return an iterable of format tuples for testing.
3280
:return: An iterable of (from_format, to_format) to use when testing
3281
this InterBranch class. Each InterBranch class should define this
3284
raise NotImplementedError(klass._get_branch_formats_to_test)
3287
def pull(self, overwrite=False, stop_revision=None,
3288
possible_transports=None, local=False):
3289
"""Mirror source into target branch.
3291
The target branch is considered to be 'local', having low latency.
3293
:returns: PullResult instance
3295
raise NotImplementedError(self.pull)
3298
def update_revisions(self, stop_revision=None, overwrite=False,
3300
"""Pull in new perfect-fit revisions.
3302
:param stop_revision: Updated until the given revision
3303
:param overwrite: Always set the branch pointer, rather than checking
3304
to see if it is a proper descendant.
3305
:param graph: A Graph object that can be used to query history
3306
information. This can be None.
3309
raise NotImplementedError(self.update_revisions)
3312
def push(self, overwrite=False, stop_revision=None,
3313
_override_hook_source_branch=None):
3314
"""Mirror the source branch into the target branch.
3316
The source branch is considered to be 'local', having low latency.
3318
raise NotImplementedError(self.push)
3321
def copy_content_into(self, revision_id=None):
3322
"""Copy the content of source into target
3324
revision_id: if not None, the revision history in the new branch will
3325
be truncated to end with revision_id.
3327
raise NotImplementedError(self.copy_content_into)
3330
class GenericInterBranch(InterBranch):
3331
"""InterBranch implementation that uses public Branch functions."""
3334
def is_compatible(klass, source, target):
3335
# GenericBranch uses the public API, so always compatible
3339
def _get_branch_formats_to_test(klass):
3340
return [(BranchFormat._default_format, BranchFormat._default_format)]
3343
def unwrap_format(klass, format):
3344
if isinstance(format, remote.RemoteBranchFormat):
3345
format._ensure_real()
3346
return format._custom_format
3350
def copy_content_into(self, revision_id=None):
3351
"""Copy the content of source into target
3353
revision_id: if not None, the revision history in the new branch will
3354
be truncated to end with revision_id.
3356
self.source.update_references(self.target)
3357
self.source._synchronize_history(self.target, revision_id)
3359
parent = self.source.get_parent()
3360
except errors.InaccessibleParent, e:
3361
mutter('parent was not accessible to copy: %s', e)
3364
self.target.set_parent(parent)
3365
if self.source._push_should_merge_tags():
3366
self.source.tags.merge_to(self.target.tags)
3369
def update_revisions(self, stop_revision=None, overwrite=False,
3371
"""See InterBranch.update_revisions()."""
3372
other_revno, other_last_revision = self.source.last_revision_info()
3373
stop_revno = None # unknown
3374
if stop_revision is None:
3375
stop_revision = other_last_revision
3376
if _mod_revision.is_null(stop_revision):
3377
# if there are no commits, we're done.
3379
stop_revno = other_revno
3381
# what's the current last revision, before we fetch [and change it
3383
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3384
# we fetch here so that we don't process data twice in the common
3385
# case of having something to pull, and so that the check for
3386
# already merged can operate on the just fetched graph, which will
3387
# be cached in memory.
3388
self.target.fetch(self.source, stop_revision)
3389
# Check to see if one is an ancestor of the other
3392
graph = self.target.repository.get_graph()
3393
if self.target._check_if_descendant_or_diverged(
3394
stop_revision, last_rev, graph, self.source):
3395
# stop_revision is a descendant of last_rev, but we aren't
3396
# overwriting, so we're done.
3398
if stop_revno is None:
3400
graph = self.target.repository.get_graph()
3401
this_revno, this_last_revision = \
3402
self.target.last_revision_info()
3403
stop_revno = graph.find_distance_to_null(stop_revision,
3404
[(other_last_revision, other_revno),
3405
(this_last_revision, this_revno)])
3406
self.target.set_last_revision_info(stop_revno, stop_revision)
3409
def pull(self, overwrite=False, stop_revision=None,
3410
possible_transports=None, run_hooks=True,
3411
_override_hook_target=None, local=False):
3412
"""Pull from source into self, updating my master if any.
3414
:param run_hooks: Private parameter - if false, this branch
3415
is being called because it's the master of the primary branch,
3416
so it should not run its hooks.
3418
bound_location = self.target.get_bound_location()
3419
if local and not bound_location:
3420
raise errors.LocalRequiresBoundBranch()
3421
master_branch = None
3422
if not local and bound_location and self.source.user_url != bound_location:
3423
# not pulling from master, so we need to update master.
3424
master_branch = self.target.get_master_branch(possible_transports)
3425
master_branch.lock_write()
3428
# pull from source into master.
3429
master_branch.pull(self.source, overwrite, stop_revision,
3431
return self._pull(overwrite,
3432
stop_revision, _hook_master=master_branch,
3433
run_hooks=run_hooks,
3434
_override_hook_target=_override_hook_target)
3437
master_branch.unlock()
3439
def push(self, overwrite=False, stop_revision=None,
3440
_override_hook_source_branch=None):
3441
"""See InterBranch.push.
3443
This is the basic concrete implementation of push()
3445
:param _override_hook_source_branch: If specified, run
3446
the hooks passing this Branch as the source, rather than self.
3447
This is for use of RemoteBranch, where push is delegated to the
3448
underlying vfs-based Branch.
3450
# TODO: Public option to disable running hooks - should be trivial but
3452
self.source.lock_read()
3454
return _run_with_write_locked_target(
3455
self.target, self._push_with_bound_branches, overwrite,
3457
_override_hook_source_branch=_override_hook_source_branch)
3459
self.source.unlock()
3461
def _push_with_bound_branches(self, overwrite, stop_revision,
3462
_override_hook_source_branch=None):
3463
"""Push from source into target, and into target's master if any.
3466
if _override_hook_source_branch:
3467
result.source_branch = _override_hook_source_branch
3468
for hook in Branch.hooks['post_push']:
3471
bound_location = self.target.get_bound_location()
3472
if bound_location and self.target.base != bound_location:
3473
# there is a master branch.
3475
# XXX: Why the second check? Is it even supported for a branch to
3476
# be bound to itself? -- mbp 20070507
3477
master_branch = self.target.get_master_branch()
3478
master_branch.lock_write()
3480
# push into the master from the source branch.
3481
self.source._basic_push(master_branch, overwrite, stop_revision)
3482
# and push into the target branch from the source. Note that we
3483
# push from the source branch again, because it's considered the
3484
# highest bandwidth repository.
3485
result = self.source._basic_push(self.target, overwrite,
3487
result.master_branch = master_branch
3488
result.local_branch = self.target
3492
master_branch.unlock()
3495
result = self.source._basic_push(self.target, overwrite,
3497
# TODO: Why set master_branch and local_branch if there's no
3498
# binding? Maybe cleaner to just leave them unset? -- mbp
3500
result.master_branch = self.target
3501
result.local_branch = None
3505
def _pull(self, overwrite=False, stop_revision=None,
3506
possible_transports=None, _hook_master=None, run_hooks=True,
3507
_override_hook_target=None, local=False):
3510
This function is the core worker, used by GenericInterBranch.pull to
3511
avoid duplication when pulling source->master and source->local.
3513
:param _hook_master: Private parameter - set the branch to
3514
be supplied as the master to pull hooks.
3515
:param run_hooks: Private parameter - if false, this branch
3516
is being called because it's the master of the primary branch,
3517
so it should not run its hooks.
3518
:param _override_hook_target: Private parameter - set the branch to be
3519
supplied as the target_branch to pull hooks.
3520
:param local: Only update the local branch, and not the bound branch.
3522
# This type of branch can't be bound.
3524
raise errors.LocalRequiresBoundBranch()
3525
result = PullResult()
3526
result.source_branch = self.source
3527
if _override_hook_target is None:
3528
result.target_branch = self.target
3530
result.target_branch = _override_hook_target
3531
self.source.lock_read()
3533
# We assume that during 'pull' the target repository is closer than
3535
self.source.update_references(self.target)
3536
graph = self.target.repository.get_graph(self.source.repository)
3537
# TODO: Branch formats should have a flag that indicates
3538
# that revno's are expensive, and pull() should honor that flag.
3540
result.old_revno, result.old_revid = \
3541
self.target.last_revision_info()
3542
self.target.update_revisions(self.source, stop_revision,
3543
overwrite=overwrite, graph=graph)
3544
# TODO: The old revid should be specified when merging tags,
3545
# so a tags implementation that versions tags can only
3546
# pull in the most recent changes. -- JRV20090506
3547
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3549
result.new_revno, result.new_revid = self.target.last_revision_info()
3551
result.master_branch = _hook_master
3552
result.local_branch = result.target_branch
3554
result.master_branch = result.target_branch
3555
result.local_branch = None
3557
for hook in Branch.hooks['post_pull']:
3560
self.source.unlock()
3564
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
