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
22
from warnings import warn
18
23
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,
35
revision as _mod_revision,
43
from bzrlib.config import BranchConfig, TransportConfig
44
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
45
from bzrlib.tag import (
51
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
52
from bzrlib.hooks import HookPoint, Hooks
53
from bzrlib.inter import InterObject
54
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
55
from bzrlib import registry
56
from bzrlib.symbol_versioning import (
60
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
27
from bzrlib.inventory import InventoryEntry
28
import bzrlib.inventory as inventory
29
from bzrlib.trace import mutter, note
30
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
31
rename, splitpath, sha_file, appendpath,
33
import bzrlib.errors as errors
34
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
35
NoSuchRevision, HistoryMissing, NotBranchError,
36
DivergedBranches, LockError, UnlistableStore,
37
UnlistableBranch, NoSuchFile, NotVersionedError,
39
from bzrlib.textui import show_status
40
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
43
from bzrlib.delta import compare_trees
44
from bzrlib.tree import EmptyTree, RevisionTree
45
from bzrlib.inventory import Inventory
46
from bzrlib.store import copy_all
47
from bzrlib.store.text import TextStore
48
from bzrlib.store.weave import WeaveStore
49
from bzrlib.testament import Testament
50
import bzrlib.transactions as transactions
51
from bzrlib.transport import Transport, get_transport
54
from config import TreeConfig
63
57
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
64
58
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
65
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
68
class Branch(controldir.ControlComponent):
59
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
60
## TODO: Maybe include checks for common corruption of newlines, etc?
63
# TODO: Some operations like log might retrieve the same revisions
64
# repeatedly to calculate deltas. We could perhaps have a weakref
65
# cache in memory to make this faster. In general anything can be
66
# cached in memory between lock and unlock operations.
68
def find_branch(*ignored, **ignored_too):
69
# XXX: leave this here for about one release, then remove it
70
raise NotImplementedError('find_branch() is not supported anymore, '
71
'please use one of the new branch constructors')
74
def needs_read_lock(unbound):
75
"""Decorate unbound to take out and release a read lock."""
76
def decorated(self, *args, **kwargs):
79
return unbound(self, *args, **kwargs)
85
def needs_write_lock(unbound):
86
"""Decorate unbound to take out and release a write lock."""
87
def decorated(self, *args, **kwargs):
90
return unbound(self, *args, **kwargs)
95
######################################################################
69
99
"""Branch holding a history of revisions.
72
Base directory/url of the branch; using control_url and
73
control_transport is more standardized.
75
hooks: An instance of BranchHooks.
102
Base directory/url of the branch.
77
# this is really an instance variable - FIXME move it there
82
def control_transport(self):
83
return self._transport
86
def user_transport(self):
87
return self.bzrdir.user_transport
89
106
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._partial_revision_history_cache = []
95
self._last_revision_info_cache = None
96
self._merge_sorted_revisions_cache = None
98
hooks = Branch.hooks['open']
102
def _open_hook(self):
103
"""Called by init to allow simpler extension of the base class."""
105
def _activate_fallback_location(self, url):
106
"""Activate the branch/repository from url as a fallback repository."""
107
repo = self._get_fallback_repository(url)
108
if repo.has_same_location(self.repository):
109
raise errors.UnstackableLocationError(self.user_url, url)
110
self.repository.add_fallback_repository(repo)
112
def break_lock(self):
113
"""Break a lock if one is present from another instance.
115
Uses the ui factory to ask for confirmation if the lock may be from
118
This will probe the repository for its lock as well.
120
self.control_files.break_lock()
121
self.repository.break_lock()
122
master = self.get_master_branch()
123
if master is not None:
126
def _check_stackable_repo(self):
127
if not self.repository._format.supports_external_lookups:
128
raise errors.UnstackableRepositoryFormat(self.repository._format,
129
self.repository.base)
131
def _extend_partial_history(self, stop_index=None, stop_revision=None):
132
"""Extend the partial history to include a given index
134
If a stop_index is supplied, stop when that index has been reached.
135
If a stop_revision is supplied, stop when that revision is
136
encountered. Otherwise, stop when the beginning of history is
139
:param stop_index: The index which should be present. When it is
140
present, history extension will stop.
141
:param stop_revision: The revision id which should be present. When
142
it is encountered, history extension will stop.
144
if len(self._partial_revision_history_cache) == 0:
145
self._partial_revision_history_cache = [self.last_revision()]
146
repository._iter_for_revno(
147
self.repository, self._partial_revision_history_cache,
148
stop_index=stop_index, stop_revision=stop_revision)
149
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
150
self._partial_revision_history_cache.pop()
152
def _get_check_refs(self):
153
"""Get the references needed for check().
157
revid = self.last_revision()
158
return [('revision-existence', revid), ('lefthand-distance', revid)]
161
def open(base, _unsupported=False, possible_transports=None):
162
"""Open the branch rooted at base.
164
For instance, if the branch is at URL/.bzr/branch,
165
Branch.open(URL) -> a Branch instance.
167
control = bzrdir.BzrDir.open(base, _unsupported,
168
possible_transports=possible_transports)
169
return control.open_branch(unsupported=_unsupported)
172
def open_from_transport(transport, name=None, _unsupported=False):
173
"""Open the branch rooted at transport"""
174
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
175
return control.open_branch(name=name, unsupported=_unsupported)
178
def open_containing(url, possible_transports=None):
107
raise NotImplementedError('The Branch class is abstract')
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format.
113
Only local branches are supported."""
114
return BzrBranch(get_transport(base), relax_version_check=True)
118
"""Open an existing branch, rooted at 'base' (url)"""
119
t = get_transport(base)
120
mutter("trying to open %r with transport %r", base, t)
124
def open_containing(url):
179
125
"""Open an existing branch which contains url.
181
127
This probes for a branch at url, and searches upwards from there.
183
129
Basically we keep looking up until we find the control directory or
184
130
run into the root. If there isn't one, raises NotBranchError.
185
If there is one and it is either an unrecognised format or an unsupported
186
format, UnknownFormatError or UnsupportedFormatError are raised.
187
131
If there is one, it is returned, along with the unused portion of url.
189
control, relpath = bzrdir.BzrDir.open_containing(url,
191
return control.open_branch(), relpath
193
def _push_should_merge_tags(self):
194
"""Should _basic_push merge this branch's tags into the target?
196
The default implementation returns False if this branch has no tags,
197
and True the rest of the time. Subclasses may override this.
199
return self.supports_tags() and self.tags.get_tag_dict()
201
def get_config(self):
202
"""Get a bzrlib.config.BranchConfig for this Branch.
204
This can then be used to get and set configuration options for the
207
:return: A bzrlib.config.BranchConfig.
209
return BranchConfig(self)
211
def _get_config(self):
212
"""Get the concrete config for just the config in this branch.
214
This is not intended for client use; see Branch.get_config for the
219
:return: An object supporting get_option and set_option.
221
raise NotImplementedError(self._get_config)
223
def _get_fallback_repository(self, url):
224
"""Get the repository we fallback to at url."""
225
url = urlutils.join(self.base, url)
226
a_branch = Branch.open(url,
227
possible_transports=[self.bzrdir.root_transport])
228
return a_branch.repository
230
def _get_tags_bytes(self):
231
"""Get the bytes of a serialised tags dict.
233
Note that not all branches support tags, nor do all use the same tags
234
logic: this method is specific to BasicTags. Other tag implementations
235
may use the same method name and behave differently, safely, because
236
of the double-dispatch via
237
format.make_tags->tags_instance->get_tags_dict.
239
:return: The bytes of the tags file.
240
:seealso: Branch._set_tags_bytes.
242
return self._transport.get_bytes('tags')
244
def _get_nick(self, local=False, possible_transports=None):
245
config = self.get_config()
246
# explicit overrides master, but don't look for master if local is True
247
if not local and not config.has_explicit_nickname():
133
t = get_transport(url)
249
master = self.get_master_branch(possible_transports)
250
if master and self.user_url == master.user_url:
251
raise errors.RecursiveBind(self.user_url)
252
if master is not None:
253
# return the master branch value
255
except errors.RecursiveBind, e:
257
except errors.BzrError, e:
258
# Silently fall back to local implicit nick if the master is
260
mutter("Could not connect to bound branch, "
261
"falling back to local nick.\n " + str(e))
262
return config.get_nickname()
136
return BzrBranch(t), t.relpath(url)
137
except NotBranchError:
139
new_t = t.clone('..')
140
if new_t.base == t.base:
141
# reached the root, whatever that may be
142
raise NotBranchError(path=url)
146
def initialize(base):
147
"""Create a new branch, rooted at 'base' (url)"""
148
t = get_transport(base)
149
return BzrBranch(t, init=True)
151
def setup_caching(self, cache_root):
152
"""Subclasses that care about caching should override this, and set
153
up cached stores located under cache_root.
155
self.cache_root = cache_root
158
cfg = self.tree_config()
159
return cfg.get_option(u"nickname", default=self.base.split('/')[-1])
264
161
def _set_nick(self, nick):
265
self.get_config().set_user_option('nickname', nick, warn_masked=True)
162
cfg = self.tree_config()
163
cfg.set_option(nick, "nickname")
164
assert cfg.get_option("nickname") == nick
267
166
nick = property(_get_nick, _set_nick)
270
raise NotImplementedError(self.is_locked)
272
def _lefthand_history(self, revision_id, last_rev=None,
274
if 'evil' in debug.debug_flags:
275
mutter_callsite(4, "_lefthand_history scales with history.")
276
# stop_revision must be a descendant of last_revision
277
graph = self.repository.get_graph()
278
if last_rev is not None:
279
if not graph.is_ancestor(last_rev, revision_id):
280
# our previous tip is not merged into stop_revision
281
raise errors.DivergedBranches(self, other_branch)
282
# make a new revision history from the graph
283
parents_map = graph.get_parent_map([revision_id])
284
if revision_id not in parents_map:
285
raise errors.NoSuchRevision(self, revision_id)
286
current_rev_id = revision_id
288
check_not_reserved_id = _mod_revision.check_not_reserved_id
289
# Do not include ghosts or graph origin in revision_history
290
while (current_rev_id in parents_map and
291
len(parents_map[current_rev_id]) > 0):
292
check_not_reserved_id(current_rev_id)
293
new_history.append(current_rev_id)
294
current_rev_id = parents_map[current_rev_id][0]
295
parents_map = graph.get_parent_map([current_rev_id])
296
new_history.reverse()
299
def lock_write(self, token=None):
300
"""Lock the branch for write operations.
302
:param token: A token to permit reacquiring a previously held and
304
:return: A BranchWriteLockResult.
168
def push_stores(self, branch_to):
169
"""Copy the content of this branches store to branch_to."""
170
raise NotImplementedError('push_stores is abstract')
172
def get_transaction(self):
173
"""Return the current active transaction.
175
If no transaction is active, this returns a passthrough object
176
for which all data is immediately flushed and no caching happens.
306
raise NotImplementedError(self.lock_write)
178
raise NotImplementedError('get_transaction is abstract')
180
def lock_write(self):
181
raise NotImplementedError('lock_write is abstract')
308
183
def lock_read(self):
309
"""Lock the branch for read operations.
311
:return: A bzrlib.lock.LogicalLockResult.
313
raise NotImplementedError(self.lock_read)
184
raise NotImplementedError('lock_read is abstract')
315
186
def unlock(self):
316
raise NotImplementedError(self.unlock)
318
def peek_lock_mode(self):
319
"""Return lock mode for the Branch: 'r', 'w' or None"""
320
raise NotImplementedError(self.peek_lock_mode)
322
def get_physical_lock_status(self):
323
raise NotImplementedError(self.get_physical_lock_status)
326
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
327
"""Return the revision_id for a dotted revno.
329
:param revno: a tuple like (1,) or (1,1,2)
330
:param _cache_reverse: a private parameter enabling storage
331
of the reverse mapping in a top level cache. (This should
332
only be done in selective circumstances as we want to
333
avoid having the mapping cached multiple times.)
334
:return: the revision_id
335
:raises errors.NoSuchRevision: if the revno doesn't exist
337
rev_id = self._do_dotted_revno_to_revision_id(revno)
339
self._partial_revision_id_to_revno_cache[rev_id] = revno
342
def _do_dotted_revno_to_revision_id(self, revno):
343
"""Worker function for dotted_revno_to_revision_id.
345
Subclasses should override this if they wish to
346
provide a more efficient implementation.
349
return self.get_rev_id(revno[0])
350
revision_id_to_revno = self.get_revision_id_to_revno_map()
351
revision_ids = [revision_id for revision_id, this_revno
352
in revision_id_to_revno.iteritems()
353
if revno == this_revno]
354
if len(revision_ids) == 1:
355
return revision_ids[0]
357
revno_str = '.'.join(map(str, revno))
358
raise errors.NoSuchRevision(self, revno_str)
361
def revision_id_to_dotted_revno(self, revision_id):
362
"""Given a revision id, return its dotted revno.
364
:return: a tuple like (1,) or (400,1,3).
366
return self._do_revision_id_to_dotted_revno(revision_id)
368
def _do_revision_id_to_dotted_revno(self, revision_id):
369
"""Worker function for revision_id_to_revno."""
370
# Try the caches if they are loaded
371
result = self._partial_revision_id_to_revno_cache.get(revision_id)
372
if result is not None:
374
if self._revision_id_to_revno_cache:
375
result = self._revision_id_to_revno_cache.get(revision_id)
377
raise errors.NoSuchRevision(self, revision_id)
378
# Try the mainline as it's optimised
380
revno = self.revision_id_to_revno(revision_id)
382
except errors.NoSuchRevision:
383
# We need to load and use the full revno map after all
384
result = self.get_revision_id_to_revno_map().get(revision_id)
386
raise errors.NoSuchRevision(self, revision_id)
390
def get_revision_id_to_revno_map(self):
391
"""Return the revision_id => dotted revno map.
393
This will be regenerated on demand, but will be cached.
395
:return: A dictionary mapping revision_id => dotted revno.
396
This dictionary should not be modified by the caller.
398
if self._revision_id_to_revno_cache is not None:
399
mapping = self._revision_id_to_revno_cache
401
mapping = self._gen_revno_map()
402
self._cache_revision_id_to_revno(mapping)
403
# TODO: jam 20070417 Since this is being cached, should we be returning
405
# I would rather not, and instead just declare that users should not
406
# modify the return value.
409
def _gen_revno_map(self):
410
"""Create a new mapping from revision ids to dotted revnos.
412
Dotted revnos are generated based on the current tip in the revision
414
This is the worker function for get_revision_id_to_revno_map, which
415
just caches the return value.
417
:return: A dictionary mapping revision_id => dotted revno.
419
revision_id_to_revno = dict((rev_id, revno)
420
for rev_id, depth, revno, end_of_merge
421
in self.iter_merge_sorted_revisions())
422
return revision_id_to_revno
425
def iter_merge_sorted_revisions(self, start_revision_id=None,
426
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
427
"""Walk the revisions for a branch in merge sorted order.
429
Merge sorted order is the output from a merge-aware,
430
topological sort, i.e. all parents come before their
431
children going forward; the opposite for reverse.
433
:param start_revision_id: the revision_id to begin walking from.
434
If None, the branch tip is used.
435
:param stop_revision_id: the revision_id to terminate the walk
436
after. If None, the rest of history is included.
437
:param stop_rule: if stop_revision_id is not None, the precise rule
438
to use for termination:
439
* 'exclude' - leave the stop revision out of the result (default)
440
* 'include' - the stop revision is the last item in the result
441
* 'with-merges' - include the stop revision and all of its
442
merged revisions in the result
443
* 'with-merges-without-common-ancestry' - filter out revisions
444
that are in both ancestries
445
:param direction: either 'reverse' or 'forward':
446
* reverse means return the start_revision_id first, i.e.
447
start at the most recent revision and go backwards in history
448
* forward returns tuples in the opposite order to reverse.
449
Note in particular that forward does *not* do any intelligent
450
ordering w.r.t. depth as some clients of this API may like.
451
(If required, that ought to be done at higher layers.)
453
:return: an iterator over (revision_id, depth, revno, end_of_merge)
456
* revision_id: the unique id of the revision
457
* depth: How many levels of merging deep this node has been
459
* revno_sequence: This field provides a sequence of
460
revision numbers for all revisions. The format is:
461
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
462
branch that the revno is on. From left to right the REVNO numbers
463
are the sequence numbers within that branch of the revision.
464
* end_of_merge: When True the next node (earlier in history) is
465
part of a different merge.
467
# Note: depth and revno values are in the context of the branch so
468
# we need the full graph to get stable numbers, regardless of the
470
if self._merge_sorted_revisions_cache is None:
471
last_revision = self.last_revision()
472
known_graph = self.repository.get_known_graph_ancestry(
474
self._merge_sorted_revisions_cache = known_graph.merge_sort(
476
filtered = self._filter_merge_sorted_revisions(
477
self._merge_sorted_revisions_cache, start_revision_id,
478
stop_revision_id, stop_rule)
479
# Make sure we don't return revisions that are not part of the
480
# start_revision_id ancestry.
481
filtered = self._filter_start_non_ancestors(filtered)
482
if direction == 'reverse':
484
if direction == 'forward':
485
return reversed(list(filtered))
487
raise ValueError('invalid direction %r' % direction)
489
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
490
start_revision_id, stop_revision_id, stop_rule):
491
"""Iterate over an inclusive range of sorted revisions."""
492
rev_iter = iter(merge_sorted_revisions)
493
if start_revision_id is not None:
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
if rev_id != start_revision_id:
499
# The decision to include the start or not
500
# depends on the stop_rule if a stop is provided
501
# so pop this node back into the iterator
502
rev_iter = chain(iter([node]), rev_iter)
504
if stop_revision_id is None:
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
yield (rev_id, node.merge_depth, node.revno,
510
elif stop_rule == 'exclude':
511
for node in rev_iter:
512
rev_id = node.key[-1]
513
if rev_id == stop_revision_id:
515
yield (rev_id, node.merge_depth, node.revno,
517
elif stop_rule == 'include':
518
for node in rev_iter:
519
rev_id = node.key[-1]
520
yield (rev_id, node.merge_depth, node.revno,
522
if rev_id == stop_revision_id:
524
elif stop_rule == 'with-merges-without-common-ancestry':
525
# We want to exclude all revisions that are already part of the
526
# stop_revision_id ancestry.
527
graph = self.repository.get_graph()
528
ancestors = graph.find_unique_ancestors(start_revision_id,
530
for node in rev_iter:
531
rev_id = node.key[-1]
532
if rev_id not in ancestors:
534
yield (rev_id, node.merge_depth, node.revno,
536
elif stop_rule == 'with-merges':
537
stop_rev = self.repository.get_revision(stop_revision_id)
538
if stop_rev.parent_ids:
539
left_parent = stop_rev.parent_ids[0]
541
left_parent = _mod_revision.NULL_REVISION
542
# left_parent is the actual revision we want to stop logging at,
543
# since we want to show the merged revisions after the stop_rev too
544
reached_stop_revision_id = False
545
revision_id_whitelist = []
546
for node in rev_iter:
547
rev_id = node.key[-1]
548
if rev_id == left_parent:
549
# reached the left parent after the stop_revision
551
if (not reached_stop_revision_id or
552
rev_id in revision_id_whitelist):
553
yield (rev_id, node.merge_depth, node.revno,
555
if reached_stop_revision_id or rev_id == stop_revision_id:
556
# only do the merged revs of rev_id from now on
557
rev = self.repository.get_revision(rev_id)
559
reached_stop_revision_id = True
560
revision_id_whitelist.extend(rev.parent_ids)
562
raise ValueError('invalid stop_rule %r' % stop_rule)
564
def _filter_start_non_ancestors(self, rev_iter):
565
# If we started from a dotted revno, we want to consider it as a tip
566
# and don't want to yield revisions that are not part of its
567
# ancestry. Given the order guaranteed by the merge sort, we will see
568
# uninteresting descendants of the first parent of our tip before the
570
first = rev_iter.next()
571
(rev_id, merge_depth, revno, end_of_merge) = first
574
# We start at a mainline revision so by definition, all others
575
# revisions in rev_iter are ancestors
576
for node in rev_iter:
581
pmap = self.repository.get_parent_map([rev_id])
582
parents = pmap.get(rev_id, [])
584
whitelist.update(parents)
586
# If there is no parents, there is nothing of interest left
588
# FIXME: It's hard to test this scenario here as this code is never
589
# called in that case. -- vila 20100322
592
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
594
if rev_id in whitelist:
595
pmap = self.repository.get_parent_map([rev_id])
596
parents = pmap.get(rev_id, [])
597
whitelist.remove(rev_id)
598
whitelist.update(parents)
600
# We've reached the mainline, there is nothing left to
604
# A revision that is not part of the ancestry of our
607
yield (rev_id, merge_depth, revno, end_of_merge)
609
def leave_lock_in_place(self):
610
"""Tell this branch object not to release the physical lock when this
613
If lock_write doesn't return a token, then this method is not supported.
615
self.control_files.leave_in_place()
617
def dont_leave_lock_in_place(self):
618
"""Tell this branch object to release the physical lock when this
619
object is unlocked, even if it didn't originally acquire it.
621
If lock_write doesn't return a token, then this method is not supported.
623
self.control_files.dont_leave_in_place()
625
def bind(self, other):
626
"""Bind the local branch the other branch.
628
:param other: The branch to bind to
631
raise errors.UpgradeRequired(self.user_url)
633
def set_append_revisions_only(self, enabled):
634
if not self._format.supports_set_append_revisions_only():
635
raise errors.UpgradeRequired(self.user_url)
640
self.get_config().set_user_option('append_revisions_only', value,
643
def set_reference_info(self, file_id, tree_path, branch_location):
644
"""Set the branch location to use for a tree reference."""
645
raise errors.UnsupportedOperation(self.set_reference_info, self)
647
def get_reference_info(self, file_id):
648
"""Get the tree_path and branch_location for a tree reference."""
649
raise errors.UnsupportedOperation(self.get_reference_info, self)
652
def fetch(self, from_branch, last_revision=None, pb=None):
653
"""Copy revisions from from_branch into this branch.
655
:param from_branch: Where to copy from.
656
:param last_revision: What revision to stop at (None for at the end
658
:param pb: An optional progress bar to use.
661
if self.base == from_branch.base:
664
symbol_versioning.warn(
665
symbol_versioning.deprecated_in((1, 14, 0))
666
% "pb parameter to fetch()")
667
from_branch.lock_read()
669
if last_revision is None:
670
last_revision = from_branch.last_revision()
671
last_revision = _mod_revision.ensure_null(last_revision)
672
return self.repository.fetch(from_branch.repository,
673
revision_id=last_revision,
678
def get_bound_location(self):
679
"""Return the URL of the branch we are bound to.
681
Older format branches cannot bind, please be sure to use a metadir
686
def get_old_bound_location(self):
687
"""Return the URL of the branch we used to be bound to
689
raise errors.UpgradeRequired(self.user_url)
691
def get_commit_builder(self, parents, config=None, timestamp=None,
692
timezone=None, committer=None, revprops=None,
694
"""Obtain a CommitBuilder for this branch.
696
:param parents: Revision ids of the parents of the new revision.
697
:param config: Optional configuration to use.
698
:param timestamp: Optional timestamp recorded for commit.
699
:param timezone: Optional timezone for timestamp.
700
:param committer: Optional committer to set for commit.
701
:param revprops: Optional dictionary of revision properties.
702
:param revision_id: Optional revision id.
706
config = self.get_config()
708
return self.repository.get_commit_builder(self, parents, config,
709
timestamp, timezone, committer, revprops, revision_id)
711
def get_master_branch(self, possible_transports=None):
712
"""Return the branch we are bound to.
714
:return: Either a Branch, or None
187
raise NotImplementedError('unlock is abstract')
189
def abspath(self, name):
190
"""Return absolute filename for something in the branch
192
XXX: Robert Collins 20051017 what is this used for? why is it a branch
193
method and not a tree method.
195
raise NotImplementedError('abspath is abstract')
197
def controlfilename(self, file_or_path):
198
"""Return location relative to branch."""
199
raise NotImplementedError('controlfilename is abstract')
201
def controlfile(self, file_or_path, mode='r'):
202
"""Open a control file for this branch.
204
There are two classes of file in the control directory: text
205
and binary. binary files are untranslated byte streams. Text
206
control files are stored with Unix newlines and in UTF-8, even
207
if the platform or locale defaults are different.
209
Controlfiles should almost never be opened in write mode but
210
rather should be atomically copied and replaced using atomicfile.
212
raise NotImplementedError('controlfile is abstract')
214
def put_controlfile(self, path, f, encode=True):
215
"""Write an entry as a controlfile.
217
:param path: The path to put the file, relative to the .bzr control
219
:param f: A file-like or string object whose contents should be copied.
220
:param encode: If true, encode the contents as utf-8
222
raise NotImplementedError('put_controlfile is abstract')
224
def put_controlfiles(self, files, encode=True):
225
"""Write several entries as controlfiles.
227
:param files: A list of [(path, file)] pairs, where the path is the directory
228
underneath the bzr control directory
229
:param encode: If true, encode the contents as utf-8
231
raise NotImplementedError('put_controlfiles is abstract')
233
def get_root_id(self):
234
"""Return the id of this branches root"""
235
raise NotImplementedError('get_root_id is abstract')
237
def set_root_id(self, file_id):
238
raise NotImplementedError('set_root_id is abstract')
240
def add(self, files, ids=None):
241
"""Make files versioned.
243
Note that the command line normally calls smart_add instead,
244
which can automatically recurse.
246
This puts the files in the Added state, so that they will be
247
recorded by the next commit.
250
List of paths to add, relative to the base of the tree.
253
If set, use these instead of automatically generated ids.
254
Must be the same length as the list of files, but may
255
contain None for ids that are to be autogenerated.
257
TODO: Perhaps have an option to add the ids even if the files do
260
TODO: Perhaps yield the ids and paths as they're added.
262
raise NotImplementedError('add is abstract')
264
def print_file(self, file, revno):
265
"""Print `file` to stdout."""
266
raise NotImplementedError('print_file is abstract')
269
"""Return all unknown files.
271
These are files in the working directory that are not versioned or
272
control files or ignored.
274
>>> from bzrlib.workingtree import WorkingTree
275
>>> b = ScratchBranch(files=['foo', 'foo~'])
276
>>> map(str, b.unknowns())
279
>>> list(b.unknowns())
281
>>> WorkingTree(b.base, b).remove('foo')
282
>>> list(b.unknowns())
285
raise NotImplementedError('unknowns is abstract')
287
def append_revision(self, *revision_ids):
288
raise NotImplementedError('append_revision is abstract')
290
def set_revision_history(self, rev_history):
291
raise NotImplementedError('set_revision_history is abstract')
293
def has_revision(self, revision_id):
294
"""True if this branch has a copy of the revision.
296
This does not necessarily imply the revision is merge
297
or on the mainline."""
298
raise NotImplementedError('has_revision is abstract')
300
def get_revision_xml_file(self, revision_id):
301
"""Return XML file object for revision object."""
302
raise NotImplementedError('get_revision_xml_file is abstract')
304
def get_revision_xml(self, revision_id):
305
raise NotImplementedError('get_revision_xml is abstract')
307
def get_revision(self, revision_id):
308
"""Return the Revision object for a named revision"""
309
raise NotImplementedError('get_revision is abstract')
718
311
def get_revision_delta(self, revno):
719
312
"""Return the delta for one revision.
1229
547
self.check_real_revno(revno)
1231
549
def check_real_revno(self, revno):
1233
551
Check whether a revno corresponds to a real revision.
1234
552
Zero (the NULL revision) is considered invalid
1236
554
if revno < 1 or revno > self.revno():
1237
raise errors.InvalidRevisionNumber(revno)
1240
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1241
"""Clone this branch into to_bzrdir preserving all semantic values.
1243
Most API users will want 'create_clone_on_transport', which creates a
1244
new bzrdir and branch on the fly.
1246
revision_id: if not None, the revision history in the new branch will
1247
be truncated to end with revision_id.
1249
result = to_bzrdir.create_branch()
1252
if repository_policy is not None:
1253
repository_policy.configure_branch(result)
1254
self.copy_content_into(result, revision_id=revision_id)
1260
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1261
"""Create a new line of development from the branch, into to_bzrdir.
1263
to_bzrdir controls the branch format.
1265
revision_id: if not None, the revision history in the new branch will
1266
be truncated to end with revision_id.
1268
if (repository_policy is not None and
1269
repository_policy.requires_stacking()):
1270
to_bzrdir._format.require_stacking(_skip_repo=True)
1271
result = to_bzrdir.create_branch()
1274
if repository_policy is not None:
1275
repository_policy.configure_branch(result)
1276
self.copy_content_into(result, revision_id=revision_id)
1277
result.set_parent(self.bzrdir.root_transport.base)
1282
def _synchronize_history(self, destination, revision_id):
1283
"""Synchronize last revision and revision history between branches.
1285
This version is most efficient when the destination is also a
1286
BzrBranch6, but works for BzrBranch5, as long as the destination's
1287
repository contains all the lefthand ancestors of the intended
1288
last_revision. If not, set_last_revision_info will fail.
1290
:param destination: The branch to copy the history into
1291
:param revision_id: The revision-id to truncate history at. May
1292
be None to copy complete history.
1294
source_revno, source_revision_id = self.last_revision_info()
1295
if revision_id is None:
1296
revno, revision_id = source_revno, source_revision_id
1298
graph = self.repository.get_graph()
1300
revno = graph.find_distance_to_null(revision_id,
1301
[(source_revision_id, source_revno)])
1302
except errors.GhostRevisionsHaveNoRevno:
1303
# Default to 1, if we can't find anything else
1305
destination.set_last_revision_info(revno, revision_id)
1307
def copy_content_into(self, destination, revision_id=None):
1308
"""Copy the content of self into destination.
1310
revision_id: if not None, the revision history in the new branch will
1311
be truncated to end with revision_id.
1313
return InterBranch.get(self, destination).copy_content_into(
1314
revision_id=revision_id)
1316
def update_references(self, target):
1317
if not getattr(self._format, 'supports_reference_locations', False):
1319
reference_dict = self._get_all_reference_info()
1320
if len(reference_dict) == 0:
1322
old_base = self.base
1323
new_base = target.base
1324
target_reference_dict = target._get_all_reference_info()
1325
for file_id, (tree_path, branch_location) in (
1326
reference_dict.items()):
1327
branch_location = urlutils.rebase_url(branch_location,
1329
target_reference_dict.setdefault(
1330
file_id, (tree_path, branch_location))
1331
target._set_all_reference_info(target_reference_dict)
1334
def check(self, refs):
1335
"""Check consistency of the branch.
1337
In particular this checks that revisions given in the revision-history
1338
do actually match up in the revision graph, and that they're all
1339
present in the repository.
1341
Callers will typically also want to check the repository.
1343
:param refs: Calculated refs for this branch as specified by
1344
branch._get_check_refs()
1345
:return: A BranchCheckResult.
1347
result = BranchCheckResult(self)
1348
last_revno, last_revision_id = self.last_revision_info()
1349
actual_revno = refs[('lefthand-distance', last_revision_id)]
1350
if actual_revno != last_revno:
1351
result.errors.append(errors.BzrCheckError(
1352
'revno does not match len(mainline) %s != %s' % (
1353
last_revno, actual_revno)))
1354
# TODO: We should probably also check that self.revision_history
1355
# matches the repository for older branch formats.
1356
# If looking for the code that cross-checks repository parents against
1357
# the iter_reverse_revision_history output, that is now a repository
1361
def _get_checkout_format(self):
1362
"""Return the most suitable metadir for a checkout of this branch.
1363
Weaves are used if this branch's repository uses weaves.
1365
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1366
from bzrlib.repofmt import weaverepo
1367
format = bzrdir.BzrDirMetaFormat1()
1368
format.repository_format = weaverepo.RepositoryFormat7()
1370
format = self.repository.bzrdir.checkout_metadir()
1371
format.set_branch_format(self._format)
1374
def create_clone_on_transport(self, to_transport, revision_id=None,
1375
stacked_on=None, create_prefix=False, use_existing_dir=False,
1377
"""Create a clone of this branch and its bzrdir.
1379
:param to_transport: The transport to clone onto.
1380
:param revision_id: The revision id to use as tip in the new branch.
1381
If None the tip is obtained from this branch.
1382
:param stacked_on: An optional URL to stack the clone on.
1383
:param create_prefix: Create any missing directories leading up to
1385
:param use_existing_dir: Use an existing directory if one exists.
1387
# XXX: Fix the bzrdir API to allow getting the branch back from the
1388
# clone call. Or something. 20090224 RBC/spiv.
1389
# XXX: Should this perhaps clone colocated branches as well,
1390
# rather than just the default branch? 20100319 JRV
1391
if revision_id is None:
1392
revision_id = self.last_revision()
1393
dir_to = self.bzrdir.clone_on_transport(to_transport,
1394
revision_id=revision_id, stacked_on=stacked_on,
1395
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1397
return dir_to.open_branch()
1399
def create_checkout(self, to_location, revision_id=None,
1400
lightweight=False, accelerator_tree=None,
1402
"""Create a checkout of a branch.
1404
:param to_location: The url to produce the checkout at
1405
:param revision_id: The revision to check out
1406
:param lightweight: If True, produce a lightweight checkout, otherwise,
1407
produce a bound branch (heavyweight checkout)
1408
:param accelerator_tree: A tree which can be used for retrieving file
1409
contents more quickly than the revision tree, i.e. a workingtree.
1410
The revision tree will be used for cases where accelerator_tree's
1411
content is different.
1412
:param hardlink: If true, hard-link files from accelerator_tree,
1414
:return: The tree of the created checkout
1416
t = transport.get_transport(to_location)
1419
format = self._get_checkout_format()
1420
checkout = format.initialize_on_transport(t)
1421
from_branch = BranchReferenceFormat().initialize(checkout,
1424
format = self._get_checkout_format()
1425
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1426
to_location, force_new_tree=False, format=format)
1427
checkout = checkout_branch.bzrdir
1428
checkout_branch.bind(self)
1429
# pull up to the specified revision_id to set the initial
1430
# branch tip correctly, and seed it with history.
1431
checkout_branch.pull(self, stop_revision=revision_id)
1433
tree = checkout.create_workingtree(revision_id,
1434
from_branch=from_branch,
1435
accelerator_tree=accelerator_tree,
1437
basis_tree = tree.basis_tree()
1438
basis_tree.lock_read()
1440
for path, file_id in basis_tree.iter_references():
1441
reference_parent = self.reference_parent(file_id, path)
1442
reference_parent.create_checkout(tree.abspath(path),
1443
basis_tree.get_reference_revision(file_id, path),
1450
def reconcile(self, thorough=True):
1451
"""Make sure the data stored in this branch is consistent."""
1452
from bzrlib.reconcile import BranchReconciler
1453
reconciler = BranchReconciler(self, thorough=thorough)
1454
reconciler.reconcile()
1457
def reference_parent(self, file_id, path, possible_transports=None):
1458
"""Return the parent branch for a tree-reference file_id
1459
:param file_id: The file_id of the tree reference
1460
:param path: The path of the file_id in the tree
1461
:return: A branch associated with the file_id
1463
# FIXME should provide multiple branches, based on config
1464
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1465
possible_transports=possible_transports)
1467
def supports_tags(self):
1468
return self._format.supports_tags()
1470
def automatic_tag_name(self, revision_id):
1471
"""Try to automatically find the tag name for a revision.
1473
:param revision_id: Revision id of the revision.
1474
:return: A tag name or None if no tag name could be determined.
1476
for hook in Branch.hooks['automatic_tag_name']:
1477
ret = hook(self, revision_id)
1482
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1484
"""Ensure that revision_b is a descendant of revision_a.
1486
This is a helper function for update_revisions.
1488
:raises: DivergedBranches if revision_b has diverged from revision_a.
1489
:returns: True if revision_b is a descendant of revision_a.
1491
relation = self._revision_relations(revision_a, revision_b, graph)
1492
if relation == 'b_descends_from_a':
1494
elif relation == 'diverged':
1495
raise errors.DivergedBranches(self, other_branch)
1496
elif relation == 'a_descends_from_b':
1499
raise AssertionError("invalid relation: %r" % (relation,))
1501
def _revision_relations(self, revision_a, revision_b, graph):
1502
"""Determine the relationship between two revisions.
1504
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1506
heads = graph.heads([revision_a, revision_b])
1507
if heads == set([revision_b]):
1508
return 'b_descends_from_a'
1509
elif heads == set([revision_a, revision_b]):
1510
# These branches have diverged
1512
elif heads == set([revision_a]):
1513
return 'a_descends_from_b'
1515
raise AssertionError("invalid heads: %r" % (heads,))
1518
class BranchFormat(object):
1519
"""An encapsulation of the initialization and open routines for a format.
1521
Formats provide three things:
1522
* An initialization routine,
1526
Formats are placed in an dict by their format string for reference
1527
during branch opening. It's not required that these be instances, they
1528
can be classes themselves with class methods - it simply depends on
1529
whether state is needed for a given format or not.
1531
Once a format is deprecated, just deprecate the initialize and open
1532
methods on the format class. Do not deprecate the object, as the
1533
object will be created every time regardless.
1536
_default_format = None
1537
"""The default format used for new branches."""
1540
"""The known formats."""
1542
can_set_append_revisions_only = True
1544
def __eq__(self, other):
1545
return self.__class__ is other.__class__
1547
def __ne__(self, other):
1548
return not (self == other)
1551
def find_format(klass, a_bzrdir, name=None):
1552
"""Return the format for the branch object in a_bzrdir."""
1554
transport = a_bzrdir.get_branch_transport(None, name=name)
1555
format_string = transport.get_bytes("format")
1556
format = klass._formats[format_string]
1557
if isinstance(format, MetaDirBranchFormatFactory):
1560
except errors.NoSuchFile:
1561
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1563
raise errors.UnknownFormatError(format=format_string, kind='branch')
1566
def get_default_format(klass):
1567
"""Return the current default format."""
1568
return klass._default_format
1571
def get_formats(klass):
1572
"""Get all the known formats.
1574
Warning: This triggers a load of all lazy registered formats: do not
1575
use except when that is desireed.
1578
for fmt in klass._formats.values():
1579
if isinstance(fmt, MetaDirBranchFormatFactory):
1584
def get_reference(self, a_bzrdir, name=None):
1585
"""Get the target reference of the branch in a_bzrdir.
1587
format probing must have been completed before calling
1588
this method - it is assumed that the format of the branch
1589
in a_bzrdir is correct.
1591
:param a_bzrdir: The bzrdir to get the branch data from.
1592
:param name: Name of the colocated branch to fetch
1593
:return: None if the branch is not a reference branch.
1598
def set_reference(self, a_bzrdir, name, to_branch):
1599
"""Set the target reference of the branch in a_bzrdir.
1601
format probing must have been completed before calling
1602
this method - it is assumed that the format of the branch
1603
in a_bzrdir is correct.
1605
:param a_bzrdir: The bzrdir to set the branch reference for.
1606
:param name: Name of colocated branch to set, None for default
1607
:param to_branch: branch that the checkout is to reference
1609
raise NotImplementedError(self.set_reference)
1611
def get_format_string(self):
1612
"""Return the ASCII format string that identifies this format."""
1613
raise NotImplementedError(self.get_format_string)
1615
def get_format_description(self):
1616
"""Return the short format description for this format."""
1617
raise NotImplementedError(self.get_format_description)
1619
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1620
hooks = Branch.hooks['post_branch_init']
1623
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1627
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1628
lock_type='metadir', set_format=True):
1629
"""Initialize a branch in a bzrdir, with specified files
1631
:param a_bzrdir: The bzrdir to initialize the branch in
1632
:param utf8_files: The files to create as a list of
1633
(filename, content) tuples
1634
:param name: Name of colocated branch to create, if any
1635
:param set_format: If True, set the format with
1636
self.get_format_string. (BzrBranch4 has its format set
1638
:return: a branch in this format
1640
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1641
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1643
'metadir': ('lock', lockdir.LockDir),
1644
'branch4': ('branch-lock', lockable_files.TransportLock),
1646
lock_name, lock_class = lock_map[lock_type]
1647
control_files = lockable_files.LockableFiles(branch_transport,
1648
lock_name, lock_class)
1649
control_files.create_lock()
1651
control_files.lock_write()
1652
except errors.LockContention:
1653
if lock_type != 'branch4':
1659
utf8_files += [('format', self.get_format_string())]
1661
for (filename, content) in utf8_files:
1662
branch_transport.put_bytes(
1664
mode=a_bzrdir._get_file_mode())
1667
control_files.unlock()
1668
branch = self.open(a_bzrdir, name, _found=True)
1669
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1672
def initialize(self, a_bzrdir, name=None):
1673
"""Create a branch of this format in a_bzrdir.
1675
:param name: Name of the colocated branch to create.
1677
raise NotImplementedError(self.initialize)
1679
def is_supported(self):
1680
"""Is this format supported?
1682
Supported formats can be initialized and opened.
1683
Unsupported formats may not support initialization or committing or
1684
some other features depending on the reason for not being supported.
1688
def make_tags(self, branch):
1689
"""Create a tags object for branch.
1691
This method is on BranchFormat, because BranchFormats are reflected
1692
over the wire via network_name(), whereas full Branch instances require
1693
multiple VFS method calls to operate at all.
1695
The default implementation returns a disabled-tags instance.
1697
Note that it is normal for branch to be a RemoteBranch when using tags
1700
return DisabledTags(branch)
1702
def network_name(self):
1703
"""A simple byte string uniquely identifying this format for RPC calls.
1705
MetaDir branch formats use their disk format string to identify the
1706
repository over the wire. All in one formats such as bzr < 0.8, and
1707
foreign formats like svn/git and hg should use some marker which is
1708
unique and immutable.
1710
raise NotImplementedError(self.network_name)
1712
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1713
"""Return the branch object for a_bzrdir
1715
:param a_bzrdir: A BzrDir that contains a branch.
1716
:param name: Name of colocated branch to open
1717
:param _found: a private parameter, do not use it. It is used to
1718
indicate if format probing has already be done.
1719
:param ignore_fallbacks: when set, no fallback branches will be opened
1720
(if there are any). Default is to open fallbacks.
1722
raise NotImplementedError(self.open)
1725
def register_format(klass, format):
1726
"""Register a metadir format.
1728
See MetaDirBranchFormatFactory for the ability to register a format
1729
without loading the code the format needs until it is actually used.
1731
klass._formats[format.get_format_string()] = format
1732
# Metadir formats have a network name of their format string, and get
1733
# registered as factories.
1734
if isinstance(format, MetaDirBranchFormatFactory):
1735
network_format_registry.register(format.get_format_string(), format)
1737
network_format_registry.register(format.get_format_string(),
1741
def set_default_format(klass, format):
1742
klass._default_format = format
1744
def supports_set_append_revisions_only(self):
1745
"""True if this format supports set_append_revisions_only."""
1748
def supports_stacking(self):
1749
"""True if this format records a stacked-on branch."""
1753
def unregister_format(klass, format):
1754
del klass._formats[format.get_format_string()]
1757
return self.get_format_description().rstrip()
1759
def supports_tags(self):
1760
"""True if this format supports tags stored in the branch"""
1761
return False # by default
1764
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1765
"""A factory for a BranchFormat object, permitting simple lazy registration.
1767
While none of the built in BranchFormats are lazy registered yet,
1768
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1769
use it, and the bzr-loom plugin uses it as well (see
1770
bzrlib.plugins.loom.formats).
1773
def __init__(self, format_string, module_name, member_name):
1774
"""Create a MetaDirBranchFormatFactory.
1776
:param format_string: The format string the format has.
1777
:param module_name: Module to load the format class from.
1778
:param member_name: Attribute name within the module for the format class.
1780
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1781
self._format_string = format_string
1783
def get_format_string(self):
1784
"""See BranchFormat.get_format_string."""
1785
return self._format_string
1788
"""Used for network_format_registry support."""
1789
return self.get_obj()()
1792
class BranchHooks(Hooks):
1793
"""A dictionary mapping hook name to a list of callables for branch hooks.
1795
e.g. ['set_rh'] Is the list of items to be called when the
1796
set_revision_history function is invoked.
1800
"""Create the default hooks.
1802
These are all empty initially, because by default nothing should get
1805
Hooks.__init__(self)
1806
self.create_hook(HookPoint('set_rh',
1807
"Invoked whenever the revision history has been set via "
1808
"set_revision_history. The api signature is (branch, "
1809
"revision_history), and the branch will be write-locked. "
1810
"The set_rh hook can be expensive for bzr to trigger, a better "
1811
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1812
self.create_hook(HookPoint('open',
1813
"Called with the Branch object that has been opened after a "
1814
"branch is opened.", (1, 8), None))
1815
self.create_hook(HookPoint('post_push',
1816
"Called after a push operation completes. post_push is called "
1817
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1818
"bzr client.", (0, 15), None))
1819
self.create_hook(HookPoint('post_pull',
1820
"Called after a pull operation completes. post_pull is called "
1821
"with a bzrlib.branch.PullResult object and only runs in the "
1822
"bzr client.", (0, 15), None))
1823
self.create_hook(HookPoint('pre_commit',
1824
"Called after a commit is calculated but before it is "
1825
"completed. pre_commit is called with (local, master, old_revno, "
1826
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1827
"). old_revid is NULL_REVISION for the first commit to a branch, "
1828
"tree_delta is a TreeDelta object describing changes from the "
1829
"basis revision. hooks MUST NOT modify this delta. "
1830
" future_tree is an in-memory tree obtained from "
1831
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1832
"tree.", (0,91), None))
1833
self.create_hook(HookPoint('post_commit',
1834
"Called in the bzr client after a commit has completed. "
1835
"post_commit is called with (local, master, old_revno, old_revid, "
1836
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1837
"commit to a branch.", (0, 15), None))
1838
self.create_hook(HookPoint('post_uncommit',
1839
"Called in the bzr client after an uncommit completes. "
1840
"post_uncommit is called with (local, master, old_revno, "
1841
"old_revid, new_revno, new_revid) where local is the local branch "
1842
"or None, master is the target branch, and an empty branch "
1843
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1844
self.create_hook(HookPoint('pre_change_branch_tip',
1845
"Called in bzr client and server before a change to the tip of a "
1846
"branch is made. pre_change_branch_tip is called with a "
1847
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1848
"commit, uncommit will all trigger this hook.", (1, 6), None))
1849
self.create_hook(HookPoint('post_change_branch_tip',
1850
"Called in bzr client and server after a change to the tip of a "
1851
"branch is made. post_change_branch_tip is called with a "
1852
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1853
"commit, uncommit will all trigger this hook.", (1, 4), None))
1854
self.create_hook(HookPoint('transform_fallback_location',
1855
"Called when a stacked branch is activating its fallback "
1856
"locations. transform_fallback_location is called with (branch, "
1857
"url), and should return a new url. Returning the same url "
1858
"allows it to be used as-is, returning a different one can be "
1859
"used to cause the branch to stack on a closer copy of that "
1860
"fallback_location. Note that the branch cannot have history "
1861
"accessing methods called on it during this hook because the "
1862
"fallback locations have not been activated. When there are "
1863
"multiple hooks installed for transform_fallback_location, "
1864
"all are called with the url returned from the previous hook."
1865
"The order is however undefined.", (1, 9), None))
1866
self.create_hook(HookPoint('automatic_tag_name',
1867
"Called to determine an automatic tag name for a revision. "
1868
"automatic_tag_name is called with (branch, revision_id) and "
1869
"should return a tag name or None if no tag name could be "
1870
"determined. The first non-None tag name returned will be used.",
1872
self.create_hook(HookPoint('post_branch_init',
1873
"Called after new branch initialization completes. "
1874
"post_branch_init is called with a "
1875
"bzrlib.branch.BranchInitHookParams. "
1876
"Note that init, branch and checkout (both heavyweight and "
1877
"lightweight) will all trigger this hook.", (2, 2), None))
1878
self.create_hook(HookPoint('post_switch',
1879
"Called after a checkout switches branch. "
1880
"post_switch is called with a "
1881
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1885
# install the default hooks into the Branch class.
1886
Branch.hooks = BranchHooks()
1889
class ChangeBranchTipParams(object):
1890
"""Object holding parameters passed to *_change_branch_tip hooks.
1892
There are 5 fields that hooks may wish to access:
1894
:ivar branch: the branch being changed
1895
:ivar old_revno: revision number before the change
1896
:ivar new_revno: revision number after the change
1897
:ivar old_revid: revision id before the change
1898
:ivar new_revid: revision id after the change
1900
The revid fields are strings. The revno fields are integers.
1903
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1904
"""Create a group of ChangeBranchTip parameters.
1906
:param branch: The branch being changed.
1907
:param old_revno: Revision number before the change.
1908
:param new_revno: Revision number after the change.
1909
:param old_revid: Tip revision id before the change.
1910
:param new_revid: Tip revision id after the change.
1912
self.branch = branch
1913
self.old_revno = old_revno
1914
self.new_revno = new_revno
1915
self.old_revid = old_revid
1916
self.new_revid = new_revid
1918
def __eq__(self, other):
1919
return self.__dict__ == other.__dict__
1922
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1923
self.__class__.__name__, self.branch,
1924
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1927
class BranchInitHookParams(object):
1928
"""Object holding parameters passed to *_branch_init hooks.
1930
There are 4 fields that hooks may wish to access:
1932
:ivar format: the branch format
1933
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1934
:ivar name: name of colocated branch, if any (or None)
1935
:ivar branch: the branch created
1937
Note that for lightweight checkouts, the bzrdir and format fields refer to
1938
the checkout, hence they are different from the corresponding fields in
1939
branch, which refer to the original branch.
1942
def __init__(self, format, a_bzrdir, name, branch):
1943
"""Create a group of BranchInitHook parameters.
1945
:param format: the branch format
1946
:param a_bzrdir: the BzrDir where the branch will be/has been
1948
:param name: name of colocated branch, if any (or None)
1949
:param branch: the branch created
1951
Note that for lightweight checkouts, the bzrdir and format fields refer
1952
to the checkout, hence they are different from the corresponding fields
1953
in branch, which refer to the original branch.
1955
self.format = format
1956
self.bzrdir = a_bzrdir
1958
self.branch = branch
1960
def __eq__(self, other):
1961
return self.__dict__ == other.__dict__
1964
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1967
class SwitchHookParams(object):
1968
"""Object holding parameters passed to *_switch hooks.
1970
There are 4 fields that hooks may wish to access:
1972
:ivar control_dir: BzrDir of the checkout to change
1973
:ivar to_branch: branch that the checkout is to reference
1974
:ivar force: skip the check for local commits in a heavy checkout
1975
:ivar revision_id: revision ID to switch to (or None)
1978
def __init__(self, control_dir, to_branch, force, revision_id):
1979
"""Create a group of SwitchHook parameters.
1981
:param control_dir: BzrDir of the checkout to change
1982
:param to_branch: branch that the checkout is to reference
1983
:param force: skip the check for local commits in a heavy checkout
1984
:param revision_id: revision ID to switch to (or None)
1986
self.control_dir = control_dir
1987
self.to_branch = to_branch
1989
self.revision_id = revision_id
1991
def __eq__(self, other):
1992
return self.__dict__ == other.__dict__
1995
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1996
self.control_dir, self.to_branch,
2000
class BzrBranchFormat4(BranchFormat):
2001
"""Bzr branch format 4.
2004
- a revision-history file.
2005
- a branch-lock lock file [ to be shared with the bzrdir ]
2008
def get_format_description(self):
2009
"""See BranchFormat.get_format_description()."""
2010
return "Branch format 4"
2012
def initialize(self, a_bzrdir, name=None):
2013
"""Create a branch of this format in a_bzrdir."""
2014
utf8_files = [('revision-history', ''),
2015
('branch-name', ''),
2017
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
2018
lock_type='branch4', set_format=False)
2021
super(BzrBranchFormat4, self).__init__()
2022
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2024
def network_name(self):
2025
"""The network name for this format is the control dirs disk label."""
2026
return self._matchingbzrdir.get_format_string()
2028
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2029
"""See BranchFormat.open()."""
2031
# we are being called directly and must probe.
2032
raise NotImplementedError
2033
return BzrBranch(_format=self,
2034
_control_files=a_bzrdir._control_files,
2037
_repository=a_bzrdir.open_repository())
2040
return "Bazaar-NG branch format 4"
2043
class BranchFormatMetadir(BranchFormat):
2044
"""Common logic for meta-dir based branch formats."""
2046
def _branch_class(self):
2047
"""What class to instantiate on open calls."""
2048
raise NotImplementedError(self._branch_class)
2050
def network_name(self):
2051
"""A simple byte string uniquely identifying this format for RPC calls.
2053
Metadir branch formats use their format string.
2055
return self.get_format_string()
2057
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2058
"""See BranchFormat.open()."""
2060
format = BranchFormat.find_format(a_bzrdir, name=name)
2061
if format.__class__ != self.__class__:
2062
raise AssertionError("wrong format %r found for %r" %
2064
transport = a_bzrdir.get_branch_transport(None, name=name)
2066
control_files = lockable_files.LockableFiles(transport, 'lock',
2068
return self._branch_class()(_format=self,
2069
_control_files=control_files,
2072
_repository=a_bzrdir.find_repository(),
2073
ignore_fallbacks=ignore_fallbacks)
2074
except errors.NoSuchFile:
2075
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2078
super(BranchFormatMetadir, self).__init__()
2079
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2080
self._matchingbzrdir.set_branch_format(self)
2082
def supports_tags(self):
2086
class BzrBranchFormat5(BranchFormatMetadir):
2087
"""Bzr branch format 5.
2090
- a revision-history file.
2092
- a lock dir guarding the branch itself
2093
- all of this stored in a branch/ subdirectory
2094
- works with shared repositories.
2096
This format is new in bzr 0.8.
2099
def _branch_class(self):
2102
def get_format_string(self):
2103
"""See BranchFormat.get_format_string()."""
2104
return "Bazaar-NG branch format 5\n"
2106
def get_format_description(self):
2107
"""See BranchFormat.get_format_description()."""
2108
return "Branch format 5"
2110
def initialize(self, a_bzrdir, name=None):
2111
"""Create a branch of this format in a_bzrdir."""
2112
utf8_files = [('revision-history', ''),
2113
('branch-name', ''),
2115
return self._initialize_helper(a_bzrdir, utf8_files, name)
2117
def supports_tags(self):
2121
class BzrBranchFormat6(BranchFormatMetadir):
2122
"""Branch format with last-revision and tags.
2124
Unlike previous formats, this has no explicit revision history. Instead,
2125
this just stores the last-revision, and the left-hand history leading
2126
up to there is the history.
2128
This format was introduced in bzr 0.15
2129
and became the default in 0.91.
2132
def _branch_class(self):
2135
def get_format_string(self):
2136
"""See BranchFormat.get_format_string()."""
2137
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2139
def get_format_description(self):
2140
"""See BranchFormat.get_format_description()."""
2141
return "Branch format 6"
2143
def initialize(self, a_bzrdir, name=None):
2144
"""Create a branch of this format in a_bzrdir."""
2145
utf8_files = [('last-revision', '0 null:\n'),
2146
('branch.conf', ''),
2149
return self._initialize_helper(a_bzrdir, utf8_files, name)
2151
def make_tags(self, branch):
2152
"""See bzrlib.branch.BranchFormat.make_tags()."""
2153
return BasicTags(branch)
2155
def supports_set_append_revisions_only(self):
2159
class BzrBranchFormat8(BranchFormatMetadir):
2160
"""Metadir format supporting storing locations of subtree branches."""
2162
def _branch_class(self):
2165
def get_format_string(self):
2166
"""See BranchFormat.get_format_string()."""
2167
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2169
def get_format_description(self):
2170
"""See BranchFormat.get_format_description()."""
2171
return "Branch format 8"
2173
def initialize(self, a_bzrdir, name=None):
2174
"""Create a branch of this format in a_bzrdir."""
2175
utf8_files = [('last-revision', '0 null:\n'),
2176
('branch.conf', ''),
2180
return self._initialize_helper(a_bzrdir, utf8_files, name)
2183
super(BzrBranchFormat8, self).__init__()
2184
self._matchingbzrdir.repository_format = \
2185
RepositoryFormatKnitPack5RichRoot()
2187
def make_tags(self, branch):
2188
"""See bzrlib.branch.BranchFormat.make_tags()."""
2189
return BasicTags(branch)
2191
def supports_set_append_revisions_only(self):
2194
def supports_stacking(self):
2197
supports_reference_locations = True
2200
class BzrBranchFormat7(BzrBranchFormat8):
2201
"""Branch format with last-revision, tags, and a stacked location pointer.
2203
The stacked location pointer is passed down to the repository and requires
2204
a repository format with supports_external_lookups = True.
2206
This format was introduced in bzr 1.6.
2209
def initialize(self, a_bzrdir, name=None):
2210
"""Create a branch of this format in a_bzrdir."""
2211
utf8_files = [('last-revision', '0 null:\n'),
2212
('branch.conf', ''),
2215
return self._initialize_helper(a_bzrdir, utf8_files, name)
2217
def _branch_class(self):
2220
def get_format_string(self):
2221
"""See BranchFormat.get_format_string()."""
2222
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2224
def get_format_description(self):
2225
"""See BranchFormat.get_format_description()."""
2226
return "Branch format 7"
2228
def supports_set_append_revisions_only(self):
2231
supports_reference_locations = False
2234
class BranchReferenceFormat(BranchFormat):
2235
"""Bzr branch reference format.
2237
Branch references are used in implementing checkouts, they
2238
act as an alias to the real branch which is at some other url.
2245
def get_format_string(self):
2246
"""See BranchFormat.get_format_string()."""
2247
return "Bazaar-NG Branch Reference Format 1\n"
2249
def get_format_description(self):
2250
"""See BranchFormat.get_format_description()."""
2251
return "Checkout reference format 1"
2253
def get_reference(self, a_bzrdir, name=None):
2254
"""See BranchFormat.get_reference()."""
2255
transport = a_bzrdir.get_branch_transport(None, name=name)
2256
return transport.get_bytes('location')
2258
def set_reference(self, a_bzrdir, name, to_branch):
2259
"""See BranchFormat.set_reference()."""
2260
transport = a_bzrdir.get_branch_transport(None, name=name)
2261
location = transport.put_bytes('location', to_branch.base)
2263
def initialize(self, a_bzrdir, name=None, target_branch=None):
2264
"""Create a branch of this format in a_bzrdir."""
2265
if target_branch is None:
2266
# this format does not implement branch itself, thus the implicit
2267
# creation contract must see it as uninitializable
2268
raise errors.UninitializableFormat(self)
2269
mutter('creating branch reference in %s', a_bzrdir.user_url)
2270
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2271
branch_transport.put_bytes('location',
2272
target_branch.bzrdir.user_url)
2273
branch_transport.put_bytes('format', self.get_format_string())
2275
a_bzrdir, name, _found=True,
2276
possible_transports=[target_branch.bzrdir.root_transport])
2277
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2281
super(BranchReferenceFormat, self).__init__()
2282
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2283
self._matchingbzrdir.set_branch_format(self)
2285
def _make_reference_clone_function(format, a_branch):
2286
"""Create a clone() routine for a branch dynamically."""
2287
def clone(to_bzrdir, revision_id=None,
2288
repository_policy=None):
2289
"""See Branch.clone()."""
2290
return format.initialize(to_bzrdir, target_branch=a_branch)
2291
# cannot obey revision_id limits when cloning a reference ...
2292
# FIXME RBC 20060210 either nuke revision_id for clone, or
2293
# emit some sort of warning/error to the caller ?!
2296
def open(self, a_bzrdir, name=None, _found=False, location=None,
2297
possible_transports=None, ignore_fallbacks=False):
2298
"""Return the branch that the branch reference in a_bzrdir points at.
2300
:param a_bzrdir: A BzrDir that contains a branch.
2301
:param name: Name of colocated branch to open, if any
2302
:param _found: a private parameter, do not use it. It is used to
2303
indicate if format probing has already be done.
2304
:param ignore_fallbacks: when set, no fallback branches will be opened
2305
(if there are any). Default is to open fallbacks.
2306
:param location: The location of the referenced branch. If
2307
unspecified, this will be determined from the branch reference in
2309
:param possible_transports: An optional reusable transports list.
2312
format = BranchFormat.find_format(a_bzrdir, name=name)
2313
if format.__class__ != self.__class__:
2314
raise AssertionError("wrong format %r found for %r" %
2316
if location is None:
2317
location = self.get_reference(a_bzrdir, name)
2318
real_bzrdir = bzrdir.BzrDir.open(
2319
location, possible_transports=possible_transports)
2320
result = real_bzrdir.open_branch(name=name,
2321
ignore_fallbacks=ignore_fallbacks)
2322
# this changes the behaviour of result.clone to create a new reference
2323
# rather than a copy of the content of the branch.
2324
# I did not use a proxy object because that needs much more extensive
2325
# testing, and we are only changing one behaviour at the moment.
2326
# If we decide to alter more behaviours - i.e. the implicit nickname
2327
# then this should be refactored to introduce a tested proxy branch
2328
# and a subclass of that for use in overriding clone() and ....
2330
result.clone = self._make_reference_clone_function(result)
2334
network_format_registry = registry.FormatRegistry()
2335
"""Registry of formats indexed by their network name.
2337
The network name for a branch format is an identifier that can be used when
2338
referring to formats with smart server operations. See
2339
BranchFormat.network_name() for more detail.
2343
# formats which have no format string are not discoverable
2344
# and not independently creatable, so are not registered.
2345
__format5 = BzrBranchFormat5()
2346
__format6 = BzrBranchFormat6()
2347
__format7 = BzrBranchFormat7()
2348
__format8 = BzrBranchFormat8()
2349
BranchFormat.register_format(__format5)
2350
BranchFormat.register_format(BranchReferenceFormat())
2351
BranchFormat.register_format(__format6)
2352
BranchFormat.register_format(__format7)
2353
BranchFormat.register_format(__format8)
2354
BranchFormat.set_default_format(__format7)
2355
_legacy_formats = [BzrBranchFormat4(),
2357
network_format_registry.register(
2358
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2361
class BranchWriteLockResult(LogicalLockResult):
2362
"""The result of write locking a branch.
2364
:ivar branch_token: The token obtained from the underlying branch lock, or
2366
:ivar unlock: A callable which will unlock the lock.
2369
def __init__(self, unlock, branch_token):
2370
LogicalLockResult.__init__(self, unlock)
2371
self.branch_token = branch_token
2374
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2378
class BzrBranch(Branch, _RelockDebugMixin):
555
raise InvalidRevisionNumber(revno)
557
def sign_revision(self, revision_id, gpg_strategy):
558
raise NotImplementedError('sign_revision is abstract')
560
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
561
raise NotImplementedError('store_revision_signature is abstract')
563
class BzrBranch(Branch):
2379
564
"""A branch stored in the actual filesystem.
2381
566
Note that it's "local" in the context of the filesystem; it doesn't
2382
567
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2383
568
it's writable, and can be accessed via the normal filesystem API.
2385
:ivar _transport: Transport for file operations on this branch's
2386
control files, typically pointing to the .bzr/branch directory.
2387
:ivar repository: Repository for this branch.
2388
:ivar base: The url of the base directory for this branch; the one
2389
containing the .bzr directory.
2390
:ivar name: Optional colocated branch name as it exists in the control
574
If _lock_mode is true, a positive count of the number of times the
578
Lock object from bzrlib.lock.
2394
def __init__(self, _format=None,
2395
_control_files=None, a_bzrdir=None, name=None,
2396
_repository=None, ignore_fallbacks=False):
2397
"""Create new branch object at a particular location."""
2398
if a_bzrdir is None:
2399
raise ValueError('a_bzrdir must be supplied')
2401
self.bzrdir = a_bzrdir
2402
self._base = self.bzrdir.transport.clone('..').base
2404
# XXX: We should be able to just do
2405
# self.base = self.bzrdir.root_transport.base
2406
# but this does not quite work yet -- mbp 20080522
2407
self._format = _format
2408
if _control_files is None:
2409
raise ValueError('BzrBranch _control_files is None')
2410
self.control_files = _control_files
2411
self._transport = _control_files._transport
2412
self.repository = _repository
2413
Branch.__init__(self)
580
# We actually expect this class to be somewhat short-lived; part of its
581
# purpose is to try to isolate what bits of the branch logic are tied to
582
# filesystem access, so that in a later step, we can extricate them to
583
# a separarte ("storage") class.
587
_inventory_weave = None
589
# Map some sort of prefix into a namespace
590
# stuff like "revno:10", "revid:", etc.
591
# This should match a prefix with a function which accepts
592
REVISION_NAMESPACES = {}
594
def push_stores(self, branch_to):
595
"""See Branch.push_stores."""
596
if (self._branch_format != branch_to._branch_format
597
or self._branch_format != 4):
598
from bzrlib.fetch import greedy_fetch
599
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
600
self, self._branch_format, branch_to, branch_to._branch_format)
601
greedy_fetch(to_branch=branch_to, from_branch=self,
602
revision=self.last_revision())
605
store_pairs = ((self.text_store, branch_to.text_store),
606
(self.inventory_store, branch_to.inventory_store),
607
(self.revision_store, branch_to.revision_store))
609
for from_store, to_store in store_pairs:
610
copy_all(from_store, to_store)
611
except UnlistableStore:
612
raise UnlistableBranch(from_store)
614
def __init__(self, transport, init=False,
615
relax_version_check=False):
616
"""Create new branch object at a particular location.
618
transport -- A Transport object, defining how to access files.
620
init -- If True, create new control files in a previously
621
unversioned directory. If False, the branch must already
624
relax_version_check -- If true, the usual check for the branch
625
version is not applied. This is intended only for
626
upgrade/recovery type use; it's not guaranteed that
627
all operations will work on old format branches.
629
In the test suite, creation of new trees is tested using the
630
`ScratchBranch` class.
632
assert isinstance(transport, Transport), \
633
"%r is not a Transport" % transport
634
self._transport = transport
637
self._check_format(relax_version_check)
639
def get_store(name, compressed=True, prefixed=False):
640
# FIXME: This approach of assuming stores are all entirely compressed
641
# or entirely uncompressed is tidy, but breaks upgrade from
642
# some existing branches where there's a mixture; we probably
643
# still want the option to look for both.
644
relpath = self._rel_controlfilename(name)
645
store = TextStore(self._transport.clone(relpath),
647
compressed=compressed)
648
#if self._transport.should_cache():
649
# cache_path = os.path.join(self.cache_root, name)
650
# os.mkdir(cache_path)
651
# store = bzrlib.store.CachedStore(store, cache_path)
653
def get_weave(name, prefixed=False):
654
relpath = self._rel_controlfilename(name)
655
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
656
if self._transport.should_cache():
657
ws.enable_cache = True
660
if self._branch_format == 4:
661
self.inventory_store = get_store('inventory-store')
662
self.text_store = get_store('text-store')
663
self.revision_store = get_store('revision-store')
664
elif self._branch_format == 5:
665
self.control_weaves = get_weave('')
666
self.weave_store = get_weave('weaves')
667
self.revision_store = get_store('revision-store', compressed=False)
668
elif self._branch_format == 6:
669
self.control_weaves = get_weave('')
670
self.weave_store = get_weave('weaves', prefixed=True)
671
self.revision_store = get_store('revision-store', compressed=False,
673
self.revision_store.register_suffix('sig')
674
self._transaction = None
2415
676
def __str__(self):
2416
if self.name is None:
2417
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2419
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
677
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
2422
679
__repr__ = __str__
682
if self._lock_mode or self._lock:
683
# XXX: This should show something every time, and be suitable for
684
# headless operation and embedding
685
warn("branch %r was not explicitly unlocked" % self)
688
# TODO: It might be best to do this somewhere else,
689
# but it is nice for a Branch object to automatically
690
# cache it's information.
691
# Alternatively, we could have the Transport objects cache requests
692
# See the earlier discussion about how major objects (like Branch)
693
# should never expect their __del__ function to run.
694
if hasattr(self, 'cache_root') and self.cache_root is not None:
696
shutil.rmtree(self.cache_root)
699
self.cache_root = None
2424
701
def _get_base(self):
2425
"""Returns the directory containing the control directory."""
703
return self._transport.base
2428
706
base = property(_get_base, doc="The URL for the root of this branch.")
2430
def _get_config(self):
2431
return TransportConfig(self._transport, 'branch.conf')
2433
def is_locked(self):
2434
return self.control_files.is_locked()
2436
def lock_write(self, token=None):
2437
"""Lock the branch for write operations.
2439
:param token: A token to permit reacquiring a previously held and
2441
:return: A BranchWriteLockResult.
2443
if not self.is_locked():
2444
self._note_lock('w')
2445
# All-in-one needs to always unlock/lock.
2446
repo_control = getattr(self.repository, 'control_files', None)
2447
if self.control_files == repo_control or not self.is_locked():
2448
self.repository._warn_if_deprecated(self)
2449
self.repository.lock_write()
2454
return BranchWriteLockResult(self.unlock,
2455
self.control_files.lock_write(token=token))
2458
self.repository.unlock()
708
def _finish_transaction(self):
709
"""Exit the current transaction."""
710
if self._transaction is None:
711
raise errors.LockError('Branch %s is not in a transaction' %
713
transaction = self._transaction
714
self._transaction = None
717
def get_transaction(self):
718
"""See Branch.get_transaction."""
719
if self._transaction is None:
720
return transactions.PassThroughTransaction()
722
return self._transaction
724
def _set_transaction(self, new_transaction):
725
"""Set a new active transaction."""
726
if self._transaction is not None:
727
raise errors.LockError('Branch %s is in a transaction already.' %
729
self._transaction = new_transaction
731
def lock_write(self):
732
mutter("lock write: %s (%s)", self, self._lock_count)
733
# TODO: Upgrade locking to support using a Transport,
734
# and potentially a remote locking protocol
736
if self._lock_mode != 'w':
737
raise LockError("can't upgrade to a write lock from %r" %
739
self._lock_count += 1
741
self._lock = self._transport.lock_write(
742
self._rel_controlfilename('branch-lock'))
743
self._lock_mode = 'w'
745
self._set_transaction(transactions.PassThroughTransaction())
2461
747
def lock_read(self):
2462
"""Lock the branch for read operations.
2464
:return: A bzrlib.lock.LogicalLockResult.
2466
if not self.is_locked():
2467
self._note_lock('r')
2468
# All-in-one needs to always unlock/lock.
2469
repo_control = getattr(self.repository, 'control_files', None)
2470
if self.control_files == repo_control or not self.is_locked():
2471
self.repository._warn_if_deprecated(self)
2472
self.repository.lock_read()
748
mutter("lock read: %s (%s)", self, self._lock_count)
750
assert self._lock_mode in ('r', 'w'), \
751
"invalid lock mode %r" % self._lock_mode
752
self._lock_count += 1
2477
self.control_files.lock_read()
2478
return LogicalLockResult(self.unlock)
2481
self.repository.unlock()
2484
@only_raises(errors.LockNotHeld, errors.LockBroken)
754
self._lock = self._transport.lock_read(
755
self._rel_controlfilename('branch-lock'))
756
self._lock_mode = 'r'
758
self._set_transaction(transactions.ReadOnlyTransaction())
759
# 5K may be excessive, but hey, its a knob.
760
self.get_transaction().set_cache_size(5000)
2485
762
def unlock(self):
763
mutter("unlock: %s (%s)", self, self._lock_count)
764
if not self._lock_mode:
765
raise LockError('branch %r is not locked' % (self))
767
if self._lock_count > 1:
768
self._lock_count -= 1
770
self._finish_transaction()
773
self._lock_mode = self._lock_count = None
775
def abspath(self, name):
776
"""See Branch.abspath."""
777
return self._transport.abspath(name)
779
def _rel_controlfilename(self, file_or_path):
780
if not isinstance(file_or_path, basestring):
781
file_or_path = '/'.join(file_or_path)
782
if file_or_path == '':
784
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
786
def controlfilename(self, file_or_path):
787
"""See Branch.controlfilename."""
788
return self._transport.abspath(self._rel_controlfilename(file_or_path))
790
def controlfile(self, file_or_path, mode='r'):
791
"""See Branch.controlfile."""
794
relpath = self._rel_controlfilename(file_or_path)
795
#TODO: codecs.open() buffers linewise, so it was overloaded with
796
# a much larger buffer, do we need to do the same for getreader/getwriter?
798
return self._transport.get(relpath)
800
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
802
# XXX: Do we really want errors='replace'? Perhaps it should be
803
# an error, or at least reported, if there's incorrectly-encoded
804
# data inside a file.
805
# <https://launchpad.net/products/bzr/+bug/3823>
806
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
808
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
810
raise BzrError("invalid controlfile mode %r" % mode)
812
def put_controlfile(self, path, f, encode=True):
813
"""See Branch.put_controlfile."""
814
self.put_controlfiles([(path, f)], encode=encode)
816
def put_controlfiles(self, files, encode=True):
817
"""See Branch.put_controlfiles."""
820
for path, f in files:
822
if isinstance(f, basestring):
823
f = f.encode('utf-8', 'replace')
825
f = codecs.getwriter('utf-8')(f, errors='replace')
826
path = self._rel_controlfilename(path)
827
ctrl_files.append((path, f))
828
self._transport.put_multi(ctrl_files)
830
def _make_control(self):
831
from bzrlib.inventory import Inventory
832
from bzrlib.weavefile import write_weave_v5
833
from bzrlib.weave import Weave
835
# Create an empty inventory
837
# if we want per-tree root ids then this is the place to set
838
# them; they're not needed for now and so ommitted for
840
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
841
empty_inv = sio.getvalue()
843
bzrlib.weavefile.write_weave_v5(Weave(), sio)
844
empty_weave = sio.getvalue()
846
dirs = [[], 'revision-store', 'weaves']
848
"This is a Bazaar-NG control directory.\n"
849
"Do not change any files in this directory.\n"),
850
('branch-format', BZR_BRANCH_FORMAT_6),
851
('revision-history', ''),
854
('pending-merges', ''),
855
('inventory', empty_inv),
856
('inventory.weave', empty_weave),
857
('ancestry.weave', empty_weave)
859
cfn = self._rel_controlfilename
860
self._transport.mkdir_multi([cfn(d) for d in dirs])
861
self.put_controlfiles(files)
862
mutter('created control directory in ' + self._transport.base)
864
def _check_format(self, relax_version_check):
865
"""Check this branch format is supported.
867
The format level is stored, as an integer, in
868
self._branch_format for code that needs to check it later.
870
In the future, we might need different in-memory Branch
871
classes to support downlevel branches. But not yet.
2487
self.control_files.unlock()
2489
# All-in-one needs to always unlock/lock.
2490
repo_control = getattr(self.repository, 'control_files', None)
2491
if (self.control_files == repo_control or
2492
not self.control_files.is_locked()):
2493
self.repository.unlock()
2494
if not self.control_files.is_locked():
2495
# we just released the lock
2496
self._clear_cached_state()
2498
def peek_lock_mode(self):
2499
if self.control_files._lock_count == 0:
874
fmt = self.controlfile('branch-format', 'r').read()
876
raise NotBranchError(path=self.base)
877
mutter("got branch format %r", fmt)
878
if fmt == BZR_BRANCH_FORMAT_6:
879
self._branch_format = 6
880
elif fmt == BZR_BRANCH_FORMAT_5:
881
self._branch_format = 5
882
elif fmt == BZR_BRANCH_FORMAT_4:
883
self._branch_format = 4
885
if (not relax_version_check
886
and self._branch_format not in (5, 6)):
887
raise errors.UnsupportedFormatError(
888
'sorry, branch format %r not supported' % fmt,
889
['use a different bzr version',
890
'or remove the .bzr directory'
891
' and "bzr init" again'])
893
def get_root_id(self):
894
"""See Branch.get_root_id."""
895
inv = self.get_inventory(self.last_revision())
896
return inv.root.file_id
899
def set_root_id(self, file_id):
900
"""See Branch.set_root_id."""
901
inv = self.working_tree().read_working_inventory()
902
orig_root_id = inv.root.file_id
903
del inv._byid[inv.root.file_id]
904
inv.root.file_id = file_id
905
inv._byid[inv.root.file_id] = inv.root
908
if entry.parent_id in (None, orig_root_id):
909
entry.parent_id = inv.root.file_id
910
self._write_inventory(inv)
913
def add(self, files, ids=None):
914
"""See Branch.add."""
915
# TODO: Re-adding a file that is removed in the working copy
916
# should probably put it back with the previous ID.
917
if isinstance(files, basestring):
918
assert(ids is None or isinstance(ids, basestring))
924
ids = [None] * len(files)
2502
return self.control_files._lock_mode
2504
def get_physical_lock_status(self):
2505
return self.control_files.get_physical_lock_status()
926
assert(len(ids) == len(files))
928
inv = self.working_tree().read_working_inventory()
929
for f,file_id in zip(files, ids):
930
if is_control_file(f):
931
raise BzrError("cannot add control file %s" % quotefn(f))
936
raise BzrError("cannot add top-level %r" % f)
938
fullpath = os.path.normpath(self.abspath(f))
941
kind = file_kind(fullpath)
943
# maybe something better?
944
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
946
if not InventoryEntry.versionable_kind(kind):
947
raise BzrError('cannot add: not a versionable file ('
948
'i.e. regular file, symlink or directory): %s' % quotefn(f))
951
file_id = gen_file_id(f)
952
inv.add_path(f, kind=kind, file_id=file_id)
954
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
956
self.working_tree()._write_inventory(inv)
2507
958
@needs_read_lock
2508
def print_file(self, file, revision_id):
959
def print_file(self, file, revno):
2509
960
"""See Branch.print_file."""
2510
return self.repository.print_file(file, revision_id)
2512
def _write_revision_history(self, history):
2513
"""Factored out of set_revision_history.
2515
This performs the actual writing to disk.
2516
It is intended to be called by BzrBranch5.set_revision_history."""
2517
self._transport.put_bytes(
2518
'revision-history', '\n'.join(history),
2519
mode=self.bzrdir._get_file_mode())
961
tree = self.revision_tree(self.get_rev_id(revno))
962
# use inventory as it was in that revision
963
file_id = tree.inventory.path2id(file)
965
raise BzrError("%r is not present in revision %s" % (file, revno))
966
tree.print_file(file_id)
969
"""See Branch.unknowns."""
970
return self.working_tree().unknowns()
973
def append_revision(self, *revision_ids):
974
"""See Branch.append_revision."""
975
for revision_id in revision_ids:
976
mutter("add {%s} to revision-history" % revision_id)
977
rev_history = self.revision_history()
978
rev_history.extend(revision_ids)
979
self.set_revision_history(rev_history)
2521
981
@needs_write_lock
2522
982
def set_revision_history(self, rev_history):
2523
983
"""See Branch.set_revision_history."""
2524
if 'evil' in debug.debug_flags:
2525
mutter_callsite(3, "set_revision_history scales with history.")
2526
check_not_reserved_id = _mod_revision.check_not_reserved_id
2527
for rev_id in rev_history:
2528
check_not_reserved_id(rev_id)
2529
if Branch.hooks['post_change_branch_tip']:
2530
# Don't calculate the last_revision_info() if there are no hooks
2532
old_revno, old_revid = self.last_revision_info()
2533
if len(rev_history) == 0:
2534
revid = _mod_revision.NULL_REVISION
984
self.put_controlfile('revision-history', '\n'.join(rev_history))
986
def has_revision(self, revision_id):
987
"""See Branch.has_revision."""
988
return (revision_id is None
989
or self.revision_store.has_id(revision_id))
992
def get_revision_xml_file(self, revision_id):
993
"""See Branch.get_revision_xml_file."""
994
if not revision_id or not isinstance(revision_id, basestring):
995
raise InvalidRevisionId(revision_id=revision_id, branch=self)
997
return self.revision_store.get(revision_id)
998
except (IndexError, KeyError):
999
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1002
get_revision_xml = get_revision_xml_file
1004
def get_revision_xml(self, revision_id):
1005
"""See Branch.get_revision_xml."""
1006
return self.get_revision_xml_file(revision_id).read()
1009
def get_revision(self, revision_id):
1010
"""See Branch.get_revision."""
1011
xml_file = self.get_revision_xml_file(revision_id)
1014
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
1015
except SyntaxError, e:
1016
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
1020
assert r.revision_id == revision_id
1023
def get_revision_sha1(self, revision_id):
1024
"""See Branch.get_revision_sha1."""
1025
# In the future, revision entries will be signed. At that
1026
# point, it is probably best *not* to include the signature
1027
# in the revision hash. Because that lets you re-sign
1028
# the revision, (add signatures/remove signatures) and still
1029
# have all hash pointers stay consistent.
1030
# But for now, just hash the contents.
1031
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
1033
def get_ancestry(self, revision_id):
1034
"""See Branch.get_ancestry."""
1035
if revision_id is None:
1037
w = self._get_inventory_weave()
1038
return [None] + map(w.idx_to_name,
1039
w.inclusions([w.lookup(revision_id)]))
1041
def _get_inventory_weave(self):
1042
return self.control_weaves.get_weave('inventory',
1043
self.get_transaction())
1045
def get_inventory(self, revision_id):
1046
"""See Branch.get_inventory."""
1047
xml = self.get_inventory_xml(revision_id)
1048
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1050
def get_inventory_xml(self, revision_id):
1051
"""See Branch.get_inventory_xml."""
1053
assert isinstance(revision_id, basestring), type(revision_id)
1054
iw = self._get_inventory_weave()
1055
return iw.get_text(iw.lookup(revision_id))
1057
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
1059
def get_inventory_sha1(self, revision_id):
1060
"""See Branch.get_inventory_sha1."""
1061
return self.get_revision(revision_id).inventory_sha1
1063
def get_revision_inventory(self, revision_id):
1064
"""See Branch.get_revision_inventory."""
1065
# TODO: Unify this with get_inventory()
1066
# bzr 0.0.6 and later imposes the constraint that the inventory_id
1067
# must be the same as its revision, so this is trivial.
1068
if revision_id == None:
1069
# This does not make sense: if there is no revision,
1070
# then it is the current tree inventory surely ?!
1071
# and thus get_root_id() is something that looks at the last
1072
# commit on the branch, and the get_root_id is an inventory check.
1073
raise NotImplementedError
1074
# return Inventory(self.get_root_id())
2536
revid = rev_history[-1]
2537
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2538
self._write_revision_history(rev_history)
2539
self._clear_cached_state()
2540
self._cache_revision_history(rev_history)
2541
for hook in Branch.hooks['set_rh']:
2542
hook(self, rev_history)
2543
if Branch.hooks['post_change_branch_tip']:
2544
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2546
def _synchronize_history(self, destination, revision_id):
2547
"""Synchronize last revision and revision history between branches.
2549
This version is most efficient when the destination is also a
2550
BzrBranch5, but works for BzrBranch6 as long as the revision
2551
history is the true lefthand parent history, and all of the revisions
2552
are in the destination's repository. If not, set_revision_history
2555
:param destination: The branch to copy the history into
2556
:param revision_id: The revision-id to truncate history at. May
2557
be None to copy complete history.
2559
if not isinstance(destination._format, BzrBranchFormat5):
2560
super(BzrBranch, self)._synchronize_history(
2561
destination, revision_id)
1076
return self.get_inventory(revision_id)
1079
def revision_history(self):
1080
"""See Branch.revision_history."""
1081
transaction = self.get_transaction()
1082
history = transaction.map.find_revision_history()
1083
if history is not None:
1084
mutter("cache hit for revision-history in %s", self)
1085
return list(history)
1086
history = [l.rstrip('\r\n') for l in
1087
self.controlfile('revision-history', 'r').readlines()]
1088
transaction.map.add_revision_history(history)
1089
# this call is disabled because revision_history is
1090
# not really an object yet, and the transaction is for objects.
1091
# transaction.register_clean(history, precious=True)
1092
return list(history)
1094
def update_revisions(self, other, stop_revision=None):
1095
"""See Branch.update_revisions."""
1096
from bzrlib.fetch import greedy_fetch
1097
if stop_revision is None:
1098
stop_revision = other.last_revision()
1099
### Should this be checking is_ancestor instead of revision_history?
1100
if (stop_revision is not None and
1101
stop_revision in self.revision_history()):
2563
if revision_id == _mod_revision.NULL_REVISION:
1103
greedy_fetch(to_branch=self, from_branch=other,
1104
revision=stop_revision)
1105
pullable_revs = self.pullable_revisions(other, stop_revision)
1106
if len(pullable_revs) > 0:
1107
self.append_revision(*pullable_revs)
1109
def pullable_revisions(self, other, stop_revision):
1110
"""See Branch.pullable_revisions."""
1111
other_revno = other.revision_id_to_revno(stop_revision)
1113
return self.missing_revisions(other, other_revno)
1114
except DivergedBranches, e:
1116
pullable_revs = get_intervening_revisions(self.last_revision(),
1117
stop_revision, self)
1118
assert self.last_revision() not in pullable_revs
1119
return pullable_revs
1120
except bzrlib.errors.NotAncestor:
1121
if is_ancestor(self.last_revision(), stop_revision, self):
1126
def revision_id_to_revno(self, revision_id):
1127
"""Given a revision id, return its revno"""
1128
if revision_id is None:
1130
history = self.revision_history()
1132
return history.index(revision_id) + 1
1134
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1136
def get_rev_id(self, revno, history=None):
1137
"""Find the revision id of the specified revno."""
1141
history = self.revision_history()
1142
elif revno <= 0 or revno > len(history):
1143
raise bzrlib.errors.NoSuchRevision(self, revno)
1144
return history[revno - 1]
1146
def revision_tree(self, revision_id):
1147
"""See Branch.revision_tree."""
1148
# TODO: refactor this to use an existing revision object
1149
# so we don't need to read it in twice.
1150
if revision_id == None or revision_id == NULL_REVISION:
2566
new_history = self.revision_history()
2567
if revision_id is not None and new_history != []:
2569
new_history = new_history[:new_history.index(revision_id) + 1]
2571
rev = self.repository.get_revision(revision_id)
2572
new_history = rev.get_history(self.repository)[1:]
2573
destination.set_revision_history(new_history)
2576
def set_last_revision_info(self, revno, revision_id):
2577
"""Set the last revision of this branch.
2579
The caller is responsible for checking that the revno is correct
2580
for this revision id.
2582
It may be possible to set the branch last revision to an id not
2583
present in the repository. However, branches can also be
2584
configured to check constraints on history, in which case this may not
2587
revision_id = _mod_revision.ensure_null(revision_id)
2588
# this old format stores the full history, but this api doesn't
2589
# provide it, so we must generate, and might as well check it's
2591
history = self._lefthand_history(revision_id)
2592
if len(history) != revno:
2593
raise AssertionError('%d != %d' % (len(history), revno))
2594
self.set_revision_history(history)
2596
def _gen_revision_history(self):
2597
history = self._transport.get_bytes('revision-history').split('\n')
2598
if history[-1:] == ['']:
2599
# There shouldn't be a trailing newline, but just in case.
2604
def generate_revision_history(self, revision_id, last_rev=None,
2606
"""Create a new revision history that will finish with revision_id.
2608
:param revision_id: the new tip to use.
2609
:param last_rev: The previous last_revision. If not None, then this
2610
must be a ancestory of revision_id, or DivergedBranches is raised.
2611
:param other_branch: The other branch that DivergedBranches should
2612
raise with respect to.
2614
self.set_revision_history(self._lefthand_history(revision_id,
2615
last_rev, other_branch))
2617
def basis_tree(self):
2618
"""See Branch.basis_tree."""
2619
return self.repository.revision_tree(self.last_revision())
2621
def _get_parent_location(self):
1153
inv = self.get_revision_inventory(revision_id)
1154
return RevisionTree(self.weave_store, inv, revision_id)
1156
def working_tree(self):
1157
"""See Branch.working_tree."""
1158
from bzrlib.workingtree import WorkingTree
1159
# TODO: In the future, perhaps WorkingTree should utilize Transport
1160
# RobertCollins 20051003 - I don't think it should - working trees are
1161
# much more complex to keep consistent than our careful .bzr subset.
1162
# instead, we should say that working trees are local only, and optimise
1164
if self._transport.base.find('://') != -1:
1165
raise NoWorkingTree(self.base)
1166
return WorkingTree(self.base, branch=self)
1169
def pull(self, source, overwrite=False):
1170
"""See Branch.pull."""
1174
self.update_revisions(source)
1175
except DivergedBranches:
1178
self.set_revision_history(source.revision_history())
1183
def rename_one(self, from_rel, to_rel):
1184
"""See Branch.rename_one."""
1185
tree = self.working_tree()
1186
inv = tree.inventory
1187
if not tree.has_filename(from_rel):
1188
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1189
if tree.has_filename(to_rel):
1190
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1192
file_id = inv.path2id(from_rel)
1194
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1196
if inv.path2id(to_rel):
1197
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1199
to_dir, to_tail = os.path.split(to_rel)
1200
to_dir_id = inv.path2id(to_dir)
1201
if to_dir_id == None and to_dir != '':
1202
raise BzrError("can't determine destination directory id for %r" % to_dir)
1204
mutter("rename_one:")
1205
mutter(" file_id {%s}" % file_id)
1206
mutter(" from_rel %r" % from_rel)
1207
mutter(" to_rel %r" % to_rel)
1208
mutter(" to_dir %r" % to_dir)
1209
mutter(" to_dir_id {%s}" % to_dir_id)
1211
inv.rename(file_id, to_dir_id, to_tail)
1213
from_abs = self.abspath(from_rel)
1214
to_abs = self.abspath(to_rel)
1216
rename(from_abs, to_abs)
1218
raise BzrError("failed to rename %r to %r: %s"
1219
% (from_abs, to_abs, e[1]),
1220
["rename rolled back"])
1222
self.working_tree()._write_inventory(inv)
1225
def move(self, from_paths, to_name):
1226
"""See Branch.move."""
1228
## TODO: Option to move IDs only
1229
assert not isinstance(from_paths, basestring)
1230
tree = self.working_tree()
1231
inv = tree.inventory
1232
to_abs = self.abspath(to_name)
1233
if not isdir(to_abs):
1234
raise BzrError("destination %r is not a directory" % to_abs)
1235
if not tree.has_filename(to_name):
1236
raise BzrError("destination %r not in working directory" % to_abs)
1237
to_dir_id = inv.path2id(to_name)
1238
if to_dir_id == None and to_name != '':
1239
raise BzrError("destination %r is not a versioned directory" % to_name)
1240
to_dir_ie = inv[to_dir_id]
1241
if to_dir_ie.kind not in ('directory', 'root_directory'):
1242
raise BzrError("destination %r is not a directory" % to_abs)
1244
to_idpath = inv.get_idpath(to_dir_id)
1246
for f in from_paths:
1247
if not tree.has_filename(f):
1248
raise BzrError("%r does not exist in working tree" % f)
1249
f_id = inv.path2id(f)
1251
raise BzrError("%r is not versioned" % f)
1252
name_tail = splitpath(f)[-1]
1253
dest_path = appendpath(to_name, name_tail)
1254
if tree.has_filename(dest_path):
1255
raise BzrError("destination %r already exists" % dest_path)
1256
if f_id in to_idpath:
1257
raise BzrError("can't move %r to a subdirectory of itself" % f)
1259
# OK, so there's a race here, it's possible that someone will
1260
# create a file in this interval and then the rename might be
1261
# left half-done. But we should have caught most problems.
1263
for f in from_paths:
1264
name_tail = splitpath(f)[-1]
1265
dest_path = appendpath(to_name, name_tail)
1266
result.append((f, dest_path))
1267
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1269
rename(self.abspath(f), self.abspath(dest_path))
1271
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1272
["rename rolled back"])
1274
self.working_tree()._write_inventory(inv)
1277
def get_parent(self):
1278
"""See Branch.get_parent."""
2622
1280
_locs = ['parent', 'pull', 'x-pull']
2623
1281
for l in _locs:
2625
return self._transport.get_bytes(l).strip('\n')
2626
except errors.NoSuchFile:
1283
return self.controlfile(l, 'r').read().strip('\n')
1285
if e.errno != errno.ENOENT:
2630
def _basic_push(self, target, overwrite, stop_revision):
2631
"""Basic implementation of push without bound branches or hooks.
2633
Must be called with source read locked and target write locked.
2635
result = BranchPushResult()
2636
result.source_branch = self
2637
result.target_branch = target
2638
result.old_revno, result.old_revid = target.last_revision_info()
2639
self.update_references(target)
2640
if result.old_revid != self.last_revision():
2641
# We assume that during 'push' this repository is closer than
2643
graph = self.repository.get_graph(target.repository)
2644
target.update_revisions(self, stop_revision,
2645
overwrite=overwrite, graph=graph)
2646
if self._push_should_merge_tags():
2647
result.tag_conflicts = self.tags.merge_to(target.tags,
2649
result.new_revno, result.new_revid = target.last_revision_info()
2652
def get_stacked_on_url(self):
2653
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1289
def get_push_location(self):
1290
"""See Branch.get_push_location."""
1291
config = bzrlib.config.BranchConfig(self)
1292
push_loc = config.get_user_option('push_location')
2655
1295
def set_push_location(self, location):
2656
1296
"""See Branch.set_push_location."""
2657
self.get_config().set_user_option(
2658
'push_location', location,
2659
store=_mod_config.STORE_LOCATION_NORECURSE)
2661
def _set_parent_location(self, url):
2663
self._transport.delete('parent')
2665
self._transport.put_bytes('parent', url + '\n',
2666
mode=self.bzrdir._get_file_mode())
2669
class BzrBranch5(BzrBranch):
2670
"""A format 5 branch. This supports new features over plain branches.
2672
It has support for a master_branch which is the data for bound branches.
1297
config = bzrlib.config.LocationConfig(self.base)
1298
config.set_user_option('push_location', location)
1301
def set_parent(self, url):
1302
"""See Branch.set_parent."""
1303
# TODO: Maybe delete old location files?
1304
from bzrlib.atomicfile import AtomicFile
1305
f = AtomicFile(self.controlfilename('parent'))
1312
def tree_config(self):
1313
return TreeConfig(self)
1315
def check_revno(self, revno):
1317
Check whether a revno corresponds to any revision.
1318
Zero (the NULL revision) is considered valid.
1321
self.check_real_revno(revno)
1323
def check_real_revno(self, revno):
1325
Check whether a revno corresponds to a real revision.
1326
Zero (the NULL revision) is considered invalid
1328
if revno < 1 or revno > self.revno():
1329
raise InvalidRevisionNumber(revno)
1331
def sign_revision(self, revision_id, gpg_strategy):
1332
"""See Branch.sign_revision."""
1333
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1334
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1337
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1338
"""See Branch.store_revision_signature."""
1339
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1343
class ScratchBranch(BzrBranch):
1344
"""Special test class: a branch that cleans up after itself.
1346
>>> b = ScratchBranch()
1350
>>> b._transport.__del__()
2675
def get_bound_location(self):
2677
return self._transport.get_bytes('bound')[:-1]
2678
except errors.NoSuchFile:
2682
def get_master_branch(self, possible_transports=None):
2683
"""Return the branch we are bound to.
2685
:return: Either a Branch, or None
2687
This could memoise the branch, but if thats done
2688
it must be revalidated on each new lock.
2689
So for now we just don't memoise it.
2690
# RBC 20060304 review this decision.
2692
bound_loc = self.get_bound_location()
2696
return Branch.open(bound_loc,
2697
possible_transports=possible_transports)
2698
except (errors.NotBranchError, errors.ConnectionError), e:
2699
raise errors.BoundBranchConnectionFailure(
2703
def set_bound_location(self, location):
2704
"""Set the target where this branch is bound to.
2706
:param location: URL to the target branch
2709
self._transport.put_bytes('bound', location+'\n',
2710
mode=self.bzrdir._get_file_mode())
1355
def __init__(self, files=[], dirs=[], transport=None):
1356
"""Make a test branch.
1358
This creates a temporary directory and runs init-tree in it.
1360
If any files are listed, they are created in the working copy.
1362
if transport is None:
1363
transport = bzrlib.transport.local.ScratchTransport()
1364
super(ScratchBranch, self).__init__(transport, init=True)
2713
self._transport.delete('bound')
2714
except errors.NoSuchFile:
1366
super(ScratchBranch, self).__init__(transport)
1369
self._transport.mkdir(d)
1372
self._transport.put(f, 'content of %s' % f)
1377
>>> orig = ScratchBranch(files=["file1", "file2"])
1378
>>> clone = orig.clone()
1379
>>> if os.name != 'nt':
1380
... os.path.samefile(orig.base, clone.base)
1382
... orig.base == clone.base
1385
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1388
from shutil import copytree
1389
from tempfile import mkdtemp
1392
copytree(self.base, base, symlinks=True)
1393
return ScratchBranch(
1394
transport=bzrlib.transport.local.ScratchTransport(base))
1397
######################################################################
1401
def is_control_file(filename):
1402
## FIXME: better check
1403
filename = os.path.normpath(filename)
1404
while filename != '':
1405
head, tail = os.path.split(filename)
1406
## mutter('check %r for control file' % ((head, tail), ))
1407
if tail == bzrlib.BZRDIR:
2719
def bind(self, other):
2720
"""Bind this branch to the branch other.
2722
This does not push or pull data between the branches, though it does
2723
check for divergence to raise an error when the branches are not
2724
either the same, or one a prefix of the other. That behaviour may not
2725
be useful, so that check may be removed in future.
2727
:param other: The branch to bind to
2730
# TODO: jam 20051230 Consider checking if the target is bound
2731
# It is debatable whether you should be able to bind to
2732
# a branch which is itself bound.
2733
# Committing is obviously forbidden,
2734
# but binding itself may not be.
2735
# Since we *have* to check at commit time, we don't
2736
# *need* to check here
2738
# we want to raise diverged if:
2739
# last_rev is not in the other_last_rev history, AND
2740
# other_last_rev is not in our history, and do it without pulling
2742
self.set_bound_location(other.base)
2746
"""If bound, unbind"""
2747
return self.set_bound_location(None)
2750
def update(self, possible_transports=None):
2751
"""Synchronise this branch with the master branch if any.
2753
:return: None or the last_revision that was pivoted out during the
2756
master = self.get_master_branch(possible_transports)
2757
if master is not None:
2758
old_tip = _mod_revision.ensure_null(self.last_revision())
2759
self.pull(master, overwrite=True)
2760
if self.repository.get_graph().is_ancestor(old_tip,
2761
_mod_revision.ensure_null(self.last_revision())):
2767
class BzrBranch8(BzrBranch5):
2768
"""A branch that stores tree-reference locations."""
2770
def _open_hook(self):
2771
if self._ignore_fallbacks:
2774
url = self.get_stacked_on_url()
2775
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2776
errors.UnstackableBranchFormat):
2779
for hook in Branch.hooks['transform_fallback_location']:
2780
url = hook(self, url)
2782
hook_name = Branch.hooks.get_hook_name(hook)
2783
raise AssertionError(
2784
"'transform_fallback_location' hook %s returned "
2785
"None, not a URL." % hook_name)
2786
self._activate_fallback_location(url)
2788
def __init__(self, *args, **kwargs):
2789
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2790
super(BzrBranch8, self).__init__(*args, **kwargs)
2791
self._last_revision_info_cache = None
2792
self._reference_info = None
2794
def _clear_cached_state(self):
2795
super(BzrBranch8, self)._clear_cached_state()
2796
self._last_revision_info_cache = None
2797
self._reference_info = None
2799
def _last_revision_info(self):
2800
revision_string = self._transport.get_bytes('last-revision')
2801
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2802
revision_id = cache_utf8.get_cached_utf8(revision_id)
2804
return revno, revision_id
2806
def _write_last_revision_info(self, revno, revision_id):
2807
"""Simply write out the revision id, with no checks.
2809
Use set_last_revision_info to perform this safely.
2811
Does not update the revision_history cache.
2812
Intended to be called by set_last_revision_info and
2813
_write_revision_history.
2815
revision_id = _mod_revision.ensure_null(revision_id)
2816
out_string = '%d %s\n' % (revno, revision_id)
2817
self._transport.put_bytes('last-revision', out_string,
2818
mode=self.bzrdir._get_file_mode())
2821
def set_last_revision_info(self, revno, revision_id):
2822
revision_id = _mod_revision.ensure_null(revision_id)
2823
old_revno, old_revid = self.last_revision_info()
2824
if self._get_append_revisions_only():
2825
self._check_history_violation(revision_id)
2826
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2827
self._write_last_revision_info(revno, revision_id)
2828
self._clear_cached_state()
2829
self._last_revision_info_cache = revno, revision_id
2830
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2832
def _synchronize_history(self, destination, revision_id):
2833
"""Synchronize last revision and revision history between branches.
2835
:see: Branch._synchronize_history
2837
# XXX: The base Branch has a fast implementation of this method based
2838
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2839
# that uses set_revision_history. This class inherits from BzrBranch5,
2840
# but wants the fast implementation, so it calls
2841
# Branch._synchronize_history directly.
2842
Branch._synchronize_history(self, destination, revision_id)
2844
def _check_history_violation(self, revision_id):
2845
last_revision = _mod_revision.ensure_null(self.last_revision())
2846
if _mod_revision.is_null(last_revision):
2848
if last_revision not in self._lefthand_history(revision_id):
2849
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2851
def _gen_revision_history(self):
2852
"""Generate the revision history from last revision
2854
last_revno, last_revision = self.last_revision_info()
2855
self._extend_partial_history(stop_index=last_revno-1)
2856
return list(reversed(self._partial_revision_history_cache))
2858
def _write_revision_history(self, history):
2859
"""Factored out of set_revision_history.
2861
This performs the actual writing to disk, with format-specific checks.
2862
It is intended to be called by BzrBranch5.set_revision_history.
2864
if len(history) == 0:
2865
last_revision = 'null:'
2867
if history != self._lefthand_history(history[-1]):
2868
raise errors.NotLefthandHistory(history)
2869
last_revision = history[-1]
2870
if self._get_append_revisions_only():
2871
self._check_history_violation(last_revision)
2872
self._write_last_revision_info(len(history), last_revision)
2875
def _set_parent_location(self, url):
2876
"""Set the parent branch"""
2877
self._set_config_location('parent_location', url, make_relative=True)
2880
def _get_parent_location(self):
2881
"""Set the parent branch"""
2882
return self._get_config_location('parent_location')
2885
def _set_all_reference_info(self, info_dict):
2886
"""Replace all reference info stored in a branch.
2888
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2891
writer = rio.RioWriter(s)
2892
for key, (tree_path, branch_location) in info_dict.iteritems():
2893
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2894
branch_location=branch_location)
2895
writer.write_stanza(stanza)
2896
self._transport.put_bytes('references', s.getvalue())
2897
self._reference_info = info_dict
2900
def _get_all_reference_info(self):
2901
"""Return all the reference info stored in a branch.
2903
:return: A dict of {file_id: (tree_path, branch_location)}
2905
if self._reference_info is not None:
2906
return self._reference_info
2907
rio_file = self._transport.get('references')
2909
stanzas = rio.read_stanzas(rio_file)
2910
info_dict = dict((s['file_id'], (s['tree_path'],
2911
s['branch_location'])) for s in stanzas)
2914
self._reference_info = info_dict
2917
def set_reference_info(self, file_id, tree_path, branch_location):
2918
"""Set the branch location to use for a tree reference.
2920
:param file_id: The file-id of the tree reference.
2921
:param tree_path: The path of the tree reference in the tree.
2922
:param branch_location: The location of the branch to retrieve tree
2925
info_dict = self._get_all_reference_info()
2926
info_dict[file_id] = (tree_path, branch_location)
2927
if None in (tree_path, branch_location):
2928
if tree_path is not None:
2929
raise ValueError('tree_path must be None when branch_location'
2931
if branch_location is not None:
2932
raise ValueError('branch_location must be None when tree_path'
2934
del info_dict[file_id]
2935
self._set_all_reference_info(info_dict)
2937
def get_reference_info(self, file_id):
2938
"""Get the tree_path and branch_location for a tree reference.
2940
:return: a tuple of (tree_path, branch_location)
2942
return self._get_all_reference_info().get(file_id, (None, None))
2944
def reference_parent(self, file_id, path, possible_transports=None):
2945
"""Return the parent branch for a tree-reference file_id.
2947
:param file_id: The file_id of the tree reference
2948
:param path: The path of the file_id in the tree
2949
:return: A branch associated with the file_id
2951
branch_location = self.get_reference_info(file_id)[1]
2952
if branch_location is None:
2953
return Branch.reference_parent(self, file_id, path,
2954
possible_transports)
2955
branch_location = urlutils.join(self.user_url, branch_location)
2956
return Branch.open(branch_location,
2957
possible_transports=possible_transports)
2959
def set_push_location(self, location):
2960
"""See Branch.set_push_location."""
2961
self._set_config_location('push_location', location)
2963
def set_bound_location(self, location):
2964
"""See Branch.set_push_location."""
2966
config = self.get_config()
2967
if location is None:
2968
if config.get_user_option('bound') != 'True':
2971
config.set_user_option('bound', 'False', warn_masked=True)
2974
self._set_config_location('bound_location', location,
2976
config.set_user_option('bound', 'True', warn_masked=True)
2979
def _get_bound_location(self, bound):
2980
"""Return the bound location in the config file.
2982
Return None if the bound parameter does not match"""
2983
config = self.get_config()
2984
config_bound = (config.get_user_option('bound') == 'True')
2985
if config_bound != bound:
2987
return self._get_config_location('bound_location', config=config)
2989
def get_bound_location(self):
2990
"""See Branch.set_push_location."""
2991
return self._get_bound_location(True)
2993
def get_old_bound_location(self):
2994
"""See Branch.get_old_bound_location"""
2995
return self._get_bound_location(False)
2997
def get_stacked_on_url(self):
2998
# you can always ask for the URL; but you might not be able to use it
2999
# if the repo can't support stacking.
3000
## self._check_stackable_repo()
3001
stacked_url = self._get_config_location('stacked_on_location')
3002
if stacked_url is None:
3003
raise errors.NotStacked(self)
3006
def _get_append_revisions_only(self):
3007
return self.get_config(
3008
).get_user_option_as_bool('append_revisions_only')
3011
def generate_revision_history(self, revision_id, last_rev=None,
3013
"""See BzrBranch5.generate_revision_history"""
3014
history = self._lefthand_history(revision_id, last_rev, other_branch)
3015
revno = len(history)
3016
self.set_last_revision_info(revno, revision_id)
3019
def get_rev_id(self, revno, history=None):
3020
"""Find the revision id of the specified revno."""
3022
return _mod_revision.NULL_REVISION
3024
last_revno, last_revision_id = self.last_revision_info()
3025
if revno <= 0 or revno > last_revno:
3026
raise errors.NoSuchRevision(self, revno)
3028
if history is not None:
3029
return history[revno - 1]
3031
index = last_revno - revno
3032
if len(self._partial_revision_history_cache) <= index:
3033
self._extend_partial_history(stop_index=index)
3034
if len(self._partial_revision_history_cache) > index:
3035
return self._partial_revision_history_cache[index]
3037
raise errors.NoSuchRevision(self, revno)
3040
def revision_id_to_revno(self, revision_id):
3041
"""Given a revision id, return its revno"""
3042
if _mod_revision.is_null(revision_id):
3045
index = self._partial_revision_history_cache.index(revision_id)
3047
self._extend_partial_history(stop_revision=revision_id)
3048
index = len(self._partial_revision_history_cache) - 1
3049
if self._partial_revision_history_cache[index] != revision_id:
3050
raise errors.NoSuchRevision(self, revision_id)
3051
return self.revno() - index
3054
class BzrBranch7(BzrBranch8):
3055
"""A branch with support for a fallback repository."""
3057
def set_reference_info(self, file_id, tree_path, branch_location):
3058
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3060
def get_reference_info(self, file_id):
3061
Branch.get_reference_info(self, file_id)
3063
def reference_parent(self, file_id, path, possible_transports=None):
3064
return Branch.reference_parent(self, file_id, path,
3065
possible_transports)
3068
class BzrBranch6(BzrBranch7):
3069
"""See BzrBranchFormat6 for the capabilities of this branch.
3071
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3075
def get_stacked_on_url(self):
3076
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3079
######################################################################
3080
# results of operations
3083
class _Result(object):
3085
def _show_tag_conficts(self, to_file):
3086
if not getattr(self, 'tag_conflicts', None):
3088
to_file.write('Conflicting tags:\n')
3089
for name, value1, value2 in self.tag_conflicts:
3090
to_file.write(' %s\n' % (name, ))
3093
class PullResult(_Result):
3094
"""Result of a Branch.pull operation.
3096
:ivar old_revno: Revision number before pull.
3097
:ivar new_revno: Revision number after pull.
3098
:ivar old_revid: Tip revision id before pull.
3099
:ivar new_revid: Tip revision id after pull.
3100
:ivar source_branch: Source (local) branch object. (read locked)
3101
:ivar master_branch: Master branch of the target, or the target if no
3103
:ivar local_branch: target branch if there is a Master, else None
3104
:ivar target_branch: Target/destination branch object. (write locked)
3105
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3108
@deprecated_method(deprecated_in((2, 3, 0)))
3110
"""Return the relative change in revno.
3112
:deprecated: Use `new_revno` and `old_revno` instead.
3114
return self.new_revno - self.old_revno
3116
def report(self, to_file):
3118
if self.old_revid == self.new_revid:
3119
to_file.write('No revisions to pull.\n')
3121
to_file.write('Now on revision %d.\n' % self.new_revno)
3122
self._show_tag_conficts(to_file)
3125
class BranchPushResult(_Result):
3126
"""Result of a Branch.push operation.
3128
:ivar old_revno: Revision number (eg 10) of the target before push.
3129
:ivar new_revno: Revision number (eg 12) of the target after push.
3130
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3132
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3134
:ivar source_branch: Source branch object that the push was from. This is
3135
read locked, and generally is a local (and thus low latency) branch.
3136
:ivar master_branch: If target is a bound branch, the master branch of
3137
target, or target itself. Always write locked.
3138
:ivar target_branch: The direct Branch where data is being sent (write
3140
:ivar local_branch: If the target is a bound branch this will be the
3141
target, otherwise it will be None.
3144
@deprecated_method(deprecated_in((2, 3, 0)))
3146
"""Return the relative change in revno.
3148
:deprecated: Use `new_revno` and `old_revno` instead.
3150
return self.new_revno - self.old_revno
3152
def report(self, to_file):
3153
"""Write a human-readable description of the result."""
3154
if self.old_revid == self.new_revid:
3155
note('No new revisions to push.')
3157
note('Pushed up to revision %d.' % self.new_revno)
3158
self._show_tag_conficts(to_file)
3161
class BranchCheckResult(object):
3162
"""Results of checking branch consistency.
3167
def __init__(self, branch):
3168
self.branch = branch
3171
def report_results(self, verbose):
3172
"""Report the check results via trace.note.
3174
:param verbose: Requests more detailed display of what was checked,
3177
note('checked branch %s format %s', self.branch.user_url,
3178
self.branch._format)
3179
for error in self.errors:
3180
note('found error:%s', error)
3183
class Converter5to6(object):
3184
"""Perform an in-place upgrade of format 5 to format 6"""
3186
def convert(self, branch):
3187
# Data for 5 and 6 can peacefully coexist.
3188
format = BzrBranchFormat6()
3189
new_branch = format.open(branch.bzrdir, _found=True)
3191
# Copy source data into target
3192
new_branch._write_last_revision_info(*branch.last_revision_info())
3193
new_branch.set_parent(branch.get_parent())
3194
new_branch.set_bound_location(branch.get_bound_location())
3195
new_branch.set_push_location(branch.get_push_location())
3197
# New branch has no tags by default
3198
new_branch.tags._set_tag_dict({})
3200
# Copying done; now update target format
3201
new_branch._transport.put_bytes('format',
3202
format.get_format_string(),
3203
mode=new_branch.bzrdir._get_file_mode())
3205
# Clean up old files
3206
new_branch._transport.delete('revision-history')
3208
branch.set_parent(None)
3209
except errors.NoSuchFile:
3211
branch.set_bound_location(None)
3214
class Converter6to7(object):
3215
"""Perform an in-place upgrade of format 6 to format 7"""
3217
def convert(self, branch):
3218
format = BzrBranchFormat7()
3219
branch._set_config_location('stacked_on_location', '')
3220
# update target format
3221
branch._transport.put_bytes('format', format.get_format_string())
3224
class Converter7to8(object):
3225
"""Perform an in-place upgrade of format 6 to format 7"""
3227
def convert(self, branch):
3228
format = BzrBranchFormat8()
3229
branch._transport.put_bytes('references', '')
3230
# update target format
3231
branch._transport.put_bytes('format', format.get_format_string())
3234
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3235
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3238
_run_with_write_locked_target will attempt to release the lock it acquires.
3240
If an exception is raised by callable, then that exception *will* be
3241
propagated, even if the unlock attempt raises its own error. Thus
3242
_run_with_write_locked_target should be preferred to simply doing::
3246
return callable(*args, **kwargs)
3251
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3252
# should share code?
3255
result = callable(*args, **kwargs)
3257
exc_info = sys.exc_info()
3261
raise exc_info[0], exc_info[1], exc_info[2]
3267
class InterBranch(InterObject):
3268
"""This class represents operations taking place between two branches.
3270
Its instances have methods like pull() and push() and contain
3271
references to the source and target repositories these operations
3272
can be carried out on.
3276
"""The available optimised InterBranch types."""
3279
def _get_branch_formats_to_test(klass):
3280
"""Return an iterable of format tuples for testing.
3282
:return: An iterable of (from_format, to_format) to use when testing
3283
this InterBranch class. Each InterBranch class should define this
3286
raise NotImplementedError(klass._get_branch_formats_to_test)
3289
def pull(self, overwrite=False, stop_revision=None,
3290
possible_transports=None, local=False):
3291
"""Mirror source into target branch.
3293
The target branch is considered to be 'local', having low latency.
3295
:returns: PullResult instance
3297
raise NotImplementedError(self.pull)
3300
def update_revisions(self, stop_revision=None, overwrite=False,
3302
"""Pull in new perfect-fit revisions.
3304
:param stop_revision: Updated until the given revision
3305
:param overwrite: Always set the branch pointer, rather than checking
3306
to see if it is a proper descendant.
3307
:param graph: A Graph object that can be used to query history
3308
information. This can be None.
3311
raise NotImplementedError(self.update_revisions)
3314
def push(self, overwrite=False, stop_revision=None,
3315
_override_hook_source_branch=None):
3316
"""Mirror the source branch into the target branch.
3318
The source branch is considered to be 'local', having low latency.
3320
raise NotImplementedError(self.push)
3323
def copy_content_into(self, revision_id=None):
3324
"""Copy the content of source into target
3326
revision_id: if not None, the revision history in the new branch will
3327
be truncated to end with revision_id.
3329
raise NotImplementedError(self.copy_content_into)
3332
class GenericInterBranch(InterBranch):
3333
"""InterBranch implementation that uses public Branch functions."""
3336
def is_compatible(klass, source, target):
3337
# GenericBranch uses the public API, so always compatible
3341
def _get_branch_formats_to_test(klass):
3342
return [(BranchFormat._default_format, BranchFormat._default_format)]
3345
def unwrap_format(klass, format):
3346
if isinstance(format, remote.RemoteBranchFormat):
3347
format._ensure_real()
3348
return format._custom_format
3352
def copy_content_into(self, revision_id=None):
3353
"""Copy the content of source into target
3355
revision_id: if not None, the revision history in the new branch will
3356
be truncated to end with revision_id.
3358
self.source.update_references(self.target)
3359
self.source._synchronize_history(self.target, revision_id)
3361
parent = self.source.get_parent()
3362
except errors.InaccessibleParent, e:
3363
mutter('parent was not accessible to copy: %s', e)
3366
self.target.set_parent(parent)
3367
if self.source._push_should_merge_tags():
3368
self.source.tags.merge_to(self.target.tags)
3371
def update_revisions(self, stop_revision=None, overwrite=False,
3373
"""See InterBranch.update_revisions()."""
3374
other_revno, other_last_revision = self.source.last_revision_info()
3375
stop_revno = None # unknown
3376
if stop_revision is None:
3377
stop_revision = other_last_revision
3378
if _mod_revision.is_null(stop_revision):
3379
# if there are no commits, we're done.
3381
stop_revno = other_revno
3383
# what's the current last revision, before we fetch [and change it
3385
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3386
# we fetch here so that we don't process data twice in the common
3387
# case of having something to pull, and so that the check for
3388
# already merged can operate on the just fetched graph, which will
3389
# be cached in memory.
3390
self.target.fetch(self.source, stop_revision)
3391
# Check to see if one is an ancestor of the other
3394
graph = self.target.repository.get_graph()
3395
if self.target._check_if_descendant_or_diverged(
3396
stop_revision, last_rev, graph, self.source):
3397
# stop_revision is a descendant of last_rev, but we aren't
3398
# overwriting, so we're done.
3400
if stop_revno is None:
3402
graph = self.target.repository.get_graph()
3403
this_revno, this_last_revision = \
3404
self.target.last_revision_info()
3405
stop_revno = graph.find_distance_to_null(stop_revision,
3406
[(other_last_revision, other_revno),
3407
(this_last_revision, this_revno)])
3408
self.target.set_last_revision_info(stop_revno, stop_revision)
3411
def pull(self, overwrite=False, stop_revision=None,
3412
possible_transports=None, run_hooks=True,
3413
_override_hook_target=None, local=False):
3414
"""Pull from source into self, updating my master if any.
3416
:param run_hooks: Private parameter - if false, this branch
3417
is being called because it's the master of the primary branch,
3418
so it should not run its hooks.
3420
bound_location = self.target.get_bound_location()
3421
if local and not bound_location:
3422
raise errors.LocalRequiresBoundBranch()
3423
master_branch = None
3424
if not local and bound_location and self.source.user_url != bound_location:
3425
# not pulling from master, so we need to update master.
3426
master_branch = self.target.get_master_branch(possible_transports)
3427
master_branch.lock_write()
3430
# pull from source into master.
3431
master_branch.pull(self.source, overwrite, stop_revision,
3433
return self._pull(overwrite,
3434
stop_revision, _hook_master=master_branch,
3435
run_hooks=run_hooks,
3436
_override_hook_target=_override_hook_target)
3439
master_branch.unlock()
3441
def push(self, overwrite=False, stop_revision=None,
3442
_override_hook_source_branch=None):
3443
"""See InterBranch.push.
3445
This is the basic concrete implementation of push()
3447
:param _override_hook_source_branch: If specified, run
3448
the hooks passing this Branch as the source, rather than self.
3449
This is for use of RemoteBranch, where push is delegated to the
3450
underlying vfs-based Branch.
3452
# TODO: Public option to disable running hooks - should be trivial but
3454
self.source.lock_read()
3456
return _run_with_write_locked_target(
3457
self.target, self._push_with_bound_branches, overwrite,
3459
_override_hook_source_branch=_override_hook_source_branch)
3461
self.source.unlock()
3463
def _push_with_bound_branches(self, overwrite, stop_revision,
3464
_override_hook_source_branch=None):
3465
"""Push from source into target, and into target's master if any.
3468
if _override_hook_source_branch:
3469
result.source_branch = _override_hook_source_branch
3470
for hook in Branch.hooks['post_push']:
3473
bound_location = self.target.get_bound_location()
3474
if bound_location and self.target.base != bound_location:
3475
# there is a master branch.
3477
# XXX: Why the second check? Is it even supported for a branch to
3478
# be bound to itself? -- mbp 20070507
3479
master_branch = self.target.get_master_branch()
3480
master_branch.lock_write()
3482
# push into the master from the source branch.
3483
self.source._basic_push(master_branch, overwrite, stop_revision)
3484
# and push into the target branch from the source. Note that we
3485
# push from the source branch again, because it's considered the
3486
# highest bandwidth repository.
3487
result = self.source._basic_push(self.target, overwrite,
3489
result.master_branch = master_branch
3490
result.local_branch = self.target
3494
master_branch.unlock()
3497
result = self.source._basic_push(self.target, overwrite,
3499
# TODO: Why set master_branch and local_branch if there's no
3500
# binding? Maybe cleaner to just leave them unset? -- mbp
3502
result.master_branch = self.target
3503
result.local_branch = None
3507
def _pull(self, overwrite=False, stop_revision=None,
3508
possible_transports=None, _hook_master=None, run_hooks=True,
3509
_override_hook_target=None, local=False):
3512
This function is the core worker, used by GenericInterBranch.pull to
3513
avoid duplication when pulling source->master and source->local.
3515
:param _hook_master: Private parameter - set the branch to
3516
be supplied as the master to pull hooks.
3517
:param run_hooks: Private parameter - if false, this branch
3518
is being called because it's the master of the primary branch,
3519
so it should not run its hooks.
3520
:param _override_hook_target: Private parameter - set the branch to be
3521
supplied as the target_branch to pull hooks.
3522
:param local: Only update the local branch, and not the bound branch.
3524
# This type of branch can't be bound.
3526
raise errors.LocalRequiresBoundBranch()
3527
result = PullResult()
3528
result.source_branch = self.source
3529
if _override_hook_target is None:
3530
result.target_branch = self.target
3532
result.target_branch = _override_hook_target
3533
self.source.lock_read()
3535
# We assume that during 'pull' the target repository is closer than
3537
self.source.update_references(self.target)
3538
graph = self.target.repository.get_graph(self.source.repository)
3539
# TODO: Branch formats should have a flag that indicates
3540
# that revno's are expensive, and pull() should honor that flag.
3542
result.old_revno, result.old_revid = \
3543
self.target.last_revision_info()
3544
self.target.update_revisions(self.source, stop_revision,
3545
overwrite=overwrite, graph=graph)
3546
# TODO: The old revid should be specified when merging tags,
3547
# so a tags implementation that versions tags can only
3548
# pull in the most recent changes. -- JRV20090506
3549
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3551
result.new_revno, result.new_revid = self.target.last_revision_info()
3553
result.master_branch = _hook_master
3554
result.local_branch = result.target_branch
3556
result.master_branch = result.target_branch
3557
result.local_branch = None
3559
for hook in Branch.hooks['post_pull']:
3562
self.source.unlock()
3566
InterBranch.register_optimiser(GenericInterBranch)
1409
if filename == head:
1416
def gen_file_id(name):
1417
"""Return new file id.
1419
This should probably generate proper UUIDs, but for the moment we
1420
cope with just randomness because running uuidgen every time is
1423
from binascii import hexlify
1424
from time import time
1426
# get last component
1427
idx = name.rfind('/')
1429
name = name[idx+1 : ]
1430
idx = name.rfind('\\')
1432
name = name[idx+1 : ]
1434
# make it not a hidden file
1435
name = name.lstrip('.')
1437
# remove any wierd characters; we don't escape them but rather
1438
# just pull them out
1439
name = re.sub(r'[^\w.]', '', name)
1441
s = hexlify(rand_bytes(8))
1442
return '-'.join((name, compact_date(time()), s))
1446
"""Return a new tree-root file id."""
1447
return gen_file_id('TREE_ROOT')
added
removed
bzrlib/branch.py
