1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
from warnings import warn
18
22
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
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)
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
import bzrlib.transactions as transactions
48
from bzrlib.transport import Transport, get_transport
61
53
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
54
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
class Branch(bzrdir.ControlComponent):
55
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
56
## TODO: Maybe include checks for common corruption of newlines, etc?
59
# TODO: Some operations like log might retrieve the same revisions
60
# repeatedly to calculate deltas. We could perhaps have a weakref
61
# cache in memory to make this faster. In general anything can be
62
# cached in memory between lock and unlock operations.
64
def find_branch(*ignored, **ignored_too):
65
# XXX: leave this here for about one release, then remove it
66
raise NotImplementedError('find_branch() is not supported anymore, '
67
'please use one of the new branch constructors')
69
######################################################################
67
73
"""Branch holding a history of revisions.
70
Base directory/url of the branch; using control_url and
71
control_transport is more standardized.
73
hooks: An instance of BranchHooks.
76
Base directory/url of the branch.
75
# this is really an instance variable - FIXME move it there
80
def control_transport(self):
81
return self._transport
84
def user_transport(self):
85
return self.bzrdir.user_transport
87
80
def __init__(self, *ignored, **ignored_too):
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._partial_revision_history_cache = []
93
self._last_revision_info_cache = None
94
self._merge_sorted_revisions_cache = None
96
hooks = Branch.hooks['open']
100
def _open_hook(self):
101
"""Called by init to allow simpler extension of the base class."""
103
def _activate_fallback_location(self, url):
104
"""Activate the branch/repository from url as a fallback repository."""
105
repo = self._get_fallback_repository(url)
106
if repo.has_same_location(self.repository):
107
raise errors.UnstackableLocationError(self.user_url, url)
108
self.repository.add_fallback_repository(repo)
110
def break_lock(self):
111
"""Break a lock if one is present from another instance.
113
Uses the ui factory to ask for confirmation if the lock may be from
116
This will probe the repository for its lock as well.
118
self.control_files.break_lock()
119
self.repository.break_lock()
120
master = self.get_master_branch()
121
if master is not None:
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
160
"""Open the branch rooted at base.
162
For instance, if the branch is at URL/.bzr/branch,
163
Branch.open(URL) -> a Branch instance.
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
171
"""Open the branch rooted at transport"""
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
def open_containing(url, possible_transports=None):
81
raise NotImplementedError('The Branch class is abstract')
84
def open_downlevel(base):
85
"""Open a branch which may be of an old format.
87
Only local branches are supported."""
88
return _Branch(get_transport(base), relax_version_check=True)
92
"""Open an existing branch, rooted at 'base' (url)"""
93
t = get_transport(base)
94
mutter("trying to open %r with transport %r", base, t)
98
def open_containing(url):
177
99
"""Open an existing branch which contains url.
179
101
This probes for a branch at url, and searches upwards from there.
181
103
Basically we keep looking up until we find the control directory or
182
104
run into the root. If there isn't one, raises NotBranchError.
183
If there is one and it is either an unrecognised format or an unsupported
184
format, UnknownFormatError or UnsupportedFormatError are raised.
185
If there is one, it is returned, along with the unused portion of url.
187
control, relpath = bzrdir.BzrDir.open_containing(url,
189
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
199
def get_config(self):
200
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
251
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
254
nick = property(_get_nick, _set_nick)
257
raise NotImplementedError(self.is_locked)
259
def _lefthand_history(self, revision_id, last_rev=None,
261
if 'evil' in debug.debug_flags:
262
mutter_callsite(4, "_lefthand_history scales with history.")
263
# stop_revision must be a descendant of last_revision
264
graph = self.repository.get_graph()
265
if last_rev is not None:
266
if not graph.is_ancestor(last_rev, revision_id):
267
# our previous tip is not merged into stop_revision
268
raise errors.DivergedBranches(self, other_branch)
269
# make a new revision history from the graph
270
parents_map = graph.get_parent_map([revision_id])
271
if revision_id not in parents_map:
272
raise errors.NoSuchRevision(self, revision_id)
273
current_rev_id = revision_id
275
check_not_reserved_id = _mod_revision.check_not_reserved_id
276
# Do not include ghosts or graph origin in revision_history
277
while (current_rev_id in parents_map and
278
len(parents_map[current_rev_id]) > 0):
279
check_not_reserved_id(current_rev_id)
280
new_history.append(current_rev_id)
281
current_rev_id = parents_map[current_rev_id][0]
282
parents_map = graph.get_parent_map([current_rev_id])
283
new_history.reverse()
286
def lock_write(self, token=None):
287
"""Lock the branch for write operations.
289
:param token: A token to permit reacquiring a previously held and
291
:return: A BranchWriteLockResult.
293
raise NotImplementedError(self.lock_write)
106
t = get_transport(url)
110
except NotBranchError:
112
new_t = t.clone('..')
113
if new_t.base == t.base:
114
# reached the root, whatever that may be
115
raise NotBranchError('%s is not in a branch' % url)
119
def initialize(base):
120
"""Create a new branch, rooted at 'base' (url)"""
121
t = get_transport(base)
122
return _Branch(t, init=True)
124
def setup_caching(self, cache_root):
125
"""Subclasses that care about caching should override this, and set
126
up cached stores located under cache_root.
128
self.cache_root = cache_root
131
class _Branch(Branch):
132
"""A branch stored in the actual filesystem.
134
Note that it's "local" in the context of the filesystem; it doesn't
135
really matter if it's on an nfs/smb/afs/coda/... share, as long as
136
it's writable, and can be accessed via the normal filesystem API.
142
If _lock_mode is true, a positive count of the number of times the
146
Lock object from bzrlib.lock.
148
# We actually expect this class to be somewhat short-lived; part of its
149
# purpose is to try to isolate what bits of the branch logic are tied to
150
# filesystem access, so that in a later step, we can extricate them to
151
# a separarte ("storage") class.
155
_inventory_weave = None
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
162
def push_stores(self, branch_to):
163
"""Copy the content of this branches store to branch_to."""
164
if (self._branch_format != branch_to._branch_format
165
or self._branch_format != 4):
166
from bzrlib.fetch import greedy_fetch
167
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
168
self, self._branch_format, branch_to, branch_to._branch_format)
169
greedy_fetch(to_branch=branch_to, from_branch=self,
170
revision=self.last_revision())
173
store_pairs = ((self.text_store, branch_to.text_store),
174
(self.inventory_store, branch_to.inventory_store),
175
(self.revision_store, branch_to.revision_store))
177
for from_store, to_store in store_pairs:
178
copy_all(from_store, to_store)
179
except UnlistableStore:
180
raise UnlistableBranch(from_store)
182
def __init__(self, transport, init=False,
183
relax_version_check=False):
184
"""Create new branch object at a particular location.
186
transport -- A Transport object, defining how to access files.
187
(If a string, transport.transport() will be used to
188
create a Transport object)
190
init -- If True, create new control files in a previously
191
unversioned directory. If False, the branch must already
194
relax_version_check -- If true, the usual check for the branch
195
version is not applied. This is intended only for
196
upgrade/recovery type use; it's not guaranteed that
197
all operations will work on old format branches.
199
In the test suite, creation of new trees is tested using the
200
`ScratchBranch` class.
202
assert isinstance(transport, Transport), \
203
"%r is not a Transport" % transport
204
self._transport = transport
207
self._check_format(relax_version_check)
209
def get_store(name, compressed=True, prefixed=False):
210
# FIXME: This approach of assuming stores are all entirely compressed
211
# or entirely uncompressed is tidy, but breaks upgrade from
212
# some existing branches where there's a mixture; we probably
213
# still want the option to look for both.
214
relpath = self._rel_controlfilename(name)
216
store = CompressedTextStore(self._transport.clone(relpath),
219
store = TextStore(self._transport.clone(relpath),
221
#if self._transport.should_cache():
222
# cache_path = os.path.join(self.cache_root, name)
223
# os.mkdir(cache_path)
224
# store = bzrlib.store.CachedStore(store, cache_path)
226
def get_weave(name, prefixed=False):
227
relpath = self._rel_controlfilename(name)
228
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
229
if self._transport.should_cache():
230
ws.enable_cache = True
233
if self._branch_format == 4:
234
self.inventory_store = get_store('inventory-store')
235
self.text_store = get_store('text-store')
236
self.revision_store = get_store('revision-store')
237
elif self._branch_format == 5:
238
self.control_weaves = get_weave([])
239
self.weave_store = get_weave('weaves')
240
self.revision_store = get_store('revision-store', compressed=False)
241
elif self._branch_format == 6:
242
self.control_weaves = get_weave([])
243
self.weave_store = get_weave('weaves', prefixed=True)
244
self.revision_store = get_store('revision-store', compressed=False,
246
self._transaction = None
249
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
256
if self._lock_mode or self._lock:
257
# XXX: This should show something every time, and be suitable for
258
# headless operation and embedding
259
warn("branch %r was not explicitly unlocked" % self)
262
# TODO: It might be best to do this somewhere else,
263
# but it is nice for a Branch object to automatically
264
# cache it's information.
265
# Alternatively, we could have the Transport objects cache requests
266
# See the earlier discussion about how major objects (like Branch)
267
# should never expect their __del__ function to run.
268
if hasattr(self, 'cache_root') and self.cache_root is not None:
271
shutil.rmtree(self.cache_root)
274
self.cache_root = None
278
return self._transport.base
281
base = property(_get_base, doc="The URL for the root of this branch.")
283
def _finish_transaction(self):
284
"""Exit the current transaction."""
285
if self._transaction is None:
286
raise errors.LockError('Branch %s is not in a transaction' %
288
transaction = self._transaction
289
self._transaction = None
292
def get_transaction(self):
293
"""Return the current active transaction.
295
If no transaction is active, this returns a passthrough object
296
for which all data is immedaitely flushed and no caching happens.
298
if self._transaction is None:
299
return transactions.PassThroughTransaction()
301
return self._transaction
303
def _set_transaction(self, new_transaction):
304
"""Set a new active transaction."""
305
if self._transaction is not None:
306
raise errors.LockError('Branch %s is in a transaction already.' %
308
self._transaction = new_transaction
310
def lock_write(self):
311
mutter("lock write: %s (%s)", self, self._lock_count)
312
# TODO: Upgrade locking to support using a Transport,
313
# and potentially a remote locking protocol
315
if self._lock_mode != 'w':
316
raise LockError("can't upgrade to a write lock from %r" %
318
self._lock_count += 1
320
self._lock = self._transport.lock_write(
321
self._rel_controlfilename('branch-lock'))
322
self._lock_mode = 'w'
324
self._set_transaction(transactions.PassThroughTransaction())
295
326
def lock_read(self):
296
"""Lock the branch for read operations.
298
:return: A bzrlib.lock.LogicalLockResult.
300
raise NotImplementedError(self.lock_read)
327
mutter("lock read: %s (%s)", self, self._lock_count)
329
assert self._lock_mode in ('r', 'w'), \
330
"invalid lock mode %r" % self._lock_mode
331
self._lock_count += 1
333
self._lock = self._transport.lock_read(
334
self._rel_controlfilename('branch-lock'))
335
self._lock_mode = 'r'
337
self._set_transaction(transactions.ReadOnlyTransaction())
338
# 5K may be excessive, but hey, its a knob.
339
self.get_transaction().set_cache_size(5000)
302
341
def unlock(self):
303
raise NotImplementedError(self.unlock)
305
def peek_lock_mode(self):
306
"""Return lock mode for the Branch: 'r', 'w' or None"""
307
raise NotImplementedError(self.peek_lock_mode)
309
def get_physical_lock_status(self):
310
raise NotImplementedError(self.get_physical_lock_status)
313
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
314
"""Return the revision_id for a dotted revno.
316
:param revno: a tuple like (1,) or (1,1,2)
317
:param _cache_reverse: a private parameter enabling storage
318
of the reverse mapping in a top level cache. (This should
319
only be done in selective circumstances as we want to
320
avoid having the mapping cached multiple times.)
321
:return: the revision_id
322
:raises errors.NoSuchRevision: if the revno doesn't exist
324
rev_id = self._do_dotted_revno_to_revision_id(revno)
326
self._partial_revision_id_to_revno_cache[rev_id] = revno
329
def _do_dotted_revno_to_revision_id(self, revno):
330
"""Worker function for dotted_revno_to_revision_id.
332
Subclasses should override this if they wish to
333
provide a more efficient implementation.
336
return self.get_rev_id(revno[0])
337
revision_id_to_revno = self.get_revision_id_to_revno_map()
338
revision_ids = [revision_id for revision_id, this_revno
339
in revision_id_to_revno.iteritems()
340
if revno == this_revno]
341
if len(revision_ids) == 1:
342
return revision_ids[0]
344
revno_str = '.'.join(map(str, revno))
345
raise errors.NoSuchRevision(self, revno_str)
348
def revision_id_to_dotted_revno(self, revision_id):
349
"""Given a revision id, return its dotted revno.
351
:return: a tuple like (1,) or (400,1,3).
353
return self._do_revision_id_to_dotted_revno(revision_id)
355
def _do_revision_id_to_dotted_revno(self, revision_id):
356
"""Worker function for revision_id_to_revno."""
357
# Try the caches if they are loaded
358
result = self._partial_revision_id_to_revno_cache.get(revision_id)
359
if result is not None:
361
if self._revision_id_to_revno_cache:
362
result = self._revision_id_to_revno_cache.get(revision_id)
364
raise errors.NoSuchRevision(self, revision_id)
365
# Try the mainline as it's optimised
367
revno = self.revision_id_to_revno(revision_id)
369
except errors.NoSuchRevision:
370
# We need to load and use the full revno map after all
371
result = self.get_revision_id_to_revno_map().get(revision_id)
373
raise errors.NoSuchRevision(self, revision_id)
377
def get_revision_id_to_revno_map(self):
378
"""Return the revision_id => dotted revno map.
380
This will be regenerated on demand, but will be cached.
382
:return: A dictionary mapping revision_id => dotted revno.
383
This dictionary should not be modified by the caller.
385
if self._revision_id_to_revno_cache is not None:
386
mapping = self._revision_id_to_revno_cache
388
mapping = self._gen_revno_map()
389
self._cache_revision_id_to_revno(mapping)
390
# TODO: jam 20070417 Since this is being cached, should we be returning
392
# I would rather not, and instead just declare that users should not
393
# modify the return value.
396
def _gen_revno_map(self):
397
"""Create a new mapping from revision ids to dotted revnos.
399
Dotted revnos are generated based on the current tip in the revision
401
This is the worker function for get_revision_id_to_revno_map, which
402
just caches the return value.
404
:return: A dictionary mapping revision_id => dotted revno.
406
revision_id_to_revno = dict((rev_id, revno)
407
for rev_id, depth, revno, end_of_merge
408
in self.iter_merge_sorted_revisions())
409
return revision_id_to_revno
412
def iter_merge_sorted_revisions(self, start_revision_id=None,
413
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
414
"""Walk the revisions for a branch in merge sorted order.
416
Merge sorted order is the output from a merge-aware,
417
topological sort, i.e. all parents come before their
418
children going forward; the opposite for reverse.
420
:param start_revision_id: the revision_id to begin walking from.
421
If None, the branch tip is used.
422
:param stop_revision_id: the revision_id to terminate the walk
423
after. If None, the rest of history is included.
424
:param stop_rule: if stop_revision_id is not None, the precise rule
425
to use for termination:
426
* 'exclude' - leave the stop revision out of the result (default)
427
* 'include' - the stop revision is the last item in the result
428
* 'with-merges' - include the stop revision and all of its
429
merged revisions in the result
430
* 'with-merges-without-common-ancestry' - filter out revisions
431
that are in both ancestries
432
:param direction: either 'reverse' or 'forward':
433
* reverse means return the start_revision_id first, i.e.
434
start at the most recent revision and go backwards in history
435
* forward returns tuples in the opposite order to reverse.
436
Note in particular that forward does *not* do any intelligent
437
ordering w.r.t. depth as some clients of this API may like.
438
(If required, that ought to be done at higher layers.)
440
:return: an iterator over (revision_id, depth, revno, end_of_merge)
443
* revision_id: the unique id of the revision
444
* depth: How many levels of merging deep this node has been
446
* revno_sequence: This field provides a sequence of
447
revision numbers for all revisions. The format is:
448
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
449
branch that the revno is on. From left to right the REVNO numbers
450
are the sequence numbers within that branch of the revision.
451
* end_of_merge: When True the next node (earlier in history) is
452
part of a different merge.
454
# Note: depth and revno values are in the context of the branch so
455
# we need the full graph to get stable numbers, regardless of the
457
if self._merge_sorted_revisions_cache is None:
458
last_revision = self.last_revision()
459
known_graph = self.repository.get_known_graph_ancestry(
461
self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
filtered = self._filter_merge_sorted_revisions(
464
self._merge_sorted_revisions_cache, start_revision_id,
465
stop_revision_id, stop_rule)
466
# Make sure we don't return revisions that are not part of the
467
# start_revision_id ancestry.
468
filtered = self._filter_start_non_ancestors(filtered)
469
if direction == 'reverse':
471
if direction == 'forward':
472
return reversed(list(filtered))
474
raise ValueError('invalid direction %r' % direction)
476
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
477
start_revision_id, stop_revision_id, stop_rule):
478
"""Iterate over an inclusive range of sorted revisions."""
479
rev_iter = iter(merge_sorted_revisions)
480
if start_revision_id is not None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
483
if rev_id != start_revision_id:
342
mutter("unlock: %s (%s)", self, self._lock_count)
343
if not self._lock_mode:
344
raise LockError('branch %r is not locked' % (self))
346
if self._lock_count > 1:
347
self._lock_count -= 1
349
self._finish_transaction()
352
self._lock_mode = self._lock_count = None
354
def abspath(self, name):
355
"""Return absolute filename for something in the branch
357
XXX: Robert Collins 20051017 what is this used for? why is it a branch
358
method and not a tree method.
360
return self._transport.abspath(name)
362
def _rel_controlfilename(self, file_or_path):
363
if isinstance(file_or_path, basestring):
364
file_or_path = [file_or_path]
365
return [bzrlib.BZRDIR] + file_or_path
367
def controlfilename(self, file_or_path):
368
"""Return location relative to branch."""
369
return self._transport.abspath(self._rel_controlfilename(file_or_path))
372
def controlfile(self, file_or_path, mode='r'):
373
"""Open a control file for this branch.
375
There are two classes of file in the control directory: text
376
and binary. binary files are untranslated byte streams. Text
377
control files are stored with Unix newlines and in UTF-8, even
378
if the platform or locale defaults are different.
380
Controlfiles should almost never be opened in write mode but
381
rather should be atomically copied and replaced using atomicfile.
385
relpath = self._rel_controlfilename(file_or_path)
386
#TODO: codecs.open() buffers linewise, so it was overloaded with
387
# a much larger buffer, do we need to do the same for getreader/getwriter?
389
return self._transport.get(relpath)
391
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
393
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
395
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
397
raise BzrError("invalid controlfile mode %r" % mode)
399
def put_controlfile(self, path, f, encode=True):
400
"""Write an entry as a controlfile.
402
:param path: The path to put the file, relative to the .bzr control
404
:param f: A file-like or string object whose contents should be copied.
405
:param encode: If true, encode the contents as utf-8
407
self.put_controlfiles([(path, f)], encode=encode)
409
def put_controlfiles(self, files, encode=True):
410
"""Write several entries as controlfiles.
412
:param files: A list of [(path, file)] pairs, where the path is the directory
413
underneath the bzr control directory
414
:param encode: If true, encode the contents as utf-8
418
for path, f in files:
420
if isinstance(f, basestring):
421
f = f.encode('utf-8', 'replace')
486
# The decision to include the start or not
487
# depends on the stop_rule if a stop is provided
488
# so pop this node back into the iterator
489
rev_iter = chain(iter([node]), rev_iter)
491
if stop_revision_id is None:
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
497
elif stop_rule == 'exclude':
498
for node in rev_iter:
499
rev_id = node.key[-1]
500
if rev_id == stop_revision_id:
502
yield (rev_id, node.merge_depth, node.revno,
504
elif stop_rule == 'include':
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
yield (rev_id, node.merge_depth, node.revno,
509
if rev_id == stop_revision_id:
511
elif stop_rule == 'with-merges-without-common-ancestry':
512
# We want to exclude all revisions that are already part of the
513
# stop_revision_id ancestry.
514
graph = self.repository.get_graph()
515
ancestors = graph.find_unique_ancestors(start_revision_id,
517
for node in rev_iter:
518
rev_id = node.key[-1]
519
if rev_id not in ancestors:
521
yield (rev_id, node.merge_depth, node.revno,
523
elif stop_rule == 'with-merges':
524
stop_rev = self.repository.get_revision(stop_revision_id)
525
if stop_rev.parent_ids:
526
left_parent = stop_rev.parent_ids[0]
423
f = codecs.getwriter('utf-8')(f, errors='replace')
424
path = self._rel_controlfilename(path)
425
ctrl_files.append((path, f))
426
self._transport.put_multi(ctrl_files)
428
def _make_control(self):
429
from bzrlib.inventory import Inventory
430
from bzrlib.weavefile import write_weave_v5
431
from bzrlib.weave import Weave
433
# Create an empty inventory
435
# if we want per-tree root ids then this is the place to set
436
# them; they're not needed for now and so ommitted for
438
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
439
empty_inv = sio.getvalue()
441
bzrlib.weavefile.write_weave_v5(Weave(), sio)
442
empty_weave = sio.getvalue()
444
dirs = [[], 'revision-store', 'weaves']
446
"This is a Bazaar-NG control directory.\n"
447
"Do not change any files in this directory.\n"),
448
('branch-format', BZR_BRANCH_FORMAT_6),
449
('revision-history', ''),
452
('pending-merges', ''),
453
('inventory', empty_inv),
454
('inventory.weave', empty_weave),
455
('ancestry.weave', empty_weave)
457
cfn = self._rel_controlfilename
458
self._transport.mkdir_multi([cfn(d) for d in dirs])
459
self.put_controlfiles(files)
460
mutter('created control directory in ' + self._transport.base)
462
def _check_format(self, relax_version_check):
463
"""Check this branch format is supported.
465
The format level is stored, as an integer, in
466
self._branch_format for code that needs to check it later.
468
In the future, we might need different in-memory Branch
469
classes to support downlevel branches. But not yet.
472
fmt = self.controlfile('branch-format', 'r').read()
474
raise NotBranchError(self.base)
475
mutter("got branch format %r", fmt)
476
if fmt == BZR_BRANCH_FORMAT_6:
477
self._branch_format = 6
478
elif fmt == BZR_BRANCH_FORMAT_5:
479
self._branch_format = 5
480
elif fmt == BZR_BRANCH_FORMAT_4:
481
self._branch_format = 4
483
if (not relax_version_check
484
and self._branch_format not in (5, 6)):
485
raise errors.UnsupportedFormatError(
486
'sorry, branch format %r not supported' % fmt,
487
['use a different bzr version',
488
'or remove the .bzr directory'
489
' and "bzr init" again'])
491
def get_root_id(self):
492
"""Return the id of this branches root"""
493
inv = self.read_working_inventory()
494
return inv.root.file_id
496
def set_root_id(self, file_id):
497
inv = self.read_working_inventory()
498
orig_root_id = inv.root.file_id
499
del inv._byid[inv.root.file_id]
500
inv.root.file_id = file_id
501
inv._byid[inv.root.file_id] = inv.root
504
if entry.parent_id in (None, orig_root_id):
505
entry.parent_id = inv.root.file_id
506
self._write_inventory(inv)
508
def read_working_inventory(self):
509
"""Read the working inventory."""
512
# ElementTree does its own conversion from UTF-8, so open in
514
f = self.controlfile('inventory', 'rb')
515
return bzrlib.xml5.serializer_v5.read_inventory(f)
520
def _write_inventory(self, inv):
521
"""Update the working inventory.
523
That is to say, the inventory describing changes underway, that
524
will be committed to the next revision.
526
from cStringIO import StringIO
530
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
532
# Transport handles atomicity
533
self.put_controlfile('inventory', sio)
537
mutter('wrote working inventory')
539
inventory = property(read_working_inventory, _write_inventory, None,
540
"""Inventory for the working copy.""")
542
def add(self, files, ids=None):
543
"""Make files versioned.
545
Note that the command line normally calls smart_add instead,
546
which can automatically recurse.
548
This puts the files in the Added state, so that they will be
549
recorded by the next commit.
552
List of paths to add, relative to the base of the tree.
555
If set, use these instead of automatically generated ids.
556
Must be the same length as the list of files, but may
557
contain None for ids that are to be autogenerated.
559
TODO: Perhaps have an option to add the ids even if the files do
562
TODO: Perhaps yield the ids and paths as they're added.
564
# TODO: Re-adding a file that is removed in the working copy
565
# should probably put it back with the previous ID.
566
if isinstance(files, basestring):
567
assert(ids is None or isinstance(ids, basestring))
573
ids = [None] * len(files)
575
assert(len(ids) == len(files))
579
inv = self.read_working_inventory()
580
for f,file_id in zip(files, ids):
581
if is_control_file(f):
582
raise BzrError("cannot add control file %s" % quotefn(f))
587
raise BzrError("cannot add top-level %r" % f)
589
fullpath = os.path.normpath(self.abspath(f))
592
kind = file_kind(fullpath)
594
# maybe something better?
595
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
597
if not InventoryEntry.versionable_kind(kind):
598
raise BzrError('cannot add: not a versionable file ('
599
'i.e. regular file, symlink or directory): %s' % quotefn(f))
602
file_id = gen_file_id(f)
603
inv.add_path(f, kind=kind, file_id=file_id)
605
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
607
self._write_inventory(inv)
612
def print_file(self, file, revno):
613
"""Print `file` to stdout."""
616
tree = self.revision_tree(self.get_rev_id(revno))
617
# use inventory as it was in that revision
618
file_id = tree.inventory.path2id(file)
620
raise BzrError("%r is not present in revision %s" % (file, revno))
621
tree.print_file(file_id)
626
def remove(self, files, verbose=False):
627
"""Mark nominated files for removal from the inventory.
629
This does not remove their text. This does not run on
631
TODO: Refuse to remove modified files unless --force is given?
633
TODO: Do something useful with directories.
635
TODO: Should this remove the text or not? Tough call; not
636
removing may be useful and the user can just use use rm, and
637
is the opposite of add. Removing it is consistent with most
638
other tools. Maybe an option.
640
## TODO: Normalize names
641
## TODO: Remove nested loops; better scalability
642
if isinstance(files, basestring):
648
tree = self.working_tree()
651
# do this before any modifications
655
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
656
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
658
# having remove it, it must be either ignored or unknown
659
if tree.is_ignored(f):
663
show_status(new_status, inv[fid].kind, quotefn(f))
666
self._write_inventory(inv)
670
# FIXME: this doesn't need to be a branch method
671
def set_inventory(self, new_inventory_list):
672
from bzrlib.inventory import Inventory, InventoryEntry
673
inv = Inventory(self.get_root_id())
674
for path, file_id, parent, kind in new_inventory_list:
675
name = os.path.basename(path)
678
# fixme, there should be a factory function inv,add_??
679
if kind == 'directory':
680
inv.add(inventory.InventoryDirectory(file_id, name, parent))
682
inv.add(inventory.InventoryFile(file_id, name, parent))
683
elif kind == 'symlink':
684
inv.add(inventory.InventoryLink(file_id, name, parent))
528
left_parent = _mod_revision.NULL_REVISION
529
# left_parent is the actual revision we want to stop logging at,
530
# since we want to show the merged revisions after the stop_rev too
531
reached_stop_revision_id = False
532
revision_id_whitelist = []
533
for node in rev_iter:
534
rev_id = node.key[-1]
535
if rev_id == left_parent:
536
# reached the left parent after the stop_revision
538
if (not reached_stop_revision_id or
539
rev_id in revision_id_whitelist):
540
yield (rev_id, node.merge_depth, node.revno,
542
if reached_stop_revision_id or rev_id == stop_revision_id:
543
# only do the merged revs of rev_id from now on
544
rev = self.repository.get_revision(rev_id)
546
reached_stop_revision_id = True
547
revision_id_whitelist.extend(rev.parent_ids)
549
raise ValueError('invalid stop_rule %r' % stop_rule)
551
def _filter_start_non_ancestors(self, rev_iter):
552
# If we started from a dotted revno, we want to consider it as a tip
553
# and don't want to yield revisions that are not part of its
554
# ancestry. Given the order guaranteed by the merge sort, we will see
555
# uninteresting descendants of the first parent of our tip before the
557
first = rev_iter.next()
558
(rev_id, merge_depth, revno, end_of_merge) = first
561
# We start at a mainline revision so by definition, all others
562
# revisions in rev_iter are ancestors
563
for node in rev_iter:
568
pmap = self.repository.get_parent_map([rev_id])
569
parents = pmap.get(rev_id, [])
571
whitelist.update(parents)
573
# If there is no parents, there is nothing of interest left
575
# FIXME: It's hard to test this scenario here as this code is never
576
# called in that case. -- vila 20100322
579
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
if rev_id in whitelist:
582
pmap = self.repository.get_parent_map([rev_id])
583
parents = pmap.get(rev_id, [])
584
whitelist.remove(rev_id)
585
whitelist.update(parents)
587
# We've reached the mainline, there is nothing left to
591
# A revision that is not part of the ancestry of our
594
yield (rev_id, merge_depth, revno, end_of_merge)
596
def leave_lock_in_place(self):
597
"""Tell this branch object not to release the physical lock when this
600
If lock_write doesn't return a token, then this method is not supported.
602
self.control_files.leave_in_place()
604
def dont_leave_lock_in_place(self):
605
"""Tell this branch object to release the physical lock when this
606
object is unlocked, even if it didn't originally acquire it.
608
If lock_write doesn't return a token, then this method is not supported.
610
self.control_files.dont_leave_in_place()
612
def bind(self, other):
613
"""Bind the local branch the other branch.
615
:param other: The branch to bind to
618
raise errors.UpgradeRequired(self.user_url)
620
def set_append_revisions_only(self, enabled):
621
if not self._format.supports_set_append_revisions_only():
622
raise errors.UpgradeRequired(self.user_url)
627
self.get_config().set_user_option('append_revisions_only', value,
630
def set_reference_info(self, file_id, tree_path, branch_location):
631
"""Set the branch location to use for a tree reference."""
632
raise errors.UnsupportedOperation(self.set_reference_info, self)
634
def get_reference_info(self, file_id):
635
"""Get the tree_path and branch_location for a tree reference."""
636
raise errors.UnsupportedOperation(self.get_reference_info, self)
639
def fetch(self, from_branch, last_revision=None, pb=None):
640
"""Copy revisions from from_branch into this branch.
642
:param from_branch: Where to copy from.
643
:param last_revision: What revision to stop at (None for at the end
645
:param pb: An optional progress bar to use.
648
if self.base == from_branch.base:
651
symbol_versioning.warn(
652
symbol_versioning.deprecated_in((1, 14, 0))
653
% "pb parameter to fetch()")
654
from_branch.lock_read()
656
if last_revision is None:
657
last_revision = from_branch.last_revision()
658
last_revision = _mod_revision.ensure_null(last_revision)
659
return self.repository.fetch(from_branch.repository,
660
revision_id=last_revision,
665
def get_bound_location(self):
666
"""Return the URL of the branch we are bound to.
668
Older format branches cannot bind, please be sure to use a metadir
673
def get_old_bound_location(self):
674
"""Return the URL of the branch we used to be bound to
676
raise errors.UpgradeRequired(self.user_url)
678
def get_commit_builder(self, parents, config=None, timestamp=None,
679
timezone=None, committer=None, revprops=None,
681
"""Obtain a CommitBuilder for this branch.
683
:param parents: Revision ids of the parents of the new revision.
684
:param config: Optional configuration to use.
685
:param timestamp: Optional timestamp recorded for commit.
686
:param timezone: Optional timezone for timestamp.
687
:param committer: Optional committer to set for commit.
688
:param revprops: Optional dictionary of revision properties.
689
:param revision_id: Optional revision id.
693
config = self.get_config()
695
return self.repository.get_commit_builder(self, parents, config,
696
timestamp, timezone, committer, revprops, revision_id)
698
def get_master_branch(self, possible_transports=None):
699
"""Return the branch we are bound to.
701
:return: Either a Branch, or None
686
raise BzrError("unknown kind %r" % kind)
687
self._write_inventory(inv)
690
"""Return all unknown files.
692
These are files in the working directory that are not versioned or
693
control files or ignored.
695
>>> b = ScratchBranch(files=['foo', 'foo~'])
696
>>> list(b.unknowns())
699
>>> list(b.unknowns())
702
>>> list(b.unknowns())
705
return self.working_tree().unknowns()
708
def append_revision(self, *revision_ids):
709
for revision_id in revision_ids:
710
mutter("add {%s} to revision-history" % revision_id)
713
rev_history = self.revision_history()
714
rev_history.extend(revision_ids)
715
self.put_controlfile('revision-history', '\n'.join(rev_history))
719
def has_revision(self, revision_id):
720
"""True if this branch has a copy of the revision.
722
This does not necessarily imply the revision is merge
723
or on the mainline."""
724
return (revision_id is None
725
or revision_id in self.revision_store)
727
def get_revision_xml_file(self, revision_id):
728
"""Return XML file object for revision object."""
729
if not revision_id or not isinstance(revision_id, basestring):
730
raise InvalidRevisionId(revision_id)
735
return self.revision_store[revision_id]
736
except (IndexError, KeyError):
737
raise bzrlib.errors.NoSuchRevision(self, revision_id)
742
get_revision_xml = get_revision_xml_file
744
def get_revision_xml(self, revision_id):
745
return self.get_revision_xml_file(revision_id).read()
748
def get_revision(self, revision_id):
749
"""Return the Revision object for a named revision"""
750
xml_file = self.get_revision_xml_file(revision_id)
753
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
754
except SyntaxError, e:
755
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
759
assert r.revision_id == revision_id
705
762
def get_revision_delta(self, revno):
706
763
"""Return the delta for one revision.
952
908
common_index = min(self_len, other_len) -1
953
909
if common_index >= 0 and \
954
910
self_history[common_index] != other_history[common_index]:
955
raise errors.DivergedBranches(self, other)
911
raise DivergedBranches(self, other)
957
913
if stop_revision is None:
958
914
stop_revision = other_len
916
assert isinstance(stop_revision, int)
960
917
if stop_revision > other_len:
961
raise errors.NoSuchRevision(self, stop_revision)
918
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
962
919
return other_history[self_len:stop_revision]
965
def update_revisions(self, other, stop_revision=None, overwrite=False,
967
"""Pull in new perfect-fit revisions.
969
:param other: Another Branch to pull from
970
:param stop_revision: Updated until the given revision
971
:param overwrite: Always set the branch pointer, rather than checking
972
to see if it is a proper descendant.
973
:param graph: A Graph object that can be used to query history
974
information. This can be None.
977
return InterBranch.get(other, self).update_revisions(stop_revision,
980
def import_last_revision_info(self, source_repo, revno, revid):
981
"""Set the last revision info, importing from another repo if necessary.
983
This is used by the bound branch code to upload a revision to
984
the master branch first before updating the tip of the local branch.
986
:param source_repo: Source repository to optionally fetch from
987
:param revno: Revision number of the new tip
988
:param revid: Revision id of the new tip
990
if not self.repository.has_same_location(source_repo):
991
self.repository.fetch(source_repo, revision_id=revid)
992
self.set_last_revision_info(revno, revid)
921
def update_revisions(self, other, stop_revision=None):
922
"""Pull in new perfect-fit revisions."""
923
# FIXME: If the branches have diverged, but the latest
924
# revision in this branch is completely merged into the other,
925
# then we should still be able to pull.
926
from bzrlib.fetch import greedy_fetch
927
if stop_revision is None:
928
stop_revision = other.last_revision()
929
### Should this be checking is_ancestor instead of revision_history?
930
if (stop_revision is not None and
931
stop_revision in self.revision_history()):
933
greedy_fetch(to_branch=self, from_branch=other,
934
revision=stop_revision)
935
pullable_revs = self.pullable_revisions(other, stop_revision)
936
if len(pullable_revs) > 0:
937
self.append_revision(*pullable_revs)
939
def pullable_revisions(self, other, stop_revision):
940
other_revno = other.revision_id_to_revno(stop_revision)
942
return self.missing_revisions(other, other_revno)
943
except DivergedBranches, e:
945
pullable_revs = get_intervening_revisions(self.last_revision(),
947
assert self.last_revision() not in pullable_revs
949
except bzrlib.errors.NotAncestor:
950
if is_ancestor(self.last_revision(), stop_revision, self):
956
def commit(self, *args, **kw):
957
from bzrlib.commit import Commit
958
Commit().commit(self, *args, **kw)
994
960
def revision_id_to_revno(self, revision_id):
995
961
"""Given a revision id, return its revno"""
996
if _mod_revision.is_null(revision_id):
962
if revision_id is None:
998
964
history = self.revision_history()
1000
966
return history.index(revision_id) + 1
1001
967
except ValueError:
1002
raise errors.NoSuchRevision(self, revision_id)
968
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1005
970
def get_rev_id(self, revno, history=None):
1006
971
"""Find the revision id of the specified revno."""
1008
return _mod_revision.NULL_REVISION
1009
last_revno, last_revid = self.last_revision_info()
1010
if revno == last_revno:
1012
if revno <= 0 or revno > last_revno:
1013
raise errors.NoSuchRevision(self, revno)
1014
distance_from_last = last_revno - revno
1015
if len(self._partial_revision_history_cache) <= distance_from_last:
1016
self._extend_partial_history(distance_from_last)
1017
return self._partial_revision_history_cache[distance_from_last]
1020
def pull(self, source, overwrite=False, stop_revision=None,
1021
possible_transports=None, *args, **kwargs):
1022
"""Mirror source into this branch.
1024
This branch is considered to be 'local', having low latency.
1026
:returns: PullResult instance
1028
return InterBranch.get(source, self).pull(overwrite=overwrite,
1029
stop_revision=stop_revision,
1030
possible_transports=possible_transports, *args, **kwargs)
1032
def push(self, target, overwrite=False, stop_revision=None, *args,
1034
"""Mirror this branch into target.
1036
This branch is considered to be 'local', having low latency.
1038
return InterBranch.get(self, target).push(overwrite, stop_revision,
1041
def lossy_push(self, target, stop_revision=None):
1042
"""Push deltas into another branch.
1044
:note: This does not, like push, retain the revision ids from
1045
the source branch and will, rather than adding bzr-specific
1046
metadata, push only those semantics of the revision that can be
1047
natively represented by this branch' VCS.
1049
:param target: Target branch
1050
:param stop_revision: Revision to push, defaults to last revision.
1051
:return: BranchPushResult with an extra member revidmap:
1052
A dictionary mapping revision ids from the target branch
1053
to new revision ids in the target branch, for each
1054
revision that was pushed.
1056
inter = InterBranch.get(self, target)
1057
lossy_push = getattr(inter, "lossy_push", None)
1058
if lossy_push is None:
1059
raise errors.LossyPushToSameVCS(self, target)
1060
return lossy_push(stop_revision)
975
history = self.revision_history()
976
elif revno <= 0 or revno > len(history):
977
raise bzrlib.errors.NoSuchRevision(self, revno)
978
return history[revno - 1]
980
def revision_tree(self, revision_id):
981
"""Return Tree for a revision on this branch.
983
`revision_id` may be None for the null revision, in which case
984
an `EmptyTree` is returned."""
985
# TODO: refactor this to use an existing revision object
986
# so we don't need to read it in twice.
987
if revision_id == None:
990
inv = self.get_revision_inventory(revision_id)
991
return RevisionTree(self.weave_store, inv, revision_id)
994
def working_tree(self):
995
"""Return a `Tree` for the working copy."""
996
from bzrlib.workingtree import WorkingTree
997
# TODO: In the future, WorkingTree should utilize Transport
998
# RobertCollins 20051003 - I don't think it should - working trees are
999
# much more complex to keep consistent than our careful .bzr subset.
1000
# instead, we should say that working trees are local only, and optimise
1002
return WorkingTree(self.base, branch=self)
1062
1005
def basis_tree(self):
1063
"""Return `Tree` object for last revision."""
1064
return self.repository.revision_tree(self.last_revision())
1006
"""Return `Tree` object for last revision.
1008
If there are no revisions yet, return an `EmptyTree`.
1010
return self.revision_tree(self.last_revision())
1013
def rename_one(self, from_rel, to_rel):
1016
This can change the directory or the filename or both.
1020
tree = self.working_tree()
1021
inv = tree.inventory
1022
if not tree.has_filename(from_rel):
1023
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1024
if tree.has_filename(to_rel):
1025
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1027
file_id = inv.path2id(from_rel)
1029
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1031
if inv.path2id(to_rel):
1032
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1034
to_dir, to_tail = os.path.split(to_rel)
1035
to_dir_id = inv.path2id(to_dir)
1036
if to_dir_id == None and to_dir != '':
1037
raise BzrError("can't determine destination directory id for %r" % to_dir)
1039
mutter("rename_one:")
1040
mutter(" file_id {%s}" % file_id)
1041
mutter(" from_rel %r" % from_rel)
1042
mutter(" to_rel %r" % to_rel)
1043
mutter(" to_dir %r" % to_dir)
1044
mutter(" to_dir_id {%s}" % to_dir_id)
1046
inv.rename(file_id, to_dir_id, to_tail)
1048
from_abs = self.abspath(from_rel)
1049
to_abs = self.abspath(to_rel)
1051
rename(from_abs, to_abs)
1053
raise BzrError("failed to rename %r to %r: %s"
1054
% (from_abs, to_abs, e[1]),
1055
["rename rolled back"])
1057
self._write_inventory(inv)
1062
def move(self, from_paths, to_name):
1065
to_name must exist as a versioned directory.
1067
If to_name exists and is a directory, the files are moved into
1068
it, keeping their old names. If it is a directory,
1070
Note that to_name is only the last component of the new name;
1071
this doesn't change the directory.
1073
This returns a list of (from_path, to_path) pairs for each
1074
entry that is moved.
1079
## TODO: Option to move IDs only
1080
assert not isinstance(from_paths, basestring)
1081
tree = self.working_tree()
1082
inv = tree.inventory
1083
to_abs = self.abspath(to_name)
1084
if not isdir(to_abs):
1085
raise BzrError("destination %r is not a directory" % to_abs)
1086
if not tree.has_filename(to_name):
1087
raise BzrError("destination %r not in working directory" % to_abs)
1088
to_dir_id = inv.path2id(to_name)
1089
if to_dir_id == None and to_name != '':
1090
raise BzrError("destination %r is not a versioned directory" % to_name)
1091
to_dir_ie = inv[to_dir_id]
1092
if to_dir_ie.kind not in ('directory', 'root_directory'):
1093
raise BzrError("destination %r is not a directory" % to_abs)
1095
to_idpath = inv.get_idpath(to_dir_id)
1097
for f in from_paths:
1098
if not tree.has_filename(f):
1099
raise BzrError("%r does not exist in working tree" % f)
1100
f_id = inv.path2id(f)
1102
raise BzrError("%r is not versioned" % f)
1103
name_tail = splitpath(f)[-1]
1104
dest_path = appendpath(to_name, name_tail)
1105
if tree.has_filename(dest_path):
1106
raise BzrError("destination %r already exists" % dest_path)
1107
if f_id in to_idpath:
1108
raise BzrError("can't move %r to a subdirectory of itself" % f)
1110
# OK, so there's a race here, it's possible that someone will
1111
# create a file in this interval and then the rename might be
1112
# left half-done. But we should have caught most problems.
1114
for f in from_paths:
1115
name_tail = splitpath(f)[-1]
1116
dest_path = appendpath(to_name, name_tail)
1117
result.append((f, dest_path))
1118
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1120
rename(self.abspath(f), self.abspath(dest_path))
1122
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1123
["rename rolled back"])
1125
self._write_inventory(inv)
1132
def revert(self, filenames, old_tree=None, backups=True):
1133
"""Restore selected files to the versions from a previous tree.
1136
If true (default) backups are made of files before
1139
from bzrlib.errors import NotVersionedError, BzrError
1140
from bzrlib.atomicfile import AtomicFile
1141
from bzrlib.osutils import backup_file
1143
inv = self.read_working_inventory()
1144
if old_tree is None:
1145
old_tree = self.basis_tree()
1146
old_inv = old_tree.inventory
1149
for fn in filenames:
1150
file_id = inv.path2id(fn)
1152
raise NotVersionedError("not a versioned file", fn)
1153
if not old_inv.has_id(file_id):
1154
raise BzrError("file not present in old tree", fn, file_id)
1155
nids.append((fn, file_id))
1157
# TODO: Rename back if it was previously at a different location
1159
# TODO: If given a directory, restore the entire contents from
1160
# the previous version.
1162
# TODO: Make a backup to a temporary file.
1164
# TODO: If the file previously didn't exist, delete it?
1165
for fn, file_id in nids:
1168
f = AtomicFile(fn, 'wb')
1170
f.write(old_tree.get_file(file_id).read())
1176
def pending_merges(self):
1177
"""Return a list of pending merges.
1179
These are revisions that have been merged into the working
1180
directory but not yet committed.
1182
cfn = self._rel_controlfilename('pending-merges')
1183
if not self._transport.has(cfn):
1186
for l in self.controlfile('pending-merges', 'r').readlines():
1187
p.append(l.rstrip('\n'))
1191
def add_pending_merge(self, *revision_ids):
1192
# TODO: Perhaps should check at this point that the
1193
# history of the revision is actually present?
1194
p = self.pending_merges()
1196
for rev_id in revision_ids:
1202
self.set_pending_merges(p)
1204
def set_pending_merges(self, rev_list):
1207
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1066
1212
def get_parent(self):
1067
1213
"""Return the parent location of the branch.
1069
This is the default location for pull/missing. The usual
1215
This is the default location for push/pull/missing. The usual
1070
1216
pattern is that the user can override it by specifying a
1073
parent = self._get_parent_location()
1076
# This is an old-format absolute path to a local branch
1077
# turn it into a url
1078
if parent.startswith('/'):
1079
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1220
_locs = ['parent', 'pull', 'x-pull']
1223
return self.controlfile(l, 'r').read().strip('\n')
1225
if e.errno != errno.ENOENT:
1230
def set_parent(self, url):
1231
# TODO: Maybe delete old location files?
1232
from bzrlib.atomicfile import AtomicFile
1081
return urlutils.join(self.base[:-1], parent)
1082
except errors.InvalidURLJoin, e:
1083
raise errors.InaccessibleParent(parent, self.user_url)
1085
def _get_parent_location(self):
1086
raise NotImplementedError(self._get_parent_location)
1088
def _set_config_location(self, name, url, config=None,
1089
make_relative=False):
1091
config = self.get_config()
1095
url = urlutils.relative_url(self.base, url)
1096
config.set_user_option(name, url, warn_masked=True)
1098
def _get_config_location(self, name, config=None):
1100
config = self.get_config()
1101
location = config.get_user_option(name)
1106
def get_child_submit_format(self):
1107
"""Return the preferred format of submissions to this branch."""
1108
return self.get_config().get_user_option("child_submit_format")
1110
def get_submit_branch(self):
1111
"""Return the submit location of the branch.
1113
This is the default location for bundle. The usual
1114
pattern is that the user can override it by specifying a
1117
return self.get_config().get_user_option('submit_branch')
1119
def set_submit_branch(self, location):
1120
"""Return the submit location of the branch.
1122
This is the default location for bundle. The usual
1123
pattern is that the user can override it by specifying a
1126
self.get_config().set_user_option('submit_branch', location,
1129
def get_public_branch(self):
1130
"""Return the public location of the branch.
1132
This is used by merge directives.
1134
return self._get_config_location('public_branch')
1136
def set_public_branch(self, location):
1137
"""Return the submit location of the branch.
1139
This is the default location for bundle. The usual
1140
pattern is that the user can override it by specifying a
1143
self._set_config_location('public_branch', location)
1145
def get_push_location(self):
1146
"""Return the None or the location to push this branch to."""
1147
push_loc = self.get_config().get_user_option('push_location')
1150
def set_push_location(self, location):
1151
"""Set a new push location for this branch."""
1152
raise NotImplementedError(self.set_push_location)
1154
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1155
"""Run the post_change_branch_tip hooks."""
1156
hooks = Branch.hooks['post_change_branch_tip']
1159
new_revno, new_revid = self.last_revision_info()
1160
params = ChangeBranchTipParams(
1161
self, old_revno, new_revno, old_revid, new_revid)
1165
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1166
"""Run the pre_change_branch_tip hooks."""
1167
hooks = Branch.hooks['pre_change_branch_tip']
1170
old_revno, old_revid = self.last_revision_info()
1171
params = ChangeBranchTipParams(
1172
self, old_revno, new_revno, old_revid, new_revid)
1178
"""Synchronise this branch with the master branch if any.
1180
:return: None or the last_revision pivoted out during the update.
1235
f = AtomicFile(self.controlfilename('parent'))
1184
1244
def check_revno(self, revno):
1190
1250
self.check_real_revno(revno)
1192
1252
def check_real_revno(self, revno):
1194
1254
Check whether a revno corresponds to a real revision.
1195
1255
Zero (the NULL revision) is considered invalid
1197
1257
if revno < 1 or revno > self.revno():
1198
raise errors.InvalidRevisionNumber(revno)
1201
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1202
"""Clone this branch into to_bzrdir preserving all semantic values.
1204
Most API users will want 'create_clone_on_transport', which creates a
1205
new bzrdir and branch on the fly.
1207
revision_id: if not None, the revision history in the new branch will
1208
be truncated to end with revision_id.
1210
result = to_bzrdir.create_branch()
1213
if repository_policy is not None:
1214
repository_policy.configure_branch(result)
1215
self.copy_content_into(result, revision_id=revision_id)
1221
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1222
"""Create a new line of development from the branch, into to_bzrdir.
1224
to_bzrdir controls the branch format.
1226
revision_id: if not None, the revision history in the new branch will
1227
be truncated to end with revision_id.
1229
if (repository_policy is not None and
1230
repository_policy.requires_stacking()):
1231
to_bzrdir._format.require_stacking(_skip_repo=True)
1232
result = to_bzrdir.create_branch()
1235
if repository_policy is not None:
1236
repository_policy.configure_branch(result)
1237
self.copy_content_into(result, revision_id=revision_id)
1238
result.set_parent(self.bzrdir.root_transport.base)
1243
def _synchronize_history(self, destination, revision_id):
1244
"""Synchronize last revision and revision history between branches.
1246
This version is most efficient when the destination is also a
1247
BzrBranch6, but works for BzrBranch5, as long as the destination's
1248
repository contains all the lefthand ancestors of the intended
1249
last_revision. If not, set_last_revision_info will fail.
1251
:param destination: The branch to copy the history into
1252
:param revision_id: The revision-id to truncate history at. May
1253
be None to copy complete history.
1255
source_revno, source_revision_id = self.last_revision_info()
1256
if revision_id is None:
1257
revno, revision_id = source_revno, source_revision_id
1259
graph = self.repository.get_graph()
1261
revno = graph.find_distance_to_null(revision_id,
1262
[(source_revision_id, source_revno)])
1263
except errors.GhostRevisionsHaveNoRevno:
1264
# Default to 1, if we can't find anything else
1266
destination.set_last_revision_info(revno, revision_id)
1269
def copy_content_into(self, destination, revision_id=None):
1270
"""Copy the content of self into destination.
1272
revision_id: if not None, the revision history in the new branch will
1273
be truncated to end with revision_id.
1275
self.update_references(destination)
1276
self._synchronize_history(destination, revision_id)
1278
parent = self.get_parent()
1279
except errors.InaccessibleParent, e:
1280
mutter('parent was not accessible to copy: %s', e)
1283
destination.set_parent(parent)
1284
if self._push_should_merge_tags():
1285
self.tags.merge_to(destination.tags)
1287
def update_references(self, target):
1288
if not getattr(self._format, 'supports_reference_locations', False):
1290
reference_dict = self._get_all_reference_info()
1291
if len(reference_dict) == 0:
1293
old_base = self.base
1294
new_base = target.base
1295
target_reference_dict = target._get_all_reference_info()
1296
for file_id, (tree_path, branch_location) in (
1297
reference_dict.items()):
1298
branch_location = urlutils.rebase_url(branch_location,
1300
target_reference_dict.setdefault(
1301
file_id, (tree_path, branch_location))
1302
target._set_all_reference_info(target_reference_dict)
1305
def check(self, refs):
1306
"""Check consistency of the branch.
1308
In particular this checks that revisions given in the revision-history
1309
do actually match up in the revision graph, and that they're all
1310
present in the repository.
1312
Callers will typically also want to check the repository.
1314
:param refs: Calculated refs for this branch as specified by
1315
branch._get_check_refs()
1316
:return: A BranchCheckResult.
1318
result = BranchCheckResult(self)
1319
last_revno, last_revision_id = self.last_revision_info()
1320
actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
if actual_revno != last_revno:
1322
result.errors.append(errors.BzrCheckError(
1323
'revno does not match len(mainline) %s != %s' % (
1324
last_revno, actual_revno)))
1325
# TODO: We should probably also check that self.revision_history
1326
# matches the repository for older branch formats.
1327
# If looking for the code that cross-checks repository parents against
1328
# the iter_reverse_revision_history output, that is now a repository
1332
def _get_checkout_format(self):
1333
"""Return the most suitable metadir for a checkout of this branch.
1334
Weaves are used if this branch's repository uses weaves.
1336
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1337
from bzrlib.repofmt import weaverepo
1338
format = bzrdir.BzrDirMetaFormat1()
1339
format.repository_format = weaverepo.RepositoryFormat7()
1341
format = self.repository.bzrdir.checkout_metadir()
1342
format.set_branch_format(self._format)
1345
def create_clone_on_transport(self, to_transport, revision_id=None,
1346
stacked_on=None, create_prefix=False, use_existing_dir=False):
1347
"""Create a clone of this branch and its bzrdir.
1349
:param to_transport: The transport to clone onto.
1350
:param revision_id: The revision id to use as tip in the new branch.
1351
If None the tip is obtained from this branch.
1352
:param stacked_on: An optional URL to stack the clone on.
1353
:param create_prefix: Create any missing directories leading up to
1355
:param use_existing_dir: Use an existing directory if one exists.
1357
# XXX: Fix the bzrdir API to allow getting the branch back from the
1358
# clone call. Or something. 20090224 RBC/spiv.
1359
# XXX: Should this perhaps clone colocated branches as well,
1360
# rather than just the default branch? 20100319 JRV
1361
if revision_id is None:
1362
revision_id = self.last_revision()
1363
dir_to = self.bzrdir.clone_on_transport(to_transport,
1364
revision_id=revision_id, stacked_on=stacked_on,
1365
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1366
return dir_to.open_branch()
1368
def create_checkout(self, to_location, revision_id=None,
1369
lightweight=False, accelerator_tree=None,
1371
"""Create a checkout of a branch.
1373
:param to_location: The url to produce the checkout at
1374
:param revision_id: The revision to check out
1375
:param lightweight: If True, produce a lightweight checkout, otherwise,
1376
produce a bound branch (heavyweight checkout)
1377
:param accelerator_tree: A tree which can be used for retrieving file
1378
contents more quickly than the revision tree, i.e. a workingtree.
1379
The revision tree will be used for cases where accelerator_tree's
1380
content is different.
1381
:param hardlink: If true, hard-link files from accelerator_tree,
1383
:return: The tree of the created checkout
1385
t = transport.get_transport(to_location)
1388
format = self._get_checkout_format()
1389
checkout = format.initialize_on_transport(t)
1390
from_branch = BranchReferenceFormat().initialize(checkout,
1393
format = self._get_checkout_format()
1394
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1395
to_location, force_new_tree=False, format=format)
1396
checkout = checkout_branch.bzrdir
1397
checkout_branch.bind(self)
1398
# pull up to the specified revision_id to set the initial
1399
# branch tip correctly, and seed it with history.
1400
checkout_branch.pull(self, stop_revision=revision_id)
1402
tree = checkout.create_workingtree(revision_id,
1403
from_branch=from_branch,
1404
accelerator_tree=accelerator_tree,
1406
basis_tree = tree.basis_tree()
1407
basis_tree.lock_read()
1409
for path, file_id in basis_tree.iter_references():
1410
reference_parent = self.reference_parent(file_id, path)
1411
reference_parent.create_checkout(tree.abspath(path),
1412
basis_tree.get_reference_revision(file_id, path),
1419
def reconcile(self, thorough=True):
1420
"""Make sure the data stored in this branch is consistent."""
1421
from bzrlib.reconcile import BranchReconciler
1422
reconciler = BranchReconciler(self, thorough=thorough)
1423
reconciler.reconcile()
1426
def reference_parent(self, file_id, path, possible_transports=None):
1427
"""Return the parent branch for a tree-reference file_id
1428
:param file_id: The file_id of the tree reference
1429
:param path: The path of the file_id in the tree
1430
:return: A branch associated with the file_id
1432
# FIXME should provide multiple branches, based on config
1433
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1434
possible_transports=possible_transports)
1436
def supports_tags(self):
1437
return self._format.supports_tags()
1439
def automatic_tag_name(self, revision_id):
1440
"""Try to automatically find the tag name for a revision.
1442
:param revision_id: Revision id of the revision.
1443
:return: A tag name or None if no tag name could be determined.
1445
for hook in Branch.hooks['automatic_tag_name']:
1446
ret = hook(self, revision_id)
1451
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1453
"""Ensure that revision_b is a descendant of revision_a.
1455
This is a helper function for update_revisions.
1457
:raises: DivergedBranches if revision_b has diverged from revision_a.
1458
:returns: True if revision_b is a descendant of revision_a.
1460
relation = self._revision_relations(revision_a, revision_b, graph)
1461
if relation == 'b_descends_from_a':
1463
elif relation == 'diverged':
1464
raise errors.DivergedBranches(self, other_branch)
1465
elif relation == 'a_descends_from_b':
1468
raise AssertionError("invalid relation: %r" % (relation,))
1470
def _revision_relations(self, revision_a, revision_b, graph):
1471
"""Determine the relationship between two revisions.
1473
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1475
heads = graph.heads([revision_a, revision_b])
1476
if heads == set([revision_b]):
1477
return 'b_descends_from_a'
1478
elif heads == set([revision_a, revision_b]):
1479
# These branches have diverged
1481
elif heads == set([revision_a]):
1482
return 'a_descends_from_b'
1484
raise AssertionError("invalid heads: %r" % (heads,))
1487
class BranchFormat(object):
1488
"""An encapsulation of the initialization and open routines for a format.
1490
Formats provide three things:
1491
* An initialization routine,
1495
Formats are placed in an dict by their format string for reference
1496
during branch opening. Its not required that these be instances, they
1497
can be classes themselves with class methods - it simply depends on
1498
whether state is needed for a given format or not.
1500
Once a format is deprecated, just deprecate the initialize and open
1501
methods on the format class. Do not deprecate the object, as the
1502
object will be created every time regardless.
1505
_default_format = None
1506
"""The default format used for new branches."""
1509
"""The known formats."""
1511
can_set_append_revisions_only = True
1513
def __eq__(self, other):
1514
return self.__class__ is other.__class__
1516
def __ne__(self, other):
1517
return not (self == other)
1520
def find_format(klass, a_bzrdir, name=None):
1521
"""Return the format for the branch object in a_bzrdir."""
1523
transport = a_bzrdir.get_branch_transport(None, name=name)
1524
format_string = transport.get_bytes("format")
1525
return klass._formats[format_string]
1526
except errors.NoSuchFile:
1527
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1529
raise errors.UnknownFormatError(format=format_string, kind='branch')
1532
def get_default_format(klass):
1533
"""Return the current default format."""
1534
return klass._default_format
1536
def get_reference(self, a_bzrdir, name=None):
1537
"""Get the target reference of the branch in a_bzrdir.
1539
format probing must have been completed before calling
1540
this method - it is assumed that the format of the branch
1541
in a_bzrdir is correct.
1543
:param a_bzrdir: The bzrdir to get the branch data from.
1544
:param name: Name of the colocated branch to fetch
1545
:return: None if the branch is not a reference branch.
1550
def set_reference(self, a_bzrdir, name, to_branch):
1551
"""Set the target reference of the branch in a_bzrdir.
1553
format probing must have been completed before calling
1554
this method - it is assumed that the format of the branch
1555
in a_bzrdir is correct.
1557
:param a_bzrdir: The bzrdir to set the branch reference for.
1558
:param name: Name of colocated branch to set, None for default
1559
:param to_branch: branch that the checkout is to reference
1561
raise NotImplementedError(self.set_reference)
1563
def get_format_string(self):
1564
"""Return the ASCII format string that identifies this format."""
1565
raise NotImplementedError(self.get_format_string)
1567
def get_format_description(self):
1568
"""Return the short format description for this format."""
1569
raise NotImplementedError(self.get_format_description)
1571
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1572
hooks = Branch.hooks['post_branch_init']
1575
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1579
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
lock_type='metadir', set_format=True):
1581
"""Initialize a branch in a bzrdir, with specified files
1583
:param a_bzrdir: The bzrdir to initialize the branch in
1584
:param utf8_files: The files to create as a list of
1585
(filename, content) tuples
1586
:param name: Name of colocated branch to create, if any
1587
:param set_format: If True, set the format with
1588
self.get_format_string. (BzrBranch4 has its format set
1590
:return: a branch in this format
1592
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1595
'metadir': ('lock', lockdir.LockDir),
1596
'branch4': ('branch-lock', lockable_files.TransportLock),
1598
lock_name, lock_class = lock_map[lock_type]
1599
control_files = lockable_files.LockableFiles(branch_transport,
1600
lock_name, lock_class)
1601
control_files.create_lock()
1603
control_files.lock_write()
1604
except errors.LockContention:
1605
if lock_type != 'branch4':
1611
utf8_files += [('format', self.get_format_string())]
1613
for (filename, content) in utf8_files:
1614
branch_transport.put_bytes(
1616
mode=a_bzrdir._get_file_mode())
1619
control_files.unlock()
1620
branch = self.open(a_bzrdir, name, _found=True)
1621
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1624
def initialize(self, a_bzrdir, name=None):
1625
"""Create a branch of this format in a_bzrdir.
1627
:param name: Name of the colocated branch to create.
1629
raise NotImplementedError(self.initialize)
1631
def is_supported(self):
1632
"""Is this format supported?
1634
Supported formats can be initialized and opened.
1635
Unsupported formats may not support initialization or committing or
1636
some other features depending on the reason for not being supported.
1640
def make_tags(self, branch):
1641
"""Create a tags object for branch.
1643
This method is on BranchFormat, because BranchFormats are reflected
1644
over the wire via network_name(), whereas full Branch instances require
1645
multiple VFS method calls to operate at all.
1647
The default implementation returns a disabled-tags instance.
1649
Note that it is normal for branch to be a RemoteBranch when using tags
1652
return DisabledTags(branch)
1654
def network_name(self):
1655
"""A simple byte string uniquely identifying this format for RPC calls.
1657
MetaDir branch formats use their disk format string to identify the
1658
repository over the wire. All in one formats such as bzr < 0.8, and
1659
foreign formats like svn/git and hg should use some marker which is
1660
unique and immutable.
1662
raise NotImplementedError(self.network_name)
1664
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1665
"""Return the branch object for a_bzrdir
1667
:param a_bzrdir: A BzrDir that contains a branch.
1668
:param name: Name of colocated branch to open
1669
:param _found: a private parameter, do not use it. It is used to
1670
indicate if format probing has already be done.
1671
:param ignore_fallbacks: when set, no fallback branches will be opened
1672
(if there are any). Default is to open fallbacks.
1674
raise NotImplementedError(self.open)
1677
def register_format(klass, format):
1678
"""Register a metadir format."""
1679
klass._formats[format.get_format_string()] = format
1680
# Metadir formats have a network name of their format string, and get
1681
# registered as class factories.
1682
network_format_registry.register(format.get_format_string(), format.__class__)
1685
def set_default_format(klass, format):
1686
klass._default_format = format
1688
def supports_set_append_revisions_only(self):
1689
"""True if this format supports set_append_revisions_only."""
1692
def supports_stacking(self):
1693
"""True if this format records a stacked-on branch."""
1697
def unregister_format(klass, format):
1698
del klass._formats[format.get_format_string()]
1701
return self.get_format_description().rstrip()
1703
def supports_tags(self):
1704
"""True if this format supports tags stored in the branch"""
1705
return False # by default
1708
class BranchHooks(Hooks):
1709
"""A dictionary mapping hook name to a list of callables for branch hooks.
1711
e.g. ['set_rh'] Is the list of items to be called when the
1712
set_revision_history function is invoked.
1716
"""Create the default hooks.
1718
These are all empty initially, because by default nothing should get
1721
Hooks.__init__(self)
1722
self.create_hook(HookPoint('set_rh',
1723
"Invoked whenever the revision history has been set via "
1724
"set_revision_history. The api signature is (branch, "
1725
"revision_history), and the branch will be write-locked. "
1726
"The set_rh hook can be expensive for bzr to trigger, a better "
1727
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1728
self.create_hook(HookPoint('open',
1729
"Called with the Branch object that has been opened after a "
1730
"branch is opened.", (1, 8), None))
1731
self.create_hook(HookPoint('post_push',
1732
"Called after a push operation completes. post_push is called "
1733
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1734
"bzr client.", (0, 15), None))
1735
self.create_hook(HookPoint('post_pull',
1736
"Called after a pull operation completes. post_pull is called "
1737
"with a bzrlib.branch.PullResult object and only runs in the "
1738
"bzr client.", (0, 15), None))
1739
self.create_hook(HookPoint('pre_commit',
1740
"Called after a commit is calculated but before it is is "
1741
"completed. pre_commit is called with (local, master, old_revno, "
1742
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1743
"). old_revid is NULL_REVISION for the first commit to a branch, "
1744
"tree_delta is a TreeDelta object describing changes from the "
1745
"basis revision. hooks MUST NOT modify this delta. "
1746
" future_tree is an in-memory tree obtained from "
1747
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1748
"tree.", (0,91), None))
1749
self.create_hook(HookPoint('post_commit',
1750
"Called in the bzr client after a commit has completed. "
1751
"post_commit is called with (local, master, old_revno, old_revid, "
1752
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1753
"commit to a branch.", (0, 15), None))
1754
self.create_hook(HookPoint('post_uncommit',
1755
"Called in the bzr client after an uncommit completes. "
1756
"post_uncommit is called with (local, master, old_revno, "
1757
"old_revid, new_revno, new_revid) where local is the local branch "
1758
"or None, master is the target branch, and an empty branch "
1759
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1760
self.create_hook(HookPoint('pre_change_branch_tip',
1761
"Called in bzr client and server before a change to the tip of a "
1762
"branch is made. pre_change_branch_tip is called with a "
1763
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1764
"commit, uncommit will all trigger this hook.", (1, 6), None))
1765
self.create_hook(HookPoint('post_change_branch_tip',
1766
"Called in bzr client and server after a change to the tip of a "
1767
"branch is made. post_change_branch_tip is called with a "
1768
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1769
"commit, uncommit will all trigger this hook.", (1, 4), None))
1770
self.create_hook(HookPoint('transform_fallback_location',
1771
"Called when a stacked branch is activating its fallback "
1772
"locations. transform_fallback_location is called with (branch, "
1773
"url), and should return a new url. Returning the same url "
1774
"allows it to be used as-is, returning a different one can be "
1775
"used to cause the branch to stack on a closer copy of that "
1776
"fallback_location. Note that the branch cannot have history "
1777
"accessing methods called on it during this hook because the "
1778
"fallback locations have not been activated. When there are "
1779
"multiple hooks installed for transform_fallback_location, "
1780
"all are called with the url returned from the previous hook."
1781
"The order is however undefined.", (1, 9), None))
1782
self.create_hook(HookPoint('automatic_tag_name',
1783
"Called to determine an automatic tag name for a revision."
1784
"automatic_tag_name is called with (branch, revision_id) and "
1785
"should return a tag name or None if no tag name could be "
1786
"determined. The first non-None tag name returned will be used.",
1788
self.create_hook(HookPoint('post_branch_init',
1789
"Called after new branch initialization completes. "
1790
"post_branch_init is called with a "
1791
"bzrlib.branch.BranchInitHookParams. "
1792
"Note that init, branch and checkout (both heavyweight and "
1793
"lightweight) will all trigger this hook.", (2, 2), None))
1794
self.create_hook(HookPoint('post_switch',
1795
"Called after a checkout switches branch. "
1796
"post_switch is called with a "
1797
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1801
# install the default hooks into the Branch class.
1802
Branch.hooks = BranchHooks()
1805
class ChangeBranchTipParams(object):
1806
"""Object holding parameters passed to *_change_branch_tip hooks.
1808
There are 5 fields that hooks may wish to access:
1810
:ivar branch: the branch being changed
1811
:ivar old_revno: revision number before the change
1812
:ivar new_revno: revision number after the change
1813
:ivar old_revid: revision id before the change
1814
:ivar new_revid: revision id after the change
1816
The revid fields are strings. The revno fields are integers.
1819
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1820
"""Create a group of ChangeBranchTip parameters.
1822
:param branch: The branch being changed.
1823
:param old_revno: Revision number before the change.
1824
:param new_revno: Revision number after the change.
1825
:param old_revid: Tip revision id before the change.
1826
:param new_revid: Tip revision id after the change.
1828
self.branch = branch
1829
self.old_revno = old_revno
1830
self.new_revno = new_revno
1831
self.old_revid = old_revid
1832
self.new_revid = new_revid
1834
def __eq__(self, other):
1835
return self.__dict__ == other.__dict__
1838
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1839
self.__class__.__name__, self.branch,
1840
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1843
class BranchInitHookParams(object):
1844
"""Object holding parameters passed to *_branch_init hooks.
1846
There are 4 fields that hooks may wish to access:
1848
:ivar format: the branch format
1849
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
:ivar name: name of colocated branch, if any (or None)
1851
:ivar branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
the checkout, hence they are different from the corresponding fields in
1855
branch, which refer to the original branch.
1858
def __init__(self, format, a_bzrdir, name, branch):
1859
"""Create a group of BranchInitHook parameters.
1861
:param format: the branch format
1862
:param a_bzrdir: the BzrDir where the branch will be/has been
1864
:param name: name of colocated branch, if any (or None)
1865
:param branch: the branch created
1867
Note that for lightweight checkouts, the bzrdir and format fields refer
1868
to the checkout, hence they are different from the corresponding fields
1869
in branch, which refer to the original branch.
1871
self.format = format
1872
self.bzrdir = a_bzrdir
1874
self.branch = branch
1876
def __eq__(self, other):
1877
return self.__dict__ == other.__dict__
1881
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1883
return "<%s of format:%s bzrdir:%s>" % (
1884
self.__class__.__name__, self.branch,
1885
self.format, self.bzrdir)
1888
class SwitchHookParams(object):
1889
"""Object holding parameters passed to *_switch hooks.
1891
There are 4 fields that hooks may wish to access:
1893
:ivar control_dir: BzrDir of the checkout to change
1894
:ivar to_branch: branch that the checkout is to reference
1895
:ivar force: skip the check for local commits in a heavy checkout
1896
:ivar revision_id: revision ID to switch to (or None)
1899
def __init__(self, control_dir, to_branch, force, revision_id):
1900
"""Create a group of SwitchHook parameters.
1902
:param control_dir: BzrDir of the checkout to change
1903
:param to_branch: branch that the checkout is to reference
1904
:param force: skip the check for local commits in a heavy checkout
1905
:param revision_id: revision ID to switch to (or None)
1907
self.control_dir = control_dir
1908
self.to_branch = to_branch
1910
self.revision_id = revision_id
1912
def __eq__(self, other):
1913
return self.__dict__ == other.__dict__
1916
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
self.control_dir, self.to_branch,
1921
class BzrBranchFormat4(BranchFormat):
1922
"""Bzr branch format 4.
1925
- a revision-history file.
1926
- a branch-lock lock file [ to be shared with the bzrdir ]
1929
def get_format_description(self):
1930
"""See BranchFormat.get_format_description()."""
1931
return "Branch format 4"
1933
def initialize(self, a_bzrdir, name=None):
1934
"""Create a branch of this format in a_bzrdir."""
1935
utf8_files = [('revision-history', ''),
1936
('branch-name', ''),
1938
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1939
lock_type='branch4', set_format=False)
1942
super(BzrBranchFormat4, self).__init__()
1943
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1945
def network_name(self):
1946
"""The network name for this format is the control dirs disk label."""
1947
return self._matchingbzrdir.get_format_string()
1949
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1950
"""See BranchFormat.open()."""
1952
# we are being called directly and must probe.
1953
raise NotImplementedError
1954
return BzrBranch(_format=self,
1955
_control_files=a_bzrdir._control_files,
1958
_repository=a_bzrdir.open_repository())
1961
return "Bazaar-NG branch format 4"
1964
class BranchFormatMetadir(BranchFormat):
1965
"""Common logic for meta-dir based branch formats."""
1967
def _branch_class(self):
1968
"""What class to instantiate on open calls."""
1969
raise NotImplementedError(self._branch_class)
1971
def network_name(self):
1972
"""A simple byte string uniquely identifying this format for RPC calls.
1974
Metadir branch formats use their format string.
1976
return self.get_format_string()
1978
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1979
"""See BranchFormat.open()."""
1981
format = BranchFormat.find_format(a_bzrdir, name=name)
1982
if format.__class__ != self.__class__:
1983
raise AssertionError("wrong format %r found for %r" %
1985
transport = a_bzrdir.get_branch_transport(None, name=name)
1987
control_files = lockable_files.LockableFiles(transport, 'lock',
1989
return self._branch_class()(_format=self,
1990
_control_files=control_files,
1993
_repository=a_bzrdir.find_repository(),
1994
ignore_fallbacks=ignore_fallbacks)
1995
except errors.NoSuchFile:
1996
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1999
super(BranchFormatMetadir, self).__init__()
2000
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2001
self._matchingbzrdir.set_branch_format(self)
2003
def supports_tags(self):
2007
class BzrBranchFormat5(BranchFormatMetadir):
2008
"""Bzr branch format 5.
2011
- a revision-history file.
2013
- a lock dir guarding the branch itself
2014
- all of this stored in a branch/ subdirectory
2015
- works with shared repositories.
2017
This format is new in bzr 0.8.
2020
def _branch_class(self):
2023
def get_format_string(self):
2024
"""See BranchFormat.get_format_string()."""
2025
return "Bazaar-NG branch format 5\n"
2027
def get_format_description(self):
2028
"""See BranchFormat.get_format_description()."""
2029
return "Branch format 5"
2031
def initialize(self, a_bzrdir, name=None):
2032
"""Create a branch of this format in a_bzrdir."""
2033
utf8_files = [('revision-history', ''),
2034
('branch-name', ''),
2036
return self._initialize_helper(a_bzrdir, utf8_files, name)
2038
def supports_tags(self):
2042
class BzrBranchFormat6(BranchFormatMetadir):
2043
"""Branch format with last-revision and tags.
2045
Unlike previous formats, this has no explicit revision history. Instead,
2046
this just stores the last-revision, and the left-hand history leading
2047
up to there is the history.
2049
This format was introduced in bzr 0.15
2050
and became the default in 0.91.
2053
def _branch_class(self):
2056
def get_format_string(self):
2057
"""See BranchFormat.get_format_string()."""
2058
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2060
def get_format_description(self):
2061
"""See BranchFormat.get_format_description()."""
2062
return "Branch format 6"
2064
def initialize(self, a_bzrdir, name=None):
2065
"""Create a branch of this format in a_bzrdir."""
2066
utf8_files = [('last-revision', '0 null:\n'),
2067
('branch.conf', ''),
2070
return self._initialize_helper(a_bzrdir, utf8_files, name)
2072
def make_tags(self, branch):
2073
"""See bzrlib.branch.BranchFormat.make_tags()."""
2074
return BasicTags(branch)
2076
def supports_set_append_revisions_only(self):
2080
class BzrBranchFormat8(BranchFormatMetadir):
2081
"""Metadir format supporting storing locations of subtree branches."""
2083
def _branch_class(self):
2086
def get_format_string(self):
2087
"""See BranchFormat.get_format_string()."""
2088
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2090
def get_format_description(self):
2091
"""See BranchFormat.get_format_description()."""
2092
return "Branch format 8"
2094
def initialize(self, a_bzrdir, name=None):
2095
"""Create a branch of this format in a_bzrdir."""
2096
utf8_files = [('last-revision', '0 null:\n'),
2097
('branch.conf', ''),
2101
return self._initialize_helper(a_bzrdir, utf8_files, name)
2104
super(BzrBranchFormat8, self).__init__()
2105
self._matchingbzrdir.repository_format = \
2106
RepositoryFormatKnitPack5RichRoot()
2108
def make_tags(self, branch):
2109
"""See bzrlib.branch.BranchFormat.make_tags()."""
2110
return BasicTags(branch)
2112
def supports_set_append_revisions_only(self):
2115
def supports_stacking(self):
2118
supports_reference_locations = True
2121
class BzrBranchFormat7(BzrBranchFormat8):
2122
"""Branch format with last-revision, tags, and a stacked location pointer.
2124
The stacked location pointer is passed down to the repository and requires
2125
a repository format with supports_external_lookups = True.
2127
This format was introduced in bzr 1.6.
2130
def initialize(self, a_bzrdir, name=None):
2131
"""Create a branch of this format in a_bzrdir."""
2132
utf8_files = [('last-revision', '0 null:\n'),
2133
('branch.conf', ''),
2136
return self._initialize_helper(a_bzrdir, utf8_files, name)
2138
def _branch_class(self):
2141
def get_format_string(self):
2142
"""See BranchFormat.get_format_string()."""
2143
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2145
def get_format_description(self):
2146
"""See BranchFormat.get_format_description()."""
2147
return "Branch format 7"
2149
def supports_set_append_revisions_only(self):
2152
supports_reference_locations = False
2155
class BranchReferenceFormat(BranchFormat):
2156
"""Bzr branch reference format.
2158
Branch references are used in implementing checkouts, they
2159
act as an alias to the real branch which is at some other url.
2166
def get_format_string(self):
2167
"""See BranchFormat.get_format_string()."""
2168
return "Bazaar-NG Branch Reference Format 1\n"
2170
def get_format_description(self):
2171
"""See BranchFormat.get_format_description()."""
2172
return "Checkout reference format 1"
2174
def get_reference(self, a_bzrdir, name=None):
2175
"""See BranchFormat.get_reference()."""
2176
transport = a_bzrdir.get_branch_transport(None, name=name)
2177
return transport.get_bytes('location')
2179
def set_reference(self, a_bzrdir, name, to_branch):
2180
"""See BranchFormat.set_reference()."""
2181
transport = a_bzrdir.get_branch_transport(None, name=name)
2182
location = transport.put_bytes('location', to_branch.base)
2184
def initialize(self, a_bzrdir, name=None, target_branch=None):
2185
"""Create a branch of this format in a_bzrdir."""
2186
if target_branch is None:
2187
# this format does not implement branch itself, thus the implicit
2188
# creation contract must see it as uninitializable
2189
raise errors.UninitializableFormat(self)
2190
mutter('creating branch reference in %s', a_bzrdir.user_url)
2191
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2192
branch_transport.put_bytes('location',
2193
target_branch.bzrdir.user_url)
2194
branch_transport.put_bytes('format', self.get_format_string())
2196
a_bzrdir, name, _found=True,
2197
possible_transports=[target_branch.bzrdir.root_transport])
2198
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2202
super(BranchReferenceFormat, self).__init__()
2203
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2204
self._matchingbzrdir.set_branch_format(self)
2206
def _make_reference_clone_function(format, a_branch):
2207
"""Create a clone() routine for a branch dynamically."""
2208
def clone(to_bzrdir, revision_id=None,
2209
repository_policy=None):
2210
"""See Branch.clone()."""
2211
return format.initialize(to_bzrdir, target_branch=a_branch)
2212
# cannot obey revision_id limits when cloning a reference ...
2213
# FIXME RBC 20060210 either nuke revision_id for clone, or
2214
# emit some sort of warning/error to the caller ?!
2217
def open(self, a_bzrdir, name=None, _found=False, location=None,
2218
possible_transports=None, ignore_fallbacks=False):
2219
"""Return the branch that the branch reference in a_bzrdir points at.
2221
:param a_bzrdir: A BzrDir that contains a branch.
2222
:param name: Name of colocated branch to open, if any
2223
:param _found: a private parameter, do not use it. It is used to
2224
indicate if format probing has already be done.
2225
:param ignore_fallbacks: when set, no fallback branches will be opened
2226
(if there are any). Default is to open fallbacks.
2227
:param location: The location of the referenced branch. If
2228
unspecified, this will be determined from the branch reference in
2230
:param possible_transports: An optional reusable transports list.
2233
format = BranchFormat.find_format(a_bzrdir, name=name)
2234
if format.__class__ != self.__class__:
2235
raise AssertionError("wrong format %r found for %r" %
2237
if location is None:
2238
location = self.get_reference(a_bzrdir, name)
2239
real_bzrdir = bzrdir.BzrDir.open(
2240
location, possible_transports=possible_transports)
2241
result = real_bzrdir.open_branch(name=name,
2242
ignore_fallbacks=ignore_fallbacks)
2243
# this changes the behaviour of result.clone to create a new reference
2244
# rather than a copy of the content of the branch.
2245
# I did not use a proxy object because that needs much more extensive
2246
# testing, and we are only changing one behaviour at the moment.
2247
# If we decide to alter more behaviours - i.e. the implicit nickname
2248
# then this should be refactored to introduce a tested proxy branch
2249
# and a subclass of that for use in overriding clone() and ....
2251
result.clone = self._make_reference_clone_function(result)
2255
network_format_registry = registry.FormatRegistry()
2256
"""Registry of formats indexed by their network name.
2258
The network name for a branch format is an identifier that can be used when
2259
referring to formats with smart server operations. See
2260
BranchFormat.network_name() for more detail.
2264
# formats which have no format string are not discoverable
2265
# and not independently creatable, so are not registered.
2266
__format5 = BzrBranchFormat5()
2267
__format6 = BzrBranchFormat6()
2268
__format7 = BzrBranchFormat7()
2269
__format8 = BzrBranchFormat8()
2270
BranchFormat.register_format(__format5)
2271
BranchFormat.register_format(BranchReferenceFormat())
2272
BranchFormat.register_format(__format6)
2273
BranchFormat.register_format(__format7)
2274
BranchFormat.register_format(__format8)
2275
BranchFormat.set_default_format(__format7)
2276
_legacy_formats = [BzrBranchFormat4(),
2278
network_format_registry.register(
2279
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2282
class BranchWriteLockResult(LogicalLockResult):
2283
"""The result of write locking a branch.
2285
:ivar branch_token: The token obtained from the underlying branch lock, or
2287
:ivar unlock: A callable which will unlock the lock.
2290
def __init__(self, unlock, branch_token):
2291
LogicalLockResult.__init__(self, unlock)
2292
self.branch_token = branch_token
2295
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2299
class BzrBranch(Branch, _RelockDebugMixin):
2300
"""A branch stored in the actual filesystem.
2302
Note that it's "local" in the context of the filesystem; it doesn't
2303
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2304
it's writable, and can be accessed via the normal filesystem API.
2306
:ivar _transport: Transport for file operations on this branch's
2307
control files, typically pointing to the .bzr/branch directory.
2308
:ivar repository: Repository for this branch.
2309
:ivar base: The url of the base directory for this branch; the one
2310
containing the .bzr directory.
2311
:ivar name: Optional colocated branch name as it exists in the control
2315
def __init__(self, _format=None,
2316
_control_files=None, a_bzrdir=None, name=None,
2317
_repository=None, ignore_fallbacks=False):
2318
"""Create new branch object at a particular location."""
2319
if a_bzrdir is None:
2320
raise ValueError('a_bzrdir must be supplied')
2322
self.bzrdir = a_bzrdir
2323
self._base = self.bzrdir.transport.clone('..').base
2325
# XXX: We should be able to just do
2326
# self.base = self.bzrdir.root_transport.base
2327
# but this does not quite work yet -- mbp 20080522
2328
self._format = _format
2329
if _control_files is None:
2330
raise ValueError('BzrBranch _control_files is None')
2331
self.control_files = _control_files
2332
self._transport = _control_files._transport
2333
self.repository = _repository
2334
Branch.__init__(self)
2337
if self.name is None:
2338
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2340
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2345
def _get_base(self):
2346
"""Returns the directory containing the control directory."""
2349
base = property(_get_base, doc="The URL for the root of this branch.")
2351
def _get_config(self):
2352
return TransportConfig(self._transport, 'branch.conf')
2354
def is_locked(self):
2355
return self.control_files.is_locked()
2357
def lock_write(self, token=None):
2358
"""Lock the branch for write operations.
2360
:param token: A token to permit reacquiring a previously held and
2362
:return: A BranchWriteLockResult.
2364
if not self.is_locked():
2365
self._note_lock('w')
2366
# All-in-one needs to always unlock/lock.
2367
repo_control = getattr(self.repository, 'control_files', None)
2368
if self.control_files == repo_control or not self.is_locked():
2369
self.repository._warn_if_deprecated(self)
2370
self.repository.lock_write()
2375
return BranchWriteLockResult(self.unlock,
2376
self.control_files.lock_write(token=token))
2379
self.repository.unlock()
2382
def lock_read(self):
2383
"""Lock the branch for read operations.
2385
:return: A bzrlib.lock.LogicalLockResult.
2387
if not self.is_locked():
2388
self._note_lock('r')
2389
# All-in-one needs to always unlock/lock.
2390
repo_control = getattr(self.repository, 'control_files', None)
2391
if self.control_files == repo_control or not self.is_locked():
2392
self.repository._warn_if_deprecated(self)
2393
self.repository.lock_read()
2398
self.control_files.lock_read()
2399
return LogicalLockResult(self.unlock)
2402
self.repository.unlock()
2405
@only_raises(errors.LockNotHeld, errors.LockBroken)
2408
self.control_files.unlock()
2410
# All-in-one needs to always unlock/lock.
2411
repo_control = getattr(self.repository, 'control_files', None)
2412
if (self.control_files == repo_control or
2413
not self.control_files.is_locked()):
2414
self.repository.unlock()
2415
if not self.control_files.is_locked():
2416
# we just released the lock
2417
self._clear_cached_state()
2419
def peek_lock_mode(self):
2420
if self.control_files._lock_count == 0:
2423
return self.control_files._lock_mode
2425
def get_physical_lock_status(self):
2426
return self.control_files.get_physical_lock_status()
2429
def print_file(self, file, revision_id):
2430
"""See Branch.print_file."""
2431
return self.repository.print_file(file, revision_id)
2433
def _write_revision_history(self, history):
2434
"""Factored out of set_revision_history.
2436
This performs the actual writing to disk.
2437
It is intended to be called by BzrBranch5.set_revision_history."""
2438
self._transport.put_bytes(
2439
'revision-history', '\n'.join(history),
2440
mode=self.bzrdir._get_file_mode())
2443
def set_revision_history(self, rev_history):
2444
"""See Branch.set_revision_history."""
2445
if 'evil' in debug.debug_flags:
2446
mutter_callsite(3, "set_revision_history scales with history.")
2447
check_not_reserved_id = _mod_revision.check_not_reserved_id
2448
for rev_id in rev_history:
2449
check_not_reserved_id(rev_id)
2450
if Branch.hooks['post_change_branch_tip']:
2451
# Don't calculate the last_revision_info() if there are no hooks
2453
old_revno, old_revid = self.last_revision_info()
2454
if len(rev_history) == 0:
2455
revid = _mod_revision.NULL_REVISION
2457
revid = rev_history[-1]
2458
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2459
self._write_revision_history(rev_history)
2460
self._clear_cached_state()
2461
self._cache_revision_history(rev_history)
2462
for hook in Branch.hooks['set_rh']:
2463
hook(self, rev_history)
2464
if Branch.hooks['post_change_branch_tip']:
2465
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2467
def _synchronize_history(self, destination, revision_id):
2468
"""Synchronize last revision and revision history between branches.
2470
This version is most efficient when the destination is also a
2471
BzrBranch5, but works for BzrBranch6 as long as the revision
2472
history is the true lefthand parent history, and all of the revisions
2473
are in the destination's repository. If not, set_revision_history
2476
:param destination: The branch to copy the history into
2477
:param revision_id: The revision-id to truncate history at. May
2478
be None to copy complete history.
2480
if not isinstance(destination._format, BzrBranchFormat5):
2481
super(BzrBranch, self)._synchronize_history(
2482
destination, revision_id)
2484
if revision_id == _mod_revision.NULL_REVISION:
2487
new_history = self.revision_history()
2488
if revision_id is not None and new_history != []:
2490
new_history = new_history[:new_history.index(revision_id) + 1]
2492
rev = self.repository.get_revision(revision_id)
2493
new_history = rev.get_history(self.repository)[1:]
2494
destination.set_revision_history(new_history)
2497
def set_last_revision_info(self, revno, revision_id):
2498
"""Set the last revision of this branch.
2500
The caller is responsible for checking that the revno is correct
2501
for this revision id.
2503
It may be possible to set the branch last revision to an id not
2504
present in the repository. However, branches can also be
2505
configured to check constraints on history, in which case this may not
2508
revision_id = _mod_revision.ensure_null(revision_id)
2509
# this old format stores the full history, but this api doesn't
2510
# provide it, so we must generate, and might as well check it's
2512
history = self._lefthand_history(revision_id)
2513
if len(history) != revno:
2514
raise AssertionError('%d != %d' % (len(history), revno))
2515
self.set_revision_history(history)
2517
def _gen_revision_history(self):
2518
history = self._transport.get_bytes('revision-history').split('\n')
2519
if history[-1:] == ['']:
2520
# There shouldn't be a trailing newline, but just in case.
2525
def generate_revision_history(self, revision_id, last_rev=None,
2527
"""Create a new revision history that will finish with revision_id.
2529
:param revision_id: the new tip to use.
2530
:param last_rev: The previous last_revision. If not None, then this
2531
must be a ancestory of revision_id, or DivergedBranches is raised.
2532
:param other_branch: The other branch that DivergedBranches should
2533
raise with respect to.
2535
self.set_revision_history(self._lefthand_history(revision_id,
2536
last_rev, other_branch))
2538
def basis_tree(self):
2539
"""See Branch.basis_tree."""
2540
return self.repository.revision_tree(self.last_revision())
2542
def _get_parent_location(self):
2543
_locs = ['parent', 'pull', 'x-pull']
2546
return self._transport.get_bytes(l).strip('\n')
2547
except errors.NoSuchFile:
2551
def _basic_push(self, target, overwrite, stop_revision):
2552
"""Basic implementation of push without bound branches or hooks.
2554
Must be called with source read locked and target write locked.
2556
result = BranchPushResult()
2557
result.source_branch = self
2558
result.target_branch = target
2559
result.old_revno, result.old_revid = target.last_revision_info()
2560
self.update_references(target)
2561
if result.old_revid != self.last_revision():
2562
# We assume that during 'push' this repository is closer than
2564
graph = self.repository.get_graph(target.repository)
2565
target.update_revisions(self, stop_revision,
2566
overwrite=overwrite, graph=graph)
2567
if self._push_should_merge_tags():
2568
result.tag_conflicts = self.tags.merge_to(target.tags,
2570
result.new_revno, result.new_revid = target.last_revision_info()
2573
def get_stacked_on_url(self):
2574
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2576
def set_push_location(self, location):
2577
"""See Branch.set_push_location."""
2578
self.get_config().set_user_option(
2579
'push_location', location,
2580
store=_mod_config.STORE_LOCATION_NORECURSE)
2582
def _set_parent_location(self, url):
2584
self._transport.delete('parent')
2586
self._transport.put_bytes('parent', url + '\n',
2587
mode=self.bzrdir._get_file_mode())
2590
class BzrBranch5(BzrBranch):
2591
"""A format 5 branch. This supports new features over plain branches.
2593
It has support for a master_branch which is the data for bound branches.
2596
def get_bound_location(self):
2598
return self._transport.get_bytes('bound')[:-1]
2599
except errors.NoSuchFile:
2603
def get_master_branch(self, possible_transports=None):
2604
"""Return the branch we are bound to.
2606
:return: Either a Branch, or None
2608
This could memoise the branch, but if thats done
2609
it must be revalidated on each new lock.
2610
So for now we just don't memoise it.
2611
# RBC 20060304 review this decision.
2613
bound_loc = self.get_bound_location()
2617
return Branch.open(bound_loc,
2618
possible_transports=possible_transports)
2619
except (errors.NotBranchError, errors.ConnectionError), e:
2620
raise errors.BoundBranchConnectionFailure(
2624
def set_bound_location(self, location):
2625
"""Set the target where this branch is bound to.
2627
:param location: URL to the target branch
2630
self._transport.put_bytes('bound', location+'\n',
2631
mode=self.bzrdir._get_file_mode())
2634
self._transport.delete('bound')
2635
except errors.NoSuchFile:
2640
def bind(self, other):
2641
"""Bind this branch to the branch other.
2643
This does not push or pull data between the branches, though it does
2644
check for divergence to raise an error when the branches are not
2645
either the same, or one a prefix of the other. That behaviour may not
2646
be useful, so that check may be removed in future.
2648
:param other: The branch to bind to
2651
# TODO: jam 20051230 Consider checking if the target is bound
2652
# It is debatable whether you should be able to bind to
2653
# a branch which is itself bound.
2654
# Committing is obviously forbidden,
2655
# but binding itself may not be.
2656
# Since we *have* to check at commit time, we don't
2657
# *need* to check here
2659
# we want to raise diverged if:
2660
# last_rev is not in the other_last_rev history, AND
2661
# other_last_rev is not in our history, and do it without pulling
2663
self.set_bound_location(other.base)
2667
"""If bound, unbind"""
2668
return self.set_bound_location(None)
2671
def update(self, possible_transports=None):
2672
"""Synchronise this branch with the master branch if any.
2674
:return: None or the last_revision that was pivoted out during the
2677
master = self.get_master_branch(possible_transports)
2678
if master is not None:
2679
old_tip = _mod_revision.ensure_null(self.last_revision())
2680
self.pull(master, overwrite=True)
2681
if self.repository.get_graph().is_ancestor(old_tip,
2682
_mod_revision.ensure_null(self.last_revision())):
2688
class BzrBranch8(BzrBranch5):
2689
"""A branch that stores tree-reference locations."""
2691
def _open_hook(self):
2692
if self._ignore_fallbacks:
2695
url = self.get_stacked_on_url()
2696
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2697
errors.UnstackableBranchFormat):
2700
for hook in Branch.hooks['transform_fallback_location']:
2701
url = hook(self, url)
2703
hook_name = Branch.hooks.get_hook_name(hook)
2704
raise AssertionError(
2705
"'transform_fallback_location' hook %s returned "
2706
"None, not a URL." % hook_name)
2707
self._activate_fallback_location(url)
2709
def __init__(self, *args, **kwargs):
2710
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2711
super(BzrBranch8, self).__init__(*args, **kwargs)
2712
self._last_revision_info_cache = None
2713
self._reference_info = None
2715
def _clear_cached_state(self):
2716
super(BzrBranch8, self)._clear_cached_state()
2717
self._last_revision_info_cache = None
2718
self._reference_info = None
2720
def _last_revision_info(self):
2721
revision_string = self._transport.get_bytes('last-revision')
2722
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2723
revision_id = cache_utf8.get_cached_utf8(revision_id)
2725
return revno, revision_id
2727
def _write_last_revision_info(self, revno, revision_id):
2728
"""Simply write out the revision id, with no checks.
2730
Use set_last_revision_info to perform this safely.
2732
Does not update the revision_history cache.
2733
Intended to be called by set_last_revision_info and
2734
_write_revision_history.
2736
revision_id = _mod_revision.ensure_null(revision_id)
2737
out_string = '%d %s\n' % (revno, revision_id)
2738
self._transport.put_bytes('last-revision', out_string,
2739
mode=self.bzrdir._get_file_mode())
2742
def set_last_revision_info(self, revno, revision_id):
2743
revision_id = _mod_revision.ensure_null(revision_id)
2744
old_revno, old_revid = self.last_revision_info()
2745
if self._get_append_revisions_only():
2746
self._check_history_violation(revision_id)
2747
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2748
self._write_last_revision_info(revno, revision_id)
2749
self._clear_cached_state()
2750
self._last_revision_info_cache = revno, revision_id
2751
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2753
def _synchronize_history(self, destination, revision_id):
2754
"""Synchronize last revision and revision history between branches.
2756
:see: Branch._synchronize_history
2758
# XXX: The base Branch has a fast implementation of this method based
2759
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2760
# that uses set_revision_history. This class inherits from BzrBranch5,
2761
# but wants the fast implementation, so it calls
2762
# Branch._synchronize_history directly.
2763
Branch._synchronize_history(self, destination, revision_id)
2765
def _check_history_violation(self, revision_id):
2766
last_revision = _mod_revision.ensure_null(self.last_revision())
2767
if _mod_revision.is_null(last_revision):
2769
if last_revision not in self._lefthand_history(revision_id):
2770
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2772
def _gen_revision_history(self):
2773
"""Generate the revision history from last revision
2775
last_revno, last_revision = self.last_revision_info()
2776
self._extend_partial_history(stop_index=last_revno-1)
2777
return list(reversed(self._partial_revision_history_cache))
2779
def _write_revision_history(self, history):
2780
"""Factored out of set_revision_history.
2782
This performs the actual writing to disk, with format-specific checks.
2783
It is intended to be called by BzrBranch5.set_revision_history.
2785
if len(history) == 0:
2786
last_revision = 'null:'
2788
if history != self._lefthand_history(history[-1]):
2789
raise errors.NotLefthandHistory(history)
2790
last_revision = history[-1]
2791
if self._get_append_revisions_only():
2792
self._check_history_violation(last_revision)
2793
self._write_last_revision_info(len(history), last_revision)
2796
def _set_parent_location(self, url):
2797
"""Set the parent branch"""
2798
self._set_config_location('parent_location', url, make_relative=True)
2801
def _get_parent_location(self):
2802
"""Set the parent branch"""
2803
return self._get_config_location('parent_location')
2806
def _set_all_reference_info(self, info_dict):
2807
"""Replace all reference info stored in a branch.
2809
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2812
writer = rio.RioWriter(s)
2813
for key, (tree_path, branch_location) in info_dict.iteritems():
2814
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2815
branch_location=branch_location)
2816
writer.write_stanza(stanza)
2817
self._transport.put_bytes('references', s.getvalue())
2818
self._reference_info = info_dict
2821
def _get_all_reference_info(self):
2822
"""Return all the reference info stored in a branch.
2824
:return: A dict of {file_id: (tree_path, branch_location)}
2826
if self._reference_info is not None:
2827
return self._reference_info
2828
rio_file = self._transport.get('references')
2830
stanzas = rio.read_stanzas(rio_file)
2831
info_dict = dict((s['file_id'], (s['tree_path'],
2832
s['branch_location'])) for s in stanzas)
2835
self._reference_info = info_dict
2838
def set_reference_info(self, file_id, tree_path, branch_location):
2839
"""Set the branch location to use for a tree reference.
2841
:param file_id: The file-id of the tree reference.
2842
:param tree_path: The path of the tree reference in the tree.
2843
:param branch_location: The location of the branch to retrieve tree
2846
info_dict = self._get_all_reference_info()
2847
info_dict[file_id] = (tree_path, branch_location)
2848
if None in (tree_path, branch_location):
2849
if tree_path is not None:
2850
raise ValueError('tree_path must be None when branch_location'
2852
if branch_location is not None:
2853
raise ValueError('branch_location must be None when tree_path'
2855
del info_dict[file_id]
2856
self._set_all_reference_info(info_dict)
2858
def get_reference_info(self, file_id):
2859
"""Get the tree_path and branch_location for a tree reference.
2861
:return: a tuple of (tree_path, branch_location)
2863
return self._get_all_reference_info().get(file_id, (None, None))
2865
def reference_parent(self, file_id, path, possible_transports=None):
2866
"""Return the parent branch for a tree-reference file_id.
2868
:param file_id: The file_id of the tree reference
2869
:param path: The path of the file_id in the tree
2870
:return: A branch associated with the file_id
2872
branch_location = self.get_reference_info(file_id)[1]
2873
if branch_location is None:
2874
return Branch.reference_parent(self, file_id, path,
2875
possible_transports)
2876
branch_location = urlutils.join(self.user_url, branch_location)
2877
return Branch.open(branch_location,
2878
possible_transports=possible_transports)
2880
def set_push_location(self, location):
2881
"""See Branch.set_push_location."""
2882
self._set_config_location('push_location', location)
2884
def set_bound_location(self, location):
2885
"""See Branch.set_push_location."""
2887
config = self.get_config()
2888
if location is None:
2889
if config.get_user_option('bound') != 'True':
2892
config.set_user_option('bound', 'False', warn_masked=True)
2895
self._set_config_location('bound_location', location,
2897
config.set_user_option('bound', 'True', warn_masked=True)
2900
def _get_bound_location(self, bound):
2901
"""Return the bound location in the config file.
2903
Return None if the bound parameter does not match"""
2904
config = self.get_config()
2905
config_bound = (config.get_user_option('bound') == 'True')
2906
if config_bound != bound:
2908
return self._get_config_location('bound_location', config=config)
2910
def get_bound_location(self):
2911
"""See Branch.set_push_location."""
2912
return self._get_bound_location(True)
2914
def get_old_bound_location(self):
2915
"""See Branch.get_old_bound_location"""
2916
return self._get_bound_location(False)
2918
def get_stacked_on_url(self):
2919
# you can always ask for the URL; but you might not be able to use it
2920
# if the repo can't support stacking.
2921
## self._check_stackable_repo()
2922
stacked_url = self._get_config_location('stacked_on_location')
2923
if stacked_url is None:
2924
raise errors.NotStacked(self)
2927
def _get_append_revisions_only(self):
2928
return self.get_config(
2929
).get_user_option_as_bool('append_revisions_only')
2932
def generate_revision_history(self, revision_id, last_rev=None,
2934
"""See BzrBranch5.generate_revision_history"""
2935
history = self._lefthand_history(revision_id, last_rev, other_branch)
2936
revno = len(history)
2937
self.set_last_revision_info(revno, revision_id)
2940
def get_rev_id(self, revno, history=None):
2941
"""Find the revision id of the specified revno."""
2943
return _mod_revision.NULL_REVISION
2945
last_revno, last_revision_id = self.last_revision_info()
2946
if revno <= 0 or revno > last_revno:
2947
raise errors.NoSuchRevision(self, revno)
2949
if history is not None:
2950
return history[revno - 1]
2952
index = last_revno - revno
2953
if len(self._partial_revision_history_cache) <= index:
2954
self._extend_partial_history(stop_index=index)
2955
if len(self._partial_revision_history_cache) > index:
2956
return self._partial_revision_history_cache[index]
2958
raise errors.NoSuchRevision(self, revno)
2961
def revision_id_to_revno(self, revision_id):
2962
"""Given a revision id, return its revno"""
2963
if _mod_revision.is_null(revision_id):
2966
index = self._partial_revision_history_cache.index(revision_id)
2968
self._extend_partial_history(stop_revision=revision_id)
2969
index = len(self._partial_revision_history_cache) - 1
2970
if self._partial_revision_history_cache[index] != revision_id:
2971
raise errors.NoSuchRevision(self, revision_id)
2972
return self.revno() - index
2975
class BzrBranch7(BzrBranch8):
2976
"""A branch with support for a fallback repository."""
2978
def set_reference_info(self, file_id, tree_path, branch_location):
2979
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2981
def get_reference_info(self, file_id):
2982
Branch.get_reference_info(self, file_id)
2984
def reference_parent(self, file_id, path, possible_transports=None):
2985
return Branch.reference_parent(self, file_id, path,
2986
possible_transports)
2989
class BzrBranch6(BzrBranch7):
2990
"""See BzrBranchFormat6 for the capabilities of this branch.
2992
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2996
def get_stacked_on_url(self):
2997
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1258
raise InvalidRevisionNumber(revno)
1264
class ScratchBranch(_Branch):
1265
"""Special test class: a branch that cleans up after itself.
1267
>>> b = ScratchBranch()
1275
def __init__(self, files=[], dirs=[], base=None):
1276
"""Make a test branch.
1278
This creates a temporary directory and runs init-tree in it.
1280
If any files are listed, they are created in the working copy.
1282
from tempfile import mkdtemp
1287
if isinstance(base, basestring):
1288
base = get_transport(base)
1289
_Branch.__init__(self, base, init=init)
1291
self._transport.mkdir(d)
1294
self._transport.put(f, 'content of %s' % f)
1299
>>> orig = ScratchBranch(files=["file1", "file2"])
1300
>>> clone = orig.clone()
1301
>>> if os.name != 'nt':
1302
... os.path.samefile(orig.base, clone.base)
1304
... orig.base == clone.base
1307
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1310
from shutil import copytree
1311
from tempfile import mkdtemp
1314
copytree(self.base, base, symlinks=True)
1315
return ScratchBranch(base=base)
1321
"""Destroy the test branch, removing the scratch directory."""
1322
from shutil import rmtree
1325
mutter("delete ScratchBranch %s" % self.base)
1328
# Work around for shutil.rmtree failing on Windows when
1329
# readonly files are encountered
1330
mutter("hit exception in destroying ScratchBranch: %s" % e)
1331
for root, dirs, files in os.walk(self.base, topdown=False):
1333
os.chmod(os.path.join(root, name), 0700)
1335
self._transport = None
3000
1339
######################################################################
3001
# results of operations
3004
class _Result(object):
3006
def _show_tag_conficts(self, to_file):
3007
if not getattr(self, 'tag_conflicts', None):
3009
to_file.write('Conflicting tags:\n')
3010
for name, value1, value2 in self.tag_conflicts:
3011
to_file.write(' %s\n' % (name, ))
3014
class PullResult(_Result):
3015
"""Result of a Branch.pull operation.
3017
:ivar old_revno: Revision number before pull.
3018
:ivar new_revno: Revision number after pull.
3019
:ivar old_revid: Tip revision id before pull.
3020
:ivar new_revid: Tip revision id after pull.
3021
:ivar source_branch: Source (local) branch object. (read locked)
3022
:ivar master_branch: Master branch of the target, or the target if no
3024
:ivar local_branch: target branch if there is a Master, else None
3025
:ivar target_branch: Target/destination branch object. (write locked)
3026
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3030
# DEPRECATED: pull used to return the change in revno
3031
return self.new_revno - self.old_revno
3033
def report(self, to_file):
3035
if self.old_revid == self.new_revid:
3036
to_file.write('No revisions to pull.\n')
3038
to_file.write('Now on revision %d.\n' % self.new_revno)
3039
self._show_tag_conficts(to_file)
3042
class BranchPushResult(_Result):
3043
"""Result of a Branch.push operation.
3045
:ivar old_revno: Revision number (eg 10) of the target before push.
3046
:ivar new_revno: Revision number (eg 12) of the target after push.
3047
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3049
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3051
:ivar source_branch: Source branch object that the push was from. This is
3052
read locked, and generally is a local (and thus low latency) branch.
3053
:ivar master_branch: If target is a bound branch, the master branch of
3054
target, or target itself. Always write locked.
3055
:ivar target_branch: The direct Branch where data is being sent (write
3057
:ivar local_branch: If the target is a bound branch this will be the
3058
target, otherwise it will be None.
3062
# DEPRECATED: push used to return the change in revno
3063
return self.new_revno - self.old_revno
3065
def report(self, to_file):
3066
"""Write a human-readable description of the result."""
3067
if self.old_revid == self.new_revid:
3068
note('No new revisions to push.')
3070
note('Pushed up to revision %d.' % self.new_revno)
3071
self._show_tag_conficts(to_file)
3074
class BranchCheckResult(object):
3075
"""Results of checking branch consistency.
3080
def __init__(self, branch):
3081
self.branch = branch
3084
def report_results(self, verbose):
3085
"""Report the check results via trace.note.
3087
:param verbose: Requests more detailed display of what was checked,
3090
note('checked branch %s format %s', self.branch.user_url,
3091
self.branch._format)
3092
for error in self.errors:
3093
note('found error:%s', error)
3096
class Converter5to6(object):
3097
"""Perform an in-place upgrade of format 5 to format 6"""
3099
def convert(self, branch):
3100
# Data for 5 and 6 can peacefully coexist.
3101
format = BzrBranchFormat6()
3102
new_branch = format.open(branch.bzrdir, _found=True)
3104
# Copy source data into target
3105
new_branch._write_last_revision_info(*branch.last_revision_info())
3106
new_branch.set_parent(branch.get_parent())
3107
new_branch.set_bound_location(branch.get_bound_location())
3108
new_branch.set_push_location(branch.get_push_location())
3110
# New branch has no tags by default
3111
new_branch.tags._set_tag_dict({})
3113
# Copying done; now update target format
3114
new_branch._transport.put_bytes('format',
3115
format.get_format_string(),
3116
mode=new_branch.bzrdir._get_file_mode())
3118
# Clean up old files
3119
new_branch._transport.delete('revision-history')
3121
branch.set_parent(None)
3122
except errors.NoSuchFile:
3124
branch.set_bound_location(None)
3127
class Converter6to7(object):
3128
"""Perform an in-place upgrade of format 6 to format 7"""
3130
def convert(self, branch):
3131
format = BzrBranchFormat7()
3132
branch._set_config_location('stacked_on_location', '')
3133
# update target format
3134
branch._transport.put_bytes('format', format.get_format_string())
3137
class Converter7to8(object):
3138
"""Perform an in-place upgrade of format 6 to format 7"""
3140
def convert(self, branch):
3141
format = BzrBranchFormat8()
3142
branch._transport.put_bytes('references', '')
3143
# update target format
3144
branch._transport.put_bytes('format', format.get_format_string())
3147
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3148
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3151
_run_with_write_locked_target will attempt to release the lock it acquires.
3153
If an exception is raised by callable, then that exception *will* be
3154
propagated, even if the unlock attempt raises its own error. Thus
3155
_run_with_write_locked_target should be preferred to simply doing::
3159
return callable(*args, **kwargs)
3164
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3165
# should share code?
3168
result = callable(*args, **kwargs)
3170
exc_info = sys.exc_info()
3174
raise exc_info[0], exc_info[1], exc_info[2]
3180
class InterBranch(InterObject):
3181
"""This class represents operations taking place between two branches.
3183
Its instances have methods like pull() and push() and contain
3184
references to the source and target repositories these operations
3185
can be carried out on.
3189
"""The available optimised InterBranch types."""
3192
def _get_branch_formats_to_test():
3193
"""Return a tuple with the Branch formats to use when testing."""
3194
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3196
def pull(self, overwrite=False, stop_revision=None,
3197
possible_transports=None, local=False):
3198
"""Mirror source into target branch.
3200
The target branch is considered to be 'local', having low latency.
3202
:returns: PullResult instance
3204
raise NotImplementedError(self.pull)
3206
def update_revisions(self, stop_revision=None, overwrite=False,
3208
"""Pull in new perfect-fit revisions.
3210
:param stop_revision: Updated until the given revision
3211
:param overwrite: Always set the branch pointer, rather than checking
3212
to see if it is a proper descendant.
3213
:param graph: A Graph object that can be used to query history
3214
information. This can be None.
3217
raise NotImplementedError(self.update_revisions)
3219
def push(self, overwrite=False, stop_revision=None,
3220
_override_hook_source_branch=None):
3221
"""Mirror the source branch into the target branch.
3223
The source branch is considered to be 'local', having low latency.
3225
raise NotImplementedError(self.push)
3228
class GenericInterBranch(InterBranch):
3229
"""InterBranch implementation that uses public Branch functions.
3233
def _get_branch_formats_to_test():
3234
return BranchFormat._default_format, BranchFormat._default_format
3236
def update_revisions(self, stop_revision=None, overwrite=False,
3238
"""See InterBranch.update_revisions()."""
3239
self.source.lock_read()
3241
other_revno, other_last_revision = self.source.last_revision_info()
3242
stop_revno = None # unknown
3243
if stop_revision is None:
3244
stop_revision = other_last_revision
3245
if _mod_revision.is_null(stop_revision):
3246
# if there are no commits, we're done.
3248
stop_revno = other_revno
3250
# what's the current last revision, before we fetch [and change it
3252
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3253
# we fetch here so that we don't process data twice in the common
3254
# case of having something to pull, and so that the check for
3255
# already merged can operate on the just fetched graph, which will
3256
# be cached in memory.
3257
self.target.fetch(self.source, stop_revision)
3258
# Check to see if one is an ancestor of the other
3261
graph = self.target.repository.get_graph()
3262
if self.target._check_if_descendant_or_diverged(
3263
stop_revision, last_rev, graph, self.source):
3264
# stop_revision is a descendant of last_rev, but we aren't
3265
# overwriting, so we're done.
3267
if stop_revno is None:
3269
graph = self.target.repository.get_graph()
3270
this_revno, this_last_revision = \
3271
self.target.last_revision_info()
3272
stop_revno = graph.find_distance_to_null(stop_revision,
3273
[(other_last_revision, other_revno),
3274
(this_last_revision, this_revno)])
3275
self.target.set_last_revision_info(stop_revno, stop_revision)
3277
self.source.unlock()
3279
def pull(self, overwrite=False, stop_revision=None,
3280
possible_transports=None, _hook_master=None, run_hooks=True,
3281
_override_hook_target=None, local=False):
3284
:param _hook_master: Private parameter - set the branch to
3285
be supplied as the master to pull hooks.
3286
:param run_hooks: Private parameter - if false, this branch
3287
is being called because it's the master of the primary branch,
3288
so it should not run its hooks.
3289
:param _override_hook_target: Private parameter - set the branch to be
3290
supplied as the target_branch to pull hooks.
3291
:param local: Only update the local branch, and not the bound branch.
3293
# This type of branch can't be bound.
3295
raise errors.LocalRequiresBoundBranch()
3296
result = PullResult()
3297
result.source_branch = self.source
3298
if _override_hook_target is None:
3299
result.target_branch = self.target
3301
result.target_branch = _override_hook_target
3302
self.source.lock_read()
3304
# We assume that during 'pull' the target repository is closer than
3306
self.source.update_references(self.target)
3307
graph = self.target.repository.get_graph(self.source.repository)
3308
# TODO: Branch formats should have a flag that indicates
3309
# that revno's are expensive, and pull() should honor that flag.
3311
result.old_revno, result.old_revid = \
3312
self.target.last_revision_info()
3313
self.target.update_revisions(self.source, stop_revision,
3314
overwrite=overwrite, graph=graph)
3315
# TODO: The old revid should be specified when merging tags,
3316
# so a tags implementation that versions tags can only
3317
# pull in the most recent changes. -- JRV20090506
3318
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3320
result.new_revno, result.new_revid = self.target.last_revision_info()
3322
result.master_branch = _hook_master
3323
result.local_branch = result.target_branch
3325
result.master_branch = result.target_branch
3326
result.local_branch = None
3328
for hook in Branch.hooks['post_pull']:
3331
self.source.unlock()
3334
def push(self, overwrite=False, stop_revision=None,
3335
_override_hook_source_branch=None):
3336
"""See InterBranch.push.
3338
This is the basic concrete implementation of push()
3340
:param _override_hook_source_branch: If specified, run
3341
the hooks passing this Branch as the source, rather than self.
3342
This is for use of RemoteBranch, where push is delegated to the
3343
underlying vfs-based Branch.
3345
# TODO: Public option to disable running hooks - should be trivial but
3347
self.source.lock_read()
3349
return _run_with_write_locked_target(
3350
self.target, self._push_with_bound_branches, overwrite,
3352
_override_hook_source_branch=_override_hook_source_branch)
3354
self.source.unlock()
3356
def _push_with_bound_branches(self, overwrite, stop_revision,
3357
_override_hook_source_branch=None):
3358
"""Push from source into target, and into target's master if any.
3361
if _override_hook_source_branch:
3362
result.source_branch = _override_hook_source_branch
3363
for hook in Branch.hooks['post_push']:
3366
bound_location = self.target.get_bound_location()
3367
if bound_location and self.target.base != bound_location:
3368
# there is a master branch.
3370
# XXX: Why the second check? Is it even supported for a branch to
3371
# be bound to itself? -- mbp 20070507
3372
master_branch = self.target.get_master_branch()
3373
master_branch.lock_write()
3375
# push into the master from the source branch.
3376
self.source._basic_push(master_branch, overwrite, stop_revision)
3377
# and push into the target branch from the source. Note that we
3378
# push from the source branch again, because its considered the
3379
# highest bandwidth repository.
3380
result = self.source._basic_push(self.target, overwrite,
3382
result.master_branch = master_branch
3383
result.local_branch = self.target
3387
master_branch.unlock()
3390
result = self.source._basic_push(self.target, overwrite,
3392
# TODO: Why set master_branch and local_branch if there's no
3393
# binding? Maybe cleaner to just leave them unset? -- mbp
3395
result.master_branch = self.target
3396
result.local_branch = None
3401
def is_compatible(self, source, target):
3402
# GenericBranch uses the public API, so always compatible
3406
class InterToBranch5(GenericInterBranch):
3409
def _get_branch_formats_to_test():
3410
return BranchFormat._default_format, BzrBranchFormat5()
3412
def pull(self, overwrite=False, stop_revision=None,
3413
possible_transports=None, run_hooks=True,
3414
_override_hook_target=None, local=False):
3415
"""Pull from source into self, updating my master if any.
3417
:param run_hooks: Private parameter - if false, this branch
3418
is being called because it's the master of the primary branch,
3419
so it should not run its hooks.
3421
bound_location = self.target.get_bound_location()
3422
if local and not bound_location:
3423
raise errors.LocalRequiresBoundBranch()
3424
master_branch = None
3425
if not local and bound_location and self.source.user_url != bound_location:
3426
# not pulling from master, so we need to update master.
3427
master_branch = self.target.get_master_branch(possible_transports)
3428
master_branch.lock_write()
3431
# pull from source into master.
3432
master_branch.pull(self.source, overwrite, stop_revision,
3434
return super(InterToBranch5, self).pull(overwrite,
3435
stop_revision, _hook_master=master_branch,
3436
run_hooks=run_hooks,
3437
_override_hook_target=_override_hook_target)
3440
master_branch.unlock()
3443
InterBranch.register_optimiser(GenericInterBranch)
3444
InterBranch.register_optimiser(InterToBranch5)
1343
def is_control_file(filename):
1344
## FIXME: better check
1345
filename = os.path.normpath(filename)
1346
while filename != '':
1347
head, tail = os.path.split(filename)
1348
## mutter('check %r for control file' % ((head, tail), ))
1349
if tail == bzrlib.BZRDIR:
1351
if filename == head:
1358
def gen_file_id(name):
1359
"""Return new file id.
1361
This should probably generate proper UUIDs, but for the moment we
1362
cope with just randomness because running uuidgen every time is
1365
from binascii import hexlify
1366
from time import time
1368
# get last component
1369
idx = name.rfind('/')
1371
name = name[idx+1 : ]
1372
idx = name.rfind('\\')
1374
name = name[idx+1 : ]
1376
# make it not a hidden file
1377
name = name.lstrip('.')
1379
# remove any wierd characters; we don't escape them but rather
1380
# just pull them out
1381
name = re.sub(r'[^\w.]', '', name)
1383
s = hexlify(rand_bytes(8))
1384
return '-'.join((name, compact_date(time()), s))
1388
"""Return a new tree-root file id."""
1389
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
