1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005-2012 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
18
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
19
import traceback, socket, fnmatch, difflib, time
20
from binascii import hexlify
23
from inventory import Inventory
24
from trace import mutter, note
25
from tree import Tree, EmptyTree, RevisionTree
26
from inventory import InventoryEntry, Inventory
27
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
28
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
29
joinpath, sha_file, sha_string, file_kind, local_time_offset, appendpath
30
from store import ImmutableStore
31
from revision import Revision
32
from errors import BzrError
33
from textui import show_status
35
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
36
## TODO: Maybe include checks for common corruption of newlines, etc?
40
def find_branch(f, **args):
41
if f and (f.startswith('http://') or f.startswith('https://')):
43
return remotebranch.RemoteBranch(f, **args)
45
return Branch(f, **args)
49
def _relpath(base, path):
50
"""Return path relative to base, or raise exception.
52
The path may be either an absolute path or a path relative to the
53
current working directory.
55
Lifted out of Branch.relpath for ease of testing.
57
os.path.commonprefix (python2.4) has a bad bug that it works just
58
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
59
avoids that problem."""
60
rp = os.path.abspath(path)
64
while len(head) >= len(base):
67
head, tail = os.path.split(head)
71
from errors import NotBranchError
72
raise NotBranchError("path %r is not within branch %r" % (rp, base))
77
def find_branch_root(f=None):
78
"""Find the branch root enclosing f, or pwd.
80
f may be a filename or a URL.
82
It is not necessary that f exists.
84
Basically we keep looking up until we find the control directory or
88
elif hasattr(os.path, 'realpath'):
89
f = os.path.realpath(f)
91
f = os.path.abspath(f)
92
if not os.path.exists(f):
93
raise BzrError('%r does not exist' % f)
99
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
101
head, tail = os.path.split(f)
103
# reached the root, whatever that may be
104
raise BzrError('%r is not in a branch' % orig_f)
107
class DivergedBranches(Exception):
108
def __init__(self, branch1, branch2):
109
self.branch1 = branch1
110
self.branch2 = branch2
111
Exception.__init__(self, "These branches have diverged.")
114
class NoSuchRevision(BzrError):
115
def __init__(self, branch, revision):
117
self.revision = revision
118
msg = "Branch %s has no revision %d" % (branch, revision)
119
BzrError.__init__(self, msg)
122
######################################################################
125
class Branch(object):
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
21
from cStringIO import StringIO
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
31
config as _mod_config,
40
revision as _mod_revision,
48
from bzrlib.i18n import gettext, ngettext
51
# Explicitly import bzrlib.bzrdir so that the BzrProber
52
# is guaranteed to be registered.
59
from bzrlib.decorators import (
64
from bzrlib.hooks import Hooks
65
from bzrlib.inter import InterObject
66
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
67
from bzrlib import registry
68
from bzrlib.symbol_versioning import (
72
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
75
class Branch(controldir.ControlComponent):
126
76
"""Branch holding a history of revisions.
129
Base directory of the branch.
135
If _lock_mode is true, a positive count of the number of times the
139
Lock object from bzrlib.lock.
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
85
# this is really an instance variable - FIXME move it there
146
def __init__(self, base, init=False, find_root=True):
147
"""Create new branch object at a particular location.
149
base -- Base directory for the branch.
151
init -- If True, create new control files in a previously
152
unversioned directory. If False, the branch must already
155
find_root -- If true and init is false, find the root of the
156
existing branch containing base.
158
In the test suite, creation of new trees is tested using the
159
`ScratchBranch` class.
162
self.base = os.path.realpath(base)
165
self.base = find_branch_root(base)
167
self.base = os.path.realpath(base)
168
if not isdir(self.controlfilename('.')):
169
from errors import NotBranchError
170
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
171
['use "bzr init" to initialize a new working tree',
172
'current bzr can only operate from top-of-tree'])
175
self.text_store = ImmutableStore(self.controlfilename('text-store'))
176
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
177
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
181
return '%s(%r)' % (self.__class__.__name__, self.base)
188
if self._lock_mode or self._lock:
189
from warnings import warn
190
warn("branch %r was not explicitly unlocked" % self)
195
def lock_write(self):
197
if self._lock_mode != 'w':
198
from errors import LockError
199
raise LockError("can't upgrade to a write lock from %r" %
201
self._lock_count += 1
203
from bzrlib.lock import WriteLock
205
self._lock = WriteLock(self.controlfilename('branch-lock'))
206
self._lock_mode = 'w'
90
def control_transport(self):
91
return self._transport
94
def user_transport(self):
95
return self.bzrdir.user_transport
97
def __init__(self, possible_transports=None):
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
107
self._open_hook(possible_transports)
108
hooks = Branch.hooks['open']
112
def _open_hook(self, possible_transports):
113
"""Called by init to allow simpler extension of the base class."""
115
def _activate_fallback_location(self, url, possible_transports):
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 ControlDir.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, possible_transports)
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 = controldir.ControlDir.open(base,
185
possible_transports=possible_transports, _unsupported=_unsupported)
186
return control.open_branch(unsupported=_unsupported,
187
possible_transports=possible_transports)
190
def open_from_transport(transport, name=None, _unsupported=False,
191
possible_transports=None):
192
"""Open the branch rooted at transport"""
193
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
194
return control.open_branch(name=name, unsupported=_unsupported,
195
possible_transports=possible_transports)
198
def open_containing(url, possible_transports=None):
199
"""Open an existing branch which contains url.
201
This probes for a branch at url, and searches upwards from there.
203
Basically we keep looking up until we find the control directory or
204
run into the root. If there isn't one, raises NotBranchError.
205
If there is one and it is either an unrecognised format or an unsupported
206
format, UnknownFormatError or UnsupportedFormatError are raised.
207
If there is one, it is returned, along with the unused portion of url.
209
control, relpath = controldir.ControlDir.open_containing(url,
211
branch = control.open_branch(possible_transports=possible_transports)
212
return (branch, relpath)
214
def _push_should_merge_tags(self):
215
"""Should _basic_push merge this branch's tags into the target?
217
The default implementation returns False if this branch has no tags,
218
and True the rest of the time. Subclasses may override this.
220
return self.supports_tags() and self.tags.get_tag_dict()
222
def get_config(self):
223
"""Get a bzrlib.config.BranchConfig for this Branch.
225
This can then be used to get and set configuration options for the
228
:return: A bzrlib.config.BranchConfig.
230
return _mod_config.BranchConfig(self)
232
def get_config_stack(self):
233
"""Get a bzrlib.config.BranchStack for this Branch.
235
This can then be used to get and set configuration options for the
238
:return: A bzrlib.config.BranchStack.
240
return _mod_config.BranchStack(self)
242
def _get_config(self):
243
"""Get the concrete config for just the config in this branch.
245
This is not intended for client use; see Branch.get_config for the
250
:return: An object supporting get_option and set_option.
252
raise NotImplementedError(self._get_config)
254
def _get_fallback_repository(self, url, possible_transports):
255
"""Get the repository we fallback to at url."""
256
url = urlutils.join(self.base, url)
257
a_branch = Branch.open(url, possible_transports=possible_transports)
258
return a_branch.repository
261
def _get_tags_bytes(self):
262
"""Get the bytes of a serialised tags dict.
264
Note that not all branches support tags, nor do all use the same tags
265
logic: this method is specific to BasicTags. Other tag implementations
266
may use the same method name and behave differently, safely, because
267
of the double-dispatch via
268
format.make_tags->tags_instance->get_tags_dict.
270
:return: The bytes of the tags file.
271
:seealso: Branch._set_tags_bytes.
273
if self._tags_bytes is None:
274
self._tags_bytes = self._transport.get_bytes('tags')
275
return self._tags_bytes
277
def _get_nick(self, local=False, possible_transports=None):
278
config = self.get_config()
279
# explicit overrides master, but don't look for master if local is True
280
if not local and not config.has_explicit_nickname():
282
master = self.get_master_branch(possible_transports)
283
if master and self.user_url == master.user_url:
284
raise errors.RecursiveBind(self.user_url)
285
if master is not None:
286
# return the master branch value
288
except errors.RecursiveBind, e:
290
except errors.BzrError, e:
291
# Silently fall back to local implicit nick if the master is
293
mutter("Could not connect to bound branch, "
294
"falling back to local nick.\n " + str(e))
295
return config.get_nickname()
297
def _set_nick(self, nick):
298
self.get_config().set_user_option('nickname', nick, warn_masked=True)
300
nick = property(_get_nick, _set_nick)
303
raise NotImplementedError(self.is_locked)
305
def _lefthand_history(self, revision_id, last_rev=None,
307
if 'evil' in debug.debug_flags:
308
mutter_callsite(4, "_lefthand_history scales with history.")
309
# stop_revision must be a descendant of last_revision
310
graph = self.repository.get_graph()
311
if last_rev is not None:
312
if not graph.is_ancestor(last_rev, revision_id):
313
# our previous tip is not merged into stop_revision
314
raise errors.DivergedBranches(self, other_branch)
315
# make a new revision history from the graph
316
parents_map = graph.get_parent_map([revision_id])
317
if revision_id not in parents_map:
318
raise errors.NoSuchRevision(self, revision_id)
319
current_rev_id = revision_id
321
check_not_reserved_id = _mod_revision.check_not_reserved_id
322
# Do not include ghosts or graph origin in revision_history
323
while (current_rev_id in parents_map and
324
len(parents_map[current_rev_id]) > 0):
325
check_not_reserved_id(current_rev_id)
326
new_history.append(current_rev_id)
327
current_rev_id = parents_map[current_rev_id][0]
328
parents_map = graph.get_parent_map([current_rev_id])
329
new_history.reverse()
332
def lock_write(self, token=None):
333
"""Lock the branch for write operations.
335
:param token: A token to permit reacquiring a previously held and
337
:return: A BranchWriteLockResult.
339
raise NotImplementedError(self.lock_write)
211
341
def lock_read(self):
213
assert self._lock_mode in ('r', 'w'), \
214
"invalid lock mode %r" % self._lock_mode
215
self._lock_count += 1
217
from bzrlib.lock import ReadLock
219
self._lock = ReadLock(self.controlfilename('branch-lock'))
220
self._lock_mode = 'r'
342
"""Lock the branch for read operations.
344
:return: A bzrlib.lock.LogicalLockResult.
346
raise NotImplementedError(self.lock_read)
225
348
def unlock(self):
226
if not self._lock_mode:
227
from errors import LockError
228
raise LockError('branch %r is not locked' % (self))
230
if self._lock_count > 1:
231
self._lock_count -= 1
235
self._lock_mode = self._lock_count = None
238
def abspath(self, name):
239
"""Return absolute filename for something in the branch"""
240
return os.path.join(self.base, name)
243
def relpath(self, path):
244
"""Return path relative to this branch of something inside it.
246
Raises an error if path is not in this branch."""
247
return _relpath(self.base, path)
250
def controlfilename(self, file_or_path):
251
"""Return location relative to branch."""
252
if isinstance(file_or_path, types.StringTypes):
253
file_or_path = [file_or_path]
254
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
257
def controlfile(self, file_or_path, mode='r'):
258
"""Open a control file for this branch.
260
There are two classes of file in the control directory: text
261
and binary. binary files are untranslated byte streams. Text
262
control files are stored with Unix newlines and in UTF-8, even
263
if the platform or locale defaults are different.
265
Controlfiles should almost never be opened in write mode but
266
rather should be atomically copied and replaced using atomicfile.
269
fn = self.controlfilename(file_or_path)
271
if mode == 'rb' or mode == 'wb':
272
return file(fn, mode)
273
elif mode == 'r' or mode == 'w':
274
# open in binary mode anyhow so there's no newline translation;
275
# codecs uses line buffering by default; don't want that.
277
return codecs.open(fn, mode + 'b', 'utf-8',
280
raise BzrError("invalid controlfile mode %r" % mode)
284
def _make_control(self):
285
os.mkdir(self.controlfilename([]))
286
self.controlfile('README', 'w').write(
287
"This is a Bazaar-NG control directory.\n"
288
"Do not change any files in this directory.\n")
289
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
290
for d in ('text-store', 'inventory-store', 'revision-store'):
291
os.mkdir(self.controlfilename(d))
292
for f in ('revision-history', 'merged-patches',
293
'pending-merged-patches', 'branch-name',
295
self.controlfile(f, 'w').write('')
296
mutter('created control directory in ' + self.base)
297
Inventory().write_xml(self.controlfile('inventory','w'))
300
def _check_format(self):
301
"""Check this branch format is supported.
303
The current tool only supports the current unstable format.
305
In the future, we might need different in-memory Branch
306
classes to support downlevel branches. But not yet.
308
# This ignores newlines so that we can open branches created
309
# on Windows from Linux and so on. I think it might be better
310
# to always make all internal files in unix format.
311
fmt = self.controlfile('branch-format', 'r').read()
312
fmt.replace('\r\n', '')
313
if fmt != BZR_BRANCH_FORMAT:
314
raise BzrError('sorry, branch format %r not supported' % fmt,
315
['use a different bzr version',
316
'or remove the .bzr directory and "bzr init" again'])
320
def read_working_inventory(self):
321
"""Read the working inventory."""
323
# ElementTree does its own conversion from UTF-8, so open in
327
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
328
mutter("loaded inventory of %d items in %f"
329
% (len(inv), time.time() - before))
335
def _write_inventory(self, inv):
336
"""Update the working inventory.
338
That is to say, the inventory describing changes underway, that
339
will be committed to the next revision.
341
## TODO: factor out to atomicfile? is rename safe on windows?
342
## TODO: Maybe some kind of clean/dirty marker on inventory?
343
tmpfname = self.controlfilename('inventory.tmp')
344
tmpf = file(tmpfname, 'wb')
347
inv_fname = self.controlfilename('inventory')
348
if sys.platform == 'win32':
350
os.rename(tmpfname, inv_fname)
351
mutter('wrote working inventory')
354
inventory = property(read_working_inventory, _write_inventory, None,
355
"""Inventory for the working copy.""")
358
def add(self, files, verbose=False, ids=None):
359
"""Make files versioned.
361
Note that the command line normally calls smart_add instead.
363
This puts the files in the Added state, so that they will be
364
recorded by the next commit.
367
List of paths to add, relative to the base of the tree.
370
If set, use these instead of automatically generated ids.
371
Must be the same length as the list of files, but may
372
contain None for ids that are to be autogenerated.
374
TODO: Perhaps have an option to add the ids even if the files do
377
TODO: Perhaps return the ids of the files? But then again it
378
is easy to retrieve them if they're needed.
380
TODO: Adding a directory should optionally recurse down and
381
add all non-ignored children. Perhaps do that in a
384
# TODO: Re-adding a file that is removed in the working copy
385
# should probably put it back with the previous ID.
386
if isinstance(files, types.StringTypes):
387
assert(ids is None or isinstance(ids, types.StringTypes))
393
ids = [None] * len(files)
395
assert(len(ids) == len(files))
399
inv = self.read_working_inventory()
400
for f,file_id in zip(files, ids):
401
if is_control_file(f):
402
raise BzrError("cannot add control file %s" % quotefn(f))
407
raise BzrError("cannot add top-level %r" % f)
409
fullpath = os.path.normpath(self.abspath(f))
412
kind = file_kind(fullpath)
414
# maybe something better?
415
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
417
if kind != 'file' and kind != 'directory':
418
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
421
file_id = gen_file_id(f)
422
inv.add_path(f, kind=kind, file_id=file_id)
425
show_status('A', kind, quotefn(f))
427
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
429
self._write_inventory(inv)
434
def print_file(self, file, revno):
349
raise NotImplementedError(self.unlock)
351
def peek_lock_mode(self):
352
"""Return lock mode for the Branch: 'r', 'w' or None"""
353
raise NotImplementedError(self.peek_lock_mode)
355
def get_physical_lock_status(self):
356
raise NotImplementedError(self.get_physical_lock_status)
359
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
360
"""Return the revision_id for a dotted revno.
362
:param revno: a tuple like (1,) or (1,1,2)
363
:param _cache_reverse: a private parameter enabling storage
364
of the reverse mapping in a top level cache. (This should
365
only be done in selective circumstances as we want to
366
avoid having the mapping cached multiple times.)
367
:return: the revision_id
368
:raises errors.NoSuchRevision: if the revno doesn't exist
370
rev_id = self._do_dotted_revno_to_revision_id(revno)
372
self._partial_revision_id_to_revno_cache[rev_id] = revno
375
def _do_dotted_revno_to_revision_id(self, revno):
376
"""Worker function for dotted_revno_to_revision_id.
378
Subclasses should override this if they wish to
379
provide a more efficient implementation.
382
return self.get_rev_id(revno[0])
383
revision_id_to_revno = self.get_revision_id_to_revno_map()
384
revision_ids = [revision_id for revision_id, this_revno
385
in revision_id_to_revno.iteritems()
386
if revno == this_revno]
387
if len(revision_ids) == 1:
388
return revision_ids[0]
390
revno_str = '.'.join(map(str, revno))
391
raise errors.NoSuchRevision(self, revno_str)
394
def revision_id_to_dotted_revno(self, revision_id):
395
"""Given a revision id, return its dotted revno.
397
:return: a tuple like (1,) or (400,1,3).
399
return self._do_revision_id_to_dotted_revno(revision_id)
401
def _do_revision_id_to_dotted_revno(self, revision_id):
402
"""Worker function for revision_id_to_revno."""
403
# Try the caches if they are loaded
404
result = self._partial_revision_id_to_revno_cache.get(revision_id)
405
if result is not None:
407
if self._revision_id_to_revno_cache:
408
result = self._revision_id_to_revno_cache.get(revision_id)
410
raise errors.NoSuchRevision(self, revision_id)
411
# Try the mainline as it's optimised
413
revno = self.revision_id_to_revno(revision_id)
415
except errors.NoSuchRevision:
416
# We need to load and use the full revno map after all
417
result = self.get_revision_id_to_revno_map().get(revision_id)
419
raise errors.NoSuchRevision(self, revision_id)
423
def get_revision_id_to_revno_map(self):
424
"""Return the revision_id => dotted revno map.
426
This will be regenerated on demand, but will be cached.
428
:return: A dictionary mapping revision_id => dotted revno.
429
This dictionary should not be modified by the caller.
431
if self._revision_id_to_revno_cache is not None:
432
mapping = self._revision_id_to_revno_cache
434
mapping = self._gen_revno_map()
435
self._cache_revision_id_to_revno(mapping)
436
# TODO: jam 20070417 Since this is being cached, should we be returning
438
# I would rather not, and instead just declare that users should not
439
# modify the return value.
442
def _gen_revno_map(self):
443
"""Create a new mapping from revision ids to dotted revnos.
445
Dotted revnos are generated based on the current tip in the revision
447
This is the worker function for get_revision_id_to_revno_map, which
448
just caches the return value.
450
:return: A dictionary mapping revision_id => dotted revno.
452
revision_id_to_revno = dict((rev_id, revno)
453
for rev_id, depth, revno, end_of_merge
454
in self.iter_merge_sorted_revisions())
455
return revision_id_to_revno
458
def iter_merge_sorted_revisions(self, start_revision_id=None,
459
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
460
"""Walk the revisions for a branch in merge sorted order.
462
Merge sorted order is the output from a merge-aware,
463
topological sort, i.e. all parents come before their
464
children going forward; the opposite for reverse.
466
:param start_revision_id: the revision_id to begin walking from.
467
If None, the branch tip is used.
468
:param stop_revision_id: the revision_id to terminate the walk
469
after. If None, the rest of history is included.
470
:param stop_rule: if stop_revision_id is not None, the precise rule
471
to use for termination:
473
* 'exclude' - leave the stop revision out of the result (default)
474
* 'include' - the stop revision is the last item in the result
475
* 'with-merges' - include the stop revision and all of its
476
merged revisions in the result
477
* 'with-merges-without-common-ancestry' - filter out revisions
478
that are in both ancestries
479
:param direction: either 'reverse' or 'forward':
481
* reverse means return the start_revision_id first, i.e.
482
start at the most recent revision and go backwards in history
483
* forward returns tuples in the opposite order to reverse.
484
Note in particular that forward does *not* do any intelligent
485
ordering w.r.t. depth as some clients of this API may like.
486
(If required, that ought to be done at higher layers.)
488
:return: an iterator over (revision_id, depth, revno, end_of_merge)
491
* revision_id: the unique id of the revision
492
* depth: How many levels of merging deep this node has been
494
* revno_sequence: This field provides a sequence of
495
revision numbers for all revisions. The format is:
496
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
497
branch that the revno is on. From left to right the REVNO numbers
498
are the sequence numbers within that branch of the revision.
499
* end_of_merge: When True the next node (earlier in history) is
500
part of a different merge.
502
# Note: depth and revno values are in the context of the branch so
503
# we need the full graph to get stable numbers, regardless of the
505
if self._merge_sorted_revisions_cache is None:
506
last_revision = self.last_revision()
507
known_graph = self.repository.get_known_graph_ancestry(
509
self._merge_sorted_revisions_cache = known_graph.merge_sort(
511
filtered = self._filter_merge_sorted_revisions(
512
self._merge_sorted_revisions_cache, start_revision_id,
513
stop_revision_id, stop_rule)
514
# Make sure we don't return revisions that are not part of the
515
# start_revision_id ancestry.
516
filtered = self._filter_start_non_ancestors(filtered)
517
if direction == 'reverse':
519
if direction == 'forward':
520
return reversed(list(filtered))
522
raise ValueError('invalid direction %r' % direction)
524
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
525
start_revision_id, stop_revision_id, stop_rule):
526
"""Iterate over an inclusive range of sorted revisions."""
527
rev_iter = iter(merge_sorted_revisions)
528
if start_revision_id is not None:
529
for node in rev_iter:
531
if rev_id != start_revision_id:
534
# The decision to include the start or not
535
# depends on the stop_rule if a stop is provided
536
# so pop this node back into the iterator
537
rev_iter = itertools.chain(iter([node]), rev_iter)
539
if stop_revision_id is None:
541
for node in rev_iter:
543
yield (rev_id, node.merge_depth, node.revno,
545
elif stop_rule == 'exclude':
546
for node in rev_iter:
548
if rev_id == stop_revision_id:
550
yield (rev_id, node.merge_depth, node.revno,
552
elif stop_rule == 'include':
553
for node in rev_iter:
555
yield (rev_id, node.merge_depth, node.revno,
557
if rev_id == stop_revision_id:
559
elif stop_rule == 'with-merges-without-common-ancestry':
560
# We want to exclude all revisions that are already part of the
561
# stop_revision_id ancestry.
562
graph = self.repository.get_graph()
563
ancestors = graph.find_unique_ancestors(start_revision_id,
565
for node in rev_iter:
567
if rev_id not in ancestors:
569
yield (rev_id, node.merge_depth, node.revno,
571
elif stop_rule == 'with-merges':
572
stop_rev = self.repository.get_revision(stop_revision_id)
573
if stop_rev.parent_ids:
574
left_parent = stop_rev.parent_ids[0]
576
left_parent = _mod_revision.NULL_REVISION
577
# left_parent is the actual revision we want to stop logging at,
578
# since we want to show the merged revisions after the stop_rev too
579
reached_stop_revision_id = False
580
revision_id_whitelist = []
581
for node in rev_iter:
583
if rev_id == left_parent:
584
# reached the left parent after the stop_revision
586
if (not reached_stop_revision_id or
587
rev_id in revision_id_whitelist):
588
yield (rev_id, node.merge_depth, node.revno,
590
if reached_stop_revision_id or rev_id == stop_revision_id:
591
# only do the merged revs of rev_id from now on
592
rev = self.repository.get_revision(rev_id)
594
reached_stop_revision_id = True
595
revision_id_whitelist.extend(rev.parent_ids)
597
raise ValueError('invalid stop_rule %r' % stop_rule)
599
def _filter_start_non_ancestors(self, rev_iter):
600
# If we started from a dotted revno, we want to consider it as a tip
601
# and don't want to yield revisions that are not part of its
602
# ancestry. Given the order guaranteed by the merge sort, we will see
603
# uninteresting descendants of the first parent of our tip before the
605
first = rev_iter.next()
606
(rev_id, merge_depth, revno, end_of_merge) = first
609
# We start at a mainline revision so by definition, all others
610
# revisions in rev_iter are ancestors
611
for node in rev_iter:
616
pmap = self.repository.get_parent_map([rev_id])
617
parents = pmap.get(rev_id, [])
619
whitelist.update(parents)
621
# If there is no parents, there is nothing of interest left
623
# FIXME: It's hard to test this scenario here as this code is never
624
# called in that case. -- vila 20100322
627
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
629
if rev_id in whitelist:
630
pmap = self.repository.get_parent_map([rev_id])
631
parents = pmap.get(rev_id, [])
632
whitelist.remove(rev_id)
633
whitelist.update(parents)
635
# We've reached the mainline, there is nothing left to
639
# A revision that is not part of the ancestry of our
642
yield (rev_id, merge_depth, revno, end_of_merge)
644
def leave_lock_in_place(self):
645
"""Tell this branch object not to release the physical lock when this
648
If lock_write doesn't return a token, then this method is not supported.
650
self.control_files.leave_in_place()
652
def dont_leave_lock_in_place(self):
653
"""Tell this branch object to release the physical lock when this
654
object is unlocked, even if it didn't originally acquire it.
656
If lock_write doesn't return a token, then this method is not supported.
658
self.control_files.dont_leave_in_place()
660
def bind(self, other):
661
"""Bind the local branch the other branch.
663
:param other: The branch to bind to
666
raise errors.UpgradeRequired(self.user_url)
668
def get_append_revisions_only(self):
669
"""Whether it is only possible to append revisions to the history.
671
if not self._format.supports_set_append_revisions_only():
673
return self.get_config_stack().get('append_revisions_only')
675
def set_append_revisions_only(self, enabled):
676
if not self._format.supports_set_append_revisions_only():
677
raise errors.UpgradeRequired(self.user_url)
678
self.get_config_stack().set('append_revisions_only', enabled)
680
def set_reference_info(self, file_id, tree_path, branch_location):
681
"""Set the branch location to use for a tree reference."""
682
raise errors.UnsupportedOperation(self.set_reference_info, self)
684
def get_reference_info(self, file_id):
685
"""Get the tree_path and branch_location for a tree reference."""
686
raise errors.UnsupportedOperation(self.get_reference_info, self)
689
def fetch(self, from_branch, last_revision=None, limit=None):
690
"""Copy revisions from from_branch into this branch.
692
:param from_branch: Where to copy from.
693
:param last_revision: What revision to stop at (None for at the end
695
:param limit: Optional rough limit of revisions to fetch
698
return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
700
def get_bound_location(self):
701
"""Return the URL of the branch we are bound to.
703
Older format branches cannot bind, please be sure to use a metadir
708
def get_old_bound_location(self):
709
"""Return the URL of the branch we used to be bound to
711
raise errors.UpgradeRequired(self.user_url)
713
def get_commit_builder(self, parents, config_stack=None, timestamp=None,
714
timezone=None, committer=None, revprops=None,
715
revision_id=None, lossy=False):
716
"""Obtain a CommitBuilder for this branch.
718
:param parents: Revision ids of the parents of the new revision.
719
:param config: Optional configuration to use.
720
:param timestamp: Optional timestamp recorded for commit.
721
:param timezone: Optional timezone for timestamp.
722
:param committer: Optional committer to set for commit.
723
:param revprops: Optional dictionary of revision properties.
724
:param revision_id: Optional revision id.
725
:param lossy: Whether to discard data that can not be natively
726
represented, when pushing to a foreign VCS
729
if config_stack is None:
730
config_stack = self.get_config_stack()
732
return self.repository.get_commit_builder(self, parents, config_stack,
733
timestamp, timezone, committer, revprops, revision_id,
736
def get_master_branch(self, possible_transports=None):
737
"""Return the branch we are bound to.
739
:return: Either a Branch, or None
743
@deprecated_method(deprecated_in((2, 5, 0)))
744
def get_revision_delta(self, revno):
745
"""Return the delta for one revision.
747
The delta is relative to its mainline predecessor, or the
748
empty tree for revision 1.
751
revid = self.get_rev_id(revno)
752
except errors.NoSuchRevision:
753
raise errors.InvalidRevisionNumber(revno)
754
return self.repository.get_revision_delta(revid)
756
def get_stacked_on_url(self):
757
"""Get the URL this branch is stacked against.
759
:raises NotStacked: If the branch is not stacked.
760
:raises UnstackableBranchFormat: If the branch does not support
763
raise NotImplementedError(self.get_stacked_on_url)
765
def print_file(self, file, revision_id):
435
766
"""Print `file` to stdout."""
438
tree = self.revision_tree(self.lookup_revision(revno))
439
# use inventory as it was in that revision
440
file_id = tree.inventory.path2id(file)
442
raise BzrError("%r is not present in revision %d" % (file, revno))
443
tree.print_file(file_id)
448
def remove(self, files, verbose=False):
449
"""Mark nominated files for removal from the inventory.
451
This does not remove their text. This does not run on
453
TODO: Refuse to remove modified files unless --force is given?
455
TODO: Do something useful with directories.
457
TODO: Should this remove the text or not? Tough call; not
458
removing may be useful and the user can just use use rm, and
459
is the opposite of add. Removing it is consistent with most
460
other tools. Maybe an option.
462
## TODO: Normalize names
463
## TODO: Remove nested loops; better scalability
464
if isinstance(files, types.StringTypes):
470
tree = self.working_tree()
473
# do this before any modifications
477
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
478
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
480
# having remove it, it must be either ignored or unknown
481
if tree.is_ignored(f):
485
show_status(new_status, inv[fid].kind, quotefn(f))
488
self._write_inventory(inv)
493
# FIXME: this doesn't need to be a branch method
494
def set_inventory(self, new_inventory_list):
496
for path, file_id, parent, kind in new_inventory_list:
497
name = os.path.basename(path)
500
inv.add(InventoryEntry(file_id, name, kind, parent))
501
self._write_inventory(inv)
505
"""Return all unknown files.
507
These are files in the working directory that are not versioned or
508
control files or ignored.
510
>>> b = ScratchBranch(files=['foo', 'foo~'])
511
>>> list(b.unknowns())
514
>>> list(b.unknowns())
517
>>> list(b.unknowns())
520
return self.working_tree().unknowns()
523
def append_revision(self, revision_id):
524
mutter("add {%s} to revision-history" % revision_id)
525
rev_history = self.revision_history()
527
tmprhname = self.controlfilename('revision-history.tmp')
528
rhname = self.controlfilename('revision-history')
530
f = file(tmprhname, 'wt')
531
rev_history.append(revision_id)
532
f.write('\n'.join(rev_history))
536
if sys.platform == 'win32':
538
os.rename(tmprhname, rhname)
542
def get_revision(self, revision_id):
543
"""Return the Revision object for a named revision"""
544
if not revision_id or not isinstance(revision_id, basestring):
545
raise ValueError('invalid revision-id: %r' % revision_id)
546
r = Revision.read_xml(self.revision_store[revision_id])
547
assert r.revision_id == revision_id
550
def get_revision_sha1(self, revision_id):
551
"""Hash the stored value of a revision, and return it."""
552
# In the future, revision entries will be signed. At that
553
# point, it is probably best *not* to include the signature
554
# in the revision hash. Because that lets you re-sign
555
# the revision, (add signatures/remove signatures) and still
556
# have all hash pointers stay consistent.
557
# But for now, just hash the contents.
558
return sha_file(self.revision_store[revision_id])
561
def get_inventory(self, inventory_id):
562
"""Get Inventory object by hash.
564
TODO: Perhaps for this and similar methods, take a revision
565
parameter which can be either an integer revno or a
567
i = Inventory.read_xml(self.inventory_store[inventory_id])
570
def get_inventory_sha1(self, inventory_id):
571
"""Return the sha1 hash of the inventory entry
573
return sha_file(self.inventory_store[inventory_id])
576
def get_revision_inventory(self, revision_id):
577
"""Return inventory of a past revision."""
578
if revision_id == None:
581
return self.get_inventory(self.get_revision(revision_id).inventory_id)
767
raise NotImplementedError(self.print_file)
769
@deprecated_method(deprecated_in((2, 4, 0)))
770
def set_revision_history(self, rev_history):
771
"""See Branch.set_revision_history."""
772
self._set_revision_history(rev_history)
775
def _set_revision_history(self, rev_history):
776
if len(rev_history) == 0:
777
revid = _mod_revision.NULL_REVISION
779
revid = rev_history[-1]
780
if rev_history != self._lefthand_history(revid):
781
raise errors.NotLefthandHistory(rev_history)
782
self.set_last_revision_info(len(rev_history), revid)
783
self._cache_revision_history(rev_history)
784
for hook in Branch.hooks['set_rh']:
785
hook(self, rev_history)
788
def set_last_revision_info(self, revno, revision_id):
789
"""Set the last revision of this branch.
791
The caller is responsible for checking that the revno is correct
792
for this revision id.
794
It may be possible to set the branch last revision to an id not
795
present in the repository. However, branches can also be
796
configured to check constraints on history, in which case this may not
799
raise NotImplementedError(self.set_last_revision_info)
802
def generate_revision_history(self, revision_id, last_rev=None,
804
"""See Branch.generate_revision_history"""
805
graph = self.repository.get_graph()
806
(last_revno, last_revid) = self.last_revision_info()
807
known_revision_ids = [
808
(last_revid, last_revno),
809
(_mod_revision.NULL_REVISION, 0),
811
if last_rev is not None:
812
if not graph.is_ancestor(last_rev, revision_id):
813
# our previous tip is not merged into stop_revision
814
raise errors.DivergedBranches(self, other_branch)
815
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
816
self.set_last_revision_info(revno, revision_id)
819
def set_parent(self, url):
820
"""See Branch.set_parent."""
821
# TODO: Maybe delete old location files?
822
# URLs should never be unicode, even on the local fs,
823
# FIXUP this and get_parent in a future branch format bump:
824
# read and rewrite the file. RBC 20060125
826
if isinstance(url, unicode):
828
url = url.encode('ascii')
829
except UnicodeEncodeError:
830
raise errors.InvalidURL(url,
831
"Urls must be 7-bit ascii, "
832
"use bzrlib.urlutils.escape")
833
url = urlutils.relative_url(self.base, url)
834
self._set_parent_location(url)
837
def set_stacked_on_url(self, url):
838
"""Set the URL this branch is stacked against.
840
:raises UnstackableBranchFormat: If the branch does not support
842
:raises UnstackableRepositoryFormat: If the repository does not support
845
if not self._format.supports_stacking():
846
raise errors.UnstackableBranchFormat(self._format, self.user_url)
847
# XXX: Changing from one fallback repository to another does not check
848
# that all the data you need is present in the new fallback.
849
# Possibly it should.
850
self._check_stackable_repo()
853
old_url = self.get_stacked_on_url()
854
except (errors.NotStacked, errors.UnstackableBranchFormat,
855
errors.UnstackableRepositoryFormat):
859
self._activate_fallback_location(url,
860
possible_transports=[self.bzrdir.root_transport])
861
# write this out after the repository is stacked to avoid setting a
862
# stacked config that doesn't work.
863
self._set_config_location('stacked_on_location', url)
866
"""Change a branch to be unstacked, copying data as needed.
868
Don't call this directly, use set_stacked_on_url(None).
870
pb = ui.ui_factory.nested_progress_bar()
872
pb.update(gettext("Unstacking"))
873
# The basic approach here is to fetch the tip of the branch,
874
# including all available ghosts, from the existing stacked
875
# repository into a new repository object without the fallbacks.
877
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
878
# correct for CHKMap repostiories
879
old_repository = self.repository
880
if len(old_repository._fallback_repositories) != 1:
881
raise AssertionError("can't cope with fallback repositories "
882
"of %r (fallbacks: %r)" % (old_repository,
883
old_repository._fallback_repositories))
884
# Open the new repository object.
885
# Repositories don't offer an interface to remove fallback
886
# repositories today; take the conceptually simpler option and just
887
# reopen it. We reopen it starting from the URL so that we
888
# get a separate connection for RemoteRepositories and can
889
# stream from one of them to the other. This does mean doing
890
# separate SSH connection setup, but unstacking is not a
891
# common operation so it's tolerable.
892
new_bzrdir = controldir.ControlDir.open(
893
self.bzrdir.root_transport.base)
894
new_repository = new_bzrdir.find_repository()
895
if new_repository._fallback_repositories:
896
raise AssertionError("didn't expect %r to have "
897
"fallback_repositories"
898
% (self.repository,))
899
# Replace self.repository with the new repository.
900
# Do our best to transfer the lock state (i.e. lock-tokens and
901
# lock count) of self.repository to the new repository.
902
lock_token = old_repository.lock_write().repository_token
903
self.repository = new_repository
904
if isinstance(self, remote.RemoteBranch):
905
# Remote branches can have a second reference to the old
906
# repository that need to be replaced.
907
if self._real_branch is not None:
908
self._real_branch.repository = new_repository
909
self.repository.lock_write(token=lock_token)
910
if lock_token is not None:
911
old_repository.leave_lock_in_place()
912
old_repository.unlock()
913
if lock_token is not None:
914
# XXX: self.repository.leave_lock_in_place() before this
915
# function will not be preserved. Fortunately that doesn't
916
# affect the current default format (2a), and would be a
917
# corner-case anyway.
918
# - Andrew Bennetts, 2010/06/30
919
self.repository.dont_leave_lock_in_place()
923
old_repository.unlock()
924
except errors.LockNotHeld:
927
if old_lock_count == 0:
928
raise AssertionError(
929
'old_repository should have been locked at least once.')
930
for i in range(old_lock_count-1):
931
self.repository.lock_write()
932
# Fetch from the old repository into the new.
933
old_repository.lock_read()
935
# XXX: If you unstack a branch while it has a working tree
936
# with a pending merge, the pending-merged revisions will no
937
# longer be present. You can (probably) revert and remerge.
939
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
940
except errors.TagsNotSupported:
941
tags_to_fetch = set()
942
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
943
old_repository, required_ids=[self.last_revision()],
944
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
945
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
947
old_repository.unlock()
951
def _set_tags_bytes(self, bytes):
952
"""Mirror method for _get_tags_bytes.
954
:seealso: Branch._get_tags_bytes.
956
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
957
op.add_cleanup(self.lock_write().unlock)
958
return op.run_simple(bytes)
960
def _set_tags_bytes_locked(self, bytes):
961
self._tags_bytes = bytes
962
return self._transport.put_bytes('tags', bytes)
964
def _cache_revision_history(self, rev_history):
965
"""Set the cached revision history to rev_history.
967
The revision_history method will use this cache to avoid regenerating
968
the revision history.
970
This API is semi-public; it only for use by subclasses, all other code
971
should consider it to be private.
973
self._revision_history_cache = rev_history
975
def _cache_revision_id_to_revno(self, revision_id_to_revno):
976
"""Set the cached revision_id => revno map to revision_id_to_revno.
978
This API is semi-public; it only for use by subclasses, all other code
979
should consider it to be private.
981
self._revision_id_to_revno_cache = revision_id_to_revno
983
def _clear_cached_state(self):
984
"""Clear any cached data on this branch, e.g. cached revision history.
986
This means the next call to revision_history will need to call
987
_gen_revision_history.
989
This API is semi-public; it only for use by subclasses, all other code
990
should consider it to be private.
992
self._revision_history_cache = None
993
self._revision_id_to_revno_cache = None
994
self._last_revision_info_cache = None
995
self._master_branch_cache = None
996
self._merge_sorted_revisions_cache = None
997
self._partial_revision_history_cache = []
998
self._partial_revision_id_to_revno_cache = {}
999
self._tags_bytes = None
1001
def _gen_revision_history(self):
1002
"""Return sequence of revision hashes on to this branch.
1004
Unlike revision_history, this method always regenerates or rereads the
1005
revision history, i.e. it does not cache the result, so repeated calls
1008
Concrete subclasses should override this instead of revision_history so
1009
that subclasses do not need to deal with caching logic.
1011
This API is semi-public; it only for use by subclasses, all other code
1012
should consider it to be private.
1014
raise NotImplementedError(self._gen_revision_history)
1016
@deprecated_method(deprecated_in((2, 5, 0)))
584
1018
def revision_history(self):
585
"""Return sequence of revision hashes on to this branch.
587
>>> ScratchBranch().revision_history()
592
return [l.rstrip('\r\n') for l in
593
self.controlfile('revision-history', 'r').readlines()]
598
def common_ancestor(self, other, self_revno=None, other_revno=None):
601
>>> sb = ScratchBranch(files=['foo', 'foo~'])
602
>>> sb.common_ancestor(sb) == (None, None)
604
>>> commit.commit(sb, "Committing first revision", verbose=False)
605
>>> sb.common_ancestor(sb)[0]
607
>>> clone = sb.clone()
608
>>> commit.commit(sb, "Committing second revision", verbose=False)
609
>>> sb.common_ancestor(sb)[0]
611
>>> sb.common_ancestor(clone)[0]
613
>>> commit.commit(clone, "Committing divergent second revision",
615
>>> sb.common_ancestor(clone)[0]
617
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
619
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
621
>>> clone2 = sb.clone()
622
>>> sb.common_ancestor(clone2)[0]
624
>>> sb.common_ancestor(clone2, self_revno=1)[0]
626
>>> sb.common_ancestor(clone2, other_revno=1)[0]
629
my_history = self.revision_history()
630
other_history = other.revision_history()
631
if self_revno is None:
632
self_revno = len(my_history)
633
if other_revno is None:
634
other_revno = len(other_history)
635
indices = range(min((self_revno, other_revno)))
638
if my_history[r] == other_history[r]:
639
return r+1, my_history[r]
642
def enum_history(self, direction):
643
"""Return (revno, revision_id) for history of branch.
646
'forward' is from earliest to latest
647
'reverse' is from latest to earliest
649
rh = self.revision_history()
650
if direction == 'forward':
655
elif direction == 'reverse':
1019
"""Return sequence of revision ids on this branch.
1021
This method will cache the revision history for as long as it is safe to
1024
return self._revision_history()
1026
def _revision_history(self):
1027
if 'evil' in debug.debug_flags:
1028
mutter_callsite(3, "revision_history scales with history.")
1029
if self._revision_history_cache is not None:
1030
history = self._revision_history_cache
661
raise ValueError('invalid history direction', direction)
1032
history = self._gen_revision_history()
1033
self._cache_revision_history(history)
1034
return list(history)
664
1036
def revno(self):
665
1037
"""Return current revision number for this branch.
667
1039
That is equivalent to the number of revisions committed to
670
return len(self.revision_history())
673
def last_patch(self):
674
"""Return last patch hash, or None if no history.
676
ph = self.revision_history()
683
def missing_revisions(self, other, stop_revision=None):
685
If self and other have not diverged, return a list of the revisions
686
present in other, but missing from self.
688
>>> from bzrlib.commit import commit
689
>>> bzrlib.trace.silent = True
690
>>> br1 = ScratchBranch()
691
>>> br2 = ScratchBranch()
692
>>> br1.missing_revisions(br2)
694
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
695
>>> br1.missing_revisions(br2)
697
>>> br2.missing_revisions(br1)
699
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
700
>>> br1.missing_revisions(br2)
702
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
703
>>> br1.missing_revisions(br2)
705
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
706
>>> br1.missing_revisions(br2)
707
Traceback (most recent call last):
708
DivergedBranches: These branches have diverged.
710
self_history = self.revision_history()
711
self_len = len(self_history)
712
other_history = other.revision_history()
713
other_len = len(other_history)
714
common_index = min(self_len, other_len) -1
715
if common_index >= 0 and \
716
self_history[common_index] != other_history[common_index]:
717
raise DivergedBranches(self, other)
1042
return self.last_revision_info()[0]
1045
"""Older format branches cannot bind or unbind."""
1046
raise errors.UpgradeRequired(self.user_url)
1048
def last_revision(self):
1049
"""Return last revision id, or NULL_REVISION."""
1050
return self.last_revision_info()[1]
1053
def last_revision_info(self):
1054
"""Return information about the last revision.
1056
:return: A tuple (revno, revision_id).
1058
if self._last_revision_info_cache is None:
1059
self._last_revision_info_cache = self._read_last_revision_info()
1060
return self._last_revision_info_cache
1062
def _read_last_revision_info(self):
1063
raise NotImplementedError(self._read_last_revision_info)
1065
@deprecated_method(deprecated_in((2, 4, 0)))
1066
def import_last_revision_info(self, source_repo, revno, revid):
1067
"""Set the last revision info, importing from another repo if necessary.
1069
:param source_repo: Source repository to optionally fetch from
1070
:param revno: Revision number of the new tip
1071
:param revid: Revision id of the new tip
1073
if not self.repository.has_same_location(source_repo):
1074
self.repository.fetch(source_repo, revision_id=revid)
1075
self.set_last_revision_info(revno, revid)
1077
def import_last_revision_info_and_tags(self, source, revno, revid,
1079
"""Set the last revision info, importing from another repo if necessary.
1081
This is used by the bound branch code to upload a revision to
1082
the master branch first before updating the tip of the local branch.
1083
Revisions referenced by source's tags are also transferred.
1085
:param source: Source branch to optionally fetch from
1086
:param revno: Revision number of the new tip
1087
:param revid: Revision id of the new tip
1088
:param lossy: Whether to discard metadata that can not be
1089
natively represented
1090
:return: Tuple with the new revision number and revision id
1091
(should only be different from the arguments when lossy=True)
1093
if not self.repository.has_same_location(source.repository):
1094
self.fetch(source, revid)
1095
self.set_last_revision_info(revno, revid)
1096
return (revno, revid)
1098
def revision_id_to_revno(self, revision_id):
1099
"""Given a revision id, return its revno"""
1100
if _mod_revision.is_null(revision_id):
1102
history = self._revision_history()
1104
return history.index(revision_id) + 1
1106
raise errors.NoSuchRevision(self, revision_id)
1109
def get_rev_id(self, revno, history=None):
1110
"""Find the revision id of the specified revno."""
1112
return _mod_revision.NULL_REVISION
1113
last_revno, last_revid = self.last_revision_info()
1114
if revno == last_revno:
1116
if revno <= 0 or revno > last_revno:
1117
raise errors.NoSuchRevision(self, revno)
1118
distance_from_last = last_revno - revno
1119
if len(self._partial_revision_history_cache) <= distance_from_last:
1120
self._extend_partial_history(distance_from_last)
1121
return self._partial_revision_history_cache[distance_from_last]
1123
def pull(self, source, overwrite=False, stop_revision=None,
1124
possible_transports=None, *args, **kwargs):
1125
"""Mirror source into this branch.
1127
This branch is considered to be 'local', having low latency.
1129
:returns: PullResult instance
1131
return InterBranch.get(source, self).pull(overwrite=overwrite,
1132
stop_revision=stop_revision,
1133
possible_transports=possible_transports, *args, **kwargs)
1135
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1137
"""Mirror this branch into target.
1139
This branch is considered to be 'local', having low latency.
1141
return InterBranch.get(self, target).push(overwrite, stop_revision,
1142
lossy, *args, **kwargs)
1144
def basis_tree(self):
1145
"""Return `Tree` object for last revision."""
1146
return self.repository.revision_tree(self.last_revision())
1148
def get_parent(self):
1149
"""Return the parent location of the branch.
1151
This is the default location for pull/missing. The usual
1152
pattern is that the user can override it by specifying a
1155
parent = self._get_parent_location()
1158
# This is an old-format absolute path to a local branch
1159
# turn it into a url
1160
if parent.startswith('/'):
1161
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1163
return urlutils.join(self.base[:-1], parent)
1164
except errors.InvalidURLJoin, e:
1165
raise errors.InaccessibleParent(parent, self.user_url)
1167
def _get_parent_location(self):
1168
raise NotImplementedError(self._get_parent_location)
1170
def _set_config_location(self, name, url, config=None,
1171
make_relative=False):
1173
config = self.get_config_stack()
1177
url = urlutils.relative_url(self.base, url)
1178
config.set(name, url)
1180
def _get_config_location(self, name, config=None):
1182
config = self.get_config_stack()
1183
location = config.get(name)
1188
def get_child_submit_format(self):
1189
"""Return the preferred format of submissions to this branch."""
1190
return self.get_config_stack().get('child_submit_format')
1192
def get_submit_branch(self):
1193
"""Return the submit location of the branch.
1195
This is the default location for bundle. The usual
1196
pattern is that the user can override it by specifying a
1199
return self.get_config_stack().get('submit_branch')
1201
def set_submit_branch(self, location):
1202
"""Return the submit location of the branch.
1204
This is the default location for bundle. The usual
1205
pattern is that the user can override it by specifying a
1208
self.get_config_stack().set('submit_branch', location)
1210
def get_public_branch(self):
1211
"""Return the public location of the branch.
1213
This is used by merge directives.
1215
return self._get_config_location('public_branch')
1217
def set_public_branch(self, location):
1218
"""Return the submit location of the branch.
1220
This is the default location for bundle. The usual
1221
pattern is that the user can override it by specifying a
1224
self._set_config_location('public_branch', location)
1226
def get_push_location(self):
1227
"""Return None or the location to push this branch to."""
1228
return self.get_config_stack().get('push_location')
1230
def set_push_location(self, location):
1231
"""Set a new push location for this branch."""
1232
raise NotImplementedError(self.set_push_location)
1234
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1235
"""Run the post_change_branch_tip hooks."""
1236
hooks = Branch.hooks['post_change_branch_tip']
1239
new_revno, new_revid = self.last_revision_info()
1240
params = ChangeBranchTipParams(
1241
self, old_revno, new_revno, old_revid, new_revid)
1245
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1246
"""Run the pre_change_branch_tip hooks."""
1247
hooks = Branch.hooks['pre_change_branch_tip']
1250
old_revno, old_revid = self.last_revision_info()
1251
params = ChangeBranchTipParams(
1252
self, old_revno, new_revno, old_revid, new_revid)
1258
"""Synchronise this branch with the master branch if any.
1260
:return: None or the last_revision pivoted out during the update.
1264
def check_revno(self, revno):
1266
Check whether a revno corresponds to any revision.
1267
Zero (the NULL revision) is considered valid.
1270
self.check_real_revno(revno)
1272
def check_real_revno(self, revno):
1274
Check whether a revno corresponds to a real revision.
1275
Zero (the NULL revision) is considered invalid
1277
if revno < 1 or revno > self.revno():
1278
raise errors.InvalidRevisionNumber(revno)
1281
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1282
"""Clone this branch into to_bzrdir preserving all semantic values.
1284
Most API users will want 'create_clone_on_transport', which creates a
1285
new bzrdir and branch on the fly.
1287
revision_id: if not None, the revision history in the new branch will
1288
be truncated to end with revision_id.
1290
result = to_bzrdir.create_branch()
1293
if repository_policy is not None:
1294
repository_policy.configure_branch(result)
1295
self.copy_content_into(result, revision_id=revision_id)
1301
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1303
"""Create a new line of development from the branch, into to_bzrdir.
1305
to_bzrdir controls the branch format.
1307
revision_id: if not None, the revision history in the new branch will
1308
be truncated to end with revision_id.
1310
if (repository_policy is not None and
1311
repository_policy.requires_stacking()):
1312
to_bzrdir._format.require_stacking(_skip_repo=True)
1313
result = to_bzrdir.create_branch(repository=repository)
1316
if repository_policy is not None:
1317
repository_policy.configure_branch(result)
1318
self.copy_content_into(result, revision_id=revision_id)
1319
master_url = self.get_bound_location()
1320
if master_url is None:
1321
result.set_parent(self.bzrdir.root_transport.base)
1323
result.set_parent(master_url)
1328
def _synchronize_history(self, destination, revision_id):
1329
"""Synchronize last revision and revision history between branches.
1331
This version is most efficient when the destination is also a
1332
BzrBranch6, but works for BzrBranch5, as long as the destination's
1333
repository contains all the lefthand ancestors of the intended
1334
last_revision. If not, set_last_revision_info will fail.
1336
:param destination: The branch to copy the history into
1337
:param revision_id: The revision-id to truncate history at. May
1338
be None to copy complete history.
1340
source_revno, source_revision_id = self.last_revision_info()
1341
if revision_id is None:
1342
revno, revision_id = source_revno, source_revision_id
1344
graph = self.repository.get_graph()
1346
revno = graph.find_distance_to_null(revision_id,
1347
[(source_revision_id, source_revno)])
1348
except errors.GhostRevisionsHaveNoRevno:
1349
# Default to 1, if we can't find anything else
1351
destination.set_last_revision_info(revno, revision_id)
1353
def copy_content_into(self, destination, revision_id=None):
1354
"""Copy the content of self into destination.
1356
revision_id: if not None, the revision history in the new branch will
1357
be truncated to end with revision_id.
1359
return InterBranch.get(self, destination).copy_content_into(
1360
revision_id=revision_id)
1362
def update_references(self, target):
1363
if not getattr(self._format, 'supports_reference_locations', False):
1365
reference_dict = self._get_all_reference_info()
1366
if len(reference_dict) == 0:
1368
old_base = self.base
1369
new_base = target.base
1370
target_reference_dict = target._get_all_reference_info()
1371
for file_id, (tree_path, branch_location) in (
1372
reference_dict.items()):
1373
branch_location = urlutils.rebase_url(branch_location,
1375
target_reference_dict.setdefault(
1376
file_id, (tree_path, branch_location))
1377
target._set_all_reference_info(target_reference_dict)
1380
def check(self, refs):
1381
"""Check consistency of the branch.
1383
In particular this checks that revisions given in the revision-history
1384
do actually match up in the revision graph, and that they're all
1385
present in the repository.
1387
Callers will typically also want to check the repository.
1389
:param refs: Calculated refs for this branch as specified by
1390
branch._get_check_refs()
1391
:return: A BranchCheckResult.
1393
result = BranchCheckResult(self)
1394
last_revno, last_revision_id = self.last_revision_info()
1395
actual_revno = refs[('lefthand-distance', last_revision_id)]
1396
if actual_revno != last_revno:
1397
result.errors.append(errors.BzrCheckError(
1398
'revno does not match len(mainline) %s != %s' % (
1399
last_revno, actual_revno)))
1400
# TODO: We should probably also check that self.revision_history
1401
# matches the repository for older branch formats.
1402
# If looking for the code that cross-checks repository parents against
1403
# the Graph.iter_lefthand_ancestry output, that is now a repository
1407
def _get_checkout_format(self, lightweight=False):
1408
"""Return the most suitable metadir for a checkout of this branch.
1409
Weaves are used if this branch's repository uses weaves.
1411
format = self.repository.bzrdir.checkout_metadir()
1412
format.set_branch_format(self._format)
1415
def create_clone_on_transport(self, to_transport, revision_id=None,
1416
stacked_on=None, create_prefix=False, use_existing_dir=False,
1418
"""Create a clone of this branch and its bzrdir.
1420
:param to_transport: The transport to clone onto.
1421
:param revision_id: The revision id to use as tip in the new branch.
1422
If None the tip is obtained from this branch.
1423
:param stacked_on: An optional URL to stack the clone on.
1424
:param create_prefix: Create any missing directories leading up to
1426
:param use_existing_dir: Use an existing directory if one exists.
1428
# XXX: Fix the bzrdir API to allow getting the branch back from the
1429
# clone call. Or something. 20090224 RBC/spiv.
1430
# XXX: Should this perhaps clone colocated branches as well,
1431
# rather than just the default branch? 20100319 JRV
1432
if revision_id is None:
1433
revision_id = self.last_revision()
1434
dir_to = self.bzrdir.clone_on_transport(to_transport,
1435
revision_id=revision_id, stacked_on=stacked_on,
1436
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1438
return dir_to.open_branch()
1440
def create_checkout(self, to_location, revision_id=None,
1441
lightweight=False, accelerator_tree=None,
1443
"""Create a checkout of a branch.
1445
:param to_location: The url to produce the checkout at
1446
:param revision_id: The revision to check out
1447
:param lightweight: If True, produce a lightweight checkout, otherwise,
1448
produce a bound branch (heavyweight checkout)
1449
:param accelerator_tree: A tree which can be used for retrieving file
1450
contents more quickly than the revision tree, i.e. a workingtree.
1451
The revision tree will be used for cases where accelerator_tree's
1452
content is different.
1453
:param hardlink: If true, hard-link files from accelerator_tree,
1455
:return: The tree of the created checkout
1457
t = transport.get_transport(to_location)
1459
format = self._get_checkout_format(lightweight=lightweight)
1461
checkout = format.initialize_on_transport(t)
1462
from_branch = BranchReferenceFormat().initialize(checkout,
1465
checkout_branch = controldir.ControlDir.create_branch_convenience(
1466
to_location, force_new_tree=False, format=format)
1467
checkout = checkout_branch.bzrdir
1468
checkout_branch.bind(self)
1469
# pull up to the specified revision_id to set the initial
1470
# branch tip correctly, and seed it with history.
1471
checkout_branch.pull(self, stop_revision=revision_id)
1473
tree = checkout.create_workingtree(revision_id,
1474
from_branch=from_branch,
1475
accelerator_tree=accelerator_tree,
1477
basis_tree = tree.basis_tree()
1478
basis_tree.lock_read()
1480
for path, file_id in basis_tree.iter_references():
1481
reference_parent = self.reference_parent(file_id, path)
1482
reference_parent.create_checkout(tree.abspath(path),
1483
basis_tree.get_reference_revision(file_id, path),
1490
def reconcile(self, thorough=True):
1491
"""Make sure the data stored in this branch is consistent."""
1492
from bzrlib.reconcile import BranchReconciler
1493
reconciler = BranchReconciler(self, thorough=thorough)
1494
reconciler.reconcile()
1497
def reference_parent(self, file_id, path, possible_transports=None):
1498
"""Return the parent branch for a tree-reference file_id
1500
:param file_id: The file_id of the tree reference
1501
:param path: The path of the file_id in the tree
1502
:return: A branch associated with the file_id
1504
# FIXME should provide multiple branches, based on config
1505
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1506
possible_transports=possible_transports)
1508
def supports_tags(self):
1509
return self._format.supports_tags()
1511
def automatic_tag_name(self, revision_id):
1512
"""Try to automatically find the tag name for a revision.
1514
:param revision_id: Revision id of the revision.
1515
:return: A tag name or None if no tag name could be determined.
1517
for hook in Branch.hooks['automatic_tag_name']:
1518
ret = hook(self, revision_id)
1523
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1525
"""Ensure that revision_b is a descendant of revision_a.
1527
This is a helper function for update_revisions.
1529
:raises: DivergedBranches if revision_b has diverged from revision_a.
1530
:returns: True if revision_b is a descendant of revision_a.
1532
relation = self._revision_relations(revision_a, revision_b, graph)
1533
if relation == 'b_descends_from_a':
1535
elif relation == 'diverged':
1536
raise errors.DivergedBranches(self, other_branch)
1537
elif relation == 'a_descends_from_b':
1540
raise AssertionError("invalid relation: %r" % (relation,))
1542
def _revision_relations(self, revision_a, revision_b, graph):
1543
"""Determine the relationship between two revisions.
1545
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1547
heads = graph.heads([revision_a, revision_b])
1548
if heads == set([revision_b]):
1549
return 'b_descends_from_a'
1550
elif heads == set([revision_a, revision_b]):
1551
# These branches have diverged
1553
elif heads == set([revision_a]):
1554
return 'a_descends_from_b'
1556
raise AssertionError("invalid heads: %r" % (heads,))
1558
def heads_to_fetch(self):
1559
"""Return the heads that must and that should be fetched to copy this
1560
branch into another repo.
1562
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1563
set of heads that must be fetched. if_present_fetch is a set of
1564
heads that must be fetched if present, but no error is necessary if
1565
they are not present.
1567
# For bzr native formats must_fetch is just the tip, and
1568
# if_present_fetch are the tags.
1569
must_fetch = set([self.last_revision()])
1570
if_present_fetch = set()
1571
if self.get_config_stack().get('branch.fetch_tags'):
1573
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1574
except errors.TagsNotSupported:
1576
must_fetch.discard(_mod_revision.NULL_REVISION)
1577
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1578
return must_fetch, if_present_fetch
1581
class BranchFormat(controldir.ControlComponentFormat):
1582
"""An encapsulation of the initialization and open routines for a format.
1584
Formats provide three things:
1585
* An initialization routine,
1586
* a format description
1589
Formats are placed in an dict by their format string for reference
1590
during branch opening. It's not required that these be instances, they
1591
can be classes themselves with class methods - it simply depends on
1592
whether state is needed for a given format or not.
1594
Once a format is deprecated, just deprecate the initialize and open
1595
methods on the format class. Do not deprecate the object, as the
1596
object will be created every time regardless.
1599
def __eq__(self, other):
1600
return self.__class__ is other.__class__
1602
def __ne__(self, other):
1603
return not (self == other)
1606
@deprecated_method(deprecated_in((2, 4, 0)))
1607
def get_default_format(klass):
1608
"""Return the current default format."""
1609
return format_registry.get_default()
1612
@deprecated_method(deprecated_in((2, 4, 0)))
1613
def get_formats(klass):
1614
"""Get all the known formats.
1616
Warning: This triggers a load of all lazy registered formats: do not
1617
use except when that is desireed.
1619
return format_registry._get_all()
1621
def get_reference(self, controldir, name=None):
1622
"""Get the target reference of the branch in controldir.
1624
format probing must have been completed before calling
1625
this method - it is assumed that the format of the branch
1626
in controldir is correct.
1628
:param controldir: The controldir to get the branch data from.
1629
:param name: Name of the colocated branch to fetch
1630
:return: None if the branch is not a reference branch.
1635
def set_reference(self, controldir, name, to_branch):
1636
"""Set the target reference of the branch in controldir.
1638
format probing must have been completed before calling
1639
this method - it is assumed that the format of the branch
1640
in controldir is correct.
1642
:param controldir: The controldir to set the branch reference for.
1643
:param name: Name of colocated branch to set, None for default
1644
:param to_branch: branch that the checkout is to reference
1646
raise NotImplementedError(self.set_reference)
1648
def get_format_description(self):
1649
"""Return the short format description for this format."""
1650
raise NotImplementedError(self.get_format_description)
1652
def _run_post_branch_init_hooks(self, controldir, name, branch):
1653
hooks = Branch.hooks['post_branch_init']
1656
params = BranchInitHookParams(self, controldir, name, branch)
1660
def initialize(self, controldir, name=None, repository=None,
1661
append_revisions_only=None):
1662
"""Create a branch of this format in controldir.
1664
:param name: Name of the colocated branch to create.
1666
raise NotImplementedError(self.initialize)
1668
def is_supported(self):
1669
"""Is this format supported?
1671
Supported formats can be initialized and opened.
1672
Unsupported formats may not support initialization or committing or
1673
some other features depending on the reason for not being supported.
1677
def make_tags(self, branch):
1678
"""Create a tags object for branch.
1680
This method is on BranchFormat, because BranchFormats are reflected
1681
over the wire via network_name(), whereas full Branch instances require
1682
multiple VFS method calls to operate at all.
1684
The default implementation returns a disabled-tags instance.
1686
Note that it is normal for branch to be a RemoteBranch when using tags
1689
return _mod_tag.DisabledTags(branch)
1691
def network_name(self):
1692
"""A simple byte string uniquely identifying this format for RPC calls.
1694
MetaDir branch formats use their disk format string to identify the
1695
repository over the wire. All in one formats such as bzr < 0.8, and
1696
foreign formats like svn/git and hg should use some marker which is
1697
unique and immutable.
1699
raise NotImplementedError(self.network_name)
1701
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1702
found_repository=None, possible_transports=None):
1703
"""Return the branch object for controldir.
1705
:param controldir: A ControlDir that contains a branch.
1706
:param name: Name of colocated branch to open
1707
:param _found: a private parameter, do not use it. It is used to
1708
indicate if format probing has already be done.
1709
:param ignore_fallbacks: when set, no fallback branches will be opened
1710
(if there are any). Default is to open fallbacks.
1712
raise NotImplementedError(self.open)
1715
@deprecated_method(deprecated_in((2, 4, 0)))
1716
def register_format(klass, format):
1717
"""Register a metadir format.
1719
See MetaDirBranchFormatFactory for the ability to register a format
1720
without loading the code the format needs until it is actually used.
1722
format_registry.register(format)
1725
@deprecated_method(deprecated_in((2, 4, 0)))
1726
def set_default_format(klass, format):
1727
format_registry.set_default(format)
1729
def supports_set_append_revisions_only(self):
1730
"""True if this format supports set_append_revisions_only."""
1733
def supports_stacking(self):
1734
"""True if this format records a stacked-on branch."""
1737
def supports_leaving_lock(self):
1738
"""True if this format supports leaving locks in place."""
1739
return False # by default
1742
@deprecated_method(deprecated_in((2, 4, 0)))
1743
def unregister_format(klass, format):
1744
format_registry.remove(format)
1747
return self.get_format_description().rstrip()
1749
def supports_tags(self):
1750
"""True if this format supports tags stored in the branch"""
1751
return False # by default
1753
def tags_are_versioned(self):
1754
"""Whether the tag container for this branch versions tags."""
1757
def supports_tags_referencing_ghosts(self):
1758
"""True if tags can reference ghost revisions."""
1762
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1763
"""A factory for a BranchFormat object, permitting simple lazy registration.
1765
While none of the built in BranchFormats are lazy registered yet,
1766
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1767
use it, and the bzr-loom plugin uses it as well (see
1768
bzrlib.plugins.loom.formats).
1771
def __init__(self, format_string, module_name, member_name):
1772
"""Create a MetaDirBranchFormatFactory.
1774
:param format_string: The format string the format has.
1775
:param module_name: Module to load the format class from.
1776
:param member_name: Attribute name within the module for the format class.
1778
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1779
self._format_string = format_string
1781
def get_format_string(self):
1782
"""See BranchFormat.get_format_string."""
1783
return self._format_string
1786
"""Used for network_format_registry support."""
1787
return self.get_obj()()
1790
class BranchHooks(Hooks):
1791
"""A dictionary mapping hook name to a list of callables for branch hooks.
1793
e.g. ['set_rh'] Is the list of items to be called when the
1794
set_revision_history function is invoked.
1798
"""Create the default hooks.
1800
These are all empty initially, because by default nothing should get
1803
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1804
self.add_hook('set_rh',
1805
"Invoked whenever the revision history has been set via "
1806
"set_revision_history. The api signature is (branch, "
1807
"revision_history), and the branch will be write-locked. "
1808
"The set_rh hook can be expensive for bzr to trigger, a better "
1809
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1810
self.add_hook('open',
1811
"Called with the Branch object that has been opened after a "
1812
"branch is opened.", (1, 8))
1813
self.add_hook('post_push',
1814
"Called after a push operation completes. post_push is called "
1815
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1816
"bzr client.", (0, 15))
1817
self.add_hook('post_pull',
1818
"Called after a pull operation completes. post_pull is called "
1819
"with a bzrlib.branch.PullResult object and only runs in the "
1820
"bzr client.", (0, 15))
1821
self.add_hook('pre_commit',
1822
"Called after a commit is calculated but before it is "
1823
"completed. pre_commit is called with (local, master, old_revno, "
1824
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1825
"). old_revid is NULL_REVISION for the first commit to a branch, "
1826
"tree_delta is a TreeDelta object describing changes from the "
1827
"basis revision. hooks MUST NOT modify this delta. "
1828
" future_tree is an in-memory tree obtained from "
1829
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1831
self.add_hook('post_commit',
1832
"Called in the bzr client after a commit has completed. "
1833
"post_commit is called with (local, master, old_revno, old_revid, "
1834
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1835
"commit to a branch.", (0, 15))
1836
self.add_hook('post_uncommit',
1837
"Called in the bzr client after an uncommit completes. "
1838
"post_uncommit is called with (local, master, old_revno, "
1839
"old_revid, new_revno, new_revid) where local is the local branch "
1840
"or None, master is the target branch, and an empty branch "
1841
"receives new_revno of 0, new_revid of None.", (0, 15))
1842
self.add_hook('pre_change_branch_tip',
1843
"Called in bzr client and server before a change to the tip of a "
1844
"branch is made. pre_change_branch_tip is called with a "
1845
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1846
"commit, uncommit will all trigger this hook.", (1, 6))
1847
self.add_hook('post_change_branch_tip',
1848
"Called in bzr client and server after a change to the tip of a "
1849
"branch is made. post_change_branch_tip is called with a "
1850
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1851
"commit, uncommit will all trigger this hook.", (1, 4))
1852
self.add_hook('transform_fallback_location',
1853
"Called when a stacked branch is activating its fallback "
1854
"locations. transform_fallback_location is called with (branch, "
1855
"url), and should return a new url. Returning the same url "
1856
"allows it to be used as-is, returning a different one can be "
1857
"used to cause the branch to stack on a closer copy of that "
1858
"fallback_location. Note that the branch cannot have history "
1859
"accessing methods called on it during this hook because the "
1860
"fallback locations have not been activated. When there are "
1861
"multiple hooks installed for transform_fallback_location, "
1862
"all are called with the url returned from the previous hook."
1863
"The order is however undefined.", (1, 9))
1864
self.add_hook('automatic_tag_name',
1865
"Called to determine an automatic tag name for a revision. "
1866
"automatic_tag_name is called with (branch, revision_id) and "
1867
"should return a tag name or None if no tag name could be "
1868
"determined. The first non-None tag name returned will be used.",
1870
self.add_hook('post_branch_init',
1871
"Called after new branch initialization completes. "
1872
"post_branch_init is called with a "
1873
"bzrlib.branch.BranchInitHookParams. "
1874
"Note that init, branch and checkout (both heavyweight and "
1875
"lightweight) will all trigger this hook.", (2, 2))
1876
self.add_hook('post_switch',
1877
"Called after a checkout switches branch. "
1878
"post_switch is called with a "
1879
"bzrlib.branch.SwitchHookParams.", (2, 2))
1883
# install the default hooks into the Branch class.
1884
Branch.hooks = BranchHooks()
1887
class ChangeBranchTipParams(object):
1888
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1890
There are 5 fields that hooks may wish to access:
1892
:ivar branch: the branch being changed
1893
:ivar old_revno: revision number before the change
1894
:ivar new_revno: revision number after the change
1895
:ivar old_revid: revision id before the change
1896
:ivar new_revid: revision id after the change
1898
The revid fields are strings. The revno fields are integers.
1901
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1902
"""Create a group of ChangeBranchTip parameters.
1904
:param branch: The branch being changed.
1905
:param old_revno: Revision number before the change.
1906
:param new_revno: Revision number after the change.
1907
:param old_revid: Tip revision id before the change.
1908
:param new_revid: Tip revision id after the change.
1910
self.branch = branch
1911
self.old_revno = old_revno
1912
self.new_revno = new_revno
1913
self.old_revid = old_revid
1914
self.new_revid = new_revid
1916
def __eq__(self, other):
1917
return self.__dict__ == other.__dict__
1920
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1921
self.__class__.__name__, self.branch,
1922
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1925
class BranchInitHookParams(object):
1926
"""Object holding parameters passed to `*_branch_init` hooks.
1928
There are 4 fields that hooks may wish to access:
1930
:ivar format: the branch format
1931
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1932
:ivar name: name of colocated branch, if any (or None)
1933
:ivar branch: the branch created
1935
Note that for lightweight checkouts, the bzrdir and format fields refer to
1936
the checkout, hence they are different from the corresponding fields in
1937
branch, which refer to the original branch.
1940
def __init__(self, format, controldir, name, branch):
1941
"""Create a group of BranchInitHook parameters.
1943
:param format: the branch format
1944
:param controldir: the ControlDir where the branch will be/has been
1946
:param name: name of colocated branch, if any (or None)
1947
:param branch: the branch created
1949
Note that for lightweight checkouts, the bzrdir and format fields refer
1950
to the checkout, hence they are different from the corresponding fields
1951
in branch, which refer to the original branch.
1953
self.format = format
1954
self.bzrdir = controldir
1956
self.branch = branch
1958
def __eq__(self, other):
1959
return self.__dict__ == other.__dict__
1962
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1965
class SwitchHookParams(object):
1966
"""Object holding parameters passed to `*_switch` hooks.
1968
There are 4 fields that hooks may wish to access:
1970
:ivar control_dir: ControlDir of the checkout to change
1971
:ivar to_branch: branch that the checkout is to reference
1972
:ivar force: skip the check for local commits in a heavy checkout
1973
:ivar revision_id: revision ID to switch to (or None)
1976
def __init__(self, control_dir, to_branch, force, revision_id):
1977
"""Create a group of SwitchHook parameters.
1979
:param control_dir: ControlDir of the checkout to change
1980
:param to_branch: branch that the checkout is to reference
1981
:param force: skip the check for local commits in a heavy checkout
1982
:param revision_id: revision ID to switch to (or None)
1984
self.control_dir = control_dir
1985
self.to_branch = to_branch
1987
self.revision_id = revision_id
1989
def __eq__(self, other):
1990
return self.__dict__ == other.__dict__
1993
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1994
self.control_dir, self.to_branch,
1998
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1999
"""Base class for branch formats that live in meta directories.
2003
BranchFormat.__init__(self)
2004
bzrdir.BzrFormat.__init__(self)
2007
def find_format(klass, controldir, name=None):
2008
"""Return the format for the branch object in controldir."""
2010
transport = controldir.get_branch_transport(None, name=name)
2011
except errors.NoSuchFile:
2012
raise errors.NotBranchError(path=name, bzrdir=controldir)
2014
format_string = transport.get_bytes("format")
2015
except errors.NoSuchFile:
2016
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2017
return klass._find_format(format_registry, 'branch', format_string)
2019
def _branch_class(self):
2020
"""What class to instantiate on open calls."""
2021
raise NotImplementedError(self._branch_class)
2023
def _get_initial_config(self, append_revisions_only=None):
2024
if append_revisions_only:
2025
return "append_revisions_only = True\n"
2027
# Avoid writing anything if append_revisions_only is disabled,
2028
# as that is the default.
2031
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2033
"""Initialize a branch in a bzrdir, with specified files
2035
:param a_bzrdir: The bzrdir to initialize the branch in
2036
:param utf8_files: The files to create as a list of
2037
(filename, content) tuples
2038
:param name: Name of colocated branch to create, if any
2039
:return: a branch in this format
2041
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2042
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2043
control_files = lockable_files.LockableFiles(branch_transport,
2044
'lock', lockdir.LockDir)
2045
control_files.create_lock()
2046
control_files.lock_write()
2048
utf8_files += [('format', self.as_string())]
2049
for (filename, content) in utf8_files:
2050
branch_transport.put_bytes(
2052
mode=a_bzrdir._get_file_mode())
2054
control_files.unlock()
2055
branch = self.open(a_bzrdir, name, _found=True,
2056
found_repository=repository)
2057
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2060
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2061
found_repository=None, possible_transports=None):
2062
"""See BranchFormat.open()."""
2064
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2065
if format.__class__ != self.__class__:
2066
raise AssertionError("wrong format %r found for %r" %
2068
transport = a_bzrdir.get_branch_transport(None, name=name)
2070
control_files = lockable_files.LockableFiles(transport, 'lock',
2072
if found_repository is None:
2073
found_repository = a_bzrdir.find_repository()
2074
return self._branch_class()(_format=self,
2075
_control_files=control_files,
2078
_repository=found_repository,
2079
ignore_fallbacks=ignore_fallbacks,
2080
possible_transports=possible_transports)
2081
except errors.NoSuchFile:
2082
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2085
def _matchingbzrdir(self):
2086
ret = bzrdir.BzrDirMetaFormat1()
2087
ret.set_branch_format(self)
2090
def supports_tags(self):
2093
def supports_leaving_lock(self):
2096
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2098
BranchFormat.check_support_status(self,
2099
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2101
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2102
recommend_upgrade=recommend_upgrade, basedir=basedir)
2105
class BzrBranchFormat5(BranchFormatMetadir):
2106
"""Bzr branch format 5.
2109
- a revision-history file.
2111
- a lock dir guarding the branch itself
2112
- all of this stored in a branch/ subdirectory
2113
- works with shared repositories.
2115
This format is new in bzr 0.8.
2118
def _branch_class(self):
2122
def get_format_string(cls):
2123
"""See BranchFormat.get_format_string()."""
2124
return "Bazaar-NG branch format 5\n"
2126
def get_format_description(self):
2127
"""See BranchFormat.get_format_description()."""
2128
return "Branch format 5"
2130
def initialize(self, a_bzrdir, name=None, repository=None,
2131
append_revisions_only=None):
2132
"""Create a branch of this format in a_bzrdir."""
2133
if append_revisions_only:
2134
raise errors.UpgradeRequired(a_bzrdir.user_url)
2135
utf8_files = [('revision-history', ''),
2136
('branch-name', ''),
2138
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2140
def supports_tags(self):
2144
class BzrBranchFormat6(BranchFormatMetadir):
2145
"""Branch format with last-revision and tags.
2147
Unlike previous formats, this has no explicit revision history. Instead,
2148
this just stores the last-revision, and the left-hand history leading
2149
up to there is the history.
2151
This format was introduced in bzr 0.15
2152
and became the default in 0.91.
2155
def _branch_class(self):
2159
def get_format_string(cls):
2160
"""See BranchFormat.get_format_string()."""
2161
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2163
def get_format_description(self):
2164
"""See BranchFormat.get_format_description()."""
2165
return "Branch format 6"
2167
def initialize(self, a_bzrdir, name=None, repository=None,
2168
append_revisions_only=None):
2169
"""Create a branch of this format in a_bzrdir."""
2170
utf8_files = [('last-revision', '0 null:\n'),
2172
self._get_initial_config(append_revisions_only)),
2175
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2177
def make_tags(self, branch):
2178
"""See bzrlib.branch.BranchFormat.make_tags()."""
2179
return _mod_tag.BasicTags(branch)
2181
def supports_set_append_revisions_only(self):
2185
class BzrBranchFormat8(BranchFormatMetadir):
2186
"""Metadir format supporting storing locations of subtree branches."""
2188
def _branch_class(self):
2192
def get_format_string(cls):
2193
"""See BranchFormat.get_format_string()."""
2194
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2196
def get_format_description(self):
2197
"""See BranchFormat.get_format_description()."""
2198
return "Branch format 8"
2200
def initialize(self, a_bzrdir, name=None, repository=None,
2201
append_revisions_only=None):
2202
"""Create a branch of this format in a_bzrdir."""
2203
utf8_files = [('last-revision', '0 null:\n'),
2205
self._get_initial_config(append_revisions_only)),
2209
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2211
def make_tags(self, branch):
2212
"""See bzrlib.branch.BranchFormat.make_tags()."""
2213
return _mod_tag.BasicTags(branch)
2215
def supports_set_append_revisions_only(self):
2218
def supports_stacking(self):
2221
supports_reference_locations = True
2224
class BzrBranchFormat7(BranchFormatMetadir):
2225
"""Branch format with last-revision, tags, and a stacked location pointer.
2227
The stacked location pointer is passed down to the repository and requires
2228
a repository format with supports_external_lookups = True.
2230
This format was introduced in bzr 1.6.
2233
def initialize(self, a_bzrdir, name=None, repository=None,
2234
append_revisions_only=None):
2235
"""Create a branch of this format in a_bzrdir."""
2236
utf8_files = [('last-revision', '0 null:\n'),
2238
self._get_initial_config(append_revisions_only)),
2241
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2243
def _branch_class(self):
2247
def get_format_string(cls):
2248
"""See BranchFormat.get_format_string()."""
2249
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2251
def get_format_description(self):
2252
"""See BranchFormat.get_format_description()."""
2253
return "Branch format 7"
2255
def supports_set_append_revisions_only(self):
2258
def supports_stacking(self):
2261
def make_tags(self, branch):
2262
"""See bzrlib.branch.BranchFormat.make_tags()."""
2263
return _mod_tag.BasicTags(branch)
2265
supports_reference_locations = False
2268
class BranchReferenceFormat(BranchFormatMetadir):
2269
"""Bzr branch reference format.
2271
Branch references are used in implementing checkouts, they
2272
act as an alias to the real branch which is at some other url.
2280
def get_format_string(cls):
2281
"""See BranchFormat.get_format_string()."""
2282
return "Bazaar-NG Branch Reference Format 1\n"
2284
def get_format_description(self):
2285
"""See BranchFormat.get_format_description()."""
2286
return "Checkout reference format 1"
2288
def get_reference(self, a_bzrdir, name=None):
2289
"""See BranchFormat.get_reference()."""
2290
transport = a_bzrdir.get_branch_transport(None, name=name)
2291
return transport.get_bytes('location')
2293
def set_reference(self, a_bzrdir, name, to_branch):
2294
"""See BranchFormat.set_reference()."""
2295
transport = a_bzrdir.get_branch_transport(None, name=name)
2296
location = transport.put_bytes('location', to_branch.base)
2298
def initialize(self, a_bzrdir, name=None, target_branch=None,
2299
repository=None, append_revisions_only=None):
2300
"""Create a branch of this format in a_bzrdir."""
2301
if target_branch is None:
2302
# this format does not implement branch itself, thus the implicit
2303
# creation contract must see it as uninitializable
2304
raise errors.UninitializableFormat(self)
2305
mutter('creating branch reference in %s', a_bzrdir.user_url)
2306
if a_bzrdir._format.fixed_components:
2307
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2308
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2309
branch_transport.put_bytes('location',
2310
target_branch.user_url)
2311
branch_transport.put_bytes('format', self.as_string())
2313
a_bzrdir, name, _found=True,
2314
possible_transports=[target_branch.bzrdir.root_transport])
2315
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2318
def _make_reference_clone_function(format, a_branch):
2319
"""Create a clone() routine for a branch dynamically."""
2320
def clone(to_bzrdir, revision_id=None,
2321
repository_policy=None):
2322
"""See Branch.clone()."""
2323
return format.initialize(to_bzrdir, target_branch=a_branch)
2324
# cannot obey revision_id limits when cloning a reference ...
2325
# FIXME RBC 20060210 either nuke revision_id for clone, or
2326
# emit some sort of warning/error to the caller ?!
2329
def open(self, a_bzrdir, name=None, _found=False, location=None,
2330
possible_transports=None, ignore_fallbacks=False,
2331
found_repository=None):
2332
"""Return the branch that the branch reference in a_bzrdir points at.
2334
:param a_bzrdir: A BzrDir that contains a branch.
2335
:param name: Name of colocated branch to open, if any
2336
:param _found: a private parameter, do not use it. It is used to
2337
indicate if format probing has already be done.
2338
:param ignore_fallbacks: when set, no fallback branches will be opened
2339
(if there are any). Default is to open fallbacks.
2340
:param location: The location of the referenced branch. If
2341
unspecified, this will be determined from the branch reference in
2343
:param possible_transports: An optional reusable transports list.
2346
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2347
if format.__class__ != self.__class__:
2348
raise AssertionError("wrong format %r found for %r" %
2350
if location is None:
2351
location = self.get_reference(a_bzrdir, name)
2352
real_bzrdir = controldir.ControlDir.open(
2353
location, possible_transports=possible_transports)
2354
result = real_bzrdir.open_branch(name=name,
2355
ignore_fallbacks=ignore_fallbacks,
2356
possible_transports=possible_transports)
2357
# this changes the behaviour of result.clone to create a new reference
2358
# rather than a copy of the content of the branch.
2359
# I did not use a proxy object because that needs much more extensive
2360
# testing, and we are only changing one behaviour at the moment.
2361
# If we decide to alter more behaviours - i.e. the implicit nickname
2362
# then this should be refactored to introduce a tested proxy branch
2363
# and a subclass of that for use in overriding clone() and ....
2365
result.clone = self._make_reference_clone_function(result)
2369
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2370
"""Branch format registry."""
2372
def __init__(self, other_registry=None):
2373
super(BranchFormatRegistry, self).__init__(other_registry)
2374
self._default_format = None
2376
def set_default(self, format):
2377
self._default_format = format
2379
def get_default(self):
2380
return self._default_format
2383
network_format_registry = registry.FormatRegistry()
2384
"""Registry of formats indexed by their network name.
2386
The network name for a branch format is an identifier that can be used when
2387
referring to formats with smart server operations. See
2388
BranchFormat.network_name() for more detail.
2391
format_registry = BranchFormatRegistry(network_format_registry)
2394
# formats which have no format string are not discoverable
2395
# and not independently creatable, so are not registered.
2396
__format5 = BzrBranchFormat5()
2397
__format6 = BzrBranchFormat6()
2398
__format7 = BzrBranchFormat7()
2399
__format8 = BzrBranchFormat8()
2400
format_registry.register(__format5)
2401
format_registry.register(BranchReferenceFormat())
2402
format_registry.register(__format6)
2403
format_registry.register(__format7)
2404
format_registry.register(__format8)
2405
format_registry.set_default(__format7)
2408
class BranchWriteLockResult(LogicalLockResult):
2409
"""The result of write locking a branch.
2411
:ivar branch_token: The token obtained from the underlying branch lock, or
2413
:ivar unlock: A callable which will unlock the lock.
2416
def __init__(self, unlock, branch_token):
2417
LogicalLockResult.__init__(self, unlock)
2418
self.branch_token = branch_token
2421
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2425
class BzrBranch(Branch, _RelockDebugMixin):
2426
"""A branch stored in the actual filesystem.
2428
Note that it's "local" in the context of the filesystem; it doesn't
2429
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2430
it's writable, and can be accessed via the normal filesystem API.
2432
:ivar _transport: Transport for file operations on this branch's
2433
control files, typically pointing to the .bzr/branch directory.
2434
:ivar repository: Repository for this branch.
2435
:ivar base: The url of the base directory for this branch; the one
2436
containing the .bzr directory.
2437
:ivar name: Optional colocated branch name as it exists in the control
2441
def __init__(self, _format=None,
2442
_control_files=None, a_bzrdir=None, name=None,
2443
_repository=None, ignore_fallbacks=False,
2444
possible_transports=None):
2445
"""Create new branch object at a particular location."""
2446
if a_bzrdir is None:
2447
raise ValueError('a_bzrdir must be supplied')
2449
self.bzrdir = a_bzrdir
2450
self._user_transport = self.bzrdir.transport.clone('..')
2451
if name is not None:
2452
self._user_transport.set_segment_parameter(
2453
"branch", urlutils.escape(name))
2454
self._base = self._user_transport.base
2456
self._format = _format
2457
if _control_files is None:
2458
raise ValueError('BzrBranch _control_files is None')
2459
self.control_files = _control_files
2460
self._transport = _control_files._transport
2461
self.repository = _repository
2462
self.conf_store = None
2463
Branch.__init__(self, possible_transports)
2466
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2470
def _get_base(self):
2471
"""Returns the directory containing the control directory."""
2474
base = property(_get_base, doc="The URL for the root of this branch.")
2477
def user_transport(self):
2478
return self._user_transport
2480
def _get_config(self):
2481
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2483
def _get_config_store(self):
2484
if self.conf_store is None:
2485
self.conf_store = _mod_config.BranchStore(self)
2486
return self.conf_store
2488
def is_locked(self):
2489
return self.control_files.is_locked()
2491
def lock_write(self, token=None):
2492
"""Lock the branch for write operations.
2494
:param token: A token to permit reacquiring a previously held and
2496
:return: A BranchWriteLockResult.
2498
if not self.is_locked():
2499
self._note_lock('w')
2500
# All-in-one needs to always unlock/lock.
2501
repo_control = getattr(self.repository, 'control_files', None)
2502
if self.control_files == repo_control or not self.is_locked():
2503
self.repository._warn_if_deprecated(self)
2504
self.repository.lock_write()
2509
return BranchWriteLockResult(self.unlock,
2510
self.control_files.lock_write(token=token))
2513
self.repository.unlock()
2516
def lock_read(self):
2517
"""Lock the branch for read operations.
2519
:return: A bzrlib.lock.LogicalLockResult.
2521
if not self.is_locked():
2522
self._note_lock('r')
2523
# All-in-one needs to always unlock/lock.
2524
repo_control = getattr(self.repository, 'control_files', None)
2525
if self.control_files == repo_control or not self.is_locked():
2526
self.repository._warn_if_deprecated(self)
2527
self.repository.lock_read()
2532
self.control_files.lock_read()
2533
return LogicalLockResult(self.unlock)
2536
self.repository.unlock()
2539
@only_raises(errors.LockNotHeld, errors.LockBroken)
2541
if self.conf_store is not None:
2542
self.conf_store.save_changes()
2544
self.control_files.unlock()
2546
# All-in-one needs to always unlock/lock.
2547
repo_control = getattr(self.repository, 'control_files', None)
2548
if (self.control_files == repo_control or
2549
not self.control_files.is_locked()):
2550
self.repository.unlock()
2551
if not self.control_files.is_locked():
2552
# we just released the lock
2553
self._clear_cached_state()
2555
def peek_lock_mode(self):
2556
if self.control_files._lock_count == 0:
2559
return self.control_files._lock_mode
2561
def get_physical_lock_status(self):
2562
return self.control_files.get_physical_lock_status()
2565
def print_file(self, file, revision_id):
2566
"""See Branch.print_file."""
2567
return self.repository.print_file(file, revision_id)
2570
def set_last_revision_info(self, revno, revision_id):
2571
if not revision_id or not isinstance(revision_id, basestring):
2572
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2573
revision_id = _mod_revision.ensure_null(revision_id)
2574
old_revno, old_revid = self.last_revision_info()
2575
if self.get_append_revisions_only():
2576
self._check_history_violation(revision_id)
2577
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2578
self._write_last_revision_info(revno, revision_id)
2579
self._clear_cached_state()
2580
self._last_revision_info_cache = revno, revision_id
2581
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2583
def basis_tree(self):
2584
"""See Branch.basis_tree."""
2585
return self.repository.revision_tree(self.last_revision())
2587
def _get_parent_location(self):
2588
_locs = ['parent', 'pull', 'x-pull']
2591
return self._transport.get_bytes(l).strip('\n')
2592
except errors.NoSuchFile:
2596
def get_stacked_on_url(self):
2597
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2599
def set_push_location(self, location):
2600
"""See Branch.set_push_location."""
2601
self.get_config().set_user_option(
2602
'push_location', location,
2603
store=_mod_config.STORE_LOCATION_NORECURSE)
2605
def _set_parent_location(self, url):
2607
self._transport.delete('parent')
2609
self._transport.put_bytes('parent', url + '\n',
2610
mode=self.bzrdir._get_file_mode())
2614
"""If bound, unbind"""
2615
return self.set_bound_location(None)
2618
def bind(self, other):
2619
"""Bind this branch to the branch other.
2621
This does not push or pull data between the branches, though it does
2622
check for divergence to raise an error when the branches are not
2623
either the same, or one a prefix of the other. That behaviour may not
2624
be useful, so that check may be removed in future.
2626
:param other: The branch to bind to
2629
# TODO: jam 20051230 Consider checking if the target is bound
2630
# It is debatable whether you should be able to bind to
2631
# a branch which is itself bound.
2632
# Committing is obviously forbidden,
2633
# but binding itself may not be.
2634
# Since we *have* to check at commit time, we don't
2635
# *need* to check here
2637
# we want to raise diverged if:
2638
# last_rev is not in the other_last_rev history, AND
2639
# other_last_rev is not in our history, and do it without pulling
2641
self.set_bound_location(other.base)
2643
def get_bound_location(self):
2645
return self._transport.get_bytes('bound')[:-1]
2646
except errors.NoSuchFile:
2650
def get_master_branch(self, possible_transports=None):
2651
"""Return the branch we are bound to.
2653
:return: Either a Branch, or None
2655
if self._master_branch_cache is None:
2656
self._master_branch_cache = self._get_master_branch(
2657
possible_transports)
2658
return self._master_branch_cache
2660
def _get_master_branch(self, possible_transports):
2661
bound_loc = self.get_bound_location()
2665
return Branch.open(bound_loc,
2666
possible_transports=possible_transports)
2667
except (errors.NotBranchError, errors.ConnectionError), e:
2668
raise errors.BoundBranchConnectionFailure(
2672
def set_bound_location(self, location):
2673
"""Set the target where this branch is bound to.
2675
:param location: URL to the target branch
2677
self._master_branch_cache = None
2679
self._transport.put_bytes('bound', location+'\n',
2680
mode=self.bzrdir._get_file_mode())
2683
self._transport.delete('bound')
2684
except errors.NoSuchFile:
2689
def update(self, possible_transports=None):
2690
"""Synchronise this branch with the master branch if any.
2692
:return: None or the last_revision that was pivoted out during the
2695
master = self.get_master_branch(possible_transports)
2696
if master is not None:
2697
old_tip = _mod_revision.ensure_null(self.last_revision())
2698
self.pull(master, overwrite=True)
2699
if self.repository.get_graph().is_ancestor(old_tip,
2700
_mod_revision.ensure_null(self.last_revision())):
2705
def _read_last_revision_info(self):
2706
revision_string = self._transport.get_bytes('last-revision')
2707
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2708
revision_id = cache_utf8.get_cached_utf8(revision_id)
2710
return revno, revision_id
2712
def _write_last_revision_info(self, revno, revision_id):
2713
"""Simply write out the revision id, with no checks.
2715
Use set_last_revision_info to perform this safely.
2717
Does not update the revision_history cache.
2719
revision_id = _mod_revision.ensure_null(revision_id)
2720
out_string = '%d %s\n' % (revno, revision_id)
2721
self._transport.put_bytes('last-revision', out_string,
2722
mode=self.bzrdir._get_file_mode())
2725
def update_feature_flags(self, updated_flags):
2726
"""Update the feature flags for this branch.
2728
:param updated_flags: Dictionary mapping feature names to necessities
2729
A necessity can be None to indicate the feature should be removed
2731
self._format._update_feature_flags(updated_flags)
2732
self.control_transport.put_bytes('format', self._format.as_string())
2735
class FullHistoryBzrBranch(BzrBranch):
2736
"""Bzr branch which contains the full revision history."""
2739
def set_last_revision_info(self, revno, revision_id):
2740
if not revision_id or not isinstance(revision_id, basestring):
2741
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2742
revision_id = _mod_revision.ensure_null(revision_id)
2743
# this old format stores the full history, but this api doesn't
2744
# provide it, so we must generate, and might as well check it's
2746
history = self._lefthand_history(revision_id)
2747
if len(history) != revno:
2748
raise AssertionError('%d != %d' % (len(history), revno))
2749
self._set_revision_history(history)
2751
def _read_last_revision_info(self):
2752
rh = self._revision_history()
2755
return (revno, rh[-1])
2757
return (0, _mod_revision.NULL_REVISION)
2759
@deprecated_method(deprecated_in((2, 4, 0)))
2761
def set_revision_history(self, rev_history):
2762
"""See Branch.set_revision_history."""
2763
self._set_revision_history(rev_history)
2765
def _set_revision_history(self, rev_history):
2766
if 'evil' in debug.debug_flags:
2767
mutter_callsite(3, "set_revision_history scales with history.")
2768
check_not_reserved_id = _mod_revision.check_not_reserved_id
2769
for rev_id in rev_history:
2770
check_not_reserved_id(rev_id)
2771
if Branch.hooks['post_change_branch_tip']:
2772
# Don't calculate the last_revision_info() if there are no hooks
2774
old_revno, old_revid = self.last_revision_info()
2775
if len(rev_history) == 0:
2776
revid = _mod_revision.NULL_REVISION
2778
revid = rev_history[-1]
2779
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2780
self._write_revision_history(rev_history)
2781
self._clear_cached_state()
2782
self._cache_revision_history(rev_history)
2783
for hook in Branch.hooks['set_rh']:
2784
hook(self, rev_history)
2785
if Branch.hooks['post_change_branch_tip']:
2786
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2788
def _write_revision_history(self, history):
2789
"""Factored out of set_revision_history.
2791
This performs the actual writing to disk.
2792
It is intended to be called by set_revision_history."""
2793
self._transport.put_bytes(
2794
'revision-history', '\n'.join(history),
2795
mode=self.bzrdir._get_file_mode())
2797
def _gen_revision_history(self):
2798
history = self._transport.get_bytes('revision-history').split('\n')
2799
if history[-1:] == ['']:
2800
# There shouldn't be a trailing newline, but just in case.
2804
def _synchronize_history(self, destination, revision_id):
2805
if not isinstance(destination, FullHistoryBzrBranch):
2806
super(BzrBranch, self)._synchronize_history(
2807
destination, revision_id)
2809
if revision_id == _mod_revision.NULL_REVISION:
2812
new_history = self._revision_history()
2813
if revision_id is not None and new_history != []:
2815
new_history = new_history[:new_history.index(revision_id) + 1]
2817
rev = self.repository.get_revision(revision_id)
2818
new_history = rev.get_history(self.repository)[1:]
2819
destination._set_revision_history(new_history)
2822
def generate_revision_history(self, revision_id, last_rev=None,
2824
"""Create a new revision history that will finish with revision_id.
2826
:param revision_id: the new tip to use.
2827
:param last_rev: The previous last_revision. If not None, then this
2828
must be a ancestory of revision_id, or DivergedBranches is raised.
2829
:param other_branch: The other branch that DivergedBranches should
2830
raise with respect to.
2832
self._set_revision_history(self._lefthand_history(revision_id,
2833
last_rev, other_branch))
2836
class BzrBranch5(FullHistoryBzrBranch):
2837
"""A format 5 branch. This supports new features over plain branches.
2839
It has support for a master_branch which is the data for bound branches.
2843
class BzrBranch8(BzrBranch):
2844
"""A branch that stores tree-reference locations."""
2846
def _open_hook(self, possible_transports=None):
2847
if self._ignore_fallbacks:
2849
if possible_transports is None:
2850
possible_transports = [self.bzrdir.root_transport]
2852
url = self.get_stacked_on_url()
2853
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2854
errors.UnstackableBranchFormat):
2857
for hook in Branch.hooks['transform_fallback_location']:
2858
url = hook(self, url)
2860
hook_name = Branch.hooks.get_hook_name(hook)
2861
raise AssertionError(
2862
"'transform_fallback_location' hook %s returned "
2863
"None, not a URL." % hook_name)
2864
self._activate_fallback_location(url,
2865
possible_transports=possible_transports)
2867
def __init__(self, *args, **kwargs):
2868
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2869
super(BzrBranch8, self).__init__(*args, **kwargs)
2870
self._last_revision_info_cache = None
2871
self._reference_info = None
2873
def _clear_cached_state(self):
2874
super(BzrBranch8, self)._clear_cached_state()
2875
self._last_revision_info_cache = None
2876
self._reference_info = None
2878
def _check_history_violation(self, revision_id):
2879
current_revid = self.last_revision()
2880
last_revision = _mod_revision.ensure_null(current_revid)
2881
if _mod_revision.is_null(last_revision):
2883
graph = self.repository.get_graph()
2884
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2885
if lh_ancestor == current_revid:
2887
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2889
def _gen_revision_history(self):
2890
"""Generate the revision history from last revision
2892
last_revno, last_revision = self.last_revision_info()
2893
self._extend_partial_history(stop_index=last_revno-1)
2894
return list(reversed(self._partial_revision_history_cache))
2897
def _set_parent_location(self, url):
2898
"""Set the parent branch"""
2899
self._set_config_location('parent_location', url, make_relative=True)
2902
def _get_parent_location(self):
2903
"""Set the parent branch"""
2904
return self._get_config_location('parent_location')
2907
def _set_all_reference_info(self, info_dict):
2908
"""Replace all reference info stored in a branch.
2910
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2913
writer = rio.RioWriter(s)
2914
for key, (tree_path, branch_location) in info_dict.iteritems():
2915
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2916
branch_location=branch_location)
2917
writer.write_stanza(stanza)
2918
self._transport.put_bytes('references', s.getvalue())
2919
self._reference_info = info_dict
2922
def _get_all_reference_info(self):
2923
"""Return all the reference info stored in a branch.
2925
:return: A dict of {file_id: (tree_path, branch_location)}
2927
if self._reference_info is not None:
2928
return self._reference_info
2929
rio_file = self._transport.get('references')
2931
stanzas = rio.read_stanzas(rio_file)
2932
info_dict = dict((s['file_id'], (s['tree_path'],
2933
s['branch_location'])) for s in stanzas)
2936
self._reference_info = info_dict
2939
def set_reference_info(self, file_id, tree_path, branch_location):
2940
"""Set the branch location to use for a tree reference.
2942
:param file_id: The file-id of the tree reference.
2943
:param tree_path: The path of the tree reference in the tree.
2944
:param branch_location: The location of the branch to retrieve tree
2947
info_dict = self._get_all_reference_info()
2948
info_dict[file_id] = (tree_path, branch_location)
2949
if None in (tree_path, branch_location):
2950
if tree_path is not None:
2951
raise ValueError('tree_path must be None when branch_location'
2953
if branch_location is not None:
2954
raise ValueError('branch_location must be None when tree_path'
2956
del info_dict[file_id]
2957
self._set_all_reference_info(info_dict)
2959
def get_reference_info(self, file_id):
2960
"""Get the tree_path and branch_location for a tree reference.
2962
:return: a tuple of (tree_path, branch_location)
2964
return self._get_all_reference_info().get(file_id, (None, None))
2966
def reference_parent(self, file_id, path, possible_transports=None):
2967
"""Return the parent branch for a tree-reference file_id.
2969
:param file_id: The file_id of the tree reference
2970
:param path: The path of the file_id in the tree
2971
:return: A branch associated with the file_id
2973
branch_location = self.get_reference_info(file_id)[1]
2974
if branch_location is None:
2975
return Branch.reference_parent(self, file_id, path,
2976
possible_transports)
2977
branch_location = urlutils.join(self.user_url, branch_location)
2978
return Branch.open(branch_location,
2979
possible_transports=possible_transports)
2981
def set_push_location(self, location):
2982
"""See Branch.set_push_location."""
2983
self._set_config_location('push_location', location)
2985
def set_bound_location(self, location):
2986
"""See Branch.set_push_location."""
2987
self._master_branch_cache = None
2989
conf = self.get_config_stack()
2990
if location is None:
2991
if not conf.get('bound'):
2994
conf.set('bound', 'False')
2997
self._set_config_location('bound_location', location,
2999
conf.set('bound', 'True')
3002
def _get_bound_location(self, bound):
3003
"""Return the bound location in the config file.
3005
Return None if the bound parameter does not match"""
3006
conf = self.get_config_stack()
3007
if conf.get('bound') != bound:
3009
return self._get_config_location('bound_location', config=conf)
3011
def get_bound_location(self):
3012
"""See Branch.get_bound_location."""
3013
return self._get_bound_location(True)
3015
def get_old_bound_location(self):
3016
"""See Branch.get_old_bound_location"""
3017
return self._get_bound_location(False)
3019
def get_stacked_on_url(self):
3020
# you can always ask for the URL; but you might not be able to use it
3021
# if the repo can't support stacking.
3022
## self._check_stackable_repo()
3023
# stacked_on_location is only ever defined in branch.conf, so don't
3024
# waste effort reading the whole stack of config files.
3025
conf = _mod_config.BranchOnlyStack(self)
3026
stacked_url = self._get_config_location('stacked_on_location',
3028
if stacked_url is None:
3029
raise errors.NotStacked(self)
3030
return stacked_url.encode('utf-8')
3033
def get_rev_id(self, revno, history=None):
3034
"""Find the revision id of the specified revno."""
3036
return _mod_revision.NULL_REVISION
3038
last_revno, last_revision_id = self.last_revision_info()
3039
if revno <= 0 or revno > last_revno:
3040
raise errors.NoSuchRevision(self, revno)
3042
if history is not None:
3043
return history[revno - 1]
3045
index = last_revno - revno
3046
if len(self._partial_revision_history_cache) <= index:
3047
self._extend_partial_history(stop_index=index)
3048
if len(self._partial_revision_history_cache) > index:
3049
return self._partial_revision_history_cache[index]
3051
raise errors.NoSuchRevision(self, revno)
3054
def revision_id_to_revno(self, revision_id):
3055
"""Given a revision id, return its revno"""
3056
if _mod_revision.is_null(revision_id):
3059
index = self._partial_revision_history_cache.index(revision_id)
3062
self._extend_partial_history(stop_revision=revision_id)
3063
except errors.RevisionNotPresent, e:
3064
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3065
index = len(self._partial_revision_history_cache) - 1
3067
raise errors.NoSuchRevision(self, revision_id)
3068
if self._partial_revision_history_cache[index] != revision_id:
3069
raise errors.NoSuchRevision(self, revision_id)
3070
return self.revno() - index
3073
class BzrBranch7(BzrBranch8):
3074
"""A branch with support for a fallback repository."""
3076
def set_reference_info(self, file_id, tree_path, branch_location):
3077
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3079
def get_reference_info(self, file_id):
3080
Branch.get_reference_info(self, file_id)
3082
def reference_parent(self, file_id, path, possible_transports=None):
3083
return Branch.reference_parent(self, file_id, path,
3084
possible_transports)
3087
class BzrBranch6(BzrBranch7):
3088
"""See BzrBranchFormat6 for the capabilities of this branch.
3090
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3094
def get_stacked_on_url(self):
3095
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3098
######################################################################
3099
# results of operations
3102
class _Result(object):
3104
def _show_tag_conficts(self, to_file):
3105
if not getattr(self, 'tag_conflicts', None):
3107
to_file.write('Conflicting tags:\n')
3108
for name, value1, value2 in self.tag_conflicts:
3109
to_file.write(' %s\n' % (name, ))
3112
class PullResult(_Result):
3113
"""Result of a Branch.pull operation.
3115
:ivar old_revno: Revision number before pull.
3116
:ivar new_revno: Revision number after pull.
3117
:ivar old_revid: Tip revision id before pull.
3118
:ivar new_revid: Tip revision id after pull.
3119
:ivar source_branch: Source (local) branch object. (read locked)
3120
:ivar master_branch: Master branch of the target, or the target if no
3122
:ivar local_branch: target branch if there is a Master, else None
3123
:ivar target_branch: Target/destination branch object. (write locked)
3124
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3125
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3128
@deprecated_method(deprecated_in((2, 3, 0)))
3130
"""Return the relative change in revno.
3132
:deprecated: Use `new_revno` and `old_revno` instead.
3134
return self.new_revno - self.old_revno
3136
def report(self, to_file):
3137
tag_conflicts = getattr(self, "tag_conflicts", None)
3138
tag_updates = getattr(self, "tag_updates", None)
3140
if self.old_revid != self.new_revid:
3141
to_file.write('Now on revision %d.\n' % self.new_revno)
3143
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3144
if self.old_revid == self.new_revid and not tag_updates:
3145
if not tag_conflicts:
3146
to_file.write('No revisions or tags to pull.\n')
3148
to_file.write('No revisions to pull.\n')
3149
self._show_tag_conficts(to_file)
3152
class BranchPushResult(_Result):
3153
"""Result of a Branch.push operation.
3155
:ivar old_revno: Revision number (eg 10) of the target before push.
3156
:ivar new_revno: Revision number (eg 12) of the target after push.
3157
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3159
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3161
:ivar source_branch: Source branch object that the push was from. This is
3162
read locked, and generally is a local (and thus low latency) branch.
3163
:ivar master_branch: If target is a bound branch, the master branch of
3164
target, or target itself. Always write locked.
3165
:ivar target_branch: The direct Branch where data is being sent (write
3167
:ivar local_branch: If the target is a bound branch this will be the
3168
target, otherwise it will be None.
3171
@deprecated_method(deprecated_in((2, 3, 0)))
3173
"""Return the relative change in revno.
3175
:deprecated: Use `new_revno` and `old_revno` instead.
3177
return self.new_revno - self.old_revno
3179
def report(self, to_file):
3180
# TODO: This function gets passed a to_file, but then
3181
# ignores it and calls note() instead. This is also
3182
# inconsistent with PullResult(), which writes to stdout.
3183
# -- JRV20110901, bug #838853
3184
tag_conflicts = getattr(self, "tag_conflicts", None)
3185
tag_updates = getattr(self, "tag_updates", None)
3187
if self.old_revid != self.new_revid:
3188
note(gettext('Pushed up to revision %d.') % self.new_revno)
3190
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3191
if self.old_revid == self.new_revid and not tag_updates:
3192
if not tag_conflicts:
3193
note(gettext('No new revisions or tags to push.'))
3195
note(gettext('No new revisions to push.'))
3196
self._show_tag_conficts(to_file)
3199
class BranchCheckResult(object):
3200
"""Results of checking branch consistency.
3205
def __init__(self, branch):
3206
self.branch = branch
3209
def report_results(self, verbose):
3210
"""Report the check results via trace.note.
3212
:param verbose: Requests more detailed display of what was checked,
3215
note(gettext('checked branch {0} format {1}').format(
3216
self.branch.user_url, self.branch._format))
3217
for error in self.errors:
3218
note(gettext('found error:%s'), error)
3221
class Converter5to6(object):
3222
"""Perform an in-place upgrade of format 5 to format 6"""
3224
def convert(self, branch):
3225
# Data for 5 and 6 can peacefully coexist.
3226
format = BzrBranchFormat6()
3227
new_branch = format.open(branch.bzrdir, _found=True)
3229
# Copy source data into target
3230
new_branch._write_last_revision_info(*branch.last_revision_info())
3231
new_branch.lock_write()
3233
new_branch.set_parent(branch.get_parent())
3234
new_branch.set_bound_location(branch.get_bound_location())
3235
new_branch.set_push_location(branch.get_push_location())
3239
# New branch has no tags by default
3240
new_branch.tags._set_tag_dict({})
3242
# Copying done; now update target format
3243
new_branch._transport.put_bytes('format',
3245
mode=new_branch.bzrdir._get_file_mode())
3247
# Clean up old files
3248
new_branch._transport.delete('revision-history')
3252
branch.set_parent(None)
3253
except errors.NoSuchFile:
3255
branch.set_bound_location(None)
3260
class Converter6to7(object):
3261
"""Perform an in-place upgrade of format 6 to format 7"""
3263
def convert(self, branch):
3264
format = BzrBranchFormat7()
3267
branch._set_config_location('stacked_on_location', '')
3270
# update target format
3271
branch._transport.put_bytes('format', format.as_string())
3274
class Converter7to8(object):
3275
"""Perform an in-place upgrade of format 7 to format 8"""
3277
def convert(self, branch):
3278
format = BzrBranchFormat8()
3279
branch._transport.put_bytes('references', '')
3280
# update target format
3281
branch._transport.put_bytes('format', format.as_string())
3284
class InterBranch(InterObject):
3285
"""This class represents operations taking place between two branches.
3287
Its instances have methods like pull() and push() and contain
3288
references to the source and target repositories these operations
3289
can be carried out on.
3293
"""The available optimised InterBranch types."""
3296
def _get_branch_formats_to_test(klass):
3297
"""Return an iterable of format tuples for testing.
3299
:return: An iterable of (from_format, to_format) to use when testing
3300
this InterBranch class. Each InterBranch class should define this
3303
raise NotImplementedError(klass._get_branch_formats_to_test)
3306
def pull(self, overwrite=False, stop_revision=None,
3307
possible_transports=None, local=False):
3308
"""Mirror source into target branch.
3310
The target branch is considered to be 'local', having low latency.
3312
:returns: PullResult instance
3314
raise NotImplementedError(self.pull)
3317
def push(self, overwrite=False, stop_revision=None, lossy=False,
3318
_override_hook_source_branch=None):
3319
"""Mirror the source branch into the target branch.
3321
The source branch is considered to be 'local', having low latency.
3323
raise NotImplementedError(self.push)
3326
def copy_content_into(self, revision_id=None):
3327
"""Copy the content of source into target
3329
revision_id: if not None, the revision history in the new branch will
3330
be truncated to end with revision_id.
3332
raise NotImplementedError(self.copy_content_into)
3335
def fetch(self, stop_revision=None, limit=None):
3338
:param stop_revision: Last revision to fetch
3339
:param limit: Optional rough limit of revisions to fetch
3341
raise NotImplementedError(self.fetch)
3344
class GenericInterBranch(InterBranch):
3345
"""InterBranch implementation that uses public Branch functions."""
3348
def is_compatible(klass, source, target):
3349
# GenericBranch uses the public API, so always compatible
3353
def _get_branch_formats_to_test(klass):
3354
return [(format_registry.get_default(), format_registry.get_default())]
3357
def unwrap_format(klass, format):
3358
if isinstance(format, remote.RemoteBranchFormat):
3359
format._ensure_real()
3360
return format._custom_format
3364
def copy_content_into(self, revision_id=None):
3365
"""Copy the content of source into target
3367
revision_id: if not None, the revision history in the new branch will
3368
be truncated to end with revision_id.
3370
self.source.update_references(self.target)
3371
self.source._synchronize_history(self.target, revision_id)
3373
parent = self.source.get_parent()
3374
except errors.InaccessibleParent, e:
3375
mutter('parent was not accessible to copy: %s', e)
3378
self.target.set_parent(parent)
3379
if self.source._push_should_merge_tags():
3380
self.source.tags.merge_to(self.target.tags)
3383
def fetch(self, stop_revision=None, limit=None):
3384
if self.target.base == self.source.base:
3386
self.source.lock_read()
3388
fetch_spec_factory = fetch.FetchSpecFactory()
3389
fetch_spec_factory.source_branch = self.source
3390
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3391
fetch_spec_factory.source_repo = self.source.repository
3392
fetch_spec_factory.target_repo = self.target.repository
3393
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3394
fetch_spec_factory.limit = limit
3395
fetch_spec = fetch_spec_factory.make_fetch_spec()
3396
return self.target.repository.fetch(self.source.repository,
3397
fetch_spec=fetch_spec)
3399
self.source.unlock()
3402
def _update_revisions(self, stop_revision=None, overwrite=False,
3404
other_revno, other_last_revision = self.source.last_revision_info()
3405
stop_revno = None # unknown
719
3406
if stop_revision is None:
720
stop_revision = other_len
721
elif stop_revision > other_len:
722
raise NoSuchRevision(self, stop_revision)
724
return other_history[self_len:stop_revision]
727
def update_revisions(self, other, stop_revision=None):
728
"""Pull in all new revisions from other branch.
730
>>> from bzrlib.commit import commit
731
>>> bzrlib.trace.silent = True
732
>>> br1 = ScratchBranch(files=['foo', 'bar'])
735
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
736
>>> br2 = ScratchBranch()
737
>>> br2.update_revisions(br1)
741
>>> br2.revision_history()
743
>>> br2.update_revisions(br1)
747
>>> br1.text_store.total_size() == br2.text_store.total_size()
750
from bzrlib.progress import ProgressBar
754
pb.update('comparing histories')
755
revision_ids = self.missing_revisions(other, stop_revision)
757
needed_texts = sets.Set()
759
for rev_id in revision_ids:
761
pb.update('fetching revision', i, len(revision_ids))
762
rev = other.get_revision(rev_id)
763
revisions.append(rev)
764
inv = other.get_inventory(str(rev.inventory_id))
765
for key, entry in inv.iter_entries():
766
if entry.text_id is None:
768
if entry.text_id not in self.text_store:
769
needed_texts.add(entry.text_id)
773
count = self.text_store.copy_multi(other.text_store, needed_texts)
774
print "Added %d texts." % count
775
inventory_ids = [ f.inventory_id for f in revisions ]
776
count = self.inventory_store.copy_multi(other.inventory_store,
778
print "Added %d inventories." % count
779
revision_ids = [ f.revision_id for f in revisions]
780
count = self.revision_store.copy_multi(other.revision_store,
782
for revision_id in revision_ids:
783
self.append_revision(revision_id)
784
print "Added %d revisions." % count
787
def commit(self, *args, **kw):
789
from bzrlib.commit import commit
790
commit(self, *args, **kw)
793
def lookup_revision(self, revno):
794
"""Return revision hash for revision number."""
799
# list is 0-based; revisions are 1-based
800
return self.revision_history()[revno-1]
802
raise BzrError("no such revision %s" % revno)
805
def revision_tree(self, revision_id):
806
"""Return Tree for a revision on this branch.
808
`revision_id` may be None for the null revision, in which case
809
an `EmptyTree` is returned."""
810
# TODO: refactor this to use an existing revision object
811
# so we don't need to read it in twice.
812
if revision_id == None:
815
inv = self.get_revision_inventory(revision_id)
816
return RevisionTree(self.text_store, inv)
819
def working_tree(self):
820
"""Return a `Tree` for the working copy."""
821
from workingtree import WorkingTree
822
return WorkingTree(self.base, self.read_working_inventory())
825
def basis_tree(self):
826
"""Return `Tree` object for last revision.
828
If there are no revisions yet, return an `EmptyTree`.
830
r = self.last_patch()
834
return RevisionTree(self.text_store, self.get_revision_inventory(r))
838
def rename_one(self, from_rel, to_rel):
841
This can change the directory or the filename or both.
845
tree = self.working_tree()
847
if not tree.has_filename(from_rel):
848
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
849
if tree.has_filename(to_rel):
850
raise BzrError("can't rename: new working file %r already exists" % to_rel)
852
file_id = inv.path2id(from_rel)
854
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
856
if inv.path2id(to_rel):
857
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
859
to_dir, to_tail = os.path.split(to_rel)
860
to_dir_id = inv.path2id(to_dir)
861
if to_dir_id == None and to_dir != '':
862
raise BzrError("can't determine destination directory id for %r" % to_dir)
864
mutter("rename_one:")
865
mutter(" file_id {%s}" % file_id)
866
mutter(" from_rel %r" % from_rel)
867
mutter(" to_rel %r" % to_rel)
868
mutter(" to_dir %r" % to_dir)
869
mutter(" to_dir_id {%s}" % to_dir_id)
871
inv.rename(file_id, to_dir_id, to_tail)
873
print "%s => %s" % (from_rel, to_rel)
875
from_abs = self.abspath(from_rel)
876
to_abs = self.abspath(to_rel)
3407
stop_revision = other_last_revision
3408
if _mod_revision.is_null(stop_revision):
3409
# if there are no commits, we're done.
3411
stop_revno = other_revno
3413
# what's the current last revision, before we fetch [and change it
3415
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3416
# we fetch here so that we don't process data twice in the common
3417
# case of having something to pull, and so that the check for
3418
# already merged can operate on the just fetched graph, which will
3419
# be cached in memory.
3420
self.fetch(stop_revision=stop_revision)
3421
# Check to see if one is an ancestor of the other
3424
graph = self.target.repository.get_graph()
3425
if self.target._check_if_descendant_or_diverged(
3426
stop_revision, last_rev, graph, self.source):
3427
# stop_revision is a descendant of last_rev, but we aren't
3428
# overwriting, so we're done.
3430
if stop_revno is None:
3432
graph = self.target.repository.get_graph()
3433
this_revno, this_last_revision = \
3434
self.target.last_revision_info()
3435
stop_revno = graph.find_distance_to_null(stop_revision,
3436
[(other_last_revision, other_revno),
3437
(this_last_revision, this_revno)])
3438
self.target.set_last_revision_info(stop_revno, stop_revision)
3441
def pull(self, overwrite=False, stop_revision=None,
3442
possible_transports=None, run_hooks=True,
3443
_override_hook_target=None, local=False):
3444
"""Pull from source into self, updating my master if any.
3446
:param run_hooks: Private parameter - if false, this branch
3447
is being called because it's the master of the primary branch,
3448
so it should not run its hooks.
3450
bound_location = self.target.get_bound_location()
3451
if local and not bound_location:
3452
raise errors.LocalRequiresBoundBranch()
3453
master_branch = None
3454
source_is_master = False
3456
# bound_location comes from a config file, some care has to be
3457
# taken to relate it to source.user_url
3458
normalized = urlutils.normalize_url(bound_location)
878
os.rename(from_abs, to_abs)
880
raise BzrError("failed to rename %r to %r: %s"
881
% (from_abs, to_abs, e[1]),
882
["rename rolled back"])
884
self._write_inventory(inv)
889
def move(self, from_paths, to_name):
892
to_name must exist as a versioned directory.
894
If to_name exists and is a directory, the files are moved into
895
it, keeping their old names. If it is a directory,
897
Note that to_name is only the last component of the new name;
898
this doesn't change the directory.
902
## TODO: Option to move IDs only
903
assert not isinstance(from_paths, basestring)
904
tree = self.working_tree()
906
to_abs = self.abspath(to_name)
907
if not isdir(to_abs):
908
raise BzrError("destination %r is not a directory" % to_abs)
909
if not tree.has_filename(to_name):
910
raise BzrError("destination %r not in working directory" % to_abs)
911
to_dir_id = inv.path2id(to_name)
912
if to_dir_id == None and to_name != '':
913
raise BzrError("destination %r is not a versioned directory" % to_name)
914
to_dir_ie = inv[to_dir_id]
915
if to_dir_ie.kind not in ('directory', 'root_directory'):
916
raise BzrError("destination %r is not a directory" % to_abs)
918
to_idpath = inv.get_idpath(to_dir_id)
921
if not tree.has_filename(f):
922
raise BzrError("%r does not exist in working tree" % f)
923
f_id = inv.path2id(f)
925
raise BzrError("%r is not versioned" % f)
926
name_tail = splitpath(f)[-1]
927
dest_path = appendpath(to_name, name_tail)
928
if tree.has_filename(dest_path):
929
raise BzrError("destination %r already exists" % dest_path)
930
if f_id in to_idpath:
931
raise BzrError("can't move %r to a subdirectory of itself" % f)
933
# OK, so there's a race here, it's possible that someone will
934
# create a file in this interval and then the rename might be
935
# left half-done. But we should have caught most problems.
938
name_tail = splitpath(f)[-1]
939
dest_path = appendpath(to_name, name_tail)
940
print "%s => %s" % (f, dest_path)
941
inv.rename(inv.path2id(f), to_dir_id, name_tail)
943
os.rename(self.abspath(f), self.abspath(dest_path))
945
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
946
["rename rolled back"])
948
self._write_inventory(inv)
954
class ScratchBranch(Branch):
955
"""Special test class: a branch that cleans up after itself.
957
>>> b = ScratchBranch()
965
def __init__(self, files=[], dirs=[], base=None):
966
"""Make a test branch.
968
This creates a temporary directory and runs init-tree in it.
970
If any files are listed, they are created in the working copy.
974
base = tempfile.mkdtemp()
976
Branch.__init__(self, base, init=init)
978
os.mkdir(self.abspath(d))
981
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
986
>>> orig = ScratchBranch(files=["file1", "file2"])
987
>>> clone = orig.clone()
988
>>> os.path.samefile(orig.base, clone.base)
990
>>> os.path.isfile(os.path.join(clone.base, "file1"))
993
base = tempfile.mkdtemp()
995
shutil.copytree(self.base, base, symlinks=True)
996
return ScratchBranch(base=base)
1002
"""Destroy the test branch, removing the scratch directory."""
1005
mutter("delete ScratchBranch %s" % self.base)
1006
shutil.rmtree(self.base)
1008
# Work around for shutil.rmtree failing on Windows when
1009
# readonly files are encountered
1010
mutter("hit exception in destroying ScratchBranch: %s" % e)
1011
for root, dirs, files in os.walk(self.base, topdown=False):
1013
os.chmod(os.path.join(root, name), 0700)
1014
shutil.rmtree(self.base)
1019
######################################################################
1023
def is_control_file(filename):
1024
## FIXME: better check
1025
filename = os.path.normpath(filename)
1026
while filename != '':
1027
head, tail = os.path.split(filename)
1028
## mutter('check %r for control file' % ((head, tail), ))
1029
if tail == bzrlib.BZRDIR:
1031
if filename == head:
1038
def gen_file_id(name):
1039
"""Return new file id.
1041
This should probably generate proper UUIDs, but for the moment we
1042
cope with just randomness because running uuidgen every time is
1046
# get last component
1047
idx = name.rfind('/')
1049
name = name[idx+1 : ]
1050
idx = name.rfind('\\')
1052
name = name[idx+1 : ]
1054
# make it not a hidden file
1055
name = name.lstrip('.')
1057
# remove any wierd characters; we don't escape them but rather
1058
# just pull them out
1059
name = re.sub(r'[^\w.]', '', name)
1061
s = hexlify(rand_bytes(8))
1062
return '-'.join((name, compact_date(time.time()), s))
3460
relpath = self.source.user_transport.relpath(normalized)
3461
source_is_master = (relpath == '')
3462
except (errors.PathNotChild, errors.InvalidURL):
3463
source_is_master = False
3464
if not local and bound_location and not source_is_master:
3465
# not pulling from master, so we need to update master.
3466
master_branch = self.target.get_master_branch(possible_transports)
3467
master_branch.lock_write()
3470
# pull from source into master.
3471
master_branch.pull(self.source, overwrite, stop_revision,
3473
return self._pull(overwrite,
3474
stop_revision, _hook_master=master_branch,
3475
run_hooks=run_hooks,
3476
_override_hook_target=_override_hook_target,
3477
merge_tags_to_master=not source_is_master)
3480
master_branch.unlock()
3482
def push(self, overwrite=False, stop_revision=None, lossy=False,
3483
_override_hook_source_branch=None):
3484
"""See InterBranch.push.
3486
This is the basic concrete implementation of push()
3488
:param _override_hook_source_branch: If specified, run the hooks
3489
passing this Branch as the source, rather than self. This is for
3490
use of RemoteBranch, where push is delegated to the underlying
3494
raise errors.LossyPushToSameVCS(self.source, self.target)
3495
# TODO: Public option to disable running hooks - should be trivial but
3498
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3499
op.add_cleanup(self.source.lock_read().unlock)
3500
op.add_cleanup(self.target.lock_write().unlock)
3501
return op.run(overwrite, stop_revision,
3502
_override_hook_source_branch=_override_hook_source_branch)
3504
def _basic_push(self, overwrite, stop_revision):
3505
"""Basic implementation of push without bound branches or hooks.
3507
Must be called with source read locked and target write locked.
3509
result = BranchPushResult()
3510
result.source_branch = self.source
3511
result.target_branch = self.target
3512
result.old_revno, result.old_revid = self.target.last_revision_info()
3513
self.source.update_references(self.target)
3514
if result.old_revid != stop_revision:
3515
# We assume that during 'push' this repository is closer than
3517
graph = self.source.repository.get_graph(self.target.repository)
3518
self._update_revisions(stop_revision, overwrite=overwrite,
3520
if self.source._push_should_merge_tags():
3521
result.tag_updates, result.tag_conflicts = (
3522
self.source.tags.merge_to(self.target.tags, overwrite))
3523
result.new_revno, result.new_revid = self.target.last_revision_info()
3526
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3527
_override_hook_source_branch=None):
3528
"""Push from source into target, and into target's master if any.
3531
if _override_hook_source_branch:
3532
result.source_branch = _override_hook_source_branch
3533
for hook in Branch.hooks['post_push']:
3536
bound_location = self.target.get_bound_location()
3537
if bound_location and self.target.base != bound_location:
3538
# there is a master branch.
3540
# XXX: Why the second check? Is it even supported for a branch to
3541
# be bound to itself? -- mbp 20070507
3542
master_branch = self.target.get_master_branch()
3543
master_branch.lock_write()
3544
operation.add_cleanup(master_branch.unlock)
3545
# push into the master from the source branch.
3546
master_inter = InterBranch.get(self.source, master_branch)
3547
master_inter._basic_push(overwrite, stop_revision)
3548
# and push into the target branch from the source. Note that
3549
# we push from the source branch again, because it's considered
3550
# the highest bandwidth repository.
3551
result = self._basic_push(overwrite, stop_revision)
3552
result.master_branch = master_branch
3553
result.local_branch = self.target
3555
master_branch = None
3557
result = self._basic_push(overwrite, stop_revision)
3558
# TODO: Why set master_branch and local_branch if there's no
3559
# binding? Maybe cleaner to just leave them unset? -- mbp
3561
result.master_branch = self.target
3562
result.local_branch = None
3566
def _pull(self, overwrite=False, stop_revision=None,
3567
possible_transports=None, _hook_master=None, run_hooks=True,
3568
_override_hook_target=None, local=False,
3569
merge_tags_to_master=True):
3572
This function is the core worker, used by GenericInterBranch.pull to
3573
avoid duplication when pulling source->master and source->local.
3575
:param _hook_master: Private parameter - set the branch to
3576
be supplied as the master to pull hooks.
3577
:param run_hooks: Private parameter - if false, this branch
3578
is being called because it's the master of the primary branch,
3579
so it should not run its hooks.
3580
is being called because it's the master of the primary branch,
3581
so it should not run its hooks.
3582
:param _override_hook_target: Private parameter - set the branch to be
3583
supplied as the target_branch to pull hooks.
3584
:param local: Only update the local branch, and not the bound branch.
3586
# This type of branch can't be bound.
3588
raise errors.LocalRequiresBoundBranch()
3589
result = PullResult()
3590
result.source_branch = self.source
3591
if _override_hook_target is None:
3592
result.target_branch = self.target
3594
result.target_branch = _override_hook_target
3595
self.source.lock_read()
3597
# We assume that during 'pull' the target repository is closer than
3599
self.source.update_references(self.target)
3600
graph = self.target.repository.get_graph(self.source.repository)
3601
# TODO: Branch formats should have a flag that indicates
3602
# that revno's are expensive, and pull() should honor that flag.
3604
result.old_revno, result.old_revid = \
3605
self.target.last_revision_info()
3606
self._update_revisions(stop_revision, overwrite=overwrite,
3608
# TODO: The old revid should be specified when merging tags,
3609
# so a tags implementation that versions tags can only
3610
# pull in the most recent changes. -- JRV20090506
3611
result.tag_updates, result.tag_conflicts = (
3612
self.source.tags.merge_to(self.target.tags, overwrite,
3613
ignore_master=not merge_tags_to_master))
3614
result.new_revno, result.new_revid = self.target.last_revision_info()
3616
result.master_branch = _hook_master
3617
result.local_branch = result.target_branch
3619
result.master_branch = result.target_branch
3620
result.local_branch = None
3622
for hook in Branch.hooks['post_pull']:
3625
self.source.unlock()
3629
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
