1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from cStringIO import StringIO
22
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
sha_file, appendpath, file_kind
27
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
29
from bzrlib.textui import show_status
30
from bzrlib.revision import Revision
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
33
from bzrlib.inventory import Inventory
34
from bzrlib.weavestore import WeaveStore
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
40
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
41
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
42
## TODO: Maybe include checks for common corruption of newlines, etc?
45
# TODO: Some operations like log might retrieve the same revisions
46
# repeatedly to calculate deltas. We could perhaps have a weakref
47
# cache in memory to make this faster.
49
# TODO: please move the revision-string syntax stuff out of the branch
50
# object; it's clutter
53
def find_branch(f, **args):
54
if f and (f.startswith('http://') or f.startswith('https://')):
56
return remotebranch.RemoteBranch(f, **args)
58
return Branch(f, **args)
61
def find_cached_branch(f, cache_root, **args):
62
from remotebranch import RemoteBranch
63
br = find_branch(f, **args)
64
def cacheify(br, store_name):
65
from meta_store import CachedStore
66
cache_path = os.path.join(cache_root, store_name)
68
new_store = CachedStore(getattr(br, store_name), cache_path)
69
setattr(br, store_name, new_store)
71
if isinstance(br, RemoteBranch):
72
cacheify(br, 'inventory_store')
73
cacheify(br, 'text_store')
74
cacheify(br, 'revision_store')
78
def _relpath(base, path):
79
"""Return path relative to base, or raise exception.
81
The path may be either an absolute path or a path relative to the
82
current working directory.
84
Lifted out of Branch.relpath for ease of testing.
86
os.path.commonprefix (python2.4) has a bad bug that it works just
87
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
88
avoids that problem."""
89
rp = os.path.abspath(path)
93
while len(head) >= len(base):
96
head, tail = os.path.split(head)
100
from errors import NotBranchError
101
raise NotBranchError("path %r is not within branch %r" % (rp, base))
103
return os.sep.join(s)
106
def find_branch_root(f=None):
107
"""Find the branch root enclosing f, or pwd.
109
f may be a filename or a URL.
111
It is not necessary that f exists.
113
Basically we keep looking up until we find the control directory or
114
run into the root. If there isn't one, raises NotBranchError.
118
elif hasattr(os.path, 'realpath'):
119
f = os.path.realpath(f)
121
f = os.path.abspath(f)
122
if not os.path.exists(f):
123
raise BzrError('%r does not exist' % f)
129
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
131
head, tail = os.path.split(f)
133
# reached the root, whatever that may be
134
raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
139
# XXX: move into bzrlib.errors; subclass BzrError
140
class DivergedBranches(Exception):
141
def __init__(self, branch1, branch2):
142
self.branch1 = branch1
143
self.branch2 = branch2
144
Exception.__init__(self, "These branches have diverged.")
147
######################################################################
150
class Branch(object):
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
class Branch(bzrdir.ControlComponent):
151
67
"""Branch holding a history of revisions.
154
Base directory of the branch.
160
If _lock_mode is true, a positive count of the number of times the
164
Lock object from bzrlib.lock.
70
Base directory/url of the branch; using control_url and
71
control_transport is more standardized.
73
hooks: An instance of BranchHooks.
75
# this is really an instance variable - FIXME move it there
171
# Map some sort of prefix into a namespace
172
# stuff like "revno:10", "revid:", etc.
173
# This should match a prefix with a function which accepts
174
REVISION_NAMESPACES = {}
176
def __init__(self, base, init=False, find_root=True):
177
"""Create new branch object at a particular location.
179
base -- Base directory for the branch.
181
init -- If True, create new control files in a previously
182
unversioned directory. If False, the branch must already
185
find_root -- If true and init is false, find the root of the
186
existing branch containing base.
188
In the test suite, creation of new trees is tested using the
189
`ScratchBranch` class.
191
from bzrlib.store import ImmutableStore
193
self.base = os.path.realpath(base)
196
self.base = find_branch_root(base)
198
self.base = os.path.realpath(base)
199
if not isdir(self.controlfilename('.')):
200
from errors import NotBranchError
201
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
202
['use "bzr init" to initialize a new working tree',
203
'current bzr can only operate from top-of-tree'])
206
self.weave_store = WeaveStore(self.controlfilename('weaves'))
207
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
208
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
212
return '%s(%r)' % (self.__class__.__name__, self.base)
219
if self._lock_mode or self._lock:
220
from warnings import warn
221
warn("branch %r was not explicitly unlocked" % self)
225
def lock_write(self):
227
if self._lock_mode != 'w':
228
from errors import LockError
229
raise LockError("can't upgrade to a write lock from %r" %
231
self._lock_count += 1
233
from bzrlib.lock import WriteLock
235
self._lock = WriteLock(self.controlfilename('branch-lock'))
236
self._lock_mode = 'w'
80
def control_transport(self):
81
return self._transport
84
def user_transport(self):
85
return self.bzrdir.user_transport
87
def __init__(self, *ignored, **ignored_too):
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._partial_revision_history_cache = []
93
self._last_revision_info_cache = None
94
self._merge_sorted_revisions_cache = None
96
hooks = Branch.hooks['open']
100
def _open_hook(self):
101
"""Called by init to allow simpler extension of the base class."""
103
def _activate_fallback_location(self, url):
104
"""Activate the branch/repository from url as a fallback repository."""
105
repo = self._get_fallback_repository(url)
106
if repo.has_same_location(self.repository):
107
raise errors.UnstackableLocationError(self.user_url, url)
108
self.repository.add_fallback_repository(repo)
110
def break_lock(self):
111
"""Break a lock if one is present from another instance.
113
Uses the ui factory to ask for confirmation if the lock may be from
116
This will probe the repository for its lock as well.
118
self.control_files.break_lock()
119
self.repository.break_lock()
120
master = self.get_master_branch()
121
if master is not None:
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
160
"""Open the branch rooted at base.
162
For instance, if the branch is at URL/.bzr/branch,
163
Branch.open(URL) -> a Branch instance.
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
171
"""Open the branch rooted at transport"""
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
def open_containing(url, possible_transports=None):
177
"""Open an existing branch which contains url.
179
This probes for a branch at url, and searches upwards from there.
181
Basically we keep looking up until we find the control directory or
182
run into the root. If there isn't one, raises NotBranchError.
183
If there is one and it is either an unrecognised format or an unsupported
184
format, UnknownFormatError or UnsupportedFormatError are raised.
185
If there is one, it is returned, along with the unused portion of url.
187
control, relpath = bzrdir.BzrDir.open_containing(url,
189
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
199
def get_config(self):
200
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
251
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
254
nick = property(_get_nick, _set_nick)
257
raise NotImplementedError(self.is_locked)
259
def _lefthand_history(self, revision_id, last_rev=None,
261
if 'evil' in debug.debug_flags:
262
mutter_callsite(4, "_lefthand_history scales with history.")
263
# stop_revision must be a descendant of last_revision
264
graph = self.repository.get_graph()
265
if last_rev is not None:
266
if not graph.is_ancestor(last_rev, revision_id):
267
# our previous tip is not merged into stop_revision
268
raise errors.DivergedBranches(self, other_branch)
269
# make a new revision history from the graph
270
parents_map = graph.get_parent_map([revision_id])
271
if revision_id not in parents_map:
272
raise errors.NoSuchRevision(self, revision_id)
273
current_rev_id = revision_id
275
check_not_reserved_id = _mod_revision.check_not_reserved_id
276
# Do not include ghosts or graph origin in revision_history
277
while (current_rev_id in parents_map and
278
len(parents_map[current_rev_id]) > 0):
279
check_not_reserved_id(current_rev_id)
280
new_history.append(current_rev_id)
281
current_rev_id = parents_map[current_rev_id][0]
282
parents_map = graph.get_parent_map([current_rev_id])
283
new_history.reverse()
286
def lock_write(self, token=None):
287
"""Lock the branch for write operations.
289
:param token: A token to permit reacquiring a previously held and
291
:return: A BranchWriteLockResult.
293
raise NotImplementedError(self.lock_write)
240
295
def lock_read(self):
242
assert self._lock_mode in ('r', 'w'), \
243
"invalid lock mode %r" % self._lock_mode
244
self._lock_count += 1
246
from bzrlib.lock import ReadLock
248
self._lock = ReadLock(self.controlfilename('branch-lock'))
249
self._lock_mode = 'r'
296
"""Lock the branch for read operations.
298
:return: An object with an unlock method which will release the lock
301
raise NotImplementedError(self.lock_read)
252
303
def unlock(self):
253
if not self._lock_mode:
254
from errors import LockError
255
raise LockError('branch %r is not locked' % (self))
257
if self._lock_count > 1:
258
self._lock_count -= 1
262
self._lock_mode = self._lock_count = None
264
def abspath(self, name):
265
"""Return absolute filename for something in the branch"""
266
return os.path.join(self.base, name)
268
def relpath(self, path):
269
"""Return path relative to this branch of something inside it.
271
Raises an error if path is not in this branch."""
272
return _relpath(self.base, path)
274
def controlfilename(self, file_or_path):
275
"""Return location relative to branch."""
276
if isinstance(file_or_path, basestring):
277
file_or_path = [file_or_path]
278
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
281
def controlfile(self, file_or_path, mode='r'):
282
"""Open a control file for this branch.
284
There are two classes of file in the control directory: text
285
and binary. binary files are untranslated byte streams. Text
286
control files are stored with Unix newlines and in UTF-8, even
287
if the platform or locale defaults are different.
289
Controlfiles should almost never be opened in write mode but
290
rather should be atomically copied and replaced using atomicfile.
293
fn = self.controlfilename(file_or_path)
295
if mode == 'rb' or mode == 'wb':
296
return file(fn, mode)
297
elif mode == 'r' or mode == 'w':
298
# open in binary mode anyhow so there's no newline translation;
299
# codecs uses line buffering by default; don't want that.
301
return codecs.open(fn, mode + 'b', 'utf-8',
304
raise BzrError("invalid controlfile mode %r" % mode)
306
def _make_control(self):
307
os.mkdir(self.controlfilename([]))
308
self.controlfile('README', 'w').write(
309
"This is a Bazaar-NG control directory.\n"
310
"Do not change any files in this directory.\n")
311
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
312
for d in ('text-store', 'inventory-store', 'revision-store',
314
os.mkdir(self.controlfilename(d))
315
for f in ('revision-history', 'merged-patches',
316
'pending-merged-patches', 'branch-name',
319
self.controlfile(f, 'w').write('')
320
mutter('created control directory in ' + self.base)
322
# if we want per-tree root ids then this is the place to set
323
# them; they're not needed for now and so ommitted for
325
f = self.controlfile('inventory','w')
326
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
329
def _check_format(self):
330
"""Check this branch format is supported.
332
The format level is stored, as an integer, in
333
self._branch_format for code that needs to check it later.
335
In the future, we might need different in-memory Branch
336
classes to support downlevel branches. But not yet.
338
fmt = self.controlfile('branch-format', 'r').read()
339
if fmt == BZR_BRANCH_FORMAT_5:
340
self._branch_format = 5
342
raise BzrError('sorry, branch format "%s" not supported; '
343
'use a different bzr version, '
344
'or run "bzr upgrade", '
345
'or remove the .bzr directory and "bzr init" again'
346
% fmt.rstrip('\n\r'))
348
def get_root_id(self):
349
"""Return the id of this branches root"""
350
inv = self.read_working_inventory()
351
return inv.root.file_id
353
def set_root_id(self, file_id):
354
inv = self.read_working_inventory()
355
orig_root_id = inv.root.file_id
356
del inv._byid[inv.root.file_id]
357
inv.root.file_id = file_id
358
inv._byid[inv.root.file_id] = inv.root
361
if entry.parent_id in (None, orig_root_id):
362
entry.parent_id = inv.root.file_id
363
self._write_inventory(inv)
365
def read_working_inventory(self):
366
"""Read the working inventory."""
369
# ElementTree does its own conversion from UTF-8, so open in
371
f = self.controlfile('inventory', 'rb')
372
return bzrlib.xml5.serializer_v5.read_inventory(f)
377
def _write_inventory(self, inv):
378
"""Update the working inventory.
380
That is to say, the inventory describing changes underway, that
381
will be committed to the next revision.
383
from bzrlib.atomicfile import AtomicFile
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
389
bzrlib.xml5.serializer_v5.write_inventory(inv, f)
396
mutter('wrote working inventory')
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
403
def add(self, files, ids=None):
404
"""Make files versioned.
406
Note that the command line normally calls smart_add instead,
407
which can automatically recurse.
409
This puts the files in the Added state, so that they will be
410
recorded by the next commit.
413
List of paths to add, relative to the base of the tree.
416
If set, use these instead of automatically generated ids.
417
Must be the same length as the list of files, but may
418
contain None for ids that are to be autogenerated.
420
TODO: Perhaps have an option to add the ids even if the files do
423
TODO: Perhaps yield the ids and paths as they're added.
425
# TODO: Re-adding a file that is removed in the working copy
426
# should probably put it back with the previous ID.
427
if isinstance(files, basestring):
428
assert(ids is None or isinstance(ids, basestring))
434
ids = [None] * len(files)
436
assert(len(ids) == len(files))
440
inv = self.read_working_inventory()
441
for f,file_id in zip(files, ids):
442
if is_control_file(f):
443
raise BzrError("cannot add control file %s" % quotefn(f))
448
raise BzrError("cannot add top-level %r" % f)
450
fullpath = os.path.normpath(self.abspath(f))
453
kind = file_kind(fullpath)
455
# maybe something better?
456
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
458
if kind != 'file' and kind != 'directory':
459
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
462
file_id = gen_file_id(f)
463
inv.add_path(f, kind=kind, file_id=file_id)
465
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
467
self._write_inventory(inv)
472
def print_file(self, file, revno):
473
"""Print `file` to stdout."""
476
tree = self.revision_tree(self.lookup_revision(revno))
477
# use inventory as it was in that revision
478
file_id = tree.inventory.path2id(file)
480
raise BzrError("%r is not present in revision %s" % (file, revno))
481
tree.print_file(file_id)
486
def remove(self, files, verbose=False):
487
"""Mark nominated files for removal from the inventory.
489
This does not remove their text. This does not run on
491
TODO: Refuse to remove modified files unless --force is given?
493
TODO: Do something useful with directories.
495
TODO: Should this remove the text or not? Tough call; not
496
removing may be useful and the user can just use use rm, and
497
is the opposite of add. Removing it is consistent with most
498
other tools. Maybe an option.
500
## TODO: Normalize names
501
## TODO: Remove nested loops; better scalability
502
if isinstance(files, basestring):
508
tree = self.working_tree()
511
# do this before any modifications
515
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
516
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
518
# having remove it, it must be either ignored or unknown
519
if tree.is_ignored(f):
523
show_status(new_status, inv[fid].kind, quotefn(f))
526
self._write_inventory(inv)
531
# FIXME: this doesn't need to be a branch method
532
def set_inventory(self, new_inventory_list):
533
from bzrlib.inventory import Inventory, InventoryEntry
534
inv = Inventory(self.get_root_id())
535
for path, file_id, parent, kind in new_inventory_list:
536
name = os.path.basename(path)
539
inv.add(InventoryEntry(file_id, name, kind, parent))
540
self._write_inventory(inv)
544
"""Return all unknown files.
546
These are files in the working directory that are not versioned or
547
control files or ignored.
549
>>> b = ScratchBranch(files=['foo', 'foo~'])
550
>>> list(b.unknowns())
553
>>> list(b.unknowns())
556
>>> list(b.unknowns())
559
return self.working_tree().unknowns()
562
def append_revision(self, *revision_ids):
563
from bzrlib.atomicfile import AtomicFile
565
for revision_id in revision_ids:
566
mutter("add {%s} to revision-history" % revision_id)
568
rev_history = self.revision_history()
569
rev_history.extend(revision_ids)
571
f = AtomicFile(self.controlfilename('revision-history'))
573
for rev_id in rev_history:
580
def get_revision_xml_file(self, revision_id):
581
"""Return XML file object for revision object."""
582
if not revision_id or not isinstance(revision_id, basestring):
583
raise InvalidRevisionId(revision_id)
588
return self.revision_store[revision_id]
590
raise bzrlib.errors.NoSuchRevision(self, revision_id)
596
get_revision_xml = get_revision_xml_file
599
def get_revision(self, revision_id):
600
"""Return the Revision object for a named revision"""
601
xml_file = self.get_revision_xml_file(revision_id)
604
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
605
except SyntaxError, e:
606
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
610
assert r.revision_id == revision_id
304
raise NotImplementedError(self.unlock)
306
def peek_lock_mode(self):
307
"""Return lock mode for the Branch: 'r', 'w' or None"""
308
raise NotImplementedError(self.peek_lock_mode)
310
def get_physical_lock_status(self):
311
raise NotImplementedError(self.get_physical_lock_status)
314
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
315
"""Return the revision_id for a dotted revno.
317
:param revno: a tuple like (1,) or (1,1,2)
318
:param _cache_reverse: a private parameter enabling storage
319
of the reverse mapping in a top level cache. (This should
320
only be done in selective circumstances as we want to
321
avoid having the mapping cached multiple times.)
322
:return: the revision_id
323
:raises errors.NoSuchRevision: if the revno doesn't exist
325
rev_id = self._do_dotted_revno_to_revision_id(revno)
327
self._partial_revision_id_to_revno_cache[rev_id] = revno
330
def _do_dotted_revno_to_revision_id(self, revno):
331
"""Worker function for dotted_revno_to_revision_id.
333
Subclasses should override this if they wish to
334
provide a more efficient implementation.
337
return self.get_rev_id(revno[0])
338
revision_id_to_revno = self.get_revision_id_to_revno_map()
339
revision_ids = [revision_id for revision_id, this_revno
340
in revision_id_to_revno.iteritems()
341
if revno == this_revno]
342
if len(revision_ids) == 1:
343
return revision_ids[0]
345
revno_str = '.'.join(map(str, revno))
346
raise errors.NoSuchRevision(self, revno_str)
349
def revision_id_to_dotted_revno(self, revision_id):
350
"""Given a revision id, return its dotted revno.
352
:return: a tuple like (1,) or (400,1,3).
354
return self._do_revision_id_to_dotted_revno(revision_id)
356
def _do_revision_id_to_dotted_revno(self, revision_id):
357
"""Worker function for revision_id_to_revno."""
358
# Try the caches if they are loaded
359
result = self._partial_revision_id_to_revno_cache.get(revision_id)
360
if result is not None:
362
if self._revision_id_to_revno_cache:
363
result = self._revision_id_to_revno_cache.get(revision_id)
365
raise errors.NoSuchRevision(self, revision_id)
366
# Try the mainline as it's optimised
368
revno = self.revision_id_to_revno(revision_id)
370
except errors.NoSuchRevision:
371
# We need to load and use the full revno map after all
372
result = self.get_revision_id_to_revno_map().get(revision_id)
374
raise errors.NoSuchRevision(self, revision_id)
378
def get_revision_id_to_revno_map(self):
379
"""Return the revision_id => dotted revno map.
381
This will be regenerated on demand, but will be cached.
383
:return: A dictionary mapping revision_id => dotted revno.
384
This dictionary should not be modified by the caller.
386
if self._revision_id_to_revno_cache is not None:
387
mapping = self._revision_id_to_revno_cache
389
mapping = self._gen_revno_map()
390
self._cache_revision_id_to_revno(mapping)
391
# TODO: jam 20070417 Since this is being cached, should we be returning
393
# I would rather not, and instead just declare that users should not
394
# modify the return value.
397
def _gen_revno_map(self):
398
"""Create a new mapping from revision ids to dotted revnos.
400
Dotted revnos are generated based on the current tip in the revision
402
This is the worker function for get_revision_id_to_revno_map, which
403
just caches the return value.
405
:return: A dictionary mapping revision_id => dotted revno.
407
revision_id_to_revno = dict((rev_id, revno)
408
for rev_id, depth, revno, end_of_merge
409
in self.iter_merge_sorted_revisions())
410
return revision_id_to_revno
413
def iter_merge_sorted_revisions(self, start_revision_id=None,
414
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
415
"""Walk the revisions for a branch in merge sorted order.
417
Merge sorted order is the output from a merge-aware,
418
topological sort, i.e. all parents come before their
419
children going forward; the opposite for reverse.
421
:param start_revision_id: the revision_id to begin walking from.
422
If None, the branch tip is used.
423
:param stop_revision_id: the revision_id to terminate the walk
424
after. If None, the rest of history is included.
425
:param stop_rule: if stop_revision_id is not None, the precise rule
426
to use for termination:
427
* 'exclude' - leave the stop revision out of the result (default)
428
* 'include' - the stop revision is the last item in the result
429
* 'with-merges' - include the stop revision and all of its
430
merged revisions in the result
431
* 'with-merges-without-common-ancestry' - filter out revisions
432
that are in both ancestries
433
:param direction: either 'reverse' or 'forward':
434
* reverse means return the start_revision_id first, i.e.
435
start at the most recent revision and go backwards in history
436
* forward returns tuples in the opposite order to reverse.
437
Note in particular that forward does *not* do any intelligent
438
ordering w.r.t. depth as some clients of this API may like.
439
(If required, that ought to be done at higher layers.)
441
:return: an iterator over (revision_id, depth, revno, end_of_merge)
444
* revision_id: the unique id of the revision
445
* depth: How many levels of merging deep this node has been
447
* revno_sequence: This field provides a sequence of
448
revision numbers for all revisions. The format is:
449
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
450
branch that the revno is on. From left to right the REVNO numbers
451
are the sequence numbers within that branch of the revision.
452
* end_of_merge: When True the next node (earlier in history) is
453
part of a different merge.
455
# Note: depth and revno values are in the context of the branch so
456
# we need the full graph to get stable numbers, regardless of the
458
if self._merge_sorted_revisions_cache is None:
459
last_revision = self.last_revision()
460
known_graph = self.repository.get_known_graph_ancestry(
462
self._merge_sorted_revisions_cache = known_graph.merge_sort(
464
filtered = self._filter_merge_sorted_revisions(
465
self._merge_sorted_revisions_cache, start_revision_id,
466
stop_revision_id, stop_rule)
467
# Make sure we don't return revisions that are not part of the
468
# start_revision_id ancestry.
469
filtered = self._filter_start_non_ancestors(filtered)
470
if direction == 'reverse':
472
if direction == 'forward':
473
return reversed(list(filtered))
475
raise ValueError('invalid direction %r' % direction)
477
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
478
start_revision_id, stop_revision_id, stop_rule):
479
"""Iterate over an inclusive range of sorted revisions."""
480
rev_iter = iter(merge_sorted_revisions)
481
if start_revision_id is not None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
if rev_id != start_revision_id:
487
# The decision to include the start or not
488
# depends on the stop_rule if a stop is provided
489
# so pop this node back into the iterator
490
rev_iter = chain(iter([node]), rev_iter)
492
if stop_revision_id is None:
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
elif stop_rule == 'exclude':
499
for node in rev_iter:
500
rev_id = node.key[-1]
501
if rev_id == stop_revision_id:
503
yield (rev_id, node.merge_depth, node.revno,
505
elif stop_rule == 'include':
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
yield (rev_id, node.merge_depth, node.revno,
510
if rev_id == stop_revision_id:
512
elif stop_rule == 'with-merges-without-common-ancestry':
513
# We want to exclude all revisions that are already part of the
514
# stop_revision_id ancestry.
515
graph = self.repository.get_graph()
516
ancestors = graph.find_unique_ancestors(start_revision_id,
518
for node in rev_iter:
519
rev_id = node.key[-1]
520
if rev_id not in ancestors:
522
yield (rev_id, node.merge_depth, node.revno,
524
elif stop_rule == 'with-merges':
525
stop_rev = self.repository.get_revision(stop_revision_id)
526
if stop_rev.parent_ids:
527
left_parent = stop_rev.parent_ids[0]
529
left_parent = _mod_revision.NULL_REVISION
530
# left_parent is the actual revision we want to stop logging at,
531
# since we want to show the merged revisions after the stop_rev too
532
reached_stop_revision_id = False
533
revision_id_whitelist = []
534
for node in rev_iter:
535
rev_id = node.key[-1]
536
if rev_id == left_parent:
537
# reached the left parent after the stop_revision
539
if (not reached_stop_revision_id or
540
rev_id in revision_id_whitelist):
541
yield (rev_id, node.merge_depth, node.revno,
543
if reached_stop_revision_id or rev_id == stop_revision_id:
544
# only do the merged revs of rev_id from now on
545
rev = self.repository.get_revision(rev_id)
547
reached_stop_revision_id = True
548
revision_id_whitelist.extend(rev.parent_ids)
550
raise ValueError('invalid stop_rule %r' % stop_rule)
552
def _filter_start_non_ancestors(self, rev_iter):
553
# If we started from a dotted revno, we want to consider it as a tip
554
# and don't want to yield revisions that are not part of its
555
# ancestry. Given the order guaranteed by the merge sort, we will see
556
# uninteresting descendants of the first parent of our tip before the
558
first = rev_iter.next()
559
(rev_id, merge_depth, revno, end_of_merge) = first
562
# We start at a mainline revision so by definition, all others
563
# revisions in rev_iter are ancestors
564
for node in rev_iter:
569
pmap = self.repository.get_parent_map([rev_id])
570
parents = pmap.get(rev_id, [])
572
whitelist.update(parents)
574
# If there is no parents, there is nothing of interest left
576
# FIXME: It's hard to test this scenario here as this code is never
577
# called in that case. -- vila 20100322
580
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
582
if rev_id in whitelist:
583
pmap = self.repository.get_parent_map([rev_id])
584
parents = pmap.get(rev_id, [])
585
whitelist.remove(rev_id)
586
whitelist.update(parents)
588
# We've reached the mainline, there is nothing left to
592
# A revision that is not part of the ancestry of our
595
yield (rev_id, merge_depth, revno, end_of_merge)
597
def leave_lock_in_place(self):
598
"""Tell this branch object not to release the physical lock when this
601
If lock_write doesn't return a token, then this method is not supported.
603
self.control_files.leave_in_place()
605
def dont_leave_lock_in_place(self):
606
"""Tell this branch object to release the physical lock when this
607
object is unlocked, even if it didn't originally acquire it.
609
If lock_write doesn't return a token, then this method is not supported.
611
self.control_files.dont_leave_in_place()
613
def bind(self, other):
614
"""Bind the local branch the other branch.
616
:param other: The branch to bind to
619
raise errors.UpgradeRequired(self.user_url)
621
def set_append_revisions_only(self, enabled):
622
if not self._format.supports_set_append_revisions_only():
623
raise errors.UpgradeRequired(self.user_url)
628
self.get_config().set_user_option('append_revisions_only', value,
631
def set_reference_info(self, file_id, tree_path, branch_location):
632
"""Set the branch location to use for a tree reference."""
633
raise errors.UnsupportedOperation(self.set_reference_info, self)
635
def get_reference_info(self, file_id):
636
"""Get the tree_path and branch_location for a tree reference."""
637
raise errors.UnsupportedOperation(self.get_reference_info, self)
640
def fetch(self, from_branch, last_revision=None, pb=None):
641
"""Copy revisions from from_branch into this branch.
643
:param from_branch: Where to copy from.
644
:param last_revision: What revision to stop at (None for at the end
646
:param pb: An optional progress bar to use.
649
if self.base == from_branch.base:
652
symbol_versioning.warn(
653
symbol_versioning.deprecated_in((1, 14, 0))
654
% "pb parameter to fetch()")
655
from_branch.lock_read()
657
if last_revision is None:
658
last_revision = from_branch.last_revision()
659
last_revision = _mod_revision.ensure_null(last_revision)
660
return self.repository.fetch(from_branch.repository,
661
revision_id=last_revision,
666
def get_bound_location(self):
667
"""Return the URL of the branch we are bound to.
669
Older format branches cannot bind, please be sure to use a metadir
674
def get_old_bound_location(self):
675
"""Return the URL of the branch we used to be bound to
677
raise errors.UpgradeRequired(self.user_url)
679
def get_commit_builder(self, parents, config=None, timestamp=None,
680
timezone=None, committer=None, revprops=None,
682
"""Obtain a CommitBuilder for this branch.
684
:param parents: Revision ids of the parents of the new revision.
685
:param config: Optional configuration to use.
686
:param timestamp: Optional timestamp recorded for commit.
687
:param timezone: Optional timezone for timestamp.
688
:param committer: Optional committer to set for commit.
689
:param revprops: Optional dictionary of revision properties.
690
:param revision_id: Optional revision id.
694
config = self.get_config()
696
return self.repository.get_commit_builder(self, parents, config,
697
timestamp, timezone, committer, revprops, revision_id)
699
def get_master_branch(self, possible_transports=None):
700
"""Return the branch we are bound to.
702
:return: Either a Branch, or None
614
706
def get_revision_delta(self, revno):
615
707
"""Return the delta for one revision.
794
953
common_index = min(self_len, other_len) -1
795
954
if common_index >= 0 and \
796
955
self_history[common_index] != other_history[common_index]:
797
raise DivergedBranches(self, other)
956
raise errors.DivergedBranches(self, other)
799
958
if stop_revision is None:
800
959
stop_revision = other_len
801
elif stop_revision > other_len:
802
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
961
if stop_revision > other_len:
962
raise errors.NoSuchRevision(self, stop_revision)
804
963
return other_history[self_len:stop_revision]
807
def update_revisions(self, other, stop_revision=None):
808
"""Pull in all new revisions from other branch.
810
from bzrlib.fetch import greedy_fetch
812
pb = bzrlib.ui.ui_factory.progress_bar()
813
pb.update('comparing histories')
815
revision_ids = self.missing_revisions(other, stop_revision)
817
if len(revision_ids) > 0:
818
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
821
self.append_revision(*revision_ids)
822
## note("Added %d revisions." % count)
825
def install_revisions(self, other, revision_ids, pb):
826
if hasattr(other.revision_store, "prefetch"):
827
other.revision_store.prefetch(revision_ids)
828
if hasattr(other.inventory_store, "prefetch"):
829
inventory_ids = [other.get_revision(r).inventory_id
830
for r in revision_ids]
831
other.inventory_store.prefetch(inventory_ids)
834
pb = bzrlib.ui.ui_factory.progress_bar()
841
for i, rev_id in enumerate(revision_ids):
842
pb.update('fetching revision', i+1, len(revision_ids))
844
rev = other.get_revision(rev_id)
845
except bzrlib.errors.NoSuchRevision:
849
revisions.append(rev)
850
inv = other.get_inventory(str(rev.inventory_id))
851
for key, entry in inv.iter_entries():
852
if entry.text_id is None:
854
if entry.text_id not in self.text_store:
855
needed_texts.add(entry.text_id)
859
count, cp_fail = self.text_store.copy_multi(other.text_store,
861
#print "Added %d texts." % count
862
inventory_ids = [ f.inventory_id for f in revisions ]
863
count, cp_fail = self.inventory_store.copy_multi(other.inventory_store,
865
#print "Added %d inventories." % count
866
revision_ids = [ f.revision_id for f in revisions]
868
count, cp_fail = self.revision_store.copy_multi(other.revision_store,
871
assert len(cp_fail) == 0
872
return count, failures
875
def commit(self, *args, **kw):
876
from bzrlib.commit import Commit
877
Commit().commit(self, *args, **kw)
880
def lookup_revision(self, revision):
881
"""Return the revision identifier for a given revision information."""
882
revno, info = self._get_revision_info(revision)
966
def update_revisions(self, other, stop_revision=None, overwrite=False,
968
"""Pull in new perfect-fit revisions.
970
:param other: Another Branch to pull from
971
:param stop_revision: Updated until the given revision
972
:param overwrite: Always set the branch pointer, rather than checking
973
to see if it is a proper descendant.
974
:param graph: A Graph object that can be used to query history
975
information. This can be None.
978
return InterBranch.get(other, self).update_revisions(stop_revision,
981
def import_last_revision_info(self, source_repo, revno, revid):
982
"""Set the last revision info, importing from another repo if necessary.
984
This is used by the bound branch code to upload a revision to
985
the master branch first before updating the tip of the local branch.
987
:param source_repo: Source repository to optionally fetch from
988
:param revno: Revision number of the new tip
989
:param revid: Revision id of the new tip
991
if not self.repository.has_same_location(source_repo):
992
self.repository.fetch(source_repo, revision_id=revid)
993
self.set_last_revision_info(revno, revid)
886
995
def revision_id_to_revno(self, revision_id):
887
996
"""Given a revision id, return its revno"""
997
if _mod_revision.is_null(revision_id):
888
999
history = self.revision_history()
890
1001
return history.index(revision_id) + 1
891
1002
except ValueError:
892
raise bzrlib.errors.NoSuchRevision(self, revision_id)
895
def get_revision_info(self, revision):
896
"""Return (revno, revision id) for revision identifier.
898
revision can be an integer, in which case it is assumed to be revno (though
899
this will translate negative values into positive ones)
900
revision can also be a string, in which case it is parsed for something like
901
'date:' or 'revid:' etc.
903
revno, rev_id = self._get_revision_info(revision)
905
raise bzrlib.errors.NoSuchRevision(self, revision)
1003
raise errors.NoSuchRevision(self, revision_id)
908
1006
def get_rev_id(self, revno, history=None):
909
1007
"""Find the revision id of the specified revno."""
913
history = self.revision_history()
914
elif revno <= 0 or revno > len(history):
915
raise bzrlib.errors.NoSuchRevision(self, revno)
916
return history[revno - 1]
918
def _get_revision_info(self, revision):
919
"""Return (revno, revision id) for revision specifier.
921
revision can be an integer, in which case it is assumed to be revno
922
(though this will translate negative values into positive ones)
923
revision can also be a string, in which case it is parsed for something
924
like 'date:' or 'revid:' etc.
926
A revid is always returned. If it is None, the specifier referred to
927
the null revision. If the revid does not occur in the revision
928
history, revno will be None.
934
try:# Convert to int if possible
935
revision = int(revision)
938
revs = self.revision_history()
939
if isinstance(revision, int):
941
revno = len(revs) + revision + 1
944
rev_id = self.get_rev_id(revno, revs)
945
elif isinstance(revision, basestring):
946
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
947
if revision.startswith(prefix):
948
result = func(self, revs, revision)
950
revno, rev_id = result
953
rev_id = self.get_rev_id(revno, revs)
956
raise BzrError('No namespace registered for string: %r' %
959
raise TypeError('Unhandled revision type %s' % revision)
963
raise bzrlib.errors.NoSuchRevision(self, revision)
966
def _namespace_revno(self, revs, revision):
967
"""Lookup a revision by revision number"""
968
assert revision.startswith('revno:')
970
return (int(revision[6:]),)
973
REVISION_NAMESPACES['revno:'] = _namespace_revno
975
def _namespace_revid(self, revs, revision):
976
assert revision.startswith('revid:')
977
rev_id = revision[len('revid:'):]
979
return revs.index(rev_id) + 1, rev_id
982
REVISION_NAMESPACES['revid:'] = _namespace_revid
984
def _namespace_last(self, revs, revision):
985
assert revision.startswith('last:')
987
offset = int(revision[5:])
992
raise BzrError('You must supply a positive value for --revision last:XXX')
993
return (len(revs) - offset + 1,)
994
REVISION_NAMESPACES['last:'] = _namespace_last
996
def _namespace_tag(self, revs, revision):
997
assert revision.startswith('tag:')
998
raise BzrError('tag: namespace registered, but not implemented.')
999
REVISION_NAMESPACES['tag:'] = _namespace_tag
1001
def _namespace_date(self, revs, revision):
1002
assert revision.startswith('date:')
1004
# Spec for date revisions:
1006
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1007
# it can also start with a '+/-/='. '+' says match the first
1008
# entry after the given date. '-' is match the first entry before the date
1009
# '=' is match the first entry after, but still on the given date.
1011
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1012
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1013
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1014
# May 13th, 2005 at 0:00
1016
# So the proper way of saying 'give me all entries for today' is:
1017
# -r {date:+today}:{date:-tomorrow}
1018
# The default is '=' when not supplied
1021
if val[:1] in ('+', '-', '='):
1022
match_style = val[:1]
1025
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1026
if val.lower() == 'yesterday':
1027
dt = today - datetime.timedelta(days=1)
1028
elif val.lower() == 'today':
1030
elif val.lower() == 'tomorrow':
1031
dt = today + datetime.timedelta(days=1)
1034
# This should be done outside the function to avoid recompiling it.
1035
_date_re = re.compile(
1036
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1038
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1040
m = _date_re.match(val)
1041
if not m or (not m.group('date') and not m.group('time')):
1042
raise BzrError('Invalid revision date %r' % revision)
1045
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1047
year, month, day = today.year, today.month, today.day
1049
hour = int(m.group('hour'))
1050
minute = int(m.group('minute'))
1051
if m.group('second'):
1052
second = int(m.group('second'))
1056
hour, minute, second = 0,0,0
1058
dt = datetime.datetime(year=year, month=month, day=day,
1059
hour=hour, minute=minute, second=second)
1063
if match_style == '-':
1065
elif match_style == '=':
1066
last = dt + datetime.timedelta(days=1)
1069
for i in range(len(revs)-1, -1, -1):
1070
r = self.get_revision(revs[i])
1071
# TODO: Handle timezone.
1072
dt = datetime.datetime.fromtimestamp(r.timestamp)
1073
if first >= dt and (last is None or dt >= last):
1076
for i in range(len(revs)):
1077
r = self.get_revision(revs[i])
1078
# TODO: Handle timezone.
1079
dt = datetime.datetime.fromtimestamp(r.timestamp)
1080
if first <= dt and (last is None or dt <= last):
1082
REVISION_NAMESPACES['date:'] = _namespace_date
1084
def revision_tree(self, revision_id):
1085
"""Return Tree for a revision on this branch.
1087
`revision_id` may be None for the null revision, in which case
1088
an `EmptyTree` is returned."""
1089
# TODO: refactor this to use an existing revision object
1090
# so we don't need to read it in twice.
1091
if revision_id == None:
1094
inv = self.get_revision_inventory(revision_id)
1095
return RevisionTree(self.weave_store, inv, revision_id)
1098
def working_tree(self):
1099
"""Return a `Tree` for the working copy."""
1100
from workingtree import WorkingTree
1101
return WorkingTree(self.base, self.read_working_inventory())
1009
return _mod_revision.NULL_REVISION
1010
last_revno, last_revid = self.last_revision_info()
1011
if revno == last_revno:
1013
if revno <= 0 or revno > last_revno:
1014
raise errors.NoSuchRevision(self, revno)
1015
distance_from_last = last_revno - revno
1016
if len(self._partial_revision_history_cache) <= distance_from_last:
1017
self._extend_partial_history(distance_from_last)
1018
return self._partial_revision_history_cache[distance_from_last]
1021
def pull(self, source, overwrite=False, stop_revision=None,
1022
possible_transports=None, *args, **kwargs):
1023
"""Mirror source into this branch.
1025
This branch is considered to be 'local', having low latency.
1027
:returns: PullResult instance
1029
return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
stop_revision=stop_revision,
1031
possible_transports=possible_transports, *args, **kwargs)
1033
def push(self, target, overwrite=False, stop_revision=None, *args,
1035
"""Mirror this branch into target.
1037
This branch is considered to be 'local', having low latency.
1039
return InterBranch.get(self, target).push(overwrite, stop_revision,
1042
def lossy_push(self, target, stop_revision=None):
1043
"""Push deltas into another branch.
1045
:note: This does not, like push, retain the revision ids from
1046
the source branch and will, rather than adding bzr-specific
1047
metadata, push only those semantics of the revision that can be
1048
natively represented by this branch' VCS.
1050
:param target: Target branch
1051
:param stop_revision: Revision to push, defaults to last revision.
1052
:return: BranchPushResult with an extra member revidmap:
1053
A dictionary mapping revision ids from the target branch
1054
to new revision ids in the target branch, for each
1055
revision that was pushed.
1057
inter = InterBranch.get(self, target)
1058
lossy_push = getattr(inter, "lossy_push", None)
1059
if lossy_push is None:
1060
raise errors.LossyPushToSameVCS(self, target)
1061
return lossy_push(stop_revision)
1104
1063
def basis_tree(self):
1105
"""Return `Tree` object for last revision.
1107
If there are no revisions yet, return an `EmptyTree`.
1109
return self.revision_tree(self.last_patch())
1112
def rename_one(self, from_rel, to_rel):
1115
This can change the directory or the filename or both.
1119
tree = self.working_tree()
1120
inv = tree.inventory
1121
if not tree.has_filename(from_rel):
1122
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1123
if tree.has_filename(to_rel):
1124
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1126
file_id = inv.path2id(from_rel)
1128
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1130
if inv.path2id(to_rel):
1131
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1133
to_dir, to_tail = os.path.split(to_rel)
1134
to_dir_id = inv.path2id(to_dir)
1135
if to_dir_id == None and to_dir != '':
1136
raise BzrError("can't determine destination directory id for %r" % to_dir)
1138
mutter("rename_one:")
1139
mutter(" file_id {%s}" % file_id)
1140
mutter(" from_rel %r" % from_rel)
1141
mutter(" to_rel %r" % to_rel)
1142
mutter(" to_dir %r" % to_dir)
1143
mutter(" to_dir_id {%s}" % to_dir_id)
1145
inv.rename(file_id, to_dir_id, to_tail)
1147
from_abs = self.abspath(from_rel)
1148
to_abs = self.abspath(to_rel)
1150
os.rename(from_abs, to_abs)
1152
raise BzrError("failed to rename %r to %r: %s"
1153
% (from_abs, to_abs, e[1]),
1154
["rename rolled back"])
1156
self._write_inventory(inv)
1161
def move(self, from_paths, to_name):
1164
to_name must exist as a versioned directory.
1166
If to_name exists and is a directory, the files are moved into
1167
it, keeping their old names. If it is a directory,
1169
Note that to_name is only the last component of the new name;
1170
this doesn't change the directory.
1172
This returns a list of (from_path, to_path) pairs for each
1173
entry that is moved.
1178
## TODO: Option to move IDs only
1179
assert not isinstance(from_paths, basestring)
1180
tree = self.working_tree()
1181
inv = tree.inventory
1182
to_abs = self.abspath(to_name)
1183
if not isdir(to_abs):
1184
raise BzrError("destination %r is not a directory" % to_abs)
1185
if not tree.has_filename(to_name):
1186
raise BzrError("destination %r not in working directory" % to_abs)
1187
to_dir_id = inv.path2id(to_name)
1188
if to_dir_id == None and to_name != '':
1189
raise BzrError("destination %r is not a versioned directory" % to_name)
1190
to_dir_ie = inv[to_dir_id]
1191
if to_dir_ie.kind not in ('directory', 'root_directory'):
1192
raise BzrError("destination %r is not a directory" % to_abs)
1194
to_idpath = inv.get_idpath(to_dir_id)
1196
for f in from_paths:
1197
if not tree.has_filename(f):
1198
raise BzrError("%r does not exist in working tree" % f)
1199
f_id = inv.path2id(f)
1201
raise BzrError("%r is not versioned" % f)
1202
name_tail = splitpath(f)[-1]
1203
dest_path = appendpath(to_name, name_tail)
1204
if tree.has_filename(dest_path):
1205
raise BzrError("destination %r already exists" % dest_path)
1206
if f_id in to_idpath:
1207
raise BzrError("can't move %r to a subdirectory of itself" % f)
1209
# OK, so there's a race here, it's possible that someone will
1210
# create a file in this interval and then the rename might be
1211
# left half-done. But we should have caught most problems.
1213
for f in from_paths:
1214
name_tail = splitpath(f)[-1]
1215
dest_path = appendpath(to_name, name_tail)
1216
result.append((f, dest_path))
1217
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1219
os.rename(self.abspath(f), self.abspath(dest_path))
1221
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1222
["rename rolled back"])
1224
self._write_inventory(inv)
1231
def revert(self, filenames, old_tree=None, backups=True):
1232
"""Restore selected files to the versions from a previous tree.
1235
If true (default) backups are made of files before
1238
from bzrlib.errors import NotVersionedError, BzrError
1239
from bzrlib.atomicfile import AtomicFile
1240
from bzrlib.osutils import backup_file
1242
inv = self.read_working_inventory()
1243
if old_tree is None:
1244
old_tree = self.basis_tree()
1245
old_inv = old_tree.inventory
1248
for fn in filenames:
1249
file_id = inv.path2id(fn)
1251
raise NotVersionedError("not a versioned file", fn)
1252
if not old_inv.has_id(file_id):
1253
raise BzrError("file not present in old tree", fn, file_id)
1254
nids.append((fn, file_id))
1256
# TODO: Rename back if it was previously at a different location
1258
# TODO: If given a directory, restore the entire contents from
1259
# the previous version.
1261
# TODO: Make a backup to a temporary file.
1263
# TODO: If the file previously didn't exist, delete it?
1264
for fn, file_id in nids:
1267
f = AtomicFile(fn, 'wb')
1269
f.write(old_tree.get_file(file_id).read())
1275
def pending_merges(self):
1276
"""Return a list of pending merges.
1278
These are revisions that have been merged into the working
1279
directory but not yet committed.
1281
cfn = self.controlfilename('pending-merges')
1282
if not os.path.exists(cfn):
1285
for l in self.controlfile('pending-merges', 'r').readlines():
1286
p.append(l.rstrip('\n'))
1290
def add_pending_merge(self, revision_id):
1291
from bzrlib.revision import validate_revision_id
1293
validate_revision_id(revision_id)
1295
p = self.pending_merges()
1296
if revision_id in p:
1298
p.append(revision_id)
1299
self.set_pending_merges(p)
1302
def set_pending_merges(self, rev_list):
1303
from bzrlib.atomicfile import AtomicFile
1306
f = AtomicFile(self.controlfilename('pending-merges'))
1064
"""Return `Tree` object for last revision."""
1065
return self.repository.revision_tree(self.last_revision())
1317
1067
def get_parent(self):
1318
1068
"""Return the parent location of the branch.
1320
This is the default location for push/pull/missing. The usual
1321
pattern is that the user can override it by specifying a
1325
_locs = ['parent', 'pull', 'x-pull']
1328
return self.controlfile(l, 'r').read().strip('\n')
1330
if e.errno != errno.ENOENT:
1070
This is the default location for pull/missing. The usual
1071
pattern is that the user can override it by specifying a
1074
parent = self._get_parent_location()
1077
# This is an old-format absolute path to a local branch
1078
# turn it into a url
1079
if parent.startswith('/'):
1080
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1082
return urlutils.join(self.base[:-1], parent)
1083
except errors.InvalidURLJoin, e:
1084
raise errors.InaccessibleParent(parent, self.user_url)
1086
def _get_parent_location(self):
1087
raise NotImplementedError(self._get_parent_location)
1089
def _set_config_location(self, name, url, config=None,
1090
make_relative=False):
1092
config = self.get_config()
1096
url = urlutils.relative_url(self.base, url)
1097
config.set_user_option(name, url, warn_masked=True)
1099
def _get_config_location(self, name, config=None):
1101
config = self.get_config()
1102
location = config.get_user_option(name)
1107
def get_child_submit_format(self):
1108
"""Return the preferred format of submissions to this branch."""
1109
return self.get_config().get_user_option("child_submit_format")
1111
def get_submit_branch(self):
1112
"""Return the submit location of the branch.
1114
This is the default location for bundle. The usual
1115
pattern is that the user can override it by specifying a
1118
return self.get_config().get_user_option('submit_branch')
1120
def set_submit_branch(self, location):
1121
"""Return the submit location of the branch.
1123
This is the default location for bundle. The usual
1124
pattern is that the user can override it by specifying a
1127
self.get_config().set_user_option('submit_branch', location,
1130
def get_public_branch(self):
1131
"""Return the public location of the branch.
1133
This is used by merge directives.
1135
return self._get_config_location('public_branch')
1137
def set_public_branch(self, location):
1138
"""Return the submit location of the branch.
1140
This is the default location for bundle. The usual
1141
pattern is that the user can override it by specifying a
1144
self._set_config_location('public_branch', location)
1146
def get_push_location(self):
1147
"""Return the None or the location to push this branch to."""
1148
push_loc = self.get_config().get_user_option('push_location')
1151
def set_push_location(self, location):
1152
"""Set a new push location for this branch."""
1153
raise NotImplementedError(self.set_push_location)
1155
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1156
"""Run the post_change_branch_tip hooks."""
1157
hooks = Branch.hooks['post_change_branch_tip']
1160
new_revno, new_revid = self.last_revision_info()
1161
params = ChangeBranchTipParams(
1162
self, old_revno, new_revno, old_revid, new_revid)
1166
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1167
"""Run the pre_change_branch_tip hooks."""
1168
hooks = Branch.hooks['pre_change_branch_tip']
1171
old_revno, old_revid = self.last_revision_info()
1172
params = ChangeBranchTipParams(
1173
self, old_revno, new_revno, old_revid, new_revid)
1179
"""Synchronise this branch with the master branch if any.
1181
:return: None or the last_revision pivoted out during the update.
1335
def set_parent(self, url):
1336
# TODO: Maybe delete old location files?
1337
from bzrlib.atomicfile import AtomicFile
1340
f = AtomicFile(self.controlfilename('parent'))
1349
1185
def check_revno(self, revno):
1351
1187
Check whether a revno corresponds to any revision.
1355
1191
self.check_real_revno(revno)
1357
1193
def check_real_revno(self, revno):
1359
1195
Check whether a revno corresponds to a real revision.
1360
1196
Zero (the NULL revision) is considered invalid
1362
1198
if revno < 1 or revno > self.revno():
1363
raise InvalidRevisionNumber(revno)
1368
class ScratchBranch(Branch):
1369
"""Special test class: a branch that cleans up after itself.
1371
>>> b = ScratchBranch()
1379
def __init__(self, files=[], dirs=[], base=None):
1380
"""Make a test branch.
1382
This creates a temporary directory and runs init-tree in it.
1384
If any files are listed, they are created in the working copy.
1386
from tempfile import mkdtemp
1391
Branch.__init__(self, base, init=init)
1393
os.mkdir(self.abspath(d))
1396
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1401
>>> orig = ScratchBranch(files=["file1", "file2"])
1402
>>> clone = orig.clone()
1403
>>> os.path.samefile(orig.base, clone.base)
1405
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1408
from shutil import copytree
1409
from tempfile import mkdtemp
1412
copytree(self.base, base, symlinks=True)
1413
return ScratchBranch(base=base)
1421
"""Destroy the test branch, removing the scratch directory."""
1422
from shutil import rmtree
1425
mutter("delete ScratchBranch %s" % self.base)
1428
# Work around for shutil.rmtree failing on Windows when
1429
# readonly files are encountered
1430
mutter("hit exception in destroying ScratchBranch: %s" % e)
1431
for root, dirs, files in os.walk(self.base, topdown=False):
1433
os.chmod(os.path.join(root, name), 0700)
1199
raise errors.InvalidRevisionNumber(revno)
1202
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1203
"""Clone this branch into to_bzrdir preserving all semantic values.
1205
Most API users will want 'create_clone_on_transport', which creates a
1206
new bzrdir and branch on the fly.
1208
revision_id: if not None, the revision history in the new branch will
1209
be truncated to end with revision_id.
1211
result = to_bzrdir.create_branch()
1214
if repository_policy is not None:
1215
repository_policy.configure_branch(result)
1216
self.copy_content_into(result, revision_id=revision_id)
1222
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1223
"""Create a new line of development from the branch, into to_bzrdir.
1225
to_bzrdir controls the branch format.
1227
revision_id: if not None, the revision history in the new branch will
1228
be truncated to end with revision_id.
1230
if (repository_policy is not None and
1231
repository_policy.requires_stacking()):
1232
to_bzrdir._format.require_stacking(_skip_repo=True)
1233
result = to_bzrdir.create_branch()
1236
if repository_policy is not None:
1237
repository_policy.configure_branch(result)
1238
self.copy_content_into(result, revision_id=revision_id)
1239
result.set_parent(self.bzrdir.root_transport.base)
1244
def _synchronize_history(self, destination, revision_id):
1245
"""Synchronize last revision and revision history between branches.
1247
This version is most efficient when the destination is also a
1248
BzrBranch6, but works for BzrBranch5, as long as the destination's
1249
repository contains all the lefthand ancestors of the intended
1250
last_revision. If not, set_last_revision_info will fail.
1252
:param destination: The branch to copy the history into
1253
:param revision_id: The revision-id to truncate history at. May
1254
be None to copy complete history.
1256
source_revno, source_revision_id = self.last_revision_info()
1257
if revision_id is None:
1258
revno, revision_id = source_revno, source_revision_id
1260
graph = self.repository.get_graph()
1262
revno = graph.find_distance_to_null(revision_id,
1263
[(source_revision_id, source_revno)])
1264
except errors.GhostRevisionsHaveNoRevno:
1265
# Default to 1, if we can't find anything else
1267
destination.set_last_revision_info(revno, revision_id)
1270
def copy_content_into(self, destination, revision_id=None):
1271
"""Copy the content of self into destination.
1273
revision_id: if not None, the revision history in the new branch will
1274
be truncated to end with revision_id.
1276
self.update_references(destination)
1277
self._synchronize_history(destination, revision_id)
1279
parent = self.get_parent()
1280
except errors.InaccessibleParent, e:
1281
mutter('parent was not accessible to copy: %s', e)
1284
destination.set_parent(parent)
1285
if self._push_should_merge_tags():
1286
self.tags.merge_to(destination.tags)
1288
def update_references(self, target):
1289
if not getattr(self._format, 'supports_reference_locations', False):
1291
reference_dict = self._get_all_reference_info()
1292
if len(reference_dict) == 0:
1294
old_base = self.base
1295
new_base = target.base
1296
target_reference_dict = target._get_all_reference_info()
1297
for file_id, (tree_path, branch_location) in (
1298
reference_dict.items()):
1299
branch_location = urlutils.rebase_url(branch_location,
1301
target_reference_dict.setdefault(
1302
file_id, (tree_path, branch_location))
1303
target._set_all_reference_info(target_reference_dict)
1306
def check(self, refs):
1307
"""Check consistency of the branch.
1309
In particular this checks that revisions given in the revision-history
1310
do actually match up in the revision graph, and that they're all
1311
present in the repository.
1313
Callers will typically also want to check the repository.
1315
:param refs: Calculated refs for this branch as specified by
1316
branch._get_check_refs()
1317
:return: A BranchCheckResult.
1319
result = BranchCheckResult(self)
1320
last_revno, last_revision_id = self.last_revision_info()
1321
actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
if actual_revno != last_revno:
1323
result.errors.append(errors.BzrCheckError(
1324
'revno does not match len(mainline) %s != %s' % (
1325
last_revno, actual_revno)))
1326
# TODO: We should probably also check that self.revision_history
1327
# matches the repository for older branch formats.
1328
# If looking for the code that cross-checks repository parents against
1329
# the iter_reverse_revision_history output, that is now a repository
1333
def _get_checkout_format(self):
1334
"""Return the most suitable metadir for a checkout of this branch.
1335
Weaves are used if this branch's repository uses weaves.
1337
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1338
from bzrlib.repofmt import weaverepo
1339
format = bzrdir.BzrDirMetaFormat1()
1340
format.repository_format = weaverepo.RepositoryFormat7()
1342
format = self.repository.bzrdir.checkout_metadir()
1343
format.set_branch_format(self._format)
1346
def create_clone_on_transport(self, to_transport, revision_id=None,
1347
stacked_on=None, create_prefix=False, use_existing_dir=False):
1348
"""Create a clone of this branch and its bzrdir.
1350
:param to_transport: The transport to clone onto.
1351
:param revision_id: The revision id to use as tip in the new branch.
1352
If None the tip is obtained from this branch.
1353
:param stacked_on: An optional URL to stack the clone on.
1354
:param create_prefix: Create any missing directories leading up to
1356
:param use_existing_dir: Use an existing directory if one exists.
1358
# XXX: Fix the bzrdir API to allow getting the branch back from the
1359
# clone call. Or something. 20090224 RBC/spiv.
1360
if revision_id is None:
1361
revision_id = self.last_revision()
1362
dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
revision_id=revision_id, stacked_on=stacked_on,
1364
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1365
return dir_to.open_branch()
1367
def create_checkout(self, to_location, revision_id=None,
1368
lightweight=False, accelerator_tree=None,
1370
"""Create a checkout of a branch.
1372
:param to_location: The url to produce the checkout at
1373
:param revision_id: The revision to check out
1374
:param lightweight: If True, produce a lightweight checkout, otherwise,
1375
produce a bound branch (heavyweight checkout)
1376
:param accelerator_tree: A tree which can be used for retrieving file
1377
contents more quickly than the revision tree, i.e. a workingtree.
1378
The revision tree will be used for cases where accelerator_tree's
1379
content is different.
1380
:param hardlink: If true, hard-link files from accelerator_tree,
1382
:return: The tree of the created checkout
1384
t = transport.get_transport(to_location)
1387
format = self._get_checkout_format()
1388
checkout = format.initialize_on_transport(t)
1389
from_branch = BranchReferenceFormat().initialize(checkout,
1392
format = self._get_checkout_format()
1393
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1394
to_location, force_new_tree=False, format=format)
1395
checkout = checkout_branch.bzrdir
1396
checkout_branch.bind(self)
1397
# pull up to the specified revision_id to set the initial
1398
# branch tip correctly, and seed it with history.
1399
checkout_branch.pull(self, stop_revision=revision_id)
1401
tree = checkout.create_workingtree(revision_id,
1402
from_branch=from_branch,
1403
accelerator_tree=accelerator_tree,
1405
basis_tree = tree.basis_tree()
1406
basis_tree.lock_read()
1408
for path, file_id in basis_tree.iter_references():
1409
reference_parent = self.reference_parent(file_id, path)
1410
reference_parent.create_checkout(tree.abspath(path),
1411
basis_tree.get_reference_revision(file_id, path),
1418
def reconcile(self, thorough=True):
1419
"""Make sure the data stored in this branch is consistent."""
1420
from bzrlib.reconcile import BranchReconciler
1421
reconciler = BranchReconciler(self, thorough=thorough)
1422
reconciler.reconcile()
1425
def reference_parent(self, file_id, path, possible_transports=None):
1426
"""Return the parent branch for a tree-reference file_id
1427
:param file_id: The file_id of the tree reference
1428
:param path: The path of the file_id in the tree
1429
:return: A branch associated with the file_id
1431
# FIXME should provide multiple branches, based on config
1432
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1433
possible_transports=possible_transports)
1435
def supports_tags(self):
1436
return self._format.supports_tags()
1438
def automatic_tag_name(self, revision_id):
1439
"""Try to automatically find the tag name for a revision.
1441
:param revision_id: Revision id of the revision.
1442
:return: A tag name or None if no tag name could be determined.
1444
for hook in Branch.hooks['automatic_tag_name']:
1445
ret = hook(self, revision_id)
1450
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
"""Ensure that revision_b is a descendant of revision_a.
1454
This is a helper function for update_revisions.
1456
:raises: DivergedBranches if revision_b has diverged from revision_a.
1457
:returns: True if revision_b is a descendant of revision_a.
1459
relation = self._revision_relations(revision_a, revision_b, graph)
1460
if relation == 'b_descends_from_a':
1462
elif relation == 'diverged':
1463
raise errors.DivergedBranches(self, other_branch)
1464
elif relation == 'a_descends_from_b':
1467
raise AssertionError("invalid relation: %r" % (relation,))
1469
def _revision_relations(self, revision_a, revision_b, graph):
1470
"""Determine the relationship between two revisions.
1472
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1474
heads = graph.heads([revision_a, revision_b])
1475
if heads == set([revision_b]):
1476
return 'b_descends_from_a'
1477
elif heads == set([revision_a, revision_b]):
1478
# These branches have diverged
1480
elif heads == set([revision_a]):
1481
return 'a_descends_from_b'
1483
raise AssertionError("invalid heads: %r" % (heads,))
1486
class BranchFormat(object):
1487
"""An encapsulation of the initialization and open routines for a format.
1489
Formats provide three things:
1490
* An initialization routine,
1494
Formats are placed in an dict by their format string for reference
1495
during branch opening. Its not required that these be instances, they
1496
can be classes themselves with class methods - it simply depends on
1497
whether state is needed for a given format or not.
1499
Once a format is deprecated, just deprecate the initialize and open
1500
methods on the format class. Do not deprecate the object, as the
1501
object will be created every time regardless.
1504
_default_format = None
1505
"""The default format used for new branches."""
1508
"""The known formats."""
1510
can_set_append_revisions_only = True
1512
def __eq__(self, other):
1513
return self.__class__ is other.__class__
1515
def __ne__(self, other):
1516
return not (self == other)
1519
def find_format(klass, a_bzrdir, name=None):
1520
"""Return the format for the branch object in a_bzrdir."""
1522
transport = a_bzrdir.get_branch_transport(None, name=name)
1523
format_string = transport.get_bytes("format")
1524
return klass._formats[format_string]
1525
except errors.NoSuchFile:
1526
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1528
raise errors.UnknownFormatError(format=format_string, kind='branch')
1531
def get_default_format(klass):
1532
"""Return the current default format."""
1533
return klass._default_format
1535
def get_reference(self, a_bzrdir):
1536
"""Get the target reference of the branch in a_bzrdir.
1538
format probing must have been completed before calling
1539
this method - it is assumed that the format of the branch
1540
in a_bzrdir is correct.
1542
:param a_bzrdir: The bzrdir to get the branch data from.
1543
:return: None if the branch is not a reference branch.
1548
def set_reference(self, a_bzrdir, to_branch):
1549
"""Set the target reference of the branch in a_bzrdir.
1551
format probing must have been completed before calling
1552
this method - it is assumed that the format of the branch
1553
in a_bzrdir is correct.
1555
:param a_bzrdir: The bzrdir to set the branch reference for.
1556
:param to_branch: branch that the checkout is to reference
1558
raise NotImplementedError(self.set_reference)
1560
def get_format_string(self):
1561
"""Return the ASCII format string that identifies this format."""
1562
raise NotImplementedError(self.get_format_string)
1564
def get_format_description(self):
1565
"""Return the short format description for this format."""
1566
raise NotImplementedError(self.get_format_description)
1568
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
hooks = Branch.hooks['post_branch_init']
1572
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1576
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
lock_type='metadir', set_format=True):
1578
"""Initialize a branch in a bzrdir, with specified files
1580
:param a_bzrdir: The bzrdir to initialize the branch in
1581
:param utf8_files: The files to create as a list of
1582
(filename, content) tuples
1583
:param name: Name of colocated branch to create, if any
1584
:param set_format: If True, set the format with
1585
self.get_format_string. (BzrBranch4 has its format set
1587
:return: a branch in this format
1589
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1592
'metadir': ('lock', lockdir.LockDir),
1593
'branch4': ('branch-lock', lockable_files.TransportLock),
1595
lock_name, lock_class = lock_map[lock_type]
1596
control_files = lockable_files.LockableFiles(branch_transport,
1597
lock_name, lock_class)
1598
control_files.create_lock()
1600
control_files.lock_write()
1601
except errors.LockContention:
1602
if lock_type != 'branch4':
1608
utf8_files += [('format', self.get_format_string())]
1610
for (filename, content) in utf8_files:
1611
branch_transport.put_bytes(
1613
mode=a_bzrdir._get_file_mode())
1616
control_files.unlock()
1617
branch = self.open(a_bzrdir, name, _found=True)
1618
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1621
def initialize(self, a_bzrdir, name=None):
1622
"""Create a branch of this format in a_bzrdir.
1624
:param name: Name of the colocated branch to create.
1626
raise NotImplementedError(self.initialize)
1628
def is_supported(self):
1629
"""Is this format supported?
1631
Supported formats can be initialized and opened.
1632
Unsupported formats may not support initialization or committing or
1633
some other features depending on the reason for not being supported.
1637
def make_tags(self, branch):
1638
"""Create a tags object for branch.
1640
This method is on BranchFormat, because BranchFormats are reflected
1641
over the wire via network_name(), whereas full Branch instances require
1642
multiple VFS method calls to operate at all.
1644
The default implementation returns a disabled-tags instance.
1646
Note that it is normal for branch to be a RemoteBranch when using tags
1649
return DisabledTags(branch)
1651
def network_name(self):
1652
"""A simple byte string uniquely identifying this format for RPC calls.
1654
MetaDir branch formats use their disk format string to identify the
1655
repository over the wire. All in one formats such as bzr < 0.8, and
1656
foreign formats like svn/git and hg should use some marker which is
1657
unique and immutable.
1659
raise NotImplementedError(self.network_name)
1661
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1662
"""Return the branch object for a_bzrdir
1664
:param a_bzrdir: A BzrDir that contains a branch.
1665
:param name: Name of colocated branch to open
1666
:param _found: a private parameter, do not use it. It is used to
1667
indicate if format probing has already be done.
1668
:param ignore_fallbacks: when set, no fallback branches will be opened
1669
(if there are any). Default is to open fallbacks.
1671
raise NotImplementedError(self.open)
1674
def register_format(klass, format):
1675
"""Register a metadir format."""
1676
klass._formats[format.get_format_string()] = format
1677
# Metadir formats have a network name of their format string, and get
1678
# registered as class factories.
1679
network_format_registry.register(format.get_format_string(), format.__class__)
1682
def set_default_format(klass, format):
1683
klass._default_format = format
1685
def supports_set_append_revisions_only(self):
1686
"""True if this format supports set_append_revisions_only."""
1689
def supports_stacking(self):
1690
"""True if this format records a stacked-on branch."""
1694
def unregister_format(klass, format):
1695
del klass._formats[format.get_format_string()]
1698
return self.get_format_description().rstrip()
1700
def supports_tags(self):
1701
"""True if this format supports tags stored in the branch"""
1702
return False # by default
1705
class BranchHooks(Hooks):
1706
"""A dictionary mapping hook name to a list of callables for branch hooks.
1708
e.g. ['set_rh'] Is the list of items to be called when the
1709
set_revision_history function is invoked.
1713
"""Create the default hooks.
1715
These are all empty initially, because by default nothing should get
1718
Hooks.__init__(self)
1719
self.create_hook(HookPoint('set_rh',
1720
"Invoked whenever the revision history has been set via "
1721
"set_revision_history. The api signature is (branch, "
1722
"revision_history), and the branch will be write-locked. "
1723
"The set_rh hook can be expensive for bzr to trigger, a better "
1724
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1725
self.create_hook(HookPoint('open',
1726
"Called with the Branch object that has been opened after a "
1727
"branch is opened.", (1, 8), None))
1728
self.create_hook(HookPoint('post_push',
1729
"Called after a push operation completes. post_push is called "
1730
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1731
"bzr client.", (0, 15), None))
1732
self.create_hook(HookPoint('post_pull',
1733
"Called after a pull operation completes. post_pull is called "
1734
"with a bzrlib.branch.PullResult object and only runs in the "
1735
"bzr client.", (0, 15), None))
1736
self.create_hook(HookPoint('pre_commit',
1737
"Called after a commit is calculated but before it is is "
1738
"completed. pre_commit is called with (local, master, old_revno, "
1739
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1740
"). old_revid is NULL_REVISION for the first commit to a branch, "
1741
"tree_delta is a TreeDelta object describing changes from the "
1742
"basis revision. hooks MUST NOT modify this delta. "
1743
" future_tree is an in-memory tree obtained from "
1744
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1745
"tree.", (0,91), None))
1746
self.create_hook(HookPoint('post_commit',
1747
"Called in the bzr client after a commit has completed. "
1748
"post_commit is called with (local, master, old_revno, old_revid, "
1749
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1750
"commit to a branch.", (0, 15), None))
1751
self.create_hook(HookPoint('post_uncommit',
1752
"Called in the bzr client after an uncommit completes. "
1753
"post_uncommit is called with (local, master, old_revno, "
1754
"old_revid, new_revno, new_revid) where local is the local branch "
1755
"or None, master is the target branch, and an empty branch "
1756
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1757
self.create_hook(HookPoint('pre_change_branch_tip',
1758
"Called in bzr client and server before a change to the tip of a "
1759
"branch is made. pre_change_branch_tip is called with a "
1760
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1761
"commit, uncommit will all trigger this hook.", (1, 6), None))
1762
self.create_hook(HookPoint('post_change_branch_tip',
1763
"Called in bzr client and server after a change to the tip of a "
1764
"branch is made. post_change_branch_tip is called with a "
1765
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1766
"commit, uncommit will all trigger this hook.", (1, 4), None))
1767
self.create_hook(HookPoint('transform_fallback_location',
1768
"Called when a stacked branch is activating its fallback "
1769
"locations. transform_fallback_location is called with (branch, "
1770
"url), and should return a new url. Returning the same url "
1771
"allows it to be used as-is, returning a different one can be "
1772
"used to cause the branch to stack on a closer copy of that "
1773
"fallback_location. Note that the branch cannot have history "
1774
"accessing methods called on it during this hook because the "
1775
"fallback locations have not been activated. When there are "
1776
"multiple hooks installed for transform_fallback_location, "
1777
"all are called with the url returned from the previous hook."
1778
"The order is however undefined.", (1, 9), None))
1779
self.create_hook(HookPoint('automatic_tag_name',
1780
"Called to determine an automatic tag name for a revision."
1781
"automatic_tag_name is called with (branch, revision_id) and "
1782
"should return a tag name or None if no tag name could be "
1783
"determined. The first non-None tag name returned will be used.",
1785
self.create_hook(HookPoint('post_branch_init',
1786
"Called after new branch initialization completes. "
1787
"post_branch_init is called with a "
1788
"bzrlib.branch.BranchInitHookParams. "
1789
"Note that init, branch and checkout (both heavyweight and "
1790
"lightweight) will all trigger this hook.", (2, 2), None))
1791
self.create_hook(HookPoint('post_switch',
1792
"Called after a checkout switches branch. "
1793
"post_switch is called with a "
1794
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1798
# install the default hooks into the Branch class.
1799
Branch.hooks = BranchHooks()
1802
class ChangeBranchTipParams(object):
1803
"""Object holding parameters passed to *_change_branch_tip hooks.
1805
There are 5 fields that hooks may wish to access:
1807
:ivar branch: the branch being changed
1808
:ivar old_revno: revision number before the change
1809
:ivar new_revno: revision number after the change
1810
:ivar old_revid: revision id before the change
1811
:ivar new_revid: revision id after the change
1813
The revid fields are strings. The revno fields are integers.
1816
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1817
"""Create a group of ChangeBranchTip parameters.
1819
:param branch: The branch being changed.
1820
:param old_revno: Revision number before the change.
1821
:param new_revno: Revision number after the change.
1822
:param old_revid: Tip revision id before the change.
1823
:param new_revid: Tip revision id after the change.
1825
self.branch = branch
1826
self.old_revno = old_revno
1827
self.new_revno = new_revno
1828
self.old_revid = old_revid
1829
self.new_revid = new_revid
1831
def __eq__(self, other):
1832
return self.__dict__ == other.__dict__
1835
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1836
self.__class__.__name__, self.branch,
1837
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1840
class BranchInitHookParams(object):
1841
"""Object holding parameters passed to *_branch_init hooks.
1843
There are 4 fields that hooks may wish to access:
1845
:ivar format: the branch format
1846
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
:ivar name: name of colocated branch, if any (or None)
1848
:ivar branch: the branch created
1850
Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
the checkout, hence they are different from the corresponding fields in
1852
branch, which refer to the original branch.
1855
def __init__(self, format, a_bzrdir, name, branch):
1856
"""Create a group of BranchInitHook parameters.
1858
:param format: the branch format
1859
:param a_bzrdir: the BzrDir where the branch will be/has been
1861
:param name: name of colocated branch, if any (or None)
1862
:param branch: the branch created
1864
Note that for lightweight checkouts, the bzrdir and format fields refer
1865
to the checkout, hence they are different from the corresponding fields
1866
in branch, which refer to the original branch.
1868
self.format = format
1869
self.bzrdir = a_bzrdir
1871
self.branch = branch
1873
def __eq__(self, other):
1874
return self.__dict__ == other.__dict__
1878
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1880
return "<%s of format:%s bzrdir:%s>" % (
1881
self.__class__.__name__, self.branch,
1882
self.format, self.bzrdir)
1885
class SwitchHookParams(object):
1886
"""Object holding parameters passed to *_switch hooks.
1888
There are 4 fields that hooks may wish to access:
1890
:ivar control_dir: BzrDir of the checkout to change
1891
:ivar to_branch: branch that the checkout is to reference
1892
:ivar force: skip the check for local commits in a heavy checkout
1893
:ivar revision_id: revision ID to switch to (or None)
1896
def __init__(self, control_dir, to_branch, force, revision_id):
1897
"""Create a group of SwitchHook parameters.
1899
:param control_dir: BzrDir of the checkout to change
1900
:param to_branch: branch that the checkout is to reference
1901
:param force: skip the check for local commits in a heavy checkout
1902
:param revision_id: revision ID to switch to (or None)
1904
self.control_dir = control_dir
1905
self.to_branch = to_branch
1907
self.revision_id = revision_id
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
self.control_dir, self.to_branch,
1918
class BzrBranchFormat4(BranchFormat):
1919
"""Bzr branch format 4.
1922
- a revision-history file.
1923
- a branch-lock lock file [ to be shared with the bzrdir ]
1926
def get_format_description(self):
1927
"""See BranchFormat.get_format_description()."""
1928
return "Branch format 4"
1930
def initialize(self, a_bzrdir, name=None):
1931
"""Create a branch of this format in a_bzrdir."""
1932
utf8_files = [('revision-history', ''),
1933
('branch-name', ''),
1935
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1936
lock_type='branch4', set_format=False)
1939
super(BzrBranchFormat4, self).__init__()
1940
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1942
def network_name(self):
1943
"""The network name for this format is the control dirs disk label."""
1944
return self._matchingbzrdir.get_format_string()
1946
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1947
"""See BranchFormat.open()."""
1949
# we are being called directly and must probe.
1950
raise NotImplementedError
1951
return BzrBranch(_format=self,
1952
_control_files=a_bzrdir._control_files,
1955
_repository=a_bzrdir.open_repository())
1958
return "Bazaar-NG branch format 4"
1961
class BranchFormatMetadir(BranchFormat):
1962
"""Common logic for meta-dir based branch formats."""
1964
def _branch_class(self):
1965
"""What class to instantiate on open calls."""
1966
raise NotImplementedError(self._branch_class)
1968
def network_name(self):
1969
"""A simple byte string uniquely identifying this format for RPC calls.
1971
Metadir branch formats use their format string.
1973
return self.get_format_string()
1975
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1976
"""See BranchFormat.open()."""
1978
format = BranchFormat.find_format(a_bzrdir, name=name)
1979
if format.__class__ != self.__class__:
1980
raise AssertionError("wrong format %r found for %r" %
1982
transport = a_bzrdir.get_branch_transport(None, name=name)
1984
control_files = lockable_files.LockableFiles(transport, 'lock',
1986
return self._branch_class()(_format=self,
1987
_control_files=control_files,
1990
_repository=a_bzrdir.find_repository(),
1991
ignore_fallbacks=ignore_fallbacks)
1992
except errors.NoSuchFile:
1993
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1996
super(BranchFormatMetadir, self).__init__()
1997
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1998
self._matchingbzrdir.set_branch_format(self)
2000
def supports_tags(self):
2004
class BzrBranchFormat5(BranchFormatMetadir):
2005
"""Bzr branch format 5.
2008
- a revision-history file.
2010
- a lock dir guarding the branch itself
2011
- all of this stored in a branch/ subdirectory
2012
- works with shared repositories.
2014
This format is new in bzr 0.8.
2017
def _branch_class(self):
2020
def get_format_string(self):
2021
"""See BranchFormat.get_format_string()."""
2022
return "Bazaar-NG branch format 5\n"
2024
def get_format_description(self):
2025
"""See BranchFormat.get_format_description()."""
2026
return "Branch format 5"
2028
def initialize(self, a_bzrdir, name=None):
2029
"""Create a branch of this format in a_bzrdir."""
2030
utf8_files = [('revision-history', ''),
2031
('branch-name', ''),
2033
return self._initialize_helper(a_bzrdir, utf8_files, name)
2035
def supports_tags(self):
2039
class BzrBranchFormat6(BranchFormatMetadir):
2040
"""Branch format with last-revision and tags.
2042
Unlike previous formats, this has no explicit revision history. Instead,
2043
this just stores the last-revision, and the left-hand history leading
2044
up to there is the history.
2046
This format was introduced in bzr 0.15
2047
and became the default in 0.91.
2050
def _branch_class(self):
2053
def get_format_string(self):
2054
"""See BranchFormat.get_format_string()."""
2055
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2057
def get_format_description(self):
2058
"""See BranchFormat.get_format_description()."""
2059
return "Branch format 6"
2061
def initialize(self, a_bzrdir, name=None):
2062
"""Create a branch of this format in a_bzrdir."""
2063
utf8_files = [('last-revision', '0 null:\n'),
2064
('branch.conf', ''),
2067
return self._initialize_helper(a_bzrdir, utf8_files, name)
2069
def make_tags(self, branch):
2070
"""See bzrlib.branch.BranchFormat.make_tags()."""
2071
return BasicTags(branch)
2073
def supports_set_append_revisions_only(self):
2077
class BzrBranchFormat8(BranchFormatMetadir):
2078
"""Metadir format supporting storing locations of subtree branches."""
2080
def _branch_class(self):
2083
def get_format_string(self):
2084
"""See BranchFormat.get_format_string()."""
2085
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2087
def get_format_description(self):
2088
"""See BranchFormat.get_format_description()."""
2089
return "Branch format 8"
2091
def initialize(self, a_bzrdir, name=None):
2092
"""Create a branch of this format in a_bzrdir."""
2093
utf8_files = [('last-revision', '0 null:\n'),
2094
('branch.conf', ''),
2098
return self._initialize_helper(a_bzrdir, utf8_files, name)
2101
super(BzrBranchFormat8, self).__init__()
2102
self._matchingbzrdir.repository_format = \
2103
RepositoryFormatKnitPack5RichRoot()
2105
def make_tags(self, branch):
2106
"""See bzrlib.branch.BranchFormat.make_tags()."""
2107
return BasicTags(branch)
2109
def supports_set_append_revisions_only(self):
2112
def supports_stacking(self):
2115
supports_reference_locations = True
2118
class BzrBranchFormat7(BzrBranchFormat8):
2119
"""Branch format with last-revision, tags, and a stacked location pointer.
2121
The stacked location pointer is passed down to the repository and requires
2122
a repository format with supports_external_lookups = True.
2124
This format was introduced in bzr 1.6.
2127
def initialize(self, a_bzrdir, name=None):
2128
"""Create a branch of this format in a_bzrdir."""
2129
utf8_files = [('last-revision', '0 null:\n'),
2130
('branch.conf', ''),
2133
return self._initialize_helper(a_bzrdir, utf8_files, name)
2135
def _branch_class(self):
2138
def get_format_string(self):
2139
"""See BranchFormat.get_format_string()."""
2140
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2142
def get_format_description(self):
2143
"""See BranchFormat.get_format_description()."""
2144
return "Branch format 7"
2146
def supports_set_append_revisions_only(self):
2149
supports_reference_locations = False
2152
class BranchReferenceFormat(BranchFormat):
2153
"""Bzr branch reference format.
2155
Branch references are used in implementing checkouts, they
2156
act as an alias to the real branch which is at some other url.
2163
def get_format_string(self):
2164
"""See BranchFormat.get_format_string()."""
2165
return "Bazaar-NG Branch Reference Format 1\n"
2167
def get_format_description(self):
2168
"""See BranchFormat.get_format_description()."""
2169
return "Checkout reference format 1"
2171
def get_reference(self, a_bzrdir):
2172
"""See BranchFormat.get_reference()."""
2173
transport = a_bzrdir.get_branch_transport(None)
2174
return transport.get_bytes('location')
2176
def set_reference(self, a_bzrdir, to_branch):
2177
"""See BranchFormat.set_reference()."""
2178
transport = a_bzrdir.get_branch_transport(None)
2179
location = transport.put_bytes('location', to_branch.base)
2181
def initialize(self, a_bzrdir, name=None, target_branch=None):
2182
"""Create a branch of this format in a_bzrdir."""
2183
if target_branch is None:
2184
# this format does not implement branch itself, thus the implicit
2185
# creation contract must see it as uninitializable
2186
raise errors.UninitializableFormat(self)
2187
mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2189
branch_transport.put_bytes('location',
2190
target_branch.bzrdir.user_url)
2191
branch_transport.put_bytes('format', self.get_format_string())
2193
a_bzrdir, name, _found=True,
2194
possible_transports=[target_branch.bzrdir.root_transport])
2195
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2199
super(BranchReferenceFormat, self).__init__()
2200
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2201
self._matchingbzrdir.set_branch_format(self)
2203
def _make_reference_clone_function(format, a_branch):
2204
"""Create a clone() routine for a branch dynamically."""
2205
def clone(to_bzrdir, revision_id=None,
2206
repository_policy=None):
2207
"""See Branch.clone()."""
2208
return format.initialize(to_bzrdir, target_branch=a_branch)
2209
# cannot obey revision_id limits when cloning a reference ...
2210
# FIXME RBC 20060210 either nuke revision_id for clone, or
2211
# emit some sort of warning/error to the caller ?!
2214
def open(self, a_bzrdir, name=None, _found=False, location=None,
2215
possible_transports=None, ignore_fallbacks=False):
2216
"""Return the branch that the branch reference in a_bzrdir points at.
2218
:param a_bzrdir: A BzrDir that contains a branch.
2219
:param name: Name of colocated branch to open, if any
2220
:param _found: a private parameter, do not use it. It is used to
2221
indicate if format probing has already be done.
2222
:param ignore_fallbacks: when set, no fallback branches will be opened
2223
(if there are any). Default is to open fallbacks.
2224
:param location: The location of the referenced branch. If
2225
unspecified, this will be determined from the branch reference in
2227
:param possible_transports: An optional reusable transports list.
2230
format = BranchFormat.find_format(a_bzrdir, name=name)
2231
if format.__class__ != self.__class__:
2232
raise AssertionError("wrong format %r found for %r" %
2234
if location is None:
2235
location = self.get_reference(a_bzrdir)
2236
real_bzrdir = bzrdir.BzrDir.open(
2237
location, possible_transports=possible_transports)
2238
result = real_bzrdir.open_branch(name=name,
2239
ignore_fallbacks=ignore_fallbacks)
2240
# this changes the behaviour of result.clone to create a new reference
2241
# rather than a copy of the content of the branch.
2242
# I did not use a proxy object because that needs much more extensive
2243
# testing, and we are only changing one behaviour at the moment.
2244
# If we decide to alter more behaviours - i.e. the implicit nickname
2245
# then this should be refactored to introduce a tested proxy branch
2246
# and a subclass of that for use in overriding clone() and ....
2248
result.clone = self._make_reference_clone_function(result)
2252
network_format_registry = registry.FormatRegistry()
2253
"""Registry of formats indexed by their network name.
2255
The network name for a branch format is an identifier that can be used when
2256
referring to formats with smart server operations. See
2257
BranchFormat.network_name() for more detail.
2261
# formats which have no format string are not discoverable
2262
# and not independently creatable, so are not registered.
2263
__format5 = BzrBranchFormat5()
2264
__format6 = BzrBranchFormat6()
2265
__format7 = BzrBranchFormat7()
2266
__format8 = BzrBranchFormat8()
2267
BranchFormat.register_format(__format5)
2268
BranchFormat.register_format(BranchReferenceFormat())
2269
BranchFormat.register_format(__format6)
2270
BranchFormat.register_format(__format7)
2271
BranchFormat.register_format(__format8)
2272
BranchFormat.set_default_format(__format7)
2273
_legacy_formats = [BzrBranchFormat4(),
2275
network_format_registry.register(
2276
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2279
class BranchWriteLockResult(object):
2280
"""The result of write locking a branch.
2282
:ivar branch_token: The token obtained from the underlying branch lock, or
2284
:ivar unlock: A callable which will unlock the lock.
2287
def __init__(self, unlock, branch_token):
2288
self.branch_token = branch_token
2289
self.unlock = unlock
2292
class BzrBranch(Branch, _RelockDebugMixin):
2293
"""A branch stored in the actual filesystem.
2295
Note that it's "local" in the context of the filesystem; it doesn't
2296
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2297
it's writable, and can be accessed via the normal filesystem API.
2299
:ivar _transport: Transport for file operations on this branch's
2300
control files, typically pointing to the .bzr/branch directory.
2301
:ivar repository: Repository for this branch.
2302
:ivar base: The url of the base directory for this branch; the one
2303
containing the .bzr directory.
2304
:ivar name: Optional colocated branch name as it exists in the control
2308
def __init__(self, _format=None,
2309
_control_files=None, a_bzrdir=None, name=None,
2310
_repository=None, ignore_fallbacks=False):
2311
"""Create new branch object at a particular location."""
2312
if a_bzrdir is None:
2313
raise ValueError('a_bzrdir must be supplied')
2315
self.bzrdir = a_bzrdir
2316
self._base = self.bzrdir.transport.clone('..').base
2318
# XXX: We should be able to just do
2319
# self.base = self.bzrdir.root_transport.base
2320
# but this does not quite work yet -- mbp 20080522
2321
self._format = _format
2322
if _control_files is None:
2323
raise ValueError('BzrBranch _control_files is None')
2324
self.control_files = _control_files
2325
self._transport = _control_files._transport
2326
self.repository = _repository
2327
Branch.__init__(self)
2330
if self.name is None:
2331
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2333
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2338
def _get_base(self):
2339
"""Returns the directory containing the control directory."""
2342
base = property(_get_base, doc="The URL for the root of this branch.")
2344
def _get_config(self):
2345
return TransportConfig(self._transport, 'branch.conf')
2347
def is_locked(self):
2348
return self.control_files.is_locked()
2350
def lock_write(self, token=None):
2351
"""Lock the branch for write operations.
2353
:param token: A token to permit reacquiring a previously held and
2355
:return: A BranchWriteLockResult.
2357
if not self.is_locked():
2358
self._note_lock('w')
2359
# All-in-one needs to always unlock/lock.
2360
repo_control = getattr(self.repository, 'control_files', None)
2361
if self.control_files == repo_control or not self.is_locked():
2362
self.repository._warn_if_deprecated(self)
2363
self.repository.lock_write()
2368
return BranchWriteLockResult(self.unlock,
2369
self.control_files.lock_write(token=token))
2372
self.repository.unlock()
2375
def lock_read(self):
2376
"""Lock the branch for read operations.
2378
:return: An object with an unlock method which will release the lock
2381
if not self.is_locked():
2382
self._note_lock('r')
2383
# All-in-one needs to always unlock/lock.
2384
repo_control = getattr(self.repository, 'control_files', None)
2385
if self.control_files == repo_control or not self.is_locked():
2386
self.repository._warn_if_deprecated(self)
2387
self.repository.lock_read()
2392
self.control_files.lock_read()
2396
self.repository.unlock()
2399
@only_raises(errors.LockNotHeld, errors.LockBroken)
2402
self.control_files.unlock()
2404
# All-in-one needs to always unlock/lock.
2405
repo_control = getattr(self.repository, 'control_files', None)
2406
if (self.control_files == repo_control or
2407
not self.control_files.is_locked()):
2408
self.repository.unlock()
2409
if not self.control_files.is_locked():
2410
# we just released the lock
2411
self._clear_cached_state()
2413
def peek_lock_mode(self):
2414
if self.control_files._lock_count == 0:
2417
return self.control_files._lock_mode
2419
def get_physical_lock_status(self):
2420
return self.control_files.get_physical_lock_status()
2423
def print_file(self, file, revision_id):
2424
"""See Branch.print_file."""
2425
return self.repository.print_file(file, revision_id)
2427
def _write_revision_history(self, history):
2428
"""Factored out of set_revision_history.
2430
This performs the actual writing to disk.
2431
It is intended to be called by BzrBranch5.set_revision_history."""
2432
self._transport.put_bytes(
2433
'revision-history', '\n'.join(history),
2434
mode=self.bzrdir._get_file_mode())
2437
def set_revision_history(self, rev_history):
2438
"""See Branch.set_revision_history."""
2439
if 'evil' in debug.debug_flags:
2440
mutter_callsite(3, "set_revision_history scales with history.")
2441
check_not_reserved_id = _mod_revision.check_not_reserved_id
2442
for rev_id in rev_history:
2443
check_not_reserved_id(rev_id)
2444
if Branch.hooks['post_change_branch_tip']:
2445
# Don't calculate the last_revision_info() if there are no hooks
2447
old_revno, old_revid = self.last_revision_info()
2448
if len(rev_history) == 0:
2449
revid = _mod_revision.NULL_REVISION
2451
revid = rev_history[-1]
2452
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2453
self._write_revision_history(rev_history)
2454
self._clear_cached_state()
2455
self._cache_revision_history(rev_history)
2456
for hook in Branch.hooks['set_rh']:
2457
hook(self, rev_history)
2458
if Branch.hooks['post_change_branch_tip']:
2459
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2461
def _synchronize_history(self, destination, revision_id):
2462
"""Synchronize last revision and revision history between branches.
2464
This version is most efficient when the destination is also a
2465
BzrBranch5, but works for BzrBranch6 as long as the revision
2466
history is the true lefthand parent history, and all of the revisions
2467
are in the destination's repository. If not, set_revision_history
2470
:param destination: The branch to copy the history into
2471
:param revision_id: The revision-id to truncate history at. May
2472
be None to copy complete history.
2474
if not isinstance(destination._format, BzrBranchFormat5):
2475
super(BzrBranch, self)._synchronize_history(
2476
destination, revision_id)
2478
if revision_id == _mod_revision.NULL_REVISION:
2481
new_history = self.revision_history()
2482
if revision_id is not None and new_history != []:
2484
new_history = new_history[:new_history.index(revision_id) + 1]
2486
rev = self.repository.get_revision(revision_id)
2487
new_history = rev.get_history(self.repository)[1:]
2488
destination.set_revision_history(new_history)
2491
def set_last_revision_info(self, revno, revision_id):
2492
"""Set the last revision of this branch.
2494
The caller is responsible for checking that the revno is correct
2495
for this revision id.
2497
It may be possible to set the branch last revision to an id not
2498
present in the repository. However, branches can also be
2499
configured to check constraints on history, in which case this may not
2502
revision_id = _mod_revision.ensure_null(revision_id)
2503
# this old format stores the full history, but this api doesn't
2504
# provide it, so we must generate, and might as well check it's
2506
history = self._lefthand_history(revision_id)
2507
if len(history) != revno:
2508
raise AssertionError('%d != %d' % (len(history), revno))
2509
self.set_revision_history(history)
2511
def _gen_revision_history(self):
2512
history = self._transport.get_bytes('revision-history').split('\n')
2513
if history[-1:] == ['']:
2514
# There shouldn't be a trailing newline, but just in case.
2519
def generate_revision_history(self, revision_id, last_rev=None,
2521
"""Create a new revision history that will finish with revision_id.
2523
:param revision_id: the new tip to use.
2524
:param last_rev: The previous last_revision. If not None, then this
2525
must be a ancestory of revision_id, or DivergedBranches is raised.
2526
:param other_branch: The other branch that DivergedBranches should
2527
raise with respect to.
2529
self.set_revision_history(self._lefthand_history(revision_id,
2530
last_rev, other_branch))
2532
def basis_tree(self):
2533
"""See Branch.basis_tree."""
2534
return self.repository.revision_tree(self.last_revision())
2536
def _get_parent_location(self):
2537
_locs = ['parent', 'pull', 'x-pull']
2540
return self._transport.get_bytes(l).strip('\n')
2541
except errors.NoSuchFile:
2545
def _basic_push(self, target, overwrite, stop_revision):
2546
"""Basic implementation of push without bound branches or hooks.
2548
Must be called with source read locked and target write locked.
2550
result = BranchPushResult()
2551
result.source_branch = self
2552
result.target_branch = target
2553
result.old_revno, result.old_revid = target.last_revision_info()
2554
self.update_references(target)
2555
if result.old_revid != self.last_revision():
2556
# We assume that during 'push' this repository is closer than
2558
graph = self.repository.get_graph(target.repository)
2559
target.update_revisions(self, stop_revision,
2560
overwrite=overwrite, graph=graph)
2561
if self._push_should_merge_tags():
2562
result.tag_conflicts = self.tags.merge_to(target.tags,
2564
result.new_revno, result.new_revid = target.last_revision_info()
2567
def get_stacked_on_url(self):
2568
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2570
def set_push_location(self, location):
2571
"""See Branch.set_push_location."""
2572
self.get_config().set_user_option(
2573
'push_location', location,
2574
store=_mod_config.STORE_LOCATION_NORECURSE)
2576
def _set_parent_location(self, url):
2578
self._transport.delete('parent')
2580
self._transport.put_bytes('parent', url + '\n',
2581
mode=self.bzrdir._get_file_mode())
2584
class BzrBranch5(BzrBranch):
2585
"""A format 5 branch. This supports new features over plain branches.
2587
It has support for a master_branch which is the data for bound branches.
2590
def get_bound_location(self):
2592
return self._transport.get_bytes('bound')[:-1]
2593
except errors.NoSuchFile:
2597
def get_master_branch(self, possible_transports=None):
2598
"""Return the branch we are bound to.
2600
:return: Either a Branch, or None
2602
This could memoise the branch, but if thats done
2603
it must be revalidated on each new lock.
2604
So for now we just don't memoise it.
2605
# RBC 20060304 review this decision.
2607
bound_loc = self.get_bound_location()
2611
return Branch.open(bound_loc,
2612
possible_transports=possible_transports)
2613
except (errors.NotBranchError, errors.ConnectionError), e:
2614
raise errors.BoundBranchConnectionFailure(
2618
def set_bound_location(self, location):
2619
"""Set the target where this branch is bound to.
2621
:param location: URL to the target branch
2624
self._transport.put_bytes('bound', location+'\n',
2625
mode=self.bzrdir._get_file_mode())
2628
self._transport.delete('bound')
2629
except errors.NoSuchFile:
2634
def bind(self, other):
2635
"""Bind this branch to the branch other.
2637
This does not push or pull data between the branches, though it does
2638
check for divergence to raise an error when the branches are not
2639
either the same, or one a prefix of the other. That behaviour may not
2640
be useful, so that check may be removed in future.
2642
:param other: The branch to bind to
2645
# TODO: jam 20051230 Consider checking if the target is bound
2646
# It is debatable whether you should be able to bind to
2647
# a branch which is itself bound.
2648
# Committing is obviously forbidden,
2649
# but binding itself may not be.
2650
# Since we *have* to check at commit time, we don't
2651
# *need* to check here
2653
# we want to raise diverged if:
2654
# last_rev is not in the other_last_rev history, AND
2655
# other_last_rev is not in our history, and do it without pulling
2657
self.set_bound_location(other.base)
2661
"""If bound, unbind"""
2662
return self.set_bound_location(None)
2665
def update(self, possible_transports=None):
2666
"""Synchronise this branch with the master branch if any.
2668
:return: None or the last_revision that was pivoted out during the
2671
master = self.get_master_branch(possible_transports)
2672
if master is not None:
2673
old_tip = _mod_revision.ensure_null(self.last_revision())
2674
self.pull(master, overwrite=True)
2675
if self.repository.get_graph().is_ancestor(old_tip,
2676
_mod_revision.ensure_null(self.last_revision())):
2682
class BzrBranch8(BzrBranch5):
2683
"""A branch that stores tree-reference locations."""
2685
def _open_hook(self):
2686
if self._ignore_fallbacks:
2689
url = self.get_stacked_on_url()
2690
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2691
errors.UnstackableBranchFormat):
2694
for hook in Branch.hooks['transform_fallback_location']:
2695
url = hook(self, url)
2697
hook_name = Branch.hooks.get_hook_name(hook)
2698
raise AssertionError(
2699
"'transform_fallback_location' hook %s returned "
2700
"None, not a URL." % hook_name)
2701
self._activate_fallback_location(url)
2703
def __init__(self, *args, **kwargs):
2704
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2705
super(BzrBranch8, self).__init__(*args, **kwargs)
2706
self._last_revision_info_cache = None
2707
self._reference_info = None
2709
def _clear_cached_state(self):
2710
super(BzrBranch8, self)._clear_cached_state()
2711
self._last_revision_info_cache = None
2712
self._reference_info = None
2714
def _last_revision_info(self):
2715
revision_string = self._transport.get_bytes('last-revision')
2716
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2717
revision_id = cache_utf8.get_cached_utf8(revision_id)
2719
return revno, revision_id
2721
def _write_last_revision_info(self, revno, revision_id):
2722
"""Simply write out the revision id, with no checks.
2724
Use set_last_revision_info to perform this safely.
2726
Does not update the revision_history cache.
2727
Intended to be called by set_last_revision_info and
2728
_write_revision_history.
2730
revision_id = _mod_revision.ensure_null(revision_id)
2731
out_string = '%d %s\n' % (revno, revision_id)
2732
self._transport.put_bytes('last-revision', out_string,
2733
mode=self.bzrdir._get_file_mode())
2736
def set_last_revision_info(self, revno, revision_id):
2737
revision_id = _mod_revision.ensure_null(revision_id)
2738
old_revno, old_revid = self.last_revision_info()
2739
if self._get_append_revisions_only():
2740
self._check_history_violation(revision_id)
2741
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2742
self._write_last_revision_info(revno, revision_id)
2743
self._clear_cached_state()
2744
self._last_revision_info_cache = revno, revision_id
2745
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2747
def _synchronize_history(self, destination, revision_id):
2748
"""Synchronize last revision and revision history between branches.
2750
:see: Branch._synchronize_history
2752
# XXX: The base Branch has a fast implementation of this method based
2753
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2754
# that uses set_revision_history. This class inherits from BzrBranch5,
2755
# but wants the fast implementation, so it calls
2756
# Branch._synchronize_history directly.
2757
Branch._synchronize_history(self, destination, revision_id)
2759
def _check_history_violation(self, revision_id):
2760
last_revision = _mod_revision.ensure_null(self.last_revision())
2761
if _mod_revision.is_null(last_revision):
2763
if last_revision not in self._lefthand_history(revision_id):
2764
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2766
def _gen_revision_history(self):
2767
"""Generate the revision history from last revision
2769
last_revno, last_revision = self.last_revision_info()
2770
self._extend_partial_history(stop_index=last_revno-1)
2771
return list(reversed(self._partial_revision_history_cache))
2773
def _write_revision_history(self, history):
2774
"""Factored out of set_revision_history.
2776
This performs the actual writing to disk, with format-specific checks.
2777
It is intended to be called by BzrBranch5.set_revision_history.
2779
if len(history) == 0:
2780
last_revision = 'null:'
2782
if history != self._lefthand_history(history[-1]):
2783
raise errors.NotLefthandHistory(history)
2784
last_revision = history[-1]
2785
if self._get_append_revisions_only():
2786
self._check_history_violation(last_revision)
2787
self._write_last_revision_info(len(history), last_revision)
2790
def _set_parent_location(self, url):
2791
"""Set the parent branch"""
2792
self._set_config_location('parent_location', url, make_relative=True)
2795
def _get_parent_location(self):
2796
"""Set the parent branch"""
2797
return self._get_config_location('parent_location')
2800
def _set_all_reference_info(self, info_dict):
2801
"""Replace all reference info stored in a branch.
2803
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2806
writer = rio.RioWriter(s)
2807
for key, (tree_path, branch_location) in info_dict.iteritems():
2808
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2809
branch_location=branch_location)
2810
writer.write_stanza(stanza)
2811
self._transport.put_bytes('references', s.getvalue())
2812
self._reference_info = info_dict
2815
def _get_all_reference_info(self):
2816
"""Return all the reference info stored in a branch.
2818
:return: A dict of {file_id: (tree_path, branch_location)}
2820
if self._reference_info is not None:
2821
return self._reference_info
2822
rio_file = self._transport.get('references')
2824
stanzas = rio.read_stanzas(rio_file)
2825
info_dict = dict((s['file_id'], (s['tree_path'],
2826
s['branch_location'])) for s in stanzas)
2829
self._reference_info = info_dict
2832
def set_reference_info(self, file_id, tree_path, branch_location):
2833
"""Set the branch location to use for a tree reference.
2835
:param file_id: The file-id of the tree reference.
2836
:param tree_path: The path of the tree reference in the tree.
2837
:param branch_location: The location of the branch to retrieve tree
2840
info_dict = self._get_all_reference_info()
2841
info_dict[file_id] = (tree_path, branch_location)
2842
if None in (tree_path, branch_location):
2843
if tree_path is not None:
2844
raise ValueError('tree_path must be None when branch_location'
2846
if branch_location is not None:
2847
raise ValueError('branch_location must be None when tree_path'
2849
del info_dict[file_id]
2850
self._set_all_reference_info(info_dict)
2852
def get_reference_info(self, file_id):
2853
"""Get the tree_path and branch_location for a tree reference.
2855
:return: a tuple of (tree_path, branch_location)
2857
return self._get_all_reference_info().get(file_id, (None, None))
2859
def reference_parent(self, file_id, path, possible_transports=None):
2860
"""Return the parent branch for a tree-reference file_id.
2862
:param file_id: The file_id of the tree reference
2863
:param path: The path of the file_id in the tree
2864
:return: A branch associated with the file_id
2866
branch_location = self.get_reference_info(file_id)[1]
2867
if branch_location is None:
2868
return Branch.reference_parent(self, file_id, path,
2869
possible_transports)
2870
branch_location = urlutils.join(self.user_url, branch_location)
2871
return Branch.open(branch_location,
2872
possible_transports=possible_transports)
2874
def set_push_location(self, location):
2875
"""See Branch.set_push_location."""
2876
self._set_config_location('push_location', location)
2878
def set_bound_location(self, location):
2879
"""See Branch.set_push_location."""
2881
config = self.get_config()
2882
if location is None:
2883
if config.get_user_option('bound') != 'True':
2886
config.set_user_option('bound', 'False', warn_masked=True)
2889
self._set_config_location('bound_location', location,
2891
config.set_user_option('bound', 'True', warn_masked=True)
2894
def _get_bound_location(self, bound):
2895
"""Return the bound location in the config file.
2897
Return None if the bound parameter does not match"""
2898
config = self.get_config()
2899
config_bound = (config.get_user_option('bound') == 'True')
2900
if config_bound != bound:
2902
return self._get_config_location('bound_location', config=config)
2904
def get_bound_location(self):
2905
"""See Branch.set_push_location."""
2906
return self._get_bound_location(True)
2908
def get_old_bound_location(self):
2909
"""See Branch.get_old_bound_location"""
2910
return self._get_bound_location(False)
2912
def get_stacked_on_url(self):
2913
# you can always ask for the URL; but you might not be able to use it
2914
# if the repo can't support stacking.
2915
## self._check_stackable_repo()
2916
stacked_url = self._get_config_location('stacked_on_location')
2917
if stacked_url is None:
2918
raise errors.NotStacked(self)
2921
def _get_append_revisions_only(self):
2922
return self.get_config(
2923
).get_user_option_as_bool('append_revisions_only')
2926
def generate_revision_history(self, revision_id, last_rev=None,
2928
"""See BzrBranch5.generate_revision_history"""
2929
history = self._lefthand_history(revision_id, last_rev, other_branch)
2930
revno = len(history)
2931
self.set_last_revision_info(revno, revision_id)
2934
def get_rev_id(self, revno, history=None):
2935
"""Find the revision id of the specified revno."""
2937
return _mod_revision.NULL_REVISION
2939
last_revno, last_revision_id = self.last_revision_info()
2940
if revno <= 0 or revno > last_revno:
2941
raise errors.NoSuchRevision(self, revno)
2943
if history is not None:
2944
return history[revno - 1]
2946
index = last_revno - revno
2947
if len(self._partial_revision_history_cache) <= index:
2948
self._extend_partial_history(stop_index=index)
2949
if len(self._partial_revision_history_cache) > index:
2950
return self._partial_revision_history_cache[index]
2952
raise errors.NoSuchRevision(self, revno)
2955
def revision_id_to_revno(self, revision_id):
2956
"""Given a revision id, return its revno"""
2957
if _mod_revision.is_null(revision_id):
2960
index = self._partial_revision_history_cache.index(revision_id)
2962
self._extend_partial_history(stop_revision=revision_id)
2963
index = len(self._partial_revision_history_cache) - 1
2964
if self._partial_revision_history_cache[index] != revision_id:
2965
raise errors.NoSuchRevision(self, revision_id)
2966
return self.revno() - index
2969
class BzrBranch7(BzrBranch8):
2970
"""A branch with support for a fallback repository."""
2972
def set_reference_info(self, file_id, tree_path, branch_location):
2973
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2975
def get_reference_info(self, file_id):
2976
Branch.get_reference_info(self, file_id)
2978
def reference_parent(self, file_id, path, possible_transports=None):
2979
return Branch.reference_parent(self, file_id, path,
2980
possible_transports)
2983
class BzrBranch6(BzrBranch7):
2984
"""See BzrBranchFormat6 for the capabilities of this branch.
2986
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2990
def get_stacked_on_url(self):
2991
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1439
2994
######################################################################
1443
def is_control_file(filename):
1444
## FIXME: better check
1445
filename = os.path.normpath(filename)
1446
while filename != '':
1447
head, tail = os.path.split(filename)
1448
## mutter('check %r for control file' % ((head, tail), ))
1449
if tail == bzrlib.BZRDIR:
1451
if filename == head:
1458
def gen_file_id(name):
1459
"""Return new file id.
1461
This should probably generate proper UUIDs, but for the moment we
1462
cope with just randomness because running uuidgen every time is
1465
from binascii import hexlify
1466
from time import time
1468
# get last component
1469
idx = name.rfind('/')
1471
name = name[idx+1 : ]
1472
idx = name.rfind('\\')
1474
name = name[idx+1 : ]
1476
# make it not a hidden file
1477
name = name.lstrip('.')
1479
# remove any wierd characters; we don't escape them but rather
1480
# just pull them out
1481
name = re.sub(r'[^\w.]', '', name)
1483
s = hexlify(rand_bytes(8))
1484
return '-'.join((name, compact_date(time()), s))
1488
"""Return a new tree-root file id."""
1489
return gen_file_id('TREE_ROOT')
1492
def pull_loc(branch):
1493
# TODO: Should perhaps just make attribute be 'base' in
1494
# RemoteBranch and Branch?
1495
if hasattr(branch, "baseurl"):
1496
return branch.baseurl
1501
def copy_branch(branch_from, to_location, revision=None):
1502
"""Copy branch_from into the existing directory to_location.
1505
If not None, only revisions up to this point will be copied.
1506
The head of the new branch will be that revision.
1509
The name of a local directory that exists but is empty.
1511
from bzrlib.merge import merge
1512
from bzrlib.branch import Branch
1514
assert isinstance(branch_from, Branch)
1515
assert isinstance(to_location, basestring)
1517
br_to = Branch(to_location, init=True)
1518
br_to.set_root_id(branch_from.get_root_id())
1519
if revision is None:
1520
revno = branch_from.revno()
1522
revno, rev_id = branch_from.get_revision_info(revision)
1523
br_to.update_revisions(branch_from, stop_revision=revno)
1524
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1525
check_clean=False, ignore_zero=True)
1527
from_location = pull_loc(branch_from)
1528
br_to.set_parent(pull_loc(branch_from))
2995
# results of operations
2998
class _Result(object):
3000
def _show_tag_conficts(self, to_file):
3001
if not getattr(self, 'tag_conflicts', None):
3003
to_file.write('Conflicting tags:\n')
3004
for name, value1, value2 in self.tag_conflicts:
3005
to_file.write(' %s\n' % (name, ))
3008
class PullResult(_Result):
3009
"""Result of a Branch.pull operation.
3011
:ivar old_revno: Revision number before pull.
3012
:ivar new_revno: Revision number after pull.
3013
:ivar old_revid: Tip revision id before pull.
3014
:ivar new_revid: Tip revision id after pull.
3015
:ivar source_branch: Source (local) branch object. (read locked)
3016
:ivar master_branch: Master branch of the target, or the target if no
3018
:ivar local_branch: target branch if there is a Master, else None
3019
:ivar target_branch: Target/destination branch object. (write locked)
3020
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3024
# DEPRECATED: pull used to return the change in revno
3025
return self.new_revno - self.old_revno
3027
def report(self, to_file):
3029
if self.old_revid == self.new_revid:
3030
to_file.write('No revisions to pull.\n')
3032
to_file.write('Now on revision %d.\n' % self.new_revno)
3033
self._show_tag_conficts(to_file)
3036
class BranchPushResult(_Result):
3037
"""Result of a Branch.push operation.
3039
:ivar old_revno: Revision number (eg 10) of the target before push.
3040
:ivar new_revno: Revision number (eg 12) of the target after push.
3041
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3043
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3045
:ivar source_branch: Source branch object that the push was from. This is
3046
read locked, and generally is a local (and thus low latency) branch.
3047
:ivar master_branch: If target is a bound branch, the master branch of
3048
target, or target itself. Always write locked.
3049
:ivar target_branch: The direct Branch where data is being sent (write
3051
:ivar local_branch: If the target is a bound branch this will be the
3052
target, otherwise it will be None.
3056
# DEPRECATED: push used to return the change in revno
3057
return self.new_revno - self.old_revno
3059
def report(self, to_file):
3060
"""Write a human-readable description of the result."""
3061
if self.old_revid == self.new_revid:
3062
note('No new revisions to push.')
3064
note('Pushed up to revision %d.' % self.new_revno)
3065
self._show_tag_conficts(to_file)
3068
class BranchCheckResult(object):
3069
"""Results of checking branch consistency.
3074
def __init__(self, branch):
3075
self.branch = branch
3078
def report_results(self, verbose):
3079
"""Report the check results via trace.note.
3081
:param verbose: Requests more detailed display of what was checked,
3084
note('checked branch %s format %s', self.branch.user_url,
3085
self.branch._format)
3086
for error in self.errors:
3087
note('found error:%s', error)
3090
class Converter5to6(object):
3091
"""Perform an in-place upgrade of format 5 to format 6"""
3093
def convert(self, branch):
3094
# Data for 5 and 6 can peacefully coexist.
3095
format = BzrBranchFormat6()
3096
new_branch = format.open(branch.bzrdir, _found=True)
3098
# Copy source data into target
3099
new_branch._write_last_revision_info(*branch.last_revision_info())
3100
new_branch.set_parent(branch.get_parent())
3101
new_branch.set_bound_location(branch.get_bound_location())
3102
new_branch.set_push_location(branch.get_push_location())
3104
# New branch has no tags by default
3105
new_branch.tags._set_tag_dict({})
3107
# Copying done; now update target format
3108
new_branch._transport.put_bytes('format',
3109
format.get_format_string(),
3110
mode=new_branch.bzrdir._get_file_mode())
3112
# Clean up old files
3113
new_branch._transport.delete('revision-history')
3115
branch.set_parent(None)
3116
except errors.NoSuchFile:
3118
branch.set_bound_location(None)
3121
class Converter6to7(object):
3122
"""Perform an in-place upgrade of format 6 to format 7"""
3124
def convert(self, branch):
3125
format = BzrBranchFormat7()
3126
branch._set_config_location('stacked_on_location', '')
3127
# update target format
3128
branch._transport.put_bytes('format', format.get_format_string())
3131
class Converter7to8(object):
3132
"""Perform an in-place upgrade of format 6 to format 7"""
3134
def convert(self, branch):
3135
format = BzrBranchFormat8()
3136
branch._transport.put_bytes('references', '')
3137
# update target format
3138
branch._transport.put_bytes('format', format.get_format_string())
3141
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3142
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3145
_run_with_write_locked_target will attempt to release the lock it acquires.
3147
If an exception is raised by callable, then that exception *will* be
3148
propagated, even if the unlock attempt raises its own error. Thus
3149
_run_with_write_locked_target should be preferred to simply doing::
3153
return callable(*args, **kwargs)
3158
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3159
# should share code?
3162
result = callable(*args, **kwargs)
3164
exc_info = sys.exc_info()
3168
raise exc_info[0], exc_info[1], exc_info[2]
3174
class InterBranch(InterObject):
3175
"""This class represents operations taking place between two branches.
3177
Its instances have methods like pull() and push() and contain
3178
references to the source and target repositories these operations
3179
can be carried out on.
3183
"""The available optimised InterBranch types."""
3186
def _get_branch_formats_to_test():
3187
"""Return a tuple with the Branch formats to use when testing."""
3188
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3190
def pull(self, overwrite=False, stop_revision=None,
3191
possible_transports=None, local=False):
3192
"""Mirror source into target branch.
3194
The target branch is considered to be 'local', having low latency.
3196
:returns: PullResult instance
3198
raise NotImplementedError(self.pull)
3200
def update_revisions(self, stop_revision=None, overwrite=False,
3202
"""Pull in new perfect-fit revisions.
3204
:param stop_revision: Updated until the given revision
3205
:param overwrite: Always set the branch pointer, rather than checking
3206
to see if it is a proper descendant.
3207
:param graph: A Graph object that can be used to query history
3208
information. This can be None.
3211
raise NotImplementedError(self.update_revisions)
3213
def push(self, overwrite=False, stop_revision=None,
3214
_override_hook_source_branch=None):
3215
"""Mirror the source branch into the target branch.
3217
The source branch is considered to be 'local', having low latency.
3219
raise NotImplementedError(self.push)
3222
class GenericInterBranch(InterBranch):
3223
"""InterBranch implementation that uses public Branch functions.
3227
def _get_branch_formats_to_test():
3228
return BranchFormat._default_format, BranchFormat._default_format
3230
def update_revisions(self, stop_revision=None, overwrite=False,
3232
"""See InterBranch.update_revisions()."""
3233
self.source.lock_read()
3235
other_revno, other_last_revision = self.source.last_revision_info()
3236
stop_revno = None # unknown
3237
if stop_revision is None:
3238
stop_revision = other_last_revision
3239
if _mod_revision.is_null(stop_revision):
3240
# if there are no commits, we're done.
3242
stop_revno = other_revno
3244
# what's the current last revision, before we fetch [and change it
3246
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3247
# we fetch here so that we don't process data twice in the common
3248
# case of having something to pull, and so that the check for
3249
# already merged can operate on the just fetched graph, which will
3250
# be cached in memory.
3251
self.target.fetch(self.source, stop_revision)
3252
# Check to see if one is an ancestor of the other
3255
graph = self.target.repository.get_graph()
3256
if self.target._check_if_descendant_or_diverged(
3257
stop_revision, last_rev, graph, self.source):
3258
# stop_revision is a descendant of last_rev, but we aren't
3259
# overwriting, so we're done.
3261
if stop_revno is None:
3263
graph = self.target.repository.get_graph()
3264
this_revno, this_last_revision = \
3265
self.target.last_revision_info()
3266
stop_revno = graph.find_distance_to_null(stop_revision,
3267
[(other_last_revision, other_revno),
3268
(this_last_revision, this_revno)])
3269
self.target.set_last_revision_info(stop_revno, stop_revision)
3271
self.source.unlock()
3273
def pull(self, overwrite=False, stop_revision=None,
3274
possible_transports=None, _hook_master=None, run_hooks=True,
3275
_override_hook_target=None, local=False):
3278
:param _hook_master: Private parameter - set the branch to
3279
be supplied as the master to pull hooks.
3280
:param run_hooks: Private parameter - if false, this branch
3281
is being called because it's the master of the primary branch,
3282
so it should not run its hooks.
3283
:param _override_hook_target: Private parameter - set the branch to be
3284
supplied as the target_branch to pull hooks.
3285
:param local: Only update the local branch, and not the bound branch.
3287
# This type of branch can't be bound.
3289
raise errors.LocalRequiresBoundBranch()
3290
result = PullResult()
3291
result.source_branch = self.source
3292
if _override_hook_target is None:
3293
result.target_branch = self.target
3295
result.target_branch = _override_hook_target
3296
self.source.lock_read()
3298
# We assume that during 'pull' the target repository is closer than
3300
self.source.update_references(self.target)
3301
graph = self.target.repository.get_graph(self.source.repository)
3302
# TODO: Branch formats should have a flag that indicates
3303
# that revno's are expensive, and pull() should honor that flag.
3305
result.old_revno, result.old_revid = \
3306
self.target.last_revision_info()
3307
self.target.update_revisions(self.source, stop_revision,
3308
overwrite=overwrite, graph=graph)
3309
# TODO: The old revid should be specified when merging tags,
3310
# so a tags implementation that versions tags can only
3311
# pull in the most recent changes. -- JRV20090506
3312
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3314
result.new_revno, result.new_revid = self.target.last_revision_info()
3316
result.master_branch = _hook_master
3317
result.local_branch = result.target_branch
3319
result.master_branch = result.target_branch
3320
result.local_branch = None
3322
for hook in Branch.hooks['post_pull']:
3325
self.source.unlock()
3328
def push(self, overwrite=False, stop_revision=None,
3329
_override_hook_source_branch=None):
3330
"""See InterBranch.push.
3332
This is the basic concrete implementation of push()
3334
:param _override_hook_source_branch: If specified, run
3335
the hooks passing this Branch as the source, rather than self.
3336
This is for use of RemoteBranch, where push is delegated to the
3337
underlying vfs-based Branch.
3339
# TODO: Public option to disable running hooks - should be trivial but
3341
self.source.lock_read()
3343
return _run_with_write_locked_target(
3344
self.target, self._push_with_bound_branches, overwrite,
3346
_override_hook_source_branch=_override_hook_source_branch)
3348
self.source.unlock()
3350
def _push_with_bound_branches(self, overwrite, stop_revision,
3351
_override_hook_source_branch=None):
3352
"""Push from source into target, and into target's master if any.
3355
if _override_hook_source_branch:
3356
result.source_branch = _override_hook_source_branch
3357
for hook in Branch.hooks['post_push']:
3360
bound_location = self.target.get_bound_location()
3361
if bound_location and self.target.base != bound_location:
3362
# there is a master branch.
3364
# XXX: Why the second check? Is it even supported for a branch to
3365
# be bound to itself? -- mbp 20070507
3366
master_branch = self.target.get_master_branch()
3367
master_branch.lock_write()
3369
# push into the master from the source branch.
3370
self.source._basic_push(master_branch, overwrite, stop_revision)
3371
# and push into the target branch from the source. Note that we
3372
# push from the source branch again, because its considered the
3373
# highest bandwidth repository.
3374
result = self.source._basic_push(self.target, overwrite,
3376
result.master_branch = master_branch
3377
result.local_branch = self.target
3381
master_branch.unlock()
3384
result = self.source._basic_push(self.target, overwrite,
3386
# TODO: Why set master_branch and local_branch if there's no
3387
# binding? Maybe cleaner to just leave them unset? -- mbp
3389
result.master_branch = self.target
3390
result.local_branch = None
3395
def is_compatible(self, source, target):
3396
# GenericBranch uses the public API, so always compatible
3400
class InterToBranch5(GenericInterBranch):
3403
def _get_branch_formats_to_test():
3404
return BranchFormat._default_format, BzrBranchFormat5()
3406
def pull(self, overwrite=False, stop_revision=None,
3407
possible_transports=None, run_hooks=True,
3408
_override_hook_target=None, local=False):
3409
"""Pull from source into self, updating my master if any.
3411
:param run_hooks: Private parameter - if false, this branch
3412
is being called because it's the master of the primary branch,
3413
so it should not run its hooks.
3415
bound_location = self.target.get_bound_location()
3416
if local and not bound_location:
3417
raise errors.LocalRequiresBoundBranch()
3418
master_branch = None
3419
if not local and bound_location and self.source.user_url != bound_location:
3420
# not pulling from master, so we need to update master.
3421
master_branch = self.target.get_master_branch(possible_transports)
3422
master_branch.lock_write()
3425
# pull from source into master.
3426
master_branch.pull(self.source, overwrite, stop_revision,
3428
return super(InterToBranch5, self).pull(overwrite,
3429
stop_revision, _hook_master=master_branch,
3430
run_hooks=run_hooks,
3431
_override_hook_target=_override_hook_target)
3434
master_branch.unlock()
3437
InterBranch.register_optimiser(GenericInterBranch)
3438
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
