1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
import traceback, socket, fnmatch, difflib, time
22
from binascii import hexlify
25
from inventory import Inventory
26
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
28
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset, appendpath
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout, BzrError
35
from textui import show_status
36
from diff import diff_trees
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
## TODO: Maybe include checks for common corruption of newlines, etc?
43
def find_branch(f, **args):
44
if f.startswith('http://') or f.startswith('https://'):
46
return remotebranch.RemoteBranch(f, **args)
48
return Branch(f, **args)
51
def find_branch_root(f=None):
52
"""Find the branch root enclosing f, or pwd.
54
f may be a filename or a URL.
56
It is not necessary that f exists.
58
Basically we keep looking up until we find the control directory or
62
elif hasattr(os.path, 'realpath'):
63
f = os.path.realpath(f)
65
f = os.path.abspath(f)
70
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
72
head, tail = os.path.split(f)
74
# reached the root, whatever that may be
75
raise BzrError('%r is not in a branch' % orig_f)
80
######################################################################
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
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,
36
revision as _mod_revision,
44
from bzrlib.config import BranchConfig, TransportConfig
45
from bzrlib.tag import (
54
from bzrlib.decorators import (
59
from bzrlib.hooks import Hooks
60
from bzrlib.inter import InterObject
61
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
62
from bzrlib import registry
63
from bzrlib.symbol_versioning import (
67
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
70
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
71
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
72
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
75
class Branch(controldir.ControlComponent):
84
76
"""Branch holding a history of revisions.
87
Base directory of the branch.
79
Base directory/url of the branch; using control_url and
80
control_transport is more standardized.
81
:ivar hooks: An instance of BranchHooks.
82
:ivar _master_branch_cache: cached result of get_master_branch, see
91
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
92
"""Create new branch object at a particular location.
94
base -- Base directory for the branch.
96
init -- If True, create new control files in a previously
97
unversioned directory. If False, the branch must already
100
find_root -- If true and init is false, find the root of the
101
existing branch containing base.
103
In the test suite, creation of new trees is tested using the
104
`ScratchBranch` class.
107
self.base = os.path.realpath(base)
110
self.base = find_branch_root(base)
85
# this is really an instance variable - FIXME move it there
90
def control_transport(self):
91
return self._transport
94
def user_transport(self):
95
return self.bzrdir.user_transport
97
def __init__(self, *ignored, **ignored_too):
98
self.tags = self._format.make_tags(self)
99
self._revision_history_cache = None
100
self._revision_id_to_revno_cache = None
101
self._partial_revision_id_to_revno_cache = {}
102
self._partial_revision_history_cache = []
103
self._tags_bytes = None
104
self._last_revision_info_cache = None
105
self._master_branch_cache = None
106
self._merge_sorted_revisions_cache = None
108
hooks = Branch.hooks['open']
112
def _open_hook(self):
113
"""Called by init to allow simpler extension of the base class."""
115
def _activate_fallback_location(self, url):
116
"""Activate the branch/repository from url as a fallback repository."""
117
for existing_fallback_repo in self.repository._fallback_repositories:
118
if existing_fallback_repo.user_url == url:
119
# This fallback is already configured. This probably only
120
# happens because BzrDir.sprout is a horrible mess. To avoid
121
# confusing _unstack we don't add this a second time.
122
mutter('duplicate activation of fallback %r on %r', url, self)
124
repo = self._get_fallback_repository(url)
125
if repo.has_same_location(self.repository):
126
raise errors.UnstackableLocationError(self.user_url, url)
127
self.repository.add_fallback_repository(repo)
129
def break_lock(self):
130
"""Break a lock if one is present from another instance.
132
Uses the ui factory to ask for confirmation if the lock may be from
135
This will probe the repository for its lock as well.
137
self.control_files.break_lock()
138
self.repository.break_lock()
139
master = self.get_master_branch()
140
if master is not None:
143
def _check_stackable_repo(self):
144
if not self.repository._format.supports_external_lookups:
145
raise errors.UnstackableRepositoryFormat(self.repository._format,
146
self.repository.base)
148
def _extend_partial_history(self, stop_index=None, stop_revision=None):
149
"""Extend the partial history to include a given index
151
If a stop_index is supplied, stop when that index has been reached.
152
If a stop_revision is supplied, stop when that revision is
153
encountered. Otherwise, stop when the beginning of history is
156
:param stop_index: The index which should be present. When it is
157
present, history extension will stop.
158
:param stop_revision: The revision id which should be present. When
159
it is encountered, history extension will stop.
161
if len(self._partial_revision_history_cache) == 0:
162
self._partial_revision_history_cache = [self.last_revision()]
163
repository._iter_for_revno(
164
self.repository, self._partial_revision_history_cache,
165
stop_index=stop_index, stop_revision=stop_revision)
166
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
167
self._partial_revision_history_cache.pop()
169
def _get_check_refs(self):
170
"""Get the references needed for check().
174
revid = self.last_revision()
175
return [('revision-existence', revid), ('lefthand-distance', revid)]
178
def open(base, _unsupported=False, possible_transports=None):
179
"""Open the branch rooted at base.
181
For instance, if the branch is at URL/.bzr/branch,
182
Branch.open(URL) -> a Branch instance.
184
control = bzrdir.BzrDir.open(base, _unsupported,
185
possible_transports=possible_transports)
186
return control.open_branch(unsupported=_unsupported)
189
def open_from_transport(transport, name=None, _unsupported=False):
190
"""Open the branch rooted at transport"""
191
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
192
return control.open_branch(name=name, unsupported=_unsupported)
195
def open_containing(url, possible_transports=None):
196
"""Open an existing branch which contains url.
198
This probes for a branch at url, and searches upwards from there.
200
Basically we keep looking up until we find the control directory or
201
run into the root. If there isn't one, raises NotBranchError.
202
If there is one and it is either an unrecognised format or an unsupported
203
format, UnknownFormatError or UnsupportedFormatError are raised.
204
If there is one, it is returned, along with the unused portion of url.
206
control, relpath = bzrdir.BzrDir.open_containing(url,
208
return control.open_branch(), relpath
210
def _push_should_merge_tags(self):
211
"""Should _basic_push merge this branch's tags into the target?
213
The default implementation returns False if this branch has no tags,
214
and True the rest of the time. Subclasses may override this.
216
return self.supports_tags() and self.tags.get_tag_dict()
218
def get_config(self):
219
"""Get a bzrlib.config.BranchConfig for this Branch.
221
This can then be used to get and set configuration options for the
224
:return: A bzrlib.config.BranchConfig.
226
return BranchConfig(self)
228
def _get_config(self):
229
"""Get the concrete config for just the config in this branch.
231
This is not intended for client use; see Branch.get_config for the
236
:return: An object supporting get_option and set_option.
238
raise NotImplementedError(self._get_config)
240
def _get_fallback_repository(self, url):
241
"""Get the repository we fallback to at url."""
242
url = urlutils.join(self.base, url)
243
a_branch = Branch.open(url,
244
possible_transports=[self.bzrdir.root_transport])
245
return a_branch.repository
248
def _get_tags_bytes(self):
249
"""Get the bytes of a serialised tags dict.
251
Note that not all branches support tags, nor do all use the same tags
252
logic: this method is specific to BasicTags. Other tag implementations
253
may use the same method name and behave differently, safely, because
254
of the double-dispatch via
255
format.make_tags->tags_instance->get_tags_dict.
257
:return: The bytes of the tags file.
258
:seealso: Branch._set_tags_bytes.
260
if self._tags_bytes is None:
261
self._tags_bytes = self._transport.get_bytes('tags')
262
return self._tags_bytes
264
def _get_nick(self, local=False, possible_transports=None):
265
config = self.get_config()
266
# explicit overrides master, but don't look for master if local is True
267
if not local and not config.has_explicit_nickname():
269
master = self.get_master_branch(possible_transports)
270
if master and self.user_url == master.user_url:
271
raise errors.RecursiveBind(self.user_url)
272
if master is not None:
273
# return the master branch value
275
except errors.RecursiveBind, e:
277
except errors.BzrError, e:
278
# Silently fall back to local implicit nick if the master is
280
mutter("Could not connect to bound branch, "
281
"falling back to local nick.\n " + str(e))
282
return config.get_nickname()
284
def _set_nick(self, nick):
285
self.get_config().set_user_option('nickname', nick, warn_masked=True)
287
nick = property(_get_nick, _set_nick)
290
raise NotImplementedError(self.is_locked)
292
def _lefthand_history(self, revision_id, last_rev=None,
294
if 'evil' in debug.debug_flags:
295
mutter_callsite(4, "_lefthand_history scales with history.")
296
# stop_revision must be a descendant of last_revision
297
graph = self.repository.get_graph()
298
if last_rev is not None:
299
if not graph.is_ancestor(last_rev, revision_id):
300
# our previous tip is not merged into stop_revision
301
raise errors.DivergedBranches(self, other_branch)
302
# make a new revision history from the graph
303
parents_map = graph.get_parent_map([revision_id])
304
if revision_id not in parents_map:
305
raise errors.NoSuchRevision(self, revision_id)
306
current_rev_id = revision_id
308
check_not_reserved_id = _mod_revision.check_not_reserved_id
309
# Do not include ghosts or graph origin in revision_history
310
while (current_rev_id in parents_map and
311
len(parents_map[current_rev_id]) > 0):
312
check_not_reserved_id(current_rev_id)
313
new_history.append(current_rev_id)
314
current_rev_id = parents_map[current_rev_id][0]
315
parents_map = graph.get_parent_map([current_rev_id])
316
new_history.reverse()
319
def lock_write(self, token=None):
320
"""Lock the branch for write operations.
322
:param token: A token to permit reacquiring a previously held and
324
:return: A BranchWriteLockResult.
326
raise NotImplementedError(self.lock_write)
329
"""Lock the branch for read operations.
331
:return: A bzrlib.lock.LogicalLockResult.
333
raise NotImplementedError(self.lock_read)
336
raise NotImplementedError(self.unlock)
338
def peek_lock_mode(self):
339
"""Return lock mode for the Branch: 'r', 'w' or None"""
340
raise NotImplementedError(self.peek_lock_mode)
342
def get_physical_lock_status(self):
343
raise NotImplementedError(self.get_physical_lock_status)
346
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
347
"""Return the revision_id for a dotted revno.
349
:param revno: a tuple like (1,) or (1,1,2)
350
:param _cache_reverse: a private parameter enabling storage
351
of the reverse mapping in a top level cache. (This should
352
only be done in selective circumstances as we want to
353
avoid having the mapping cached multiple times.)
354
:return: the revision_id
355
:raises errors.NoSuchRevision: if the revno doesn't exist
357
rev_id = self._do_dotted_revno_to_revision_id(revno)
359
self._partial_revision_id_to_revno_cache[rev_id] = revno
362
def _do_dotted_revno_to_revision_id(self, revno):
363
"""Worker function for dotted_revno_to_revision_id.
365
Subclasses should override this if they wish to
366
provide a more efficient implementation.
369
return self.get_rev_id(revno[0])
370
revision_id_to_revno = self.get_revision_id_to_revno_map()
371
revision_ids = [revision_id for revision_id, this_revno
372
in revision_id_to_revno.iteritems()
373
if revno == this_revno]
374
if len(revision_ids) == 1:
375
return revision_ids[0]
112
self.base = os.path.realpath(base)
113
if not isdir(self.controlfilename('.')):
114
bailout("not a bzr branch: %s" % quotefn(base),
115
['use "bzr init" to initialize a new working tree',
116
'current bzr can only operate from top-of-tree'])
120
self.text_store = ImmutableStore(self.controlfilename('text-store'))
121
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
122
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
126
return '%s(%r)' % (self.__class__.__name__, self.base)
133
def lock(self, mode='w'):
134
"""Lock the on-disk branch, excluding other processes."""
377
revno_str = '.'.join(map(str, revno))
378
raise errors.NoSuchRevision(self, revno_str)
381
def revision_id_to_dotted_revno(self, revision_id):
382
"""Given a revision id, return its dotted revno.
384
:return: a tuple like (1,) or (400,1,3).
386
return self._do_revision_id_to_dotted_revno(revision_id)
388
def _do_revision_id_to_dotted_revno(self, revision_id):
389
"""Worker function for revision_id_to_revno."""
390
# Try the caches if they are loaded
391
result = self._partial_revision_id_to_revno_cache.get(revision_id)
392
if result is not None:
394
if self._revision_id_to_revno_cache:
395
result = self._revision_id_to_revno_cache.get(revision_id)
397
raise errors.NoSuchRevision(self, revision_id)
398
# Try the mainline as it's optimised
140
om = os.O_WRONLY | os.O_CREAT
400
revno = self.revision_id_to_revno(revision_id)
402
except errors.NoSuchRevision:
403
# We need to load and use the full revno map after all
404
result = self.get_revision_id_to_revno_map().get(revision_id)
406
raise errors.NoSuchRevision(self, revision_id)
410
def get_revision_id_to_revno_map(self):
411
"""Return the revision_id => dotted revno map.
413
This will be regenerated on demand, but will be cached.
415
:return: A dictionary mapping revision_id => dotted revno.
416
This dictionary should not be modified by the caller.
418
if self._revision_id_to_revno_cache is not None:
419
mapping = self._revision_id_to_revno_cache
421
mapping = self._gen_revno_map()
422
self._cache_revision_id_to_revno(mapping)
423
# TODO: jam 20070417 Since this is being cached, should we be returning
425
# I would rather not, and instead just declare that users should not
426
# modify the return value.
429
def _gen_revno_map(self):
430
"""Create a new mapping from revision ids to dotted revnos.
432
Dotted revnos are generated based on the current tip in the revision
434
This is the worker function for get_revision_id_to_revno_map, which
435
just caches the return value.
437
:return: A dictionary mapping revision_id => dotted revno.
439
revision_id_to_revno = dict((rev_id, revno)
440
for rev_id, depth, revno, end_of_merge
441
in self.iter_merge_sorted_revisions())
442
return revision_id_to_revno
445
def iter_merge_sorted_revisions(self, start_revision_id=None,
446
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
447
"""Walk the revisions for a branch in merge sorted order.
449
Merge sorted order is the output from a merge-aware,
450
topological sort, i.e. all parents come before their
451
children going forward; the opposite for reverse.
453
:param start_revision_id: the revision_id to begin walking from.
454
If None, the branch tip is used.
455
:param stop_revision_id: the revision_id to terminate the walk
456
after. If None, the rest of history is included.
457
:param stop_rule: if stop_revision_id is not None, the precise rule
458
to use for termination:
459
* 'exclude' - leave the stop revision out of the result (default)
460
* 'include' - the stop revision is the last item in the result
461
* 'with-merges' - include the stop revision and all of its
462
merged revisions in the result
463
* 'with-merges-without-common-ancestry' - filter out revisions
464
that are in both ancestries
465
:param direction: either 'reverse' or 'forward':
466
* reverse means return the start_revision_id first, i.e.
467
start at the most recent revision and go backwards in history
468
* forward returns tuples in the opposite order to reverse.
469
Note in particular that forward does *not* do any intelligent
470
ordering w.r.t. depth as some clients of this API may like.
471
(If required, that ought to be done at higher layers.)
473
:return: an iterator over (revision_id, depth, revno, end_of_merge)
476
* revision_id: the unique id of the revision
477
* depth: How many levels of merging deep this node has been
479
* revno_sequence: This field provides a sequence of
480
revision numbers for all revisions. The format is:
481
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
482
branch that the revno is on. From left to right the REVNO numbers
483
are the sequence numbers within that branch of the revision.
484
* end_of_merge: When True the next node (earlier in history) is
485
part of a different merge.
487
# Note: depth and revno values are in the context of the branch so
488
# we need the full graph to get stable numbers, regardless of the
490
if self._merge_sorted_revisions_cache is None:
491
last_revision = self.last_revision()
492
known_graph = self.repository.get_known_graph_ancestry(
494
self._merge_sorted_revisions_cache = known_graph.merge_sort(
496
filtered = self._filter_merge_sorted_revisions(
497
self._merge_sorted_revisions_cache, start_revision_id,
498
stop_revision_id, stop_rule)
499
# Make sure we don't return revisions that are not part of the
500
# start_revision_id ancestry.
501
filtered = self._filter_start_non_ancestors(filtered)
502
if direction == 'reverse':
504
if direction == 'forward':
505
return reversed(list(filtered))
507
raise ValueError('invalid direction %r' % direction)
509
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
510
start_revision_id, stop_revision_id, stop_rule):
511
"""Iterate over an inclusive range of sorted revisions."""
512
rev_iter = iter(merge_sorted_revisions)
513
if start_revision_id is not None:
514
for node in rev_iter:
515
rev_id = node.key[-1]
516
if rev_id != start_revision_id:
519
# The decision to include the start or not
520
# depends on the stop_rule if a stop is provided
521
# so pop this node back into the iterator
522
rev_iter = chain(iter([node]), rev_iter)
524
if stop_revision_id is None:
526
for node in rev_iter:
527
rev_id = node.key[-1]
528
yield (rev_id, node.merge_depth, node.revno,
530
elif stop_rule == 'exclude':
531
for node in rev_iter:
532
rev_id = node.key[-1]
533
if rev_id == stop_revision_id:
535
yield (rev_id, node.merge_depth, node.revno,
537
elif stop_rule == 'include':
538
for node in rev_iter:
539
rev_id = node.key[-1]
540
yield (rev_id, node.merge_depth, node.revno,
542
if rev_id == stop_revision_id:
544
elif stop_rule == 'with-merges-without-common-ancestry':
545
# We want to exclude all revisions that are already part of the
546
# stop_revision_id ancestry.
547
graph = self.repository.get_graph()
548
ancestors = graph.find_unique_ancestors(start_revision_id,
550
for node in rev_iter:
551
rev_id = node.key[-1]
552
if rev_id not in ancestors:
554
yield (rev_id, node.merge_depth, node.revno,
556
elif stop_rule == 'with-merges':
557
stop_rev = self.repository.get_revision(stop_revision_id)
558
if stop_rev.parent_ids:
559
left_parent = stop_rev.parent_ids[0]
145
raise BzrError("invalid locking mode %r" % mode)
148
lockfile = os.open(self.controlfilename('branch-lock'), om)
150
if e.errno == errno.ENOENT:
151
# might not exist on branches from <0.0.4
152
self.controlfile('branch-lock', 'w').close()
153
lockfile = os.open(self.controlfilename('branch-lock'), om)
561
left_parent = _mod_revision.NULL_REVISION
562
# left_parent is the actual revision we want to stop logging at,
563
# since we want to show the merged revisions after the stop_rev too
564
reached_stop_revision_id = False
565
revision_id_whitelist = []
566
for node in rev_iter:
567
rev_id = node.key[-1]
568
if rev_id == left_parent:
569
# reached the left parent after the stop_revision
571
if (not reached_stop_revision_id or
572
rev_id in revision_id_whitelist):
573
yield (rev_id, node.merge_depth, node.revno,
575
if reached_stop_revision_id or rev_id == stop_revision_id:
576
# only do the merged revs of rev_id from now on
577
rev = self.repository.get_revision(rev_id)
579
reached_stop_revision_id = True
580
revision_id_whitelist.extend(rev.parent_ids)
582
raise ValueError('invalid stop_rule %r' % stop_rule)
584
def _filter_start_non_ancestors(self, rev_iter):
585
# If we started from a dotted revno, we want to consider it as a tip
586
# and don't want to yield revisions that are not part of its
587
# ancestry. Given the order guaranteed by the merge sort, we will see
588
# uninteresting descendants of the first parent of our tip before the
590
first = rev_iter.next()
591
(rev_id, merge_depth, revno, end_of_merge) = first
594
# We start at a mainline revision so by definition, all others
595
# revisions in rev_iter are ancestors
596
for node in rev_iter:
601
pmap = self.repository.get_parent_map([rev_id])
602
parents = pmap.get(rev_id, [])
604
whitelist.update(parents)
606
# If there is no parents, there is nothing of interest left
608
# FIXME: It's hard to test this scenario here as this code is never
609
# called in that case. -- vila 20100322
612
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
614
if rev_id in whitelist:
615
pmap = self.repository.get_parent_map([rev_id])
616
parents = pmap.get(rev_id, [])
617
whitelist.remove(rev_id)
618
whitelist.update(parents)
620
# We've reached the mainline, there is nothing left to
157
fcntl.lockf(lockfile, lm)
159
fcntl.lockf(lockfile, fcntl.LOCK_UN)
161
self._lockmode = None
163
self._lockmode = mode
165
warning("please write a locking method for platform %r" % sys.platform)
167
self._lockmode = None
169
self._lockmode = mode
172
def _need_readlock(self):
173
if self._lockmode not in ['r', 'w']:
174
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
176
def _need_writelock(self):
177
if self._lockmode not in ['w']:
178
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
181
def abspath(self, name):
182
"""Return absolute filename for something in the branch"""
183
return os.path.join(self.base, name)
186
def relpath(self, path):
187
"""Return path relative to this branch of something inside it.
189
Raises an error if path is not in this branch."""
190
rp = os.path.realpath(path)
192
if not rp.startswith(self.base):
193
bailout("path %r is not within branch %r" % (rp, self.base))
194
rp = rp[len(self.base):]
195
rp = rp.lstrip(os.sep)
199
def controlfilename(self, file_or_path):
200
"""Return location relative to branch."""
201
if isinstance(file_or_path, types.StringTypes):
202
file_or_path = [file_or_path]
203
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
206
def controlfile(self, file_or_path, mode='r'):
207
"""Open a control file for this branch.
209
There are two classes of file in the control directory: text
210
and binary. binary files are untranslated byte streams. Text
211
control files are stored with Unix newlines and in UTF-8, even
212
if the platform or locale defaults are different.
215
fn = self.controlfilename(file_or_path)
217
if mode == 'rb' or mode == 'wb':
218
return file(fn, mode)
219
elif mode == 'r' or mode == 'w':
220
# open in binary mode anyhow so there's no newline translation;
221
# codecs uses line buffering by default; don't want that.
223
return codecs.open(fn, mode + 'b', 'utf-8',
624
# A revision that is not part of the ancestry of our
627
yield (rev_id, merge_depth, revno, end_of_merge)
629
def leave_lock_in_place(self):
630
"""Tell this branch object not to release the physical lock when this
633
If lock_write doesn't return a token, then this method is not supported.
635
self.control_files.leave_in_place()
637
def dont_leave_lock_in_place(self):
638
"""Tell this branch object to release the physical lock when this
639
object is unlocked, even if it didn't originally acquire it.
641
If lock_write doesn't return a token, then this method is not supported.
643
self.control_files.dont_leave_in_place()
645
def bind(self, other):
646
"""Bind the local branch the other branch.
648
:param other: The branch to bind to
651
raise errors.UpgradeRequired(self.user_url)
653
def set_append_revisions_only(self, enabled):
654
if not self._format.supports_set_append_revisions_only():
655
raise errors.UpgradeRequired(self.user_url)
226
raise BzrError("invalid controlfile mode %r" % mode)
230
def _make_control(self):
231
os.mkdir(self.controlfilename([]))
232
self.controlfile('README', 'w').write(
233
"This is a Bazaar-NG control directory.\n"
234
"Do not change any files in this directory.")
235
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
236
for d in ('text-store', 'inventory-store', 'revision-store'):
237
os.mkdir(self.controlfilename(d))
238
for f in ('revision-history', 'merged-patches',
239
'pending-merged-patches', 'branch-name',
241
self.controlfile(f, 'w').write('')
242
mutter('created control directory in ' + self.base)
243
Inventory().write_xml(self.controlfile('inventory','w'))
246
def _check_format(self):
247
"""Check this branch format is supported.
249
The current tool only supports the current unstable format.
251
In the future, we might need different in-memory Branch
252
classes to support downlevel branches. But not yet.
254
# This ignores newlines so that we can open branches created
255
# on Windows from Linux and so on. I think it might be better
256
# to always make all internal files in unix format.
257
fmt = self.controlfile('branch-format', 'r').read()
258
fmt.replace('\r\n', '')
259
if fmt != BZR_BRANCH_FORMAT:
260
bailout('sorry, branch format %r not supported' % fmt,
261
['use a different bzr version',
262
'or remove the .bzr directory and "bzr init" again'])
265
def read_working_inventory(self):
266
"""Read the working inventory."""
267
self._need_readlock()
269
# ElementTree does its own conversion from UTF-8, so open in
271
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
272
mutter("loaded inventory of %d items in %f"
273
% (len(inv), time.time() - before))
277
def _write_inventory(self, inv):
278
"""Update the working inventory.
280
That is to say, the inventory describing changes underway, that
281
will be committed to the next revision.
283
self._need_writelock()
284
## TODO: factor out to atomicfile? is rename safe on windows?
285
## TODO: Maybe some kind of clean/dirty marker on inventory?
286
tmpfname = self.controlfilename('inventory.tmp')
287
tmpf = file(tmpfname, 'wb')
290
inv_fname = self.controlfilename('inventory')
291
if sys.platform == 'win32':
293
os.rename(tmpfname, inv_fname)
294
mutter('wrote working inventory')
297
inventory = property(read_working_inventory, _write_inventory, None,
298
"""Inventory for the working copy.""")
301
def add(self, files, verbose=False):
302
"""Make files versioned.
304
Note that the command line normally calls smart_add instead.
306
This puts the files in the Added state, so that they will be
307
recorded by the next commit.
309
TODO: Perhaps have an option to add the ids even if the files do
312
TODO: Perhaps return the ids of the files? But then again it
313
is easy to retrieve them if they're needed.
315
TODO: Option to specify file id.
317
TODO: Adding a directory should optionally recurse down and
318
add all non-ignored children. Perhaps do that in a
321
>>> b = ScratchBranch(files=['foo'])
322
>>> 'foo' in b.unknowns()
327
>>> 'foo' in b.unknowns()
329
>>> bool(b.inventory.path2id('foo'))
335
Traceback (most recent call last):
337
BzrError: ('foo is already versioned', [])
339
>>> b.add(['nothere'])
340
Traceback (most recent call last):
341
BzrError: ('cannot add: not a regular file or directory: nothere', [])
343
self._need_writelock()
345
# TODO: Re-adding a file that is removed in the working copy
346
# should probably put it back with the previous ID.
347
if isinstance(files, types.StringTypes):
350
inv = self.read_working_inventory()
352
if is_control_file(f):
353
bailout("cannot add control file %s" % quotefn(f))
358
bailout("cannot add top-level %r" % f)
360
fullpath = os.path.normpath(self.abspath(f))
363
kind = file_kind(fullpath)
365
# maybe something better?
366
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
368
if kind != 'file' and kind != 'directory':
369
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
371
file_id = gen_file_id(f)
372
inv.add_path(f, kind=kind, file_id=file_id)
375
show_status('A', kind, quotefn(f))
377
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
379
self._write_inventory(inv)
382
def print_file(self, file, revno):
660
self.get_config().set_user_option('append_revisions_only', value,
663
def set_reference_info(self, file_id, tree_path, branch_location):
664
"""Set the branch location to use for a tree reference."""
665
raise errors.UnsupportedOperation(self.set_reference_info, self)
667
def get_reference_info(self, file_id):
668
"""Get the tree_path and branch_location for a tree reference."""
669
raise errors.UnsupportedOperation(self.get_reference_info, self)
672
def fetch(self, from_branch, last_revision=None):
673
"""Copy revisions from from_branch into this branch.
675
:param from_branch: Where to copy from.
676
:param last_revision: What revision to stop at (None for at the end
680
return InterBranch.get(from_branch, self).fetch(last_revision)
682
def get_bound_location(self):
683
"""Return the URL of the branch we are bound to.
685
Older format branches cannot bind, please be sure to use a metadir
690
def get_old_bound_location(self):
691
"""Return the URL of the branch we used to be bound to
693
raise errors.UpgradeRequired(self.user_url)
695
def get_commit_builder(self, parents, config=None, timestamp=None,
696
timezone=None, committer=None, revprops=None,
697
revision_id=None, lossy=False):
698
"""Obtain a CommitBuilder for this branch.
700
:param parents: Revision ids of the parents of the new revision.
701
:param config: Optional configuration to use.
702
:param timestamp: Optional timestamp recorded for commit.
703
:param timezone: Optional timezone for timestamp.
704
:param committer: Optional committer to set for commit.
705
:param revprops: Optional dictionary of revision properties.
706
:param revision_id: Optional revision id.
707
:param lossy: Whether to discard data that can not be natively
708
represented, when pushing to a foreign VCS
712
config = self.get_config()
714
return self.repository.get_commit_builder(self, parents, config,
715
timestamp, timezone, committer, revprops, revision_id,
718
def get_master_branch(self, possible_transports=None):
719
"""Return the branch we are bound to.
721
:return: Either a Branch, or None
725
def get_revision_delta(self, revno):
726
"""Return the delta for one revision.
728
The delta is relative to its mainline predecessor, or the
729
empty tree for revision 1.
731
rh = self.revision_history()
732
if not (1 <= revno <= len(rh)):
733
raise errors.InvalidRevisionNumber(revno)
734
return self.repository.get_revision_delta(rh[revno-1])
736
def get_stacked_on_url(self):
737
"""Get the URL this branch is stacked against.
739
:raises NotStacked: If the branch is not stacked.
740
:raises UnstackableBranchFormat: If the branch does not support
743
raise NotImplementedError(self.get_stacked_on_url)
745
def print_file(self, file, revision_id):
383
746
"""Print `file` to stdout."""
384
self._need_readlock()
385
tree = self.revision_tree(self.lookup_revision(revno))
386
# use inventory as it was in that revision
387
file_id = tree.inventory.path2id(file)
389
bailout("%r is not present in revision %d" % (file, revno))
390
tree.print_file(file_id)
393
def remove(self, files, verbose=False):
394
"""Mark nominated files for removal from the inventory.
396
This does not remove their text. This does not run on
398
TODO: Refuse to remove modified files unless --force is given?
400
>>> b = ScratchBranch(files=['foo'])
402
>>> b.inventory.has_filename('foo')
405
>>> b.working_tree().has_filename('foo')
407
>>> b.inventory.has_filename('foo')
410
>>> b = ScratchBranch(files=['foo'])
415
>>> b.inventory.has_filename('foo')
417
>>> b.basis_tree().has_filename('foo')
419
>>> b.working_tree().has_filename('foo')
422
TODO: Do something useful with directories.
424
TODO: Should this remove the text or not? Tough call; not
425
removing may be useful and the user can just use use rm, and
426
is the opposite of add. Removing it is consistent with most
427
other tools. Maybe an option.
429
## TODO: Normalize names
430
## TODO: Remove nested loops; better scalability
431
self._need_writelock()
433
if isinstance(files, types.StringTypes):
436
tree = self.working_tree()
439
# do this before any modifications
443
bailout("cannot remove unversioned file %s" % quotefn(f))
444
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
446
# having remove it, it must be either ignored or unknown
447
if tree.is_ignored(f):
451
show_status(new_status, inv[fid].kind, quotefn(f))
454
self._write_inventory(inv)
458
"""Return all unknown files.
460
These are files in the working directory that are not versioned or
461
control files or ignored.
463
>>> b = ScratchBranch(files=['foo', 'foo~'])
464
>>> list(b.unknowns())
467
>>> list(b.unknowns())
470
>>> list(b.unknowns())
473
return self.working_tree().unknowns()
476
def commit(self, message, timestamp=None, timezone=None,
479
"""Commit working copy as a new revision.
481
The basic approach is to add all the file texts into the
482
store, then the inventory, then make a new revision pointing
483
to that inventory and store that.
485
This is not quite safe if the working copy changes during the
486
commit; for the moment that is simply not allowed. A better
487
approach is to make a temporary copy of the files before
488
computing their hashes, and then add those hashes in turn to
489
the inventory. This should mean at least that there are no
490
broken hash pointers. There is no way we can get a snapshot
491
of the whole directory at an instant. This would also have to
492
be robust against files disappearing, moving, etc. So the
493
whole thing is a bit hard.
495
timestamp -- if not None, seconds-since-epoch for a
496
postdated/predated commit.
498
self._need_writelock()
500
## TODO: Show branch names
502
# TODO: Don't commit if there are no changes, unless forced?
504
# First walk over the working inventory; and both update that
505
# and also build a new revision inventory. The revision
506
# inventory needs to hold the text-id, sha1 and size of the
507
# actual file versions committed in the revision. (These are
508
# not present in the working inventory.) We also need to
509
# detect missing/deleted files, and remove them from the
512
work_inv = self.read_working_inventory()
514
basis = self.basis_tree()
515
basis_inv = basis.inventory
517
for path, entry in work_inv.iter_entries():
518
## TODO: Cope with files that have gone missing.
520
## TODO: Check that the file kind has not changed from the previous
521
## revision of this file (if any).
525
p = self.abspath(path)
526
file_id = entry.file_id
527
mutter('commit prep file %s, id %r ' % (p, file_id))
529
if not os.path.exists(p):
530
mutter(" file is missing, removing from inventory")
532
show_status('D', entry.kind, quotefn(path))
533
missing_ids.append(file_id)
536
# TODO: Handle files that have been deleted
538
# TODO: Maybe a special case for empty files? Seems a
539
# waste to store them many times.
543
if basis_inv.has_id(file_id):
544
old_kind = basis_inv[file_id].kind
545
if old_kind != entry.kind:
546
bailout("entry %r changed kind from %r to %r"
547
% (file_id, old_kind, entry.kind))
549
if entry.kind == 'directory':
551
bailout("%s is entered as directory but not a directory" % quotefn(p))
552
elif entry.kind == 'file':
554
bailout("%s is entered as file but is not a file" % quotefn(p))
556
content = file(p, 'rb').read()
558
entry.text_sha1 = sha_string(content)
559
entry.text_size = len(content)
561
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
563
and (old_ie.text_size == entry.text_size)
564
and (old_ie.text_sha1 == entry.text_sha1)):
565
## assert content == basis.get_file(file_id).read()
566
entry.text_id = basis_inv[file_id].text_id
567
mutter(' unchanged from previous text_id {%s}' %
571
entry.text_id = gen_file_id(entry.name)
572
self.text_store.add(content, entry.text_id)
573
mutter(' stored with text_id {%s}' % entry.text_id)
577
elif (old_ie.name == entry.name
578
and old_ie.parent_id == entry.parent_id):
583
show_status(state, entry.kind, quotefn(path))
585
for file_id in missing_ids:
586
# have to do this later so we don't mess up the iterator.
587
# since parents may be removed before their children we
590
# FIXME: There's probably a better way to do this; perhaps
591
# the workingtree should know how to filter itself.
592
if work_inv.has_id(file_id):
593
del work_inv[file_id]
596
inv_id = rev_id = _gen_revision_id(time.time())
598
inv_tmp = tempfile.TemporaryFile()
599
inv.write_xml(inv_tmp)
601
self.inventory_store.add(inv_tmp, inv_id)
602
mutter('new inventory_id is {%s}' % inv_id)
604
self._write_inventory(work_inv)
606
if timestamp == None:
607
timestamp = time.time()
609
if committer == None:
610
committer = username()
613
timezone = local_time_offset()
615
mutter("building commit log message")
616
rev = Revision(timestamp=timestamp,
619
precursor = self.last_patch(),
624
rev_tmp = tempfile.TemporaryFile()
625
rev.write_xml(rev_tmp)
627
self.revision_store.add(rev_tmp, rev_id)
628
mutter("new revision_id is {%s}" % rev_id)
630
## XXX: Everything up to here can simply be orphaned if we abort
631
## the commit; it will leave junk files behind but that doesn't
634
## TODO: Read back the just-generated changeset, and make sure it
635
## applies and recreates the right state.
637
## TODO: Also calculate and store the inventory SHA1
638
mutter("committing patch r%d" % (self.revno() + 1))
641
self.append_revision(rev_id)
644
note("commited r%d" % self.revno())
647
def append_revision(self, revision_id):
648
mutter("add {%s} to revision-history" % revision_id)
649
rev_history = self.revision_history()
651
tmprhname = self.controlfilename('revision-history.tmp')
652
rhname = self.controlfilename('revision-history')
654
f = file(tmprhname, 'wt')
655
rev_history.append(revision_id)
656
f.write('\n'.join(rev_history))
660
if sys.platform == 'win32':
662
os.rename(tmprhname, rhname)
666
def get_revision(self, revision_id):
667
"""Return the Revision object for a named revision"""
668
self._need_readlock()
669
r = Revision.read_xml(self.revision_store[revision_id])
670
assert r.revision_id == revision_id
674
def get_inventory(self, inventory_id):
675
"""Get Inventory object by hash.
677
TODO: Perhaps for this and similar methods, take a revision
678
parameter which can be either an integer revno or a
680
self._need_readlock()
681
i = Inventory.read_xml(self.inventory_store[inventory_id])
685
def get_revision_inventory(self, revision_id):
686
"""Return inventory of a past revision."""
687
self._need_readlock()
688
if revision_id == None:
747
raise NotImplementedError(self.print_file)
749
def set_revision_history(self, rev_history):
750
raise NotImplementedError(self.set_revision_history)
753
def set_parent(self, url):
754
"""See Branch.set_parent."""
755
# TODO: Maybe delete old location files?
756
# URLs should never be unicode, even on the local fs,
757
# FIXUP this and get_parent in a future branch format bump:
758
# read and rewrite the file. RBC 20060125
760
if isinstance(url, unicode):
762
url = url.encode('ascii')
763
except UnicodeEncodeError:
764
raise errors.InvalidURL(url,
765
"Urls must be 7-bit ascii, "
766
"use bzrlib.urlutils.escape")
767
url = urlutils.relative_url(self.base, url)
768
self._set_parent_location(url)
771
def set_stacked_on_url(self, url):
772
"""Set the URL this branch is stacked against.
774
:raises UnstackableBranchFormat: If the branch does not support
776
:raises UnstackableRepositoryFormat: If the repository does not support
779
if not self._format.supports_stacking():
780
raise errors.UnstackableBranchFormat(self._format, self.user_url)
781
# XXX: Changing from one fallback repository to another does not check
782
# that all the data you need is present in the new fallback.
783
# Possibly it should.
784
self._check_stackable_repo()
787
old_url = self.get_stacked_on_url()
788
except (errors.NotStacked, errors.UnstackableBranchFormat,
789
errors.UnstackableRepositoryFormat):
691
return self.get_inventory(self.get_revision(revision_id).inventory_id)
793
self._activate_fallback_location(url)
794
# write this out after the repository is stacked to avoid setting a
795
# stacked config that doesn't work.
796
self._set_config_location('stacked_on_location', url)
799
"""Change a branch to be unstacked, copying data as needed.
801
Don't call this directly, use set_stacked_on_url(None).
803
pb = ui.ui_factory.nested_progress_bar()
805
pb.update("Unstacking")
806
# The basic approach here is to fetch the tip of the branch,
807
# including all available ghosts, from the existing stacked
808
# repository into a new repository object without the fallbacks.
810
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
811
# correct for CHKMap repostiories
812
old_repository = self.repository
813
if len(old_repository._fallback_repositories) != 1:
814
raise AssertionError("can't cope with fallback repositories "
815
"of %r (fallbacks: %r)" % (old_repository,
816
old_repository._fallback_repositories))
817
# Open the new repository object.
818
# Repositories don't offer an interface to remove fallback
819
# repositories today; take the conceptually simpler option and just
820
# reopen it. We reopen it starting from the URL so that we
821
# get a separate connection for RemoteRepositories and can
822
# stream from one of them to the other. This does mean doing
823
# separate SSH connection setup, but unstacking is not a
824
# common operation so it's tolerable.
825
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
826
new_repository = new_bzrdir.find_repository()
827
if new_repository._fallback_repositories:
828
raise AssertionError("didn't expect %r to have "
829
"fallback_repositories"
830
% (self.repository,))
831
# Replace self.repository with the new repository.
832
# Do our best to transfer the lock state (i.e. lock-tokens and
833
# lock count) of self.repository to the new repository.
834
lock_token = old_repository.lock_write().repository_token
835
self.repository = new_repository
836
if isinstance(self, remote.RemoteBranch):
837
# Remote branches can have a second reference to the old
838
# repository that need to be replaced.
839
if self._real_branch is not None:
840
self._real_branch.repository = new_repository
841
self.repository.lock_write(token=lock_token)
842
if lock_token is not None:
843
old_repository.leave_lock_in_place()
844
old_repository.unlock()
845
if lock_token is not None:
846
# XXX: self.repository.leave_lock_in_place() before this
847
# function will not be preserved. Fortunately that doesn't
848
# affect the current default format (2a), and would be a
849
# corner-case anyway.
850
# - Andrew Bennetts, 2010/06/30
851
self.repository.dont_leave_lock_in_place()
855
old_repository.unlock()
856
except errors.LockNotHeld:
859
if old_lock_count == 0:
860
raise AssertionError(
861
'old_repository should have been locked at least once.')
862
for i in range(old_lock_count-1):
863
self.repository.lock_write()
864
# Fetch from the old repository into the new.
865
old_repository.lock_read()
867
# XXX: If you unstack a branch while it has a working tree
868
# with a pending merge, the pending-merged revisions will no
869
# longer be present. You can (probably) revert and remerge.
871
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
872
except errors.TagsNotSupported:
873
tags_to_fetch = set()
874
fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
875
old_repository, required_ids=[self.last_revision()],
876
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
877
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
879
old_repository.unlock()
883
def _set_tags_bytes(self, bytes):
884
"""Mirror method for _get_tags_bytes.
886
:seealso: Branch._get_tags_bytes.
888
return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
891
def _set_tags_bytes_locked(self, bytes):
892
self._tags_bytes = bytes
893
return self._transport.put_bytes('tags', bytes)
895
def _cache_revision_history(self, rev_history):
896
"""Set the cached revision history to rev_history.
898
The revision_history method will use this cache to avoid regenerating
899
the revision history.
901
This API is semi-public; it only for use by subclasses, all other code
902
should consider it to be private.
904
self._revision_history_cache = rev_history
906
def _cache_revision_id_to_revno(self, revision_id_to_revno):
907
"""Set the cached revision_id => revno map to revision_id_to_revno.
909
This API is semi-public; it only for use by subclasses, all other code
910
should consider it to be private.
912
self._revision_id_to_revno_cache = revision_id_to_revno
914
def _clear_cached_state(self):
915
"""Clear any cached data on this branch, e.g. cached revision history.
917
This means the next call to revision_history will need to call
918
_gen_revision_history.
920
This API is semi-public; it only for use by subclasses, all other code
921
should consider it to be private.
923
self._revision_history_cache = None
924
self._revision_id_to_revno_cache = None
925
self._last_revision_info_cache = None
926
self._master_branch_cache = None
927
self._merge_sorted_revisions_cache = None
928
self._partial_revision_history_cache = []
929
self._partial_revision_id_to_revno_cache = {}
930
self._tags_bytes = None
932
def _gen_revision_history(self):
933
"""Return sequence of revision hashes on to this branch.
935
Unlike revision_history, this method always regenerates or rereads the
936
revision history, i.e. it does not cache the result, so repeated calls
939
Concrete subclasses should override this instead of revision_history so
940
that subclasses do not need to deal with caching logic.
942
This API is semi-public; it only for use by subclasses, all other code
943
should consider it to be private.
945
raise NotImplementedError(self._gen_revision_history)
694
948
def revision_history(self):
695
"""Return sequence of revision hashes on to this branch.
697
>>> ScratchBranch().revision_history()
700
self._need_readlock()
701
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
704
def enum_history(self, direction):
705
"""Return (revno, revision_id) for history of branch.
708
'forward' is from earliest to latest
709
'reverse' is from latest to earliest
711
rh = self.revision_history()
712
if direction == 'forward':
717
elif direction == 'reverse':
949
"""Return sequence of revision ids on this branch.
951
This method will cache the revision history for as long as it is safe to
954
if 'evil' in debug.debug_flags:
955
mutter_callsite(3, "revision_history scales with history.")
956
if self._revision_history_cache is not None:
957
history = self._revision_history_cache
723
raise BzrError('invalid history direction %r' % direction)
959
history = self._gen_revision_history()
960
self._cache_revision_history(history)
727
964
"""Return current revision number for this branch.
729
966
That is equivalent to the number of revisions committed to
732
>>> b = ScratchBranch()
735
>>> b.commit('no foo')
739
return len(self.revision_history())
742
def last_patch(self):
743
"""Return last patch hash, or None if no history.
745
>>> ScratchBranch().last_patch() == None
748
ph = self.revision_history()
969
return self.last_revision_info()[0]
972
"""Older format branches cannot bind or unbind."""
973
raise errors.UpgradeRequired(self.user_url)
975
def last_revision(self):
976
"""Return last revision id, or NULL_REVISION."""
977
return self.last_revision_info()[1]
980
def last_revision_info(self):
981
"""Return information about the last revision.
983
:return: A tuple (revno, revision_id).
985
if self._last_revision_info_cache is None:
986
self._last_revision_info_cache = self._last_revision_info()
987
return self._last_revision_info_cache
989
def _last_revision_info(self):
990
rh = self.revision_history()
993
return (revno, rh[-1])
755
def lookup_revision(self, revno):
756
"""Return revision hash for revision number."""
995
return (0, _mod_revision.NULL_REVISION)
997
def update_revisions(self, other, stop_revision=None, overwrite=False,
999
"""Pull in new perfect-fit revisions.
1001
:param other: Another Branch to pull from
1002
:param stop_revision: Updated until the given revision
1003
:param overwrite: Always set the branch pointer, rather than checking
1004
to see if it is a proper descendant.
1005
:param graph: A Graph object that can be used to query history
1006
information. This can be None.
1009
return InterBranch.get(other, self).update_revisions(stop_revision,
1012
@deprecated_method(deprecated_in((2, 4, 0)))
1013
def import_last_revision_info(self, source_repo, revno, revid):
1014
"""Set the last revision info, importing from another repo if necessary.
1016
:param source_repo: Source repository to optionally fetch from
1017
:param revno: Revision number of the new tip
1018
:param revid: Revision id of the new tip
1020
if not self.repository.has_same_location(source_repo):
1021
self.repository.fetch(source_repo, revision_id=revid)
1022
self.set_last_revision_info(revno, revid)
1024
def import_last_revision_info_and_tags(self, source, revno, revid,
1026
"""Set the last revision info, importing from another repo if necessary.
1028
This is used by the bound branch code to upload a revision to
1029
the master branch first before updating the tip of the local branch.
1030
Revisions referenced by source's tags are also transferred.
1032
:param source: Source branch to optionally fetch from
1033
:param revno: Revision number of the new tip
1034
:param revid: Revision id of the new tip
1035
:param lossy: Whether to discard metadata that can not be
1036
natively represented
1037
:return: Tuple with the new revision number and revision id
1038
(should only be different from the arguments when lossy=True)
1040
if not self.repository.has_same_location(source.repository):
1041
self.fetch(source, revid)
1042
self.set_last_revision_info(revno, revid)
1043
return (revno, revid)
1045
def revision_id_to_revno(self, revision_id):
1046
"""Given a revision id, return its revno"""
1047
if _mod_revision.is_null(revision_id):
1049
history = self.revision_history()
1051
return history.index(revision_id) + 1
1053
raise errors.NoSuchRevision(self, revision_id)
1056
def get_rev_id(self, revno, history=None):
1057
"""Find the revision id of the specified revno."""
761
# list is 0-based; revisions are 1-based
762
return self.revision_history()[revno-1]
764
raise BzrError("no such revision %s" % revno)
767
def revision_tree(self, revision_id):
768
"""Return Tree for a revision on this branch.
770
`revision_id` may be None for the null revision, in which case
771
an `EmptyTree` is returned."""
772
self._need_readlock()
773
if revision_id == None:
776
inv = self.get_revision_inventory(revision_id)
777
return RevisionTree(self.text_store, inv)
780
def working_tree(self):
781
"""Return a `Tree` for the working copy."""
782
return WorkingTree(self.base, self.read_working_inventory())
1059
return _mod_revision.NULL_REVISION
1060
last_revno, last_revid = self.last_revision_info()
1061
if revno == last_revno:
1063
if revno <= 0 or revno > last_revno:
1064
raise errors.NoSuchRevision(self, revno)
1065
distance_from_last = last_revno - revno
1066
if len(self._partial_revision_history_cache) <= distance_from_last:
1067
self._extend_partial_history(distance_from_last)
1068
return self._partial_revision_history_cache[distance_from_last]
1070
def pull(self, source, overwrite=False, stop_revision=None,
1071
possible_transports=None, *args, **kwargs):
1072
"""Mirror source into this branch.
1074
This branch is considered to be 'local', having low latency.
1076
:returns: PullResult instance
1078
return InterBranch.get(source, self).pull(overwrite=overwrite,
1079
stop_revision=stop_revision,
1080
possible_transports=possible_transports, *args, **kwargs)
1082
def push(self, target, overwrite=False, stop_revision=None, *args,
1084
"""Mirror this branch into target.
1086
This branch is considered to be 'local', having low latency.
1088
return InterBranch.get(self, target).push(overwrite, stop_revision,
1091
def lossy_push(self, target, stop_revision=None):
1092
"""Push deltas into another branch.
1094
:note: This does not, like push, retain the revision ids from
1095
the source branch and will, rather than adding bzr-specific
1096
metadata, push only those semantics of the revision that can be
1097
natively represented by this branch' VCS.
1099
:param target: Target branch
1100
:param stop_revision: Revision to push, defaults to last revision.
1101
:return: BranchPushResult with an extra member revidmap:
1102
A dictionary mapping revision ids from the target branch
1103
to new revision ids in the target branch, for each
1104
revision that was pushed.
1106
inter = InterBranch.get(self, target)
1107
lossy_push = getattr(inter, "lossy_push", None)
1108
if lossy_push is None:
1109
raise errors.LossyPushToSameVCS(self, target)
1110
return lossy_push(stop_revision)
785
1112
def basis_tree(self):
786
"""Return `Tree` object for last revision.
788
If there are no revisions yet, return an `EmptyTree`.
790
>>> b = ScratchBranch(files=['foo'])
791
>>> b.basis_tree().has_filename('foo')
793
>>> b.working_tree().has_filename('foo')
796
>>> b.commit('add foo')
797
>>> b.basis_tree().has_filename('foo')
800
r = self.last_patch()
1113
"""Return `Tree` object for last revision."""
1114
return self.repository.revision_tree(self.last_revision())
1116
def get_parent(self):
1117
"""Return the parent location of the branch.
1119
This is the default location for pull/missing. The usual
1120
pattern is that the user can override it by specifying a
1123
parent = self._get_parent_location()
1126
# This is an old-format absolute path to a local branch
1127
# turn it into a url
1128
if parent.startswith('/'):
1129
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1131
return urlutils.join(self.base[:-1], parent)
1132
except errors.InvalidURLJoin, e:
1133
raise errors.InaccessibleParent(parent, self.user_url)
1135
def _get_parent_location(self):
1136
raise NotImplementedError(self._get_parent_location)
1138
def _set_config_location(self, name, url, config=None,
1139
make_relative=False):
1141
config = self.get_config()
1145
url = urlutils.relative_url(self.base, url)
1146
config.set_user_option(name, url, warn_masked=True)
1148
def _get_config_location(self, name, config=None):
1150
config = self.get_config()
1151
location = config.get_user_option(name)
1156
def get_child_submit_format(self):
1157
"""Return the preferred format of submissions to this branch."""
1158
return self.get_config().get_user_option("child_submit_format")
1160
def get_submit_branch(self):
1161
"""Return the submit location of the branch.
1163
This is the default location for bundle. The usual
1164
pattern is that the user can override it by specifying a
1167
return self.get_config().get_user_option('submit_branch')
1169
def set_submit_branch(self, location):
1170
"""Return the submit location of the branch.
1172
This is the default location for bundle. The usual
1173
pattern is that the user can override it by specifying a
1176
self.get_config().set_user_option('submit_branch', location,
1179
def get_public_branch(self):
1180
"""Return the public location of the branch.
1182
This is used by merge directives.
1184
return self._get_config_location('public_branch')
1186
def set_public_branch(self, location):
1187
"""Return the submit location of the branch.
1189
This is the default location for bundle. The usual
1190
pattern is that the user can override it by specifying a
1193
self._set_config_location('public_branch', location)
1195
def get_push_location(self):
1196
"""Return the None or the location to push this branch to."""
1197
push_loc = self.get_config().get_user_option('push_location')
1200
def set_push_location(self, location):
1201
"""Set a new push location for this branch."""
1202
raise NotImplementedError(self.set_push_location)
1204
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1205
"""Run the post_change_branch_tip hooks."""
1206
hooks = Branch.hooks['post_change_branch_tip']
1209
new_revno, new_revid = self.last_revision_info()
1210
params = ChangeBranchTipParams(
1211
self, old_revno, new_revno, old_revid, new_revid)
1215
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1216
"""Run the pre_change_branch_tip hooks."""
1217
hooks = Branch.hooks['pre_change_branch_tip']
1220
old_revno, old_revid = self.last_revision_info()
1221
params = ChangeBranchTipParams(
1222
self, old_revno, new_revno, old_revid, new_revid)
1228
"""Synchronise this branch with the master branch if any.
1230
:return: None or the last_revision pivoted out during the update.
1234
def check_revno(self, revno):
1236
Check whether a revno corresponds to any revision.
1237
Zero (the NULL revision) is considered valid.
1240
self.check_real_revno(revno)
1242
def check_real_revno(self, revno):
1244
Check whether a revno corresponds to a real revision.
1245
Zero (the NULL revision) is considered invalid
1247
if revno < 1 or revno > self.revno():
1248
raise errors.InvalidRevisionNumber(revno)
1251
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1252
"""Clone this branch into to_bzrdir preserving all semantic values.
1254
Most API users will want 'create_clone_on_transport', which creates a
1255
new bzrdir and branch on the fly.
1257
revision_id: if not None, the revision history in the new branch will
1258
be truncated to end with revision_id.
1260
result = to_bzrdir.create_branch()
1263
if repository_policy is not None:
1264
repository_policy.configure_branch(result)
1265
self.copy_content_into(result, revision_id=revision_id)
1271
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1273
"""Create a new line of development from the branch, into to_bzrdir.
1275
to_bzrdir controls the branch format.
1277
revision_id: if not None, the revision history in the new branch will
1278
be truncated to end with revision_id.
1280
if (repository_policy is not None and
1281
repository_policy.requires_stacking()):
1282
to_bzrdir._format.require_stacking(_skip_repo=True)
1283
result = to_bzrdir.create_branch(repository=repository)
1286
if repository_policy is not None:
1287
repository_policy.configure_branch(result)
1288
self.copy_content_into(result, revision_id=revision_id)
1289
result.set_parent(self.bzrdir.root_transport.base)
1294
def _synchronize_history(self, destination, revision_id):
1295
"""Synchronize last revision and revision history between branches.
1297
This version is most efficient when the destination is also a
1298
BzrBranch6, but works for BzrBranch5, as long as the destination's
1299
repository contains all the lefthand ancestors of the intended
1300
last_revision. If not, set_last_revision_info will fail.
1302
:param destination: The branch to copy the history into
1303
:param revision_id: The revision-id to truncate history at. May
1304
be None to copy complete history.
1306
source_revno, source_revision_id = self.last_revision_info()
1307
if revision_id is None:
1308
revno, revision_id = source_revno, source_revision_id
804
return RevisionTree(self.text_store, self.get_revision_inventory(r))
808
def rename_one(self, from_rel, to_rel):
811
This can change the directory or the filename or both.
813
self._need_writelock()
814
tree = self.working_tree()
816
if not tree.has_filename(from_rel):
817
bailout("can't rename: old working file %r does not exist" % from_rel)
818
if tree.has_filename(to_rel):
819
bailout("can't rename: new working file %r already exists" % to_rel)
821
file_id = inv.path2id(from_rel)
823
bailout("can't rename: old name %r is not versioned" % from_rel)
825
if inv.path2id(to_rel):
826
bailout("can't rename: new name %r is already versioned" % to_rel)
828
to_dir, to_tail = os.path.split(to_rel)
829
to_dir_id = inv.path2id(to_dir)
830
if to_dir_id == None and to_dir != '':
831
bailout("can't determine destination directory id for %r" % to_dir)
833
mutter("rename_one:")
834
mutter(" file_id {%s}" % file_id)
835
mutter(" from_rel %r" % from_rel)
836
mutter(" to_rel %r" % to_rel)
837
mutter(" to_dir %r" % to_dir)
838
mutter(" to_dir_id {%s}" % to_dir_id)
840
inv.rename(file_id, to_dir_id, to_tail)
842
print "%s => %s" % (from_rel, to_rel)
844
from_abs = self.abspath(from_rel)
845
to_abs = self.abspath(to_rel)
847
os.rename(from_abs, to_abs)
849
bailout("failed to rename %r to %r: %s"
850
% (from_abs, to_abs, e[1]),
851
["rename rolled back"])
853
self._write_inventory(inv)
857
def move(self, from_paths, to_name):
860
to_name must exist as a versioned directory.
862
If to_name exists and is a directory, the files are moved into
863
it, keeping their old names. If it is a directory,
865
Note that to_name is only the last component of the new name;
866
this doesn't change the directory.
868
self._need_writelock()
869
## TODO: Option to move IDs only
870
assert not isinstance(from_paths, basestring)
871
tree = self.working_tree()
873
to_abs = self.abspath(to_name)
874
if not isdir(to_abs):
875
bailout("destination %r is not a directory" % to_abs)
876
if not tree.has_filename(to_name):
877
bailout("destination %r not in working directory" % to_abs)
878
to_dir_id = inv.path2id(to_name)
879
if to_dir_id == None and to_name != '':
880
bailout("destination %r is not a versioned directory" % to_name)
881
to_dir_ie = inv[to_dir_id]
882
if to_dir_ie.kind not in ('directory', 'root_directory'):
883
bailout("destination %r is not a directory" % to_abs)
885
to_idpath = Set(inv.get_idpath(to_dir_id))
888
if not tree.has_filename(f):
889
bailout("%r does not exist in working tree" % f)
890
f_id = inv.path2id(f)
892
bailout("%r is not versioned" % f)
893
name_tail = splitpath(f)[-1]
894
dest_path = appendpath(to_name, name_tail)
895
if tree.has_filename(dest_path):
896
bailout("destination %r already exists" % dest_path)
897
if f_id in to_idpath:
898
bailout("can't move %r to a subdirectory of itself" % f)
900
# OK, so there's a race here, it's possible that someone will
901
# create a file in this interval and then the rename might be
902
# left half-done. But we should have caught most problems.
905
name_tail = splitpath(f)[-1]
906
dest_path = appendpath(to_name, name_tail)
907
print "%s => %s" % (f, dest_path)
908
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1310
graph = self.repository.get_graph()
910
os.rename(self.abspath(f), self.abspath(dest_path))
912
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
913
["rename rolled back"])
915
self._write_inventory(inv)
919
def show_status(self, show_all=False, file_list=None):
920
"""Display single-line status for non-ignored working files.
922
The list is show sorted in order by file name.
924
>>> b = ScratchBranch(files=['foo', 'foo~'])
930
>>> b.commit("add foo")
932
>>> os.unlink(b.abspath('foo'))
936
self._need_readlock()
938
# We have to build everything into a list first so that it can
939
# sorted by name, incorporating all the different sources.
941
# FIXME: Rather than getting things in random order and then sorting,
942
# just step through in order.
944
# Interesting case: the old ID for a file has been removed,
945
# but a new file has been created under that name.
947
old = self.basis_tree()
948
new = self.working_tree()
950
items = diff_trees(old, new)
951
# We want to filter out only if any file was provided in the file_list.
952
if isinstance(file_list, list) and len(file_list):
953
items = [item for item in items if item[3] in file_list]
955
for fs, fid, oldname, newname, kind in items:
957
show_status(fs, kind,
958
oldname + ' => ' + newname)
959
elif fs == 'A' or fs == 'M':
960
show_status(fs, kind, newname)
962
show_status(fs, kind, oldname)
965
show_status(fs, kind, newname)
968
show_status(fs, kind, newname)
970
show_status(fs, kind, newname)
972
bailout("weird file state %r" % ((fs, fid),))
976
class ScratchBranch(Branch):
977
"""Special test class: a branch that cleans up after itself.
979
>>> b = ScratchBranch()
1312
revno = graph.find_distance_to_null(revision_id,
1313
[(source_revision_id, source_revno)])
1314
except errors.GhostRevisionsHaveNoRevno:
1315
# Default to 1, if we can't find anything else
1317
destination.set_last_revision_info(revno, revision_id)
1319
def copy_content_into(self, destination, revision_id=None):
1320
"""Copy the content of self into destination.
1322
revision_id: if not None, the revision history in the new branch will
1323
be truncated to end with revision_id.
1325
return InterBranch.get(self, destination).copy_content_into(
1326
revision_id=revision_id)
1328
def update_references(self, target):
1329
if not getattr(self._format, 'supports_reference_locations', False):
1331
reference_dict = self._get_all_reference_info()
1332
if len(reference_dict) == 0:
1334
old_base = self.base
1335
new_base = target.base
1336
target_reference_dict = target._get_all_reference_info()
1337
for file_id, (tree_path, branch_location) in (
1338
reference_dict.items()):
1339
branch_location = urlutils.rebase_url(branch_location,
1341
target_reference_dict.setdefault(
1342
file_id, (tree_path, branch_location))
1343
target._set_all_reference_info(target_reference_dict)
1346
def check(self, refs):
1347
"""Check consistency of the branch.
1349
In particular this checks that revisions given in the revision-history
1350
do actually match up in the revision graph, and that they're all
1351
present in the repository.
1353
Callers will typically also want to check the repository.
1355
:param refs: Calculated refs for this branch as specified by
1356
branch._get_check_refs()
1357
:return: A BranchCheckResult.
1359
result = BranchCheckResult(self)
1360
last_revno, last_revision_id = self.last_revision_info()
1361
actual_revno = refs[('lefthand-distance', last_revision_id)]
1362
if actual_revno != last_revno:
1363
result.errors.append(errors.BzrCheckError(
1364
'revno does not match len(mainline) %s != %s' % (
1365
last_revno, actual_revno)))
1366
# TODO: We should probably also check that self.revision_history
1367
# matches the repository for older branch formats.
1368
# If looking for the code that cross-checks repository parents against
1369
# the iter_reverse_revision_history output, that is now a repository
1373
def _get_checkout_format(self):
1374
"""Return the most suitable metadir for a checkout of this branch.
1375
Weaves are used if this branch's repository uses weaves.
1377
format = self.repository.bzrdir.checkout_metadir()
1378
format.set_branch_format(self._format)
1381
def create_clone_on_transport(self, to_transport, revision_id=None,
1382
stacked_on=None, create_prefix=False, use_existing_dir=False,
1384
"""Create a clone of this branch and its bzrdir.
1386
:param to_transport: The transport to clone onto.
1387
:param revision_id: The revision id to use as tip in the new branch.
1388
If None the tip is obtained from this branch.
1389
:param stacked_on: An optional URL to stack the clone on.
1390
:param create_prefix: Create any missing directories leading up to
1392
:param use_existing_dir: Use an existing directory if one exists.
1394
# XXX: Fix the bzrdir API to allow getting the branch back from the
1395
# clone call. Or something. 20090224 RBC/spiv.
1396
# XXX: Should this perhaps clone colocated branches as well,
1397
# rather than just the default branch? 20100319 JRV
1398
if revision_id is None:
1399
revision_id = self.last_revision()
1400
dir_to = self.bzrdir.clone_on_transport(to_transport,
1401
revision_id=revision_id, stacked_on=stacked_on,
1402
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1404
return dir_to.open_branch()
1406
def create_checkout(self, to_location, revision_id=None,
1407
lightweight=False, accelerator_tree=None,
1409
"""Create a checkout of a branch.
1411
:param to_location: The url to produce the checkout at
1412
:param revision_id: The revision to check out
1413
:param lightweight: If True, produce a lightweight checkout, otherwise,
1414
produce a bound branch (heavyweight checkout)
1415
:param accelerator_tree: A tree which can be used for retrieving file
1416
contents more quickly than the revision tree, i.e. a workingtree.
1417
The revision tree will be used for cases where accelerator_tree's
1418
content is different.
1419
:param hardlink: If true, hard-link files from accelerator_tree,
1421
:return: The tree of the created checkout
1423
t = transport.get_transport(to_location)
1426
format = self._get_checkout_format()
1427
checkout = format.initialize_on_transport(t)
1428
from_branch = BranchReferenceFormat().initialize(checkout,
1431
format = self._get_checkout_format()
1432
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1433
to_location, force_new_tree=False, format=format)
1434
checkout = checkout_branch.bzrdir
1435
checkout_branch.bind(self)
1436
# pull up to the specified revision_id to set the initial
1437
# branch tip correctly, and seed it with history.
1438
checkout_branch.pull(self, stop_revision=revision_id)
1440
tree = checkout.create_workingtree(revision_id,
1441
from_branch=from_branch,
1442
accelerator_tree=accelerator_tree,
1444
basis_tree = tree.basis_tree()
1445
basis_tree.lock_read()
1447
for path, file_id in basis_tree.iter_references():
1448
reference_parent = self.reference_parent(file_id, path)
1449
reference_parent.create_checkout(tree.abspath(path),
1450
basis_tree.get_reference_revision(file_id, path),
1457
def reconcile(self, thorough=True):
1458
"""Make sure the data stored in this branch is consistent."""
1459
from bzrlib.reconcile import BranchReconciler
1460
reconciler = BranchReconciler(self, thorough=thorough)
1461
reconciler.reconcile()
1464
def reference_parent(self, file_id, path, possible_transports=None):
1465
"""Return the parent branch for a tree-reference file_id
1466
:param file_id: The file_id of the tree reference
1467
:param path: The path of the file_id in the tree
1468
:return: A branch associated with the file_id
1470
# FIXME should provide multiple branches, based on config
1471
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1472
possible_transports=possible_transports)
1474
def supports_tags(self):
1475
return self._format.supports_tags()
1477
def automatic_tag_name(self, revision_id):
1478
"""Try to automatically find the tag name for a revision.
1480
:param revision_id: Revision id of the revision.
1481
:return: A tag name or None if no tag name could be determined.
1483
for hook in Branch.hooks['automatic_tag_name']:
1484
ret = hook(self, revision_id)
1489
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1491
"""Ensure that revision_b is a descendant of revision_a.
1493
This is a helper function for update_revisions.
1495
:raises: DivergedBranches if revision_b has diverged from revision_a.
1496
:returns: True if revision_b is a descendant of revision_a.
1498
relation = self._revision_relations(revision_a, revision_b, graph)
1499
if relation == 'b_descends_from_a':
1501
elif relation == 'diverged':
1502
raise errors.DivergedBranches(self, other_branch)
1503
elif relation == 'a_descends_from_b':
1506
raise AssertionError("invalid relation: %r" % (relation,))
1508
def _revision_relations(self, revision_a, revision_b, graph):
1509
"""Determine the relationship between two revisions.
1511
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1513
heads = graph.heads([revision_a, revision_b])
1514
if heads == set([revision_b]):
1515
return 'b_descends_from_a'
1516
elif heads == set([revision_a, revision_b]):
1517
# These branches have diverged
1519
elif heads == set([revision_a]):
1520
return 'a_descends_from_b'
1522
raise AssertionError("invalid heads: %r" % (heads,))
1524
def heads_to_fetch(self):
1525
"""Return the heads that must and that should be fetched to copy this
1526
branch into another repo.
1528
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1529
set of heads that must be fetched. if_present_fetch is a set of
1530
heads that must be fetched if present, but no error is necessary if
1531
they are not present.
1533
# For bzr native formats must_fetch is just the tip, and if_present_fetch
1535
must_fetch = set([self.last_revision()])
1537
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1538
except errors.TagsNotSupported:
1539
if_present_fetch = set()
1540
must_fetch.discard(_mod_revision.NULL_REVISION)
1541
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1542
return must_fetch, if_present_fetch
1545
class BranchFormat(controldir.ControlComponentFormat):
1546
"""An encapsulation of the initialization and open routines for a format.
1548
Formats provide three things:
1549
* An initialization routine,
1553
Formats are placed in an dict by their format string for reference
1554
during branch opening. It's not required that these be instances, they
1555
can be classes themselves with class methods - it simply depends on
1556
whether state is needed for a given format or not.
1558
Once a format is deprecated, just deprecate the initialize and open
1559
methods on the format class. Do not deprecate the object, as the
1560
object will be created every time regardless.
987
def __init__(self, files=[], dirs=[]):
988
"""Make a test branch.
990
This creates a temporary directory and runs init-tree in it.
992
If any files are listed, they are created in the working copy.
994
Branch.__init__(self, tempfile.mkdtemp(), init=True)
996
os.mkdir(self.abspath(d))
999
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1006
"""Destroy the test branch, removing the scratch directory."""
1563
can_set_append_revisions_only = True
1565
def __eq__(self, other):
1566
return self.__class__ is other.__class__
1568
def __ne__(self, other):
1569
return not (self == other)
1572
def find_format(klass, a_bzrdir, name=None):
1573
"""Return the format for the branch object in a_bzrdir."""
1008
mutter("delete ScratchBranch %s" % self.base)
1009
shutil.rmtree(self.base)
1011
# Work around for shutil.rmtree failing on Windows when
1012
# readonly files are encountered
1013
mutter("hit exception in destroying ScratchBranch: %s" % e)
1014
for root, dirs, files in os.walk(self.base, topdown=False):
1016
os.chmod(os.path.join(root, name), 0700)
1017
shutil.rmtree(self.base)
1575
transport = a_bzrdir.get_branch_transport(None, name=name)
1576
format_string = transport.get_bytes("format")
1577
return format_registry.get(format_string)
1578
except errors.NoSuchFile:
1579
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1581
raise errors.UnknownFormatError(format=format_string, kind='branch')
1584
@deprecated_method(deprecated_in((2, 4, 0)))
1585
def get_default_format(klass):
1586
"""Return the current default format."""
1587
return format_registry.get_default()
1590
@deprecated_method(deprecated_in((2, 4, 0)))
1591
def get_formats(klass):
1592
"""Get all the known formats.
1594
Warning: This triggers a load of all lazy registered formats: do not
1595
use except when that is desireed.
1597
return format_registry._get_all()
1599
def get_reference(self, a_bzrdir, name=None):
1600
"""Get the target reference of the branch in a_bzrdir.
1602
format probing must have been completed before calling
1603
this method - it is assumed that the format of the branch
1604
in a_bzrdir is correct.
1606
:param a_bzrdir: The bzrdir to get the branch data from.
1607
:param name: Name of the colocated branch to fetch
1608
:return: None if the branch is not a reference branch.
1613
def set_reference(self, a_bzrdir, name, to_branch):
1614
"""Set the target reference of the branch in a_bzrdir.
1616
format probing must have been completed before calling
1617
this method - it is assumed that the format of the branch
1618
in a_bzrdir is correct.
1620
:param a_bzrdir: The bzrdir to set the branch reference for.
1621
:param name: Name of colocated branch to set, None for default
1622
:param to_branch: branch that the checkout is to reference
1624
raise NotImplementedError(self.set_reference)
1626
def get_format_string(self):
1627
"""Return the ASCII format string that identifies this format."""
1628
raise NotImplementedError(self.get_format_string)
1630
def get_format_description(self):
1631
"""Return the short format description for this format."""
1632
raise NotImplementedError(self.get_format_description)
1634
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1635
hooks = Branch.hooks['post_branch_init']
1638
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1642
def initialize(self, a_bzrdir, name=None, repository=None):
1643
"""Create a branch of this format in a_bzrdir.
1645
:param name: Name of the colocated branch to create.
1647
raise NotImplementedError(self.initialize)
1649
def is_supported(self):
1650
"""Is this format supported?
1652
Supported formats can be initialized and opened.
1653
Unsupported formats may not support initialization or committing or
1654
some other features depending on the reason for not being supported.
1658
def make_tags(self, branch):
1659
"""Create a tags object for branch.
1661
This method is on BranchFormat, because BranchFormats are reflected
1662
over the wire via network_name(), whereas full Branch instances require
1663
multiple VFS method calls to operate at all.
1665
The default implementation returns a disabled-tags instance.
1667
Note that it is normal for branch to be a RemoteBranch when using tags
1670
return DisabledTags(branch)
1672
def network_name(self):
1673
"""A simple byte string uniquely identifying this format for RPC calls.
1675
MetaDir branch formats use their disk format string to identify the
1676
repository over the wire. All in one formats such as bzr < 0.8, and
1677
foreign formats like svn/git and hg should use some marker which is
1678
unique and immutable.
1680
raise NotImplementedError(self.network_name)
1682
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1683
found_repository=None):
1684
"""Return the branch object for a_bzrdir
1686
:param a_bzrdir: A BzrDir that contains a branch.
1687
:param name: Name of colocated branch to open
1688
:param _found: a private parameter, do not use it. It is used to
1689
indicate if format probing has already be done.
1690
:param ignore_fallbacks: when set, no fallback branches will be opened
1691
(if there are any). Default is to open fallbacks.
1693
raise NotImplementedError(self.open)
1696
@deprecated_method(deprecated_in((2, 4, 0)))
1697
def register_format(klass, format):
1698
"""Register a metadir format.
1700
See MetaDirBranchFormatFactory for the ability to register a format
1701
without loading the code the format needs until it is actually used.
1703
format_registry.register(format)
1706
@deprecated_method(deprecated_in((2, 4, 0)))
1707
def set_default_format(klass, format):
1708
format_registry.set_default(format)
1710
def supports_set_append_revisions_only(self):
1711
"""True if this format supports set_append_revisions_only."""
1714
def supports_stacking(self):
1715
"""True if this format records a stacked-on branch."""
1718
def supports_leaving_lock(self):
1719
"""True if this format supports leaving locks in place."""
1720
return False # by default
1723
@deprecated_method(deprecated_in((2, 4, 0)))
1724
def unregister_format(klass, format):
1725
format_registry.remove(format)
1728
return self.get_format_description().rstrip()
1730
def supports_tags(self):
1731
"""True if this format supports tags stored in the branch"""
1732
return False # by default
1735
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1736
"""A factory for a BranchFormat object, permitting simple lazy registration.
1738
While none of the built in BranchFormats are lazy registered yet,
1739
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1740
use it, and the bzr-loom plugin uses it as well (see
1741
bzrlib.plugins.loom.formats).
1744
def __init__(self, format_string, module_name, member_name):
1745
"""Create a MetaDirBranchFormatFactory.
1747
:param format_string: The format string the format has.
1748
:param module_name: Module to load the format class from.
1749
:param member_name: Attribute name within the module for the format class.
1751
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1752
self._format_string = format_string
1754
def get_format_string(self):
1755
"""See BranchFormat.get_format_string."""
1756
return self._format_string
1759
"""Used for network_format_registry support."""
1760
return self.get_obj()()
1763
class BranchHooks(Hooks):
1764
"""A dictionary mapping hook name to a list of callables for branch hooks.
1766
e.g. ['set_rh'] Is the list of items to be called when the
1767
set_revision_history function is invoked.
1771
"""Create the default hooks.
1773
These are all empty initially, because by default nothing should get
1776
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1777
self.add_hook('set_rh',
1778
"Invoked whenever the revision history has been set via "
1779
"set_revision_history. The api signature is (branch, "
1780
"revision_history), and the branch will be write-locked. "
1781
"The set_rh hook can be expensive for bzr to trigger, a better "
1782
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1783
self.add_hook('open',
1784
"Called with the Branch object that has been opened after a "
1785
"branch is opened.", (1, 8))
1786
self.add_hook('post_push',
1787
"Called after a push operation completes. post_push is called "
1788
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1789
"bzr client.", (0, 15))
1790
self.add_hook('post_pull',
1791
"Called after a pull operation completes. post_pull is called "
1792
"with a bzrlib.branch.PullResult object and only runs in the "
1793
"bzr client.", (0, 15))
1794
self.add_hook('pre_commit',
1795
"Called after a commit is calculated but before it is "
1796
"completed. pre_commit is called with (local, master, old_revno, "
1797
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1798
"). old_revid is NULL_REVISION for the first commit to a branch, "
1799
"tree_delta is a TreeDelta object describing changes from the "
1800
"basis revision. hooks MUST NOT modify this delta. "
1801
" future_tree is an in-memory tree obtained from "
1802
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1804
self.add_hook('post_commit',
1805
"Called in the bzr client after a commit has completed. "
1806
"post_commit is called with (local, master, old_revno, old_revid, "
1807
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1808
"commit to a branch.", (0, 15))
1809
self.add_hook('post_uncommit',
1810
"Called in the bzr client after an uncommit completes. "
1811
"post_uncommit is called with (local, master, old_revno, "
1812
"old_revid, new_revno, new_revid) where local is the local branch "
1813
"or None, master is the target branch, and an empty branch "
1814
"receives new_revno of 0, new_revid of None.", (0, 15))
1815
self.add_hook('pre_change_branch_tip',
1816
"Called in bzr client and server before a change to the tip of a "
1817
"branch is made. pre_change_branch_tip is called with a "
1818
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1819
"commit, uncommit will all trigger this hook.", (1, 6))
1820
self.add_hook('post_change_branch_tip',
1821
"Called in bzr client and server after a change to the tip of a "
1822
"branch is made. post_change_branch_tip is called with a "
1823
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1824
"commit, uncommit will all trigger this hook.", (1, 4))
1825
self.add_hook('transform_fallback_location',
1826
"Called when a stacked branch is activating its fallback "
1827
"locations. transform_fallback_location is called with (branch, "
1828
"url), and should return a new url. Returning the same url "
1829
"allows it to be used as-is, returning a different one can be "
1830
"used to cause the branch to stack on a closer copy of that "
1831
"fallback_location. Note that the branch cannot have history "
1832
"accessing methods called on it during this hook because the "
1833
"fallback locations have not been activated. When there are "
1834
"multiple hooks installed for transform_fallback_location, "
1835
"all are called with the url returned from the previous hook."
1836
"The order is however undefined.", (1, 9))
1837
self.add_hook('automatic_tag_name',
1838
"Called to determine an automatic tag name for a revision. "
1839
"automatic_tag_name is called with (branch, revision_id) and "
1840
"should return a tag name or None if no tag name could be "
1841
"determined. The first non-None tag name returned will be used.",
1843
self.add_hook('post_branch_init',
1844
"Called after new branch initialization completes. "
1845
"post_branch_init is called with a "
1846
"bzrlib.branch.BranchInitHookParams. "
1847
"Note that init, branch and checkout (both heavyweight and "
1848
"lightweight) will all trigger this hook.", (2, 2))
1849
self.add_hook('post_switch',
1850
"Called after a checkout switches branch. "
1851
"post_switch is called with a "
1852
"bzrlib.branch.SwitchHookParams.", (2, 2))
1856
# install the default hooks into the Branch class.
1857
Branch.hooks = BranchHooks()
1860
class ChangeBranchTipParams(object):
1861
"""Object holding parameters passed to *_change_branch_tip hooks.
1863
There are 5 fields that hooks may wish to access:
1865
:ivar branch: the branch being changed
1866
:ivar old_revno: revision number before the change
1867
:ivar new_revno: revision number after the change
1868
:ivar old_revid: revision id before the change
1869
:ivar new_revid: revision id after the change
1871
The revid fields are strings. The revno fields are integers.
1874
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1875
"""Create a group of ChangeBranchTip parameters.
1877
:param branch: The branch being changed.
1878
:param old_revno: Revision number before the change.
1879
:param new_revno: Revision number after the change.
1880
:param old_revid: Tip revision id before the change.
1881
:param new_revid: Tip revision id after the change.
1883
self.branch = branch
1884
self.old_revno = old_revno
1885
self.new_revno = new_revno
1886
self.old_revid = old_revid
1887
self.new_revid = new_revid
1889
def __eq__(self, other):
1890
return self.__dict__ == other.__dict__
1893
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1894
self.__class__.__name__, self.branch,
1895
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1898
class BranchInitHookParams(object):
1899
"""Object holding parameters passed to *_branch_init hooks.
1901
There are 4 fields that hooks may wish to access:
1903
:ivar format: the branch format
1904
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1905
:ivar name: name of colocated branch, if any (or None)
1906
:ivar branch: the branch created
1908
Note that for lightweight checkouts, the bzrdir and format fields refer to
1909
the checkout, hence they are different from the corresponding fields in
1910
branch, which refer to the original branch.
1913
def __init__(self, format, a_bzrdir, name, branch):
1914
"""Create a group of BranchInitHook parameters.
1916
:param format: the branch format
1917
:param a_bzrdir: the BzrDir where the branch will be/has been
1919
:param name: name of colocated branch, if any (or None)
1920
:param branch: the branch created
1922
Note that for lightweight checkouts, the bzrdir and format fields refer
1923
to the checkout, hence they are different from the corresponding fields
1924
in branch, which refer to the original branch.
1926
self.format = format
1927
self.bzrdir = a_bzrdir
1929
self.branch = branch
1931
def __eq__(self, other):
1932
return self.__dict__ == other.__dict__
1935
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1938
class SwitchHookParams(object):
1939
"""Object holding parameters passed to *_switch hooks.
1941
There are 4 fields that hooks may wish to access:
1943
:ivar control_dir: BzrDir of the checkout to change
1944
:ivar to_branch: branch that the checkout is to reference
1945
:ivar force: skip the check for local commits in a heavy checkout
1946
:ivar revision_id: revision ID to switch to (or None)
1949
def __init__(self, control_dir, to_branch, force, revision_id):
1950
"""Create a group of SwitchHook parameters.
1952
:param control_dir: BzrDir of the checkout to change
1953
:param to_branch: branch that the checkout is to reference
1954
:param force: skip the check for local commits in a heavy checkout
1955
:param revision_id: revision ID to switch to (or None)
1957
self.control_dir = control_dir
1958
self.to_branch = to_branch
1960
self.revision_id = revision_id
1962
def __eq__(self, other):
1963
return self.__dict__ == other.__dict__
1966
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1967
self.control_dir, self.to_branch,
1971
class BranchFormatMetadir(BranchFormat):
1972
"""Common logic for meta-dir based branch formats."""
1974
def _branch_class(self):
1975
"""What class to instantiate on open calls."""
1976
raise NotImplementedError(self._branch_class)
1978
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1980
"""Initialize a branch in a bzrdir, with specified files
1982
:param a_bzrdir: The bzrdir to initialize the branch in
1983
:param utf8_files: The files to create as a list of
1984
(filename, content) tuples
1985
:param name: Name of colocated branch to create, if any
1986
:return: a branch in this format
1988
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1989
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1990
control_files = lockable_files.LockableFiles(branch_transport,
1991
'lock', lockdir.LockDir)
1992
control_files.create_lock()
1993
control_files.lock_write()
1995
utf8_files += [('format', self.get_format_string())]
1996
for (filename, content) in utf8_files:
1997
branch_transport.put_bytes(
1999
mode=a_bzrdir._get_file_mode())
2001
control_files.unlock()
2002
branch = self.open(a_bzrdir, name, _found=True,
2003
found_repository=repository)
2004
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2007
def network_name(self):
2008
"""A simple byte string uniquely identifying this format for RPC calls.
2010
Metadir branch formats use their format string.
2012
return self.get_format_string()
2014
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2015
found_repository=None):
2016
"""See BranchFormat.open()."""
2018
format = BranchFormat.find_format(a_bzrdir, name=name)
2019
if format.__class__ != self.__class__:
2020
raise AssertionError("wrong format %r found for %r" %
2022
transport = a_bzrdir.get_branch_transport(None, name=name)
2024
control_files = lockable_files.LockableFiles(transport, 'lock',
2026
if found_repository is None:
2027
found_repository = a_bzrdir.find_repository()
2028
return self._branch_class()(_format=self,
2029
_control_files=control_files,
2032
_repository=found_repository,
2033
ignore_fallbacks=ignore_fallbacks)
2034
except errors.NoSuchFile:
2035
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2038
super(BranchFormatMetadir, self).__init__()
2039
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2040
self._matchingbzrdir.set_branch_format(self)
2042
def supports_tags(self):
2045
def supports_leaving_lock(self):
2049
class BzrBranchFormat5(BranchFormatMetadir):
2050
"""Bzr branch format 5.
2053
- a revision-history file.
2055
- a lock dir guarding the branch itself
2056
- all of this stored in a branch/ subdirectory
2057
- works with shared repositories.
2059
This format is new in bzr 0.8.
2062
def _branch_class(self):
2065
def get_format_string(self):
2066
"""See BranchFormat.get_format_string()."""
2067
return "Bazaar-NG branch format 5\n"
2069
def get_format_description(self):
2070
"""See BranchFormat.get_format_description()."""
2071
return "Branch format 5"
2073
def initialize(self, a_bzrdir, name=None, repository=None):
2074
"""Create a branch of this format in a_bzrdir."""
2075
utf8_files = [('revision-history', ''),
2076
('branch-name', ''),
2078
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2080
def supports_tags(self):
2084
class BzrBranchFormat6(BranchFormatMetadir):
2085
"""Branch format with last-revision and tags.
2087
Unlike previous formats, this has no explicit revision history. Instead,
2088
this just stores the last-revision, and the left-hand history leading
2089
up to there is the history.
2091
This format was introduced in bzr 0.15
2092
and became the default in 0.91.
2095
def _branch_class(self):
2098
def get_format_string(self):
2099
"""See BranchFormat.get_format_string()."""
2100
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2102
def get_format_description(self):
2103
"""See BranchFormat.get_format_description()."""
2104
return "Branch format 6"
2106
def initialize(self, a_bzrdir, name=None, repository=None):
2107
"""Create a branch of this format in a_bzrdir."""
2108
utf8_files = [('last-revision', '0 null:\n'),
2109
('branch.conf', ''),
2112
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2114
def make_tags(self, branch):
2115
"""See bzrlib.branch.BranchFormat.make_tags()."""
2116
return BasicTags(branch)
2118
def supports_set_append_revisions_only(self):
2122
class BzrBranchFormat8(BranchFormatMetadir):
2123
"""Metadir format supporting storing locations of subtree branches."""
2125
def _branch_class(self):
2128
def get_format_string(self):
2129
"""See BranchFormat.get_format_string()."""
2130
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2132
def get_format_description(self):
2133
"""See BranchFormat.get_format_description()."""
2134
return "Branch format 8"
2136
def initialize(self, a_bzrdir, name=None, repository=None):
2137
"""Create a branch of this format in a_bzrdir."""
2138
utf8_files = [('last-revision', '0 null:\n'),
2139
('branch.conf', ''),
2143
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2145
def make_tags(self, branch):
2146
"""See bzrlib.branch.BranchFormat.make_tags()."""
2147
return BasicTags(branch)
2149
def supports_set_append_revisions_only(self):
2152
def supports_stacking(self):
2155
supports_reference_locations = True
2158
class BzrBranchFormat7(BranchFormatMetadir):
2159
"""Branch format with last-revision, tags, and a stacked location pointer.
2161
The stacked location pointer is passed down to the repository and requires
2162
a repository format with supports_external_lookups = True.
2164
This format was introduced in bzr 1.6.
2167
def initialize(self, a_bzrdir, name=None, repository=None):
2168
"""Create a branch of this format in a_bzrdir."""
2169
utf8_files = [('last-revision', '0 null:\n'),
2170
('branch.conf', ''),
2173
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2175
def _branch_class(self):
2178
def get_format_string(self):
2179
"""See BranchFormat.get_format_string()."""
2180
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2182
def get_format_description(self):
2183
"""See BranchFormat.get_format_description()."""
2184
return "Branch format 7"
2186
def supports_set_append_revisions_only(self):
2189
def supports_stacking(self):
2192
def make_tags(self, branch):
2193
"""See bzrlib.branch.BranchFormat.make_tags()."""
2194
return BasicTags(branch)
2196
supports_reference_locations = False
2199
class BranchReferenceFormat(BranchFormat):
2200
"""Bzr branch reference format.
2202
Branch references are used in implementing checkouts, they
2203
act as an alias to the real branch which is at some other url.
2210
def get_format_string(self):
2211
"""See BranchFormat.get_format_string()."""
2212
return "Bazaar-NG Branch Reference Format 1\n"
2214
def get_format_description(self):
2215
"""See BranchFormat.get_format_description()."""
2216
return "Checkout reference format 1"
2218
def get_reference(self, a_bzrdir, name=None):
2219
"""See BranchFormat.get_reference()."""
2220
transport = a_bzrdir.get_branch_transport(None, name=name)
2221
return transport.get_bytes('location')
2223
def set_reference(self, a_bzrdir, name, to_branch):
2224
"""See BranchFormat.set_reference()."""
2225
transport = a_bzrdir.get_branch_transport(None, name=name)
2226
location = transport.put_bytes('location', to_branch.base)
2228
def initialize(self, a_bzrdir, name=None, target_branch=None,
2230
"""Create a branch of this format in a_bzrdir."""
2231
if target_branch is None:
2232
# this format does not implement branch itself, thus the implicit
2233
# creation contract must see it as uninitializable
2234
raise errors.UninitializableFormat(self)
2235
mutter('creating branch reference in %s', a_bzrdir.user_url)
2236
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2237
branch_transport.put_bytes('location',
2238
target_branch.bzrdir.user_url)
2239
branch_transport.put_bytes('format', self.get_format_string())
2241
a_bzrdir, name, _found=True,
2242
possible_transports=[target_branch.bzrdir.root_transport])
2243
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2247
super(BranchReferenceFormat, self).__init__()
2248
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2249
self._matchingbzrdir.set_branch_format(self)
2251
def _make_reference_clone_function(format, a_branch):
2252
"""Create a clone() routine for a branch dynamically."""
2253
def clone(to_bzrdir, revision_id=None,
2254
repository_policy=None):
2255
"""See Branch.clone()."""
2256
return format.initialize(to_bzrdir, target_branch=a_branch)
2257
# cannot obey revision_id limits when cloning a reference ...
2258
# FIXME RBC 20060210 either nuke revision_id for clone, or
2259
# emit some sort of warning/error to the caller ?!
2262
def open(self, a_bzrdir, name=None, _found=False, location=None,
2263
possible_transports=None, ignore_fallbacks=False,
2264
found_repository=None):
2265
"""Return the branch that the branch reference in a_bzrdir points at.
2267
:param a_bzrdir: A BzrDir that contains a branch.
2268
:param name: Name of colocated branch to open, if any
2269
:param _found: a private parameter, do not use it. It is used to
2270
indicate if format probing has already be done.
2271
:param ignore_fallbacks: when set, no fallback branches will be opened
2272
(if there are any). Default is to open fallbacks.
2273
:param location: The location of the referenced branch. If
2274
unspecified, this will be determined from the branch reference in
2276
:param possible_transports: An optional reusable transports list.
2279
format = BranchFormat.find_format(a_bzrdir, name=name)
2280
if format.__class__ != self.__class__:
2281
raise AssertionError("wrong format %r found for %r" %
2283
if location is None:
2284
location = self.get_reference(a_bzrdir, name)
2285
real_bzrdir = bzrdir.BzrDir.open(
2286
location, possible_transports=possible_transports)
2287
result = real_bzrdir.open_branch(name=name,
2288
ignore_fallbacks=ignore_fallbacks)
2289
# this changes the behaviour of result.clone to create a new reference
2290
# rather than a copy of the content of the branch.
2291
# I did not use a proxy object because that needs much more extensive
2292
# testing, and we are only changing one behaviour at the moment.
2293
# If we decide to alter more behaviours - i.e. the implicit nickname
2294
# then this should be refactored to introduce a tested proxy branch
2295
# and a subclass of that for use in overriding clone() and ....
2297
result.clone = self._make_reference_clone_function(result)
2301
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2302
"""Branch format registry."""
2304
def __init__(self, other_registry=None):
2305
super(BranchFormatRegistry, self).__init__(other_registry)
2306
self._default_format = None
2308
def set_default(self, format):
2309
self._default_format = format
2311
def get_default(self):
2312
return self._default_format
2315
network_format_registry = registry.FormatRegistry()
2316
"""Registry of formats indexed by their network name.
2318
The network name for a branch format is an identifier that can be used when
2319
referring to formats with smart server operations. See
2320
BranchFormat.network_name() for more detail.
2323
format_registry = BranchFormatRegistry(network_format_registry)
2326
# formats which have no format string are not discoverable
2327
# and not independently creatable, so are not registered.
2328
__format5 = BzrBranchFormat5()
2329
__format6 = BzrBranchFormat6()
2330
__format7 = BzrBranchFormat7()
2331
__format8 = BzrBranchFormat8()
2332
format_registry.register(__format5)
2333
format_registry.register(BranchReferenceFormat())
2334
format_registry.register(__format6)
2335
format_registry.register(__format7)
2336
format_registry.register(__format8)
2337
format_registry.set_default(__format7)
2340
class BranchWriteLockResult(LogicalLockResult):
2341
"""The result of write locking a branch.
2343
:ivar branch_token: The token obtained from the underlying branch lock, or
2345
:ivar unlock: A callable which will unlock the lock.
2348
def __init__(self, unlock, branch_token):
2349
LogicalLockResult.__init__(self, unlock)
2350
self.branch_token = branch_token
2353
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2357
class BzrBranch(Branch, _RelockDebugMixin):
2358
"""A branch stored in the actual filesystem.
2360
Note that it's "local" in the context of the filesystem; it doesn't
2361
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2362
it's writable, and can be accessed via the normal filesystem API.
2364
:ivar _transport: Transport for file operations on this branch's
2365
control files, typically pointing to the .bzr/branch directory.
2366
:ivar repository: Repository for this branch.
2367
:ivar base: The url of the base directory for this branch; the one
2368
containing the .bzr directory.
2369
:ivar name: Optional colocated branch name as it exists in the control
2373
def __init__(self, _format=None,
2374
_control_files=None, a_bzrdir=None, name=None,
2375
_repository=None, ignore_fallbacks=False):
2376
"""Create new branch object at a particular location."""
2377
if a_bzrdir is None:
2378
raise ValueError('a_bzrdir must be supplied')
2380
self.bzrdir = a_bzrdir
2381
self._base = self.bzrdir.transport.clone('..').base
2383
# XXX: We should be able to just do
2384
# self.base = self.bzrdir.root_transport.base
2385
# but this does not quite work yet -- mbp 20080522
2386
self._format = _format
2387
if _control_files is None:
2388
raise ValueError('BzrBranch _control_files is None')
2389
self.control_files = _control_files
2390
self._transport = _control_files._transport
2391
self.repository = _repository
2392
Branch.__init__(self)
2395
if self.name is None:
2396
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2398
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2403
def _get_base(self):
2404
"""Returns the directory containing the control directory."""
2407
base = property(_get_base, doc="The URL for the root of this branch.")
2409
def _get_config(self):
2410
return TransportConfig(self._transport, 'branch.conf')
2412
def is_locked(self):
2413
return self.control_files.is_locked()
2415
def lock_write(self, token=None):
2416
"""Lock the branch for write operations.
2418
:param token: A token to permit reacquiring a previously held and
2420
:return: A BranchWriteLockResult.
2422
if not self.is_locked():
2423
self._note_lock('w')
2424
# All-in-one needs to always unlock/lock.
2425
repo_control = getattr(self.repository, 'control_files', None)
2426
if self.control_files == repo_control or not self.is_locked():
2427
self.repository._warn_if_deprecated(self)
2428
self.repository.lock_write()
2433
return BranchWriteLockResult(self.unlock,
2434
self.control_files.lock_write(token=token))
2437
self.repository.unlock()
2440
def lock_read(self):
2441
"""Lock the branch for read operations.
2443
:return: A bzrlib.lock.LogicalLockResult.
2445
if not self.is_locked():
2446
self._note_lock('r')
2447
# All-in-one needs to always unlock/lock.
2448
repo_control = getattr(self.repository, 'control_files', None)
2449
if self.control_files == repo_control or not self.is_locked():
2450
self.repository._warn_if_deprecated(self)
2451
self.repository.lock_read()
2456
self.control_files.lock_read()
2457
return LogicalLockResult(self.unlock)
2460
self.repository.unlock()
2463
@only_raises(errors.LockNotHeld, errors.LockBroken)
2466
self.control_files.unlock()
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
2471
not self.control_files.is_locked()):
2472
self.repository.unlock()
2473
if not self.control_files.is_locked():
2474
# we just released the lock
2475
self._clear_cached_state()
2477
def peek_lock_mode(self):
2478
if self.control_files._lock_count == 0:
2481
return self.control_files._lock_mode
2483
def get_physical_lock_status(self):
2484
return self.control_files.get_physical_lock_status()
2487
def print_file(self, file, revision_id):
2488
"""See Branch.print_file."""
2489
return self.repository.print_file(file, revision_id)
2491
def _write_revision_history(self, history):
2492
"""Factored out of set_revision_history.
2494
This performs the actual writing to disk.
2495
It is intended to be called by BzrBranch5.set_revision_history."""
2496
self._transport.put_bytes(
2497
'revision-history', '\n'.join(history),
2498
mode=self.bzrdir._get_file_mode())
2500
@deprecated_method(deprecated_in((2, 4, 0)))
2501
def set_revision_history(self, rev_history):
2502
"""See Branch.set_revision_history."""
2503
self._set_revision_history(rev_history)
2506
def _set_revision_history(self, rev_history):
2507
if 'evil' in debug.debug_flags:
2508
mutter_callsite(3, "set_revision_history scales with history.")
2509
check_not_reserved_id = _mod_revision.check_not_reserved_id
2510
for rev_id in rev_history:
2511
check_not_reserved_id(rev_id)
2512
if Branch.hooks['post_change_branch_tip']:
2513
# Don't calculate the last_revision_info() if there are no hooks
2515
old_revno, old_revid = self.last_revision_info()
2516
if len(rev_history) == 0:
2517
revid = _mod_revision.NULL_REVISION
2519
revid = rev_history[-1]
2520
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2521
self._write_revision_history(rev_history)
2522
self._clear_cached_state()
2523
self._cache_revision_history(rev_history)
2524
for hook in Branch.hooks['set_rh']:
2525
hook(self, rev_history)
2526
if Branch.hooks['post_change_branch_tip']:
2527
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2529
def _synchronize_history(self, destination, revision_id):
2530
"""Synchronize last revision and revision history between branches.
2532
This version is most efficient when the destination is also a
2533
BzrBranch5, but works for BzrBranch6 as long as the revision
2534
history is the true lefthand parent history, and all of the revisions
2535
are in the destination's repository. If not, set_revision_history
2538
:param destination: The branch to copy the history into
2539
:param revision_id: The revision-id to truncate history at. May
2540
be None to copy complete history.
2542
if not isinstance(destination._format, BzrBranchFormat5):
2543
super(BzrBranch, self)._synchronize_history(
2544
destination, revision_id)
2546
if revision_id == _mod_revision.NULL_REVISION:
2549
new_history = self.revision_history()
2550
if revision_id is not None and new_history != []:
2552
new_history = new_history[:new_history.index(revision_id) + 1]
2554
rev = self.repository.get_revision(revision_id)
2555
new_history = rev.get_history(self.repository)[1:]
2556
destination._set_revision_history(new_history)
2559
def set_last_revision_info(self, revno, revision_id):
2560
"""Set the last revision of this branch.
2562
The caller is responsible for checking that the revno is correct
2563
for this revision id.
2565
It may be possible to set the branch last revision to an id not
2566
present in the repository. However, branches can also be
2567
configured to check constraints on history, in which case this may not
2570
if not revision_id or not isinstance(revision_id, basestring):
2571
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2572
# this old format stores the full history, but this api doesn't
2573
# provide it, so we must generate, and might as well check it's
2575
history = self._lefthand_history(revision_id)
2576
if len(history) != revno:
2577
raise AssertionError('%d != %d' % (len(history), revno))
2578
self._set_revision_history(history)
2580
def _gen_revision_history(self):
2581
history = self._transport.get_bytes('revision-history').split('\n')
2582
if history[-1:] == ['']:
2583
# There shouldn't be a trailing newline, but just in case.
2588
def generate_revision_history(self, revision_id, last_rev=None,
2590
"""Create a new revision history that will finish with revision_id.
2592
:param revision_id: the new tip to use.
2593
:param last_rev: The previous last_revision. If not None, then this
2594
must be a ancestory of revision_id, or DivergedBranches is raised.
2595
:param other_branch: The other branch that DivergedBranches should
2596
raise with respect to.
2598
self._set_revision_history(self._lefthand_history(revision_id,
2599
last_rev, other_branch))
2601
def basis_tree(self):
2602
"""See Branch.basis_tree."""
2603
return self.repository.revision_tree(self.last_revision())
2605
def _get_parent_location(self):
2606
_locs = ['parent', 'pull', 'x-pull']
2609
return self._transport.get_bytes(l).strip('\n')
2610
except errors.NoSuchFile:
2614
def _basic_push(self, target, overwrite, stop_revision):
2615
"""Basic implementation of push without bound branches or hooks.
2617
Must be called with source read locked and target write locked.
2619
result = BranchPushResult()
2620
result.source_branch = self
2621
result.target_branch = target
2622
result.old_revno, result.old_revid = target.last_revision_info()
2623
self.update_references(target)
2624
if result.old_revid != stop_revision:
2625
# We assume that during 'push' this repository is closer than
2627
graph = self.repository.get_graph(target.repository)
2628
target.update_revisions(self, stop_revision,
2629
overwrite=overwrite, graph=graph)
2630
if self._push_should_merge_tags():
2631
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2632
result.new_revno, result.new_revid = target.last_revision_info()
2635
def get_stacked_on_url(self):
2636
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2638
def set_push_location(self, location):
2639
"""See Branch.set_push_location."""
2640
self.get_config().set_user_option(
2641
'push_location', location,
2642
store=_mod_config.STORE_LOCATION_NORECURSE)
2644
def _set_parent_location(self, url):
2646
self._transport.delete('parent')
2648
self._transport.put_bytes('parent', url + '\n',
2649
mode=self.bzrdir._get_file_mode())
2652
class BzrBranch5(BzrBranch):
2653
"""A format 5 branch. This supports new features over plain branches.
2655
It has support for a master_branch which is the data for bound branches.
2658
def get_bound_location(self):
2660
return self._transport.get_bytes('bound')[:-1]
2661
except errors.NoSuchFile:
2665
def get_master_branch(self, possible_transports=None):
2666
"""Return the branch we are bound to.
2668
:return: Either a Branch, or None
2670
if self._master_branch_cache is None:
2671
self._master_branch_cache = self._get_master_branch(
2672
possible_transports)
2673
return self._master_branch_cache
2675
def _get_master_branch(self, possible_transports):
2676
bound_loc = self.get_bound_location()
2680
return Branch.open(bound_loc,
2681
possible_transports=possible_transports)
2682
except (errors.NotBranchError, errors.ConnectionError), e:
2683
raise errors.BoundBranchConnectionFailure(
2687
def set_bound_location(self, location):
2688
"""Set the target where this branch is bound to.
2690
:param location: URL to the target branch
2692
self._master_branch_cache = None
2694
self._transport.put_bytes('bound', location+'\n',
2695
mode=self.bzrdir._get_file_mode())
2698
self._transport.delete('bound')
2699
except errors.NoSuchFile:
2704
def bind(self, other):
2705
"""Bind this branch to the branch other.
2707
This does not push or pull data between the branches, though it does
2708
check for divergence to raise an error when the branches are not
2709
either the same, or one a prefix of the other. That behaviour may not
2710
be useful, so that check may be removed in future.
2712
:param other: The branch to bind to
2715
# TODO: jam 20051230 Consider checking if the target is bound
2716
# It is debatable whether you should be able to bind to
2717
# a branch which is itself bound.
2718
# Committing is obviously forbidden,
2719
# but binding itself may not be.
2720
# Since we *have* to check at commit time, we don't
2721
# *need* to check here
2723
# we want to raise diverged if:
2724
# last_rev is not in the other_last_rev history, AND
2725
# other_last_rev is not in our history, and do it without pulling
2727
self.set_bound_location(other.base)
2731
"""If bound, unbind"""
2732
return self.set_bound_location(None)
2735
def update(self, possible_transports=None):
2736
"""Synchronise this branch with the master branch if any.
2738
:return: None or the last_revision that was pivoted out during the
2741
master = self.get_master_branch(possible_transports)
2742
if master is not None:
2743
old_tip = _mod_revision.ensure_null(self.last_revision())
2744
self.pull(master, overwrite=True)
2745
if self.repository.get_graph().is_ancestor(old_tip,
2746
_mod_revision.ensure_null(self.last_revision())):
2752
class BzrBranch8(BzrBranch5):
2753
"""A branch that stores tree-reference locations."""
2755
def _open_hook(self):
2756
if self._ignore_fallbacks:
2759
url = self.get_stacked_on_url()
2760
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2761
errors.UnstackableBranchFormat):
2764
for hook in Branch.hooks['transform_fallback_location']:
2765
url = hook(self, url)
2767
hook_name = Branch.hooks.get_hook_name(hook)
2768
raise AssertionError(
2769
"'transform_fallback_location' hook %s returned "
2770
"None, not a URL." % hook_name)
2771
self._activate_fallback_location(url)
2773
def __init__(self, *args, **kwargs):
2774
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2775
super(BzrBranch8, self).__init__(*args, **kwargs)
2776
self._last_revision_info_cache = None
2777
self._reference_info = None
2779
def _clear_cached_state(self):
2780
super(BzrBranch8, self)._clear_cached_state()
2781
self._last_revision_info_cache = None
2782
self._reference_info = None
2784
def _last_revision_info(self):
2785
revision_string = self._transport.get_bytes('last-revision')
2786
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2787
revision_id = cache_utf8.get_cached_utf8(revision_id)
2789
return revno, revision_id
2791
def _write_last_revision_info(self, revno, revision_id):
2792
"""Simply write out the revision id, with no checks.
2794
Use set_last_revision_info to perform this safely.
2796
Does not update the revision_history cache.
2797
Intended to be called by set_last_revision_info and
2798
_write_revision_history.
2800
revision_id = _mod_revision.ensure_null(revision_id)
2801
out_string = '%d %s\n' % (revno, revision_id)
2802
self._transport.put_bytes('last-revision', out_string,
2803
mode=self.bzrdir._get_file_mode())
2806
def set_last_revision_info(self, revno, revision_id):
2807
if not revision_id or not isinstance(revision_id, basestring):
2808
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2809
old_revno, old_revid = self.last_revision_info()
2810
if self._get_append_revisions_only():
2811
self._check_history_violation(revision_id)
2812
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2813
self._write_last_revision_info(revno, revision_id)
2814
self._clear_cached_state()
2815
self._last_revision_info_cache = revno, revision_id
2816
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2818
def _synchronize_history(self, destination, revision_id):
2819
"""Synchronize last revision and revision history between branches.
2821
:see: Branch._synchronize_history
2823
# XXX: The base Branch has a fast implementation of this method based
2824
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2825
# that uses set_revision_history. This class inherits from BzrBranch5,
2826
# but wants the fast implementation, so it calls
2827
# Branch._synchronize_history directly.
2828
Branch._synchronize_history(self, destination, revision_id)
2830
def _check_history_violation(self, revision_id):
2831
last_revision = _mod_revision.ensure_null(self.last_revision())
2832
if _mod_revision.is_null(last_revision):
2834
if last_revision not in self._lefthand_history(revision_id):
2835
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2837
def _gen_revision_history(self):
2838
"""Generate the revision history from last revision
2840
last_revno, last_revision = self.last_revision_info()
2841
self._extend_partial_history(stop_index=last_revno-1)
2842
return list(reversed(self._partial_revision_history_cache))
2844
def _write_revision_history(self, history):
2845
"""Factored out of set_revision_history.
2847
This performs the actual writing to disk, with format-specific checks.
2848
It is intended to be called by BzrBranch5.set_revision_history.
2850
if len(history) == 0:
2851
last_revision = 'null:'
2853
if history != self._lefthand_history(history[-1]):
2854
raise errors.NotLefthandHistory(history)
2855
last_revision = history[-1]
2856
if self._get_append_revisions_only():
2857
self._check_history_violation(last_revision)
2858
self._write_last_revision_info(len(history), last_revision)
2861
def _set_parent_location(self, url):
2862
"""Set the parent branch"""
2863
self._set_config_location('parent_location', url, make_relative=True)
2866
def _get_parent_location(self):
2867
"""Set the parent branch"""
2868
return self._get_config_location('parent_location')
2871
def _set_all_reference_info(self, info_dict):
2872
"""Replace all reference info stored in a branch.
2874
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2877
writer = rio.RioWriter(s)
2878
for key, (tree_path, branch_location) in info_dict.iteritems():
2879
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2880
branch_location=branch_location)
2881
writer.write_stanza(stanza)
2882
self._transport.put_bytes('references', s.getvalue())
2883
self._reference_info = info_dict
2886
def _get_all_reference_info(self):
2887
"""Return all the reference info stored in a branch.
2889
:return: A dict of {file_id: (tree_path, branch_location)}
2891
if self._reference_info is not None:
2892
return self._reference_info
2893
rio_file = self._transport.get('references')
2895
stanzas = rio.read_stanzas(rio_file)
2896
info_dict = dict((s['file_id'], (s['tree_path'],
2897
s['branch_location'])) for s in stanzas)
2900
self._reference_info = info_dict
2903
def set_reference_info(self, file_id, tree_path, branch_location):
2904
"""Set the branch location to use for a tree reference.
2906
:param file_id: The file-id of the tree reference.
2907
:param tree_path: The path of the tree reference in the tree.
2908
:param branch_location: The location of the branch to retrieve tree
2911
info_dict = self._get_all_reference_info()
2912
info_dict[file_id] = (tree_path, branch_location)
2913
if None in (tree_path, branch_location):
2914
if tree_path is not None:
2915
raise ValueError('tree_path must be None when branch_location'
2917
if branch_location is not None:
2918
raise ValueError('branch_location must be None when tree_path'
2920
del info_dict[file_id]
2921
self._set_all_reference_info(info_dict)
2923
def get_reference_info(self, file_id):
2924
"""Get the tree_path and branch_location for a tree reference.
2926
:return: a tuple of (tree_path, branch_location)
2928
return self._get_all_reference_info().get(file_id, (None, None))
2930
def reference_parent(self, file_id, path, possible_transports=None):
2931
"""Return the parent branch for a tree-reference file_id.
2933
:param file_id: The file_id of the tree reference
2934
:param path: The path of the file_id in the tree
2935
:return: A branch associated with the file_id
2937
branch_location = self.get_reference_info(file_id)[1]
2938
if branch_location is None:
2939
return Branch.reference_parent(self, file_id, path,
2940
possible_transports)
2941
branch_location = urlutils.join(self.user_url, branch_location)
2942
return Branch.open(branch_location,
2943
possible_transports=possible_transports)
2945
def set_push_location(self, location):
2946
"""See Branch.set_push_location."""
2947
self._set_config_location('push_location', location)
2949
def set_bound_location(self, location):
2950
"""See Branch.set_push_location."""
2951
self._master_branch_cache = None
2953
config = self.get_config()
2954
if location is None:
2955
if config.get_user_option('bound') != 'True':
2958
config.set_user_option('bound', 'False', warn_masked=True)
2961
self._set_config_location('bound_location', location,
2963
config.set_user_option('bound', 'True', warn_masked=True)
2966
def _get_bound_location(self, bound):
2967
"""Return the bound location in the config file.
2969
Return None if the bound parameter does not match"""
2970
config = self.get_config()
2971
config_bound = (config.get_user_option('bound') == 'True')
2972
if config_bound != bound:
2974
return self._get_config_location('bound_location', config=config)
2976
def get_bound_location(self):
2977
"""See Branch.set_push_location."""
2978
return self._get_bound_location(True)
2980
def get_old_bound_location(self):
2981
"""See Branch.get_old_bound_location"""
2982
return self._get_bound_location(False)
2984
def get_stacked_on_url(self):
2985
# you can always ask for the URL; but you might not be able to use it
2986
# if the repo can't support stacking.
2987
## self._check_stackable_repo()
2988
stacked_url = self._get_config_location('stacked_on_location')
2989
if stacked_url is None:
2990
raise errors.NotStacked(self)
2993
def _get_append_revisions_only(self):
2994
return self.get_config(
2995
).get_user_option_as_bool('append_revisions_only')
2998
def generate_revision_history(self, revision_id, last_rev=None,
3000
"""See BzrBranch5.generate_revision_history"""
3001
history = self._lefthand_history(revision_id, last_rev, other_branch)
3002
revno = len(history)
3003
self.set_last_revision_info(revno, revision_id)
3006
def get_rev_id(self, revno, history=None):
3007
"""Find the revision id of the specified revno."""
3009
return _mod_revision.NULL_REVISION
3011
last_revno, last_revision_id = self.last_revision_info()
3012
if revno <= 0 or revno > last_revno:
3013
raise errors.NoSuchRevision(self, revno)
3015
if history is not None:
3016
return history[revno - 1]
3018
index = last_revno - revno
3019
if len(self._partial_revision_history_cache) <= index:
3020
self._extend_partial_history(stop_index=index)
3021
if len(self._partial_revision_history_cache) > index:
3022
return self._partial_revision_history_cache[index]
3024
raise errors.NoSuchRevision(self, revno)
3027
def revision_id_to_revno(self, revision_id):
3028
"""Given a revision id, return its revno"""
3029
if _mod_revision.is_null(revision_id):
3032
index = self._partial_revision_history_cache.index(revision_id)
3035
self._extend_partial_history(stop_revision=revision_id)
3036
except errors.RevisionNotPresent, e:
3037
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3038
index = len(self._partial_revision_history_cache) - 1
3039
if self._partial_revision_history_cache[index] != revision_id:
3040
raise errors.NoSuchRevision(self, revision_id)
3041
return self.revno() - index
3044
class BzrBranch7(BzrBranch8):
3045
"""A branch with support for a fallback repository."""
3047
def set_reference_info(self, file_id, tree_path, branch_location):
3048
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3050
def get_reference_info(self, file_id):
3051
Branch.get_reference_info(self, file_id)
3053
def reference_parent(self, file_id, path, possible_transports=None):
3054
return Branch.reference_parent(self, file_id, path,
3055
possible_transports)
3058
class BzrBranch6(BzrBranch7):
3059
"""See BzrBranchFormat6 for the capabilities of this branch.
3061
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3065
def get_stacked_on_url(self):
3066
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1022
3069
######################################################################
1026
def is_control_file(filename):
1027
## FIXME: better check
1028
filename = os.path.normpath(filename)
1029
while filename != '':
1030
head, tail = os.path.split(filename)
1031
## mutter('check %r for control file' % ((head, tail), ))
1032
if tail == bzrlib.BZRDIR:
1034
if filename == head:
1041
def _gen_revision_id(when):
1042
"""Return new revision-id."""
1043
s = '%s-%s-' % (user_email(), compact_date(when))
1044
s += hexlify(rand_bytes(8))
1048
def gen_file_id(name):
1049
"""Return new file id.
1051
This should probably generate proper UUIDs, but for the moment we
1052
cope with just randomness because running uuidgen every time is
1054
idx = name.rfind('/')
1056
name = name[idx+1 : ]
1057
idx = name.rfind('\\')
1059
name = name[idx+1 : ]
1061
name = name.lstrip('.')
1063
s = hexlify(rand_bytes(8))
1064
return '-'.join((name, compact_date(time.time()), s))
3070
# results of operations
3073
class _Result(object):
3075
def _show_tag_conficts(self, to_file):
3076
if not getattr(self, 'tag_conflicts', None):
3078
to_file.write('Conflicting tags:\n')
3079
for name, value1, value2 in self.tag_conflicts:
3080
to_file.write(' %s\n' % (name, ))
3083
class PullResult(_Result):
3084
"""Result of a Branch.pull operation.
3086
:ivar old_revno: Revision number before pull.
3087
:ivar new_revno: Revision number after pull.
3088
:ivar old_revid: Tip revision id before pull.
3089
:ivar new_revid: Tip revision id after pull.
3090
:ivar source_branch: Source (local) branch object. (read locked)
3091
:ivar master_branch: Master branch of the target, or the target if no
3093
:ivar local_branch: target branch if there is a Master, else None
3094
:ivar target_branch: Target/destination branch object. (write locked)
3095
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3098
@deprecated_method(deprecated_in((2, 3, 0)))
3100
"""Return the relative change in revno.
3102
:deprecated: Use `new_revno` and `old_revno` instead.
3104
return self.new_revno - self.old_revno
3106
def report(self, to_file):
3108
if self.old_revid == self.new_revid:
3109
to_file.write('No revisions to pull.\n')
3111
to_file.write('Now on revision %d.\n' % self.new_revno)
3112
self._show_tag_conficts(to_file)
3115
class BranchPushResult(_Result):
3116
"""Result of a Branch.push operation.
3118
:ivar old_revno: Revision number (eg 10) of the target before push.
3119
:ivar new_revno: Revision number (eg 12) of the target after push.
3120
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3122
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3124
:ivar source_branch: Source branch object that the push was from. This is
3125
read locked, and generally is a local (and thus low latency) branch.
3126
:ivar master_branch: If target is a bound branch, the master branch of
3127
target, or target itself. Always write locked.
3128
:ivar target_branch: The direct Branch where data is being sent (write
3130
:ivar local_branch: If the target is a bound branch this will be the
3131
target, otherwise it will be None.
3134
@deprecated_method(deprecated_in((2, 3, 0)))
3136
"""Return the relative change in revno.
3138
:deprecated: Use `new_revno` and `old_revno` instead.
3140
return self.new_revno - self.old_revno
3142
def report(self, to_file):
3143
"""Write a human-readable description of the result."""
3144
if self.old_revid == self.new_revid:
3145
note('No new revisions to push.')
3147
note('Pushed up to revision %d.' % self.new_revno)
3148
self._show_tag_conficts(to_file)
3151
class BranchCheckResult(object):
3152
"""Results of checking branch consistency.
3157
def __init__(self, branch):
3158
self.branch = branch
3161
def report_results(self, verbose):
3162
"""Report the check results via trace.note.
3164
:param verbose: Requests more detailed display of what was checked,
3167
note('checked branch %s format %s', self.branch.user_url,
3168
self.branch._format)
3169
for error in self.errors:
3170
note('found error:%s', error)
3173
class Converter5to6(object):
3174
"""Perform an in-place upgrade of format 5 to format 6"""
3176
def convert(self, branch):
3177
# Data for 5 and 6 can peacefully coexist.
3178
format = BzrBranchFormat6()
3179
new_branch = format.open(branch.bzrdir, _found=True)
3181
# Copy source data into target
3182
new_branch._write_last_revision_info(*branch.last_revision_info())
3183
new_branch.set_parent(branch.get_parent())
3184
new_branch.set_bound_location(branch.get_bound_location())
3185
new_branch.set_push_location(branch.get_push_location())
3187
# New branch has no tags by default
3188
new_branch.tags._set_tag_dict({})
3190
# Copying done; now update target format
3191
new_branch._transport.put_bytes('format',
3192
format.get_format_string(),
3193
mode=new_branch.bzrdir._get_file_mode())
3195
# Clean up old files
3196
new_branch._transport.delete('revision-history')
3198
branch.set_parent(None)
3199
except errors.NoSuchFile:
3201
branch.set_bound_location(None)
3204
class Converter6to7(object):
3205
"""Perform an in-place upgrade of format 6 to format 7"""
3207
def convert(self, branch):
3208
format = BzrBranchFormat7()
3209
branch._set_config_location('stacked_on_location', '')
3210
# update target format
3211
branch._transport.put_bytes('format', format.get_format_string())
3214
class Converter7to8(object):
3215
"""Perform an in-place upgrade of format 6 to format 7"""
3217
def convert(self, branch):
3218
format = BzrBranchFormat8()
3219
branch._transport.put_bytes('references', '')
3220
# update target format
3221
branch._transport.put_bytes('format', format.get_format_string())
3224
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3225
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3228
_run_with_write_locked_target will attempt to release the lock it acquires.
3230
If an exception is raised by callable, then that exception *will* be
3231
propagated, even if the unlock attempt raises its own error. Thus
3232
_run_with_write_locked_target should be preferred to simply doing::
3236
return callable(*args, **kwargs)
3241
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3242
# should share code?
3245
result = callable(*args, **kwargs)
3247
exc_info = sys.exc_info()
3251
raise exc_info[0], exc_info[1], exc_info[2]
3257
class InterBranch(InterObject):
3258
"""This class represents operations taking place between two branches.
3260
Its instances have methods like pull() and push() and contain
3261
references to the source and target repositories these operations
3262
can be carried out on.
3266
"""The available optimised InterBranch types."""
3269
def _get_branch_formats_to_test(klass):
3270
"""Return an iterable of format tuples for testing.
3272
:return: An iterable of (from_format, to_format) to use when testing
3273
this InterBranch class. Each InterBranch class should define this
3276
raise NotImplementedError(klass._get_branch_formats_to_test)
3279
def pull(self, overwrite=False, stop_revision=None,
3280
possible_transports=None, local=False):
3281
"""Mirror source into target branch.
3283
The target branch is considered to be 'local', having low latency.
3285
:returns: PullResult instance
3287
raise NotImplementedError(self.pull)
3290
def update_revisions(self, stop_revision=None, overwrite=False,
3292
"""Pull in new perfect-fit revisions.
3294
:param stop_revision: Updated until the given revision
3295
:param overwrite: Always set the branch pointer, rather than checking
3296
to see if it is a proper descendant.
3297
:param graph: A Graph object that can be used to query history
3298
information. This can be None.
3301
raise NotImplementedError(self.update_revisions)
3304
def push(self, overwrite=False, stop_revision=None,
3305
_override_hook_source_branch=None):
3306
"""Mirror the source branch into the target branch.
3308
The source branch is considered to be 'local', having low latency.
3310
raise NotImplementedError(self.push)
3313
def copy_content_into(self, revision_id=None):
3314
"""Copy the content of source into target
3316
revision_id: if not None, the revision history in the new branch will
3317
be truncated to end with revision_id.
3319
raise NotImplementedError(self.copy_content_into)
3322
def fetch(self, stop_revision=None):
3325
:param stop_revision: Last revision to fetch
3327
raise NotImplementedError(self.fetch)
3330
class GenericInterBranch(InterBranch):
3331
"""InterBranch implementation that uses public Branch functions."""
3334
def is_compatible(klass, source, target):
3335
# GenericBranch uses the public API, so always compatible
3339
def _get_branch_formats_to_test(klass):
3340
return [(format_registry.get_default(), format_registry.get_default())]
3343
def unwrap_format(klass, format):
3344
if isinstance(format, remote.RemoteBranchFormat):
3345
format._ensure_real()
3346
return format._custom_format
3350
def copy_content_into(self, revision_id=None):
3351
"""Copy the content of source into target
3353
revision_id: if not None, the revision history in the new branch will
3354
be truncated to end with revision_id.
3356
self.source.update_references(self.target)
3357
self.source._synchronize_history(self.target, revision_id)
3359
parent = self.source.get_parent()
3360
except errors.InaccessibleParent, e:
3361
mutter('parent was not accessible to copy: %s', e)
3364
self.target.set_parent(parent)
3365
if self.source._push_should_merge_tags():
3366
self.source.tags.merge_to(self.target.tags)
3369
def fetch(self, stop_revision=None):
3370
if self.target.base == self.source.base:
3372
self.source.lock_read()
3374
fetch_spec_factory = fetch.FetchSpecFactory()
3375
fetch_spec_factory.source_branch = self.source
3376
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3377
fetch_spec_factory.source_repo = self.source.repository
3378
fetch_spec_factory.target_repo = self.target.repository
3379
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3380
fetch_spec = fetch_spec_factory.make_fetch_spec()
3381
return self.target.repository.fetch(self.source.repository,
3382
fetch_spec=fetch_spec)
3384
self.source.unlock()
3387
def update_revisions(self, stop_revision=None, overwrite=False,
3389
"""See InterBranch.update_revisions()."""
3390
other_revno, other_last_revision = self.source.last_revision_info()
3391
stop_revno = None # unknown
3392
if stop_revision is None:
3393
stop_revision = other_last_revision
3394
if _mod_revision.is_null(stop_revision):
3395
# if there are no commits, we're done.
3397
stop_revno = other_revno
3399
# what's the current last revision, before we fetch [and change it
3401
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3402
# we fetch here so that we don't process data twice in the common
3403
# case of having something to pull, and so that the check for
3404
# already merged can operate on the just fetched graph, which will
3405
# be cached in memory.
3406
self.fetch(stop_revision=stop_revision)
3407
# Check to see if one is an ancestor of the other
3410
graph = self.target.repository.get_graph()
3411
if self.target._check_if_descendant_or_diverged(
3412
stop_revision, last_rev, graph, self.source):
3413
# stop_revision is a descendant of last_rev, but we aren't
3414
# overwriting, so we're done.
3416
if stop_revno is None:
3418
graph = self.target.repository.get_graph()
3419
this_revno, this_last_revision = \
3420
self.target.last_revision_info()
3421
stop_revno = graph.find_distance_to_null(stop_revision,
3422
[(other_last_revision, other_revno),
3423
(this_last_revision, this_revno)])
3424
self.target.set_last_revision_info(stop_revno, stop_revision)
3427
def pull(self, overwrite=False, stop_revision=None,
3428
possible_transports=None, run_hooks=True,
3429
_override_hook_target=None, local=False):
3430
"""Pull from source into self, updating my master if any.
3432
:param run_hooks: Private parameter - if false, this branch
3433
is being called because it's the master of the primary branch,
3434
so it should not run its hooks.
3436
bound_location = self.target.get_bound_location()
3437
if local and not bound_location:
3438
raise errors.LocalRequiresBoundBranch()
3439
master_branch = None
3440
source_is_master = (self.source.user_url == bound_location)
3441
if not local and bound_location and not source_is_master:
3442
# not pulling from master, so we need to update master.
3443
master_branch = self.target.get_master_branch(possible_transports)
3444
master_branch.lock_write()
3447
# pull from source into master.
3448
master_branch.pull(self.source, overwrite, stop_revision,
3450
return self._pull(overwrite,
3451
stop_revision, _hook_master=master_branch,
3452
run_hooks=run_hooks,
3453
_override_hook_target=_override_hook_target,
3454
merge_tags_to_master=not source_is_master)
3457
master_branch.unlock()
3459
def push(self, overwrite=False, stop_revision=None,
3460
_override_hook_source_branch=None):
3461
"""See InterBranch.push.
3463
This is the basic concrete implementation of push()
3465
:param _override_hook_source_branch: If specified, run
3466
the hooks passing this Branch as the source, rather than self.
3467
This is for use of RemoteBranch, where push is delegated to the
3468
underlying vfs-based Branch.
3470
# TODO: Public option to disable running hooks - should be trivial but
3472
self.source.lock_read()
3474
return _run_with_write_locked_target(
3475
self.target, self._push_with_bound_branches, overwrite,
3477
_override_hook_source_branch=_override_hook_source_branch)
3479
self.source.unlock()
3481
def _push_with_bound_branches(self, overwrite, stop_revision,
3482
_override_hook_source_branch=None):
3483
"""Push from source into target, and into target's master if any.
3486
if _override_hook_source_branch:
3487
result.source_branch = _override_hook_source_branch
3488
for hook in Branch.hooks['post_push']:
3491
bound_location = self.target.get_bound_location()
3492
if bound_location and self.target.base != bound_location:
3493
# there is a master branch.
3495
# XXX: Why the second check? Is it even supported for a branch to
3496
# be bound to itself? -- mbp 20070507
3497
master_branch = self.target.get_master_branch()
3498
master_branch.lock_write()
3500
# push into the master from the source branch.
3501
self.source._basic_push(master_branch, overwrite, stop_revision)
3502
# and push into the target branch from the source. Note that we
3503
# push from the source branch again, because it's considered the
3504
# highest bandwidth repository.
3505
result = self.source._basic_push(self.target, overwrite,
3507
result.master_branch = master_branch
3508
result.local_branch = self.target
3512
master_branch.unlock()
3515
result = self.source._basic_push(self.target, overwrite,
3517
# TODO: Why set master_branch and local_branch if there's no
3518
# binding? Maybe cleaner to just leave them unset? -- mbp
3520
result.master_branch = self.target
3521
result.local_branch = None
3525
def _pull(self, overwrite=False, stop_revision=None,
3526
possible_transports=None, _hook_master=None, run_hooks=True,
3527
_override_hook_target=None, local=False,
3528
merge_tags_to_master=True):
3531
This function is the core worker, used by GenericInterBranch.pull to
3532
avoid duplication when pulling source->master and source->local.
3534
:param _hook_master: Private parameter - set the branch to
3535
be supplied as the master to pull hooks.
3536
:param run_hooks: Private parameter - if false, this branch
3537
is being called because it's the master of the primary branch,
3538
so it should not run its hooks.
3539
is being called because it's the master of the primary branch,
3540
so it should not run its hooks.
3541
:param _override_hook_target: Private parameter - set the branch to be
3542
supplied as the target_branch to pull hooks.
3543
:param local: Only update the local branch, and not the bound branch.
3545
# This type of branch can't be bound.
3547
raise errors.LocalRequiresBoundBranch()
3548
result = PullResult()
3549
result.source_branch = self.source
3550
if _override_hook_target is None:
3551
result.target_branch = self.target
3553
result.target_branch = _override_hook_target
3554
self.source.lock_read()
3556
# We assume that during 'pull' the target repository is closer than
3558
self.source.update_references(self.target)
3559
graph = self.target.repository.get_graph(self.source.repository)
3560
# TODO: Branch formats should have a flag that indicates
3561
# that revno's are expensive, and pull() should honor that flag.
3563
result.old_revno, result.old_revid = \
3564
self.target.last_revision_info()
3565
self.target.update_revisions(self.source, stop_revision,
3566
overwrite=overwrite, graph=graph)
3567
# TODO: The old revid should be specified when merging tags,
3568
# so a tags implementation that versions tags can only
3569
# pull in the most recent changes. -- JRV20090506
3570
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3571
overwrite, ignore_master=not merge_tags_to_master)
3572
result.new_revno, result.new_revid = self.target.last_revision_info()
3574
result.master_branch = _hook_master
3575
result.local_branch = result.target_branch
3577
result.master_branch = result.target_branch
3578
result.local_branch = None
3580
for hook in Branch.hooks['post_pull']:
3583
self.source.unlock()
3587
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
