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
26
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
27
from bzrlib.textui import show_status
28
from bzrlib.revision import Revision
29
from bzrlib.xml import unpack_xml
30
from bzrlib.delta import compare_trees
31
from bzrlib.tree import EmptyTree, RevisionTree
33
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
34
## TODO: Maybe include checks for common corruption of newlines, etc?
37
# TODO: Some operations like log might retrieve the same revisions
38
# repeatedly to calculate deltas. We could perhaps have a weakref
39
# cache in memory to make this faster.
42
def find_branch(f, **args):
43
if f and (f.startswith('http://') or f.startswith('https://')):
45
return remotebranch.RemoteBranch(f, **args)
47
return Branch(f, **args)
50
def find_cached_branch(f, cache_root, **args):
51
from remotebranch import RemoteBranch
52
br = find_branch(f, **args)
53
def cacheify(br, store_name):
54
from meta_store import CachedStore
55
cache_path = os.path.join(cache_root, store_name)
57
new_store = CachedStore(getattr(br, store_name), cache_path)
58
setattr(br, store_name, new_store)
60
if isinstance(br, RemoteBranch):
61
cacheify(br, 'inventory_store')
62
cacheify(br, 'text_store')
63
cacheify(br, 'revision_store')
67
def _relpath(base, path):
68
"""Return path relative to base, or raise exception.
70
The path may be either an absolute path or a path relative to the
71
current working directory.
73
Lifted out of Branch.relpath for ease of testing.
75
os.path.commonprefix (python2.4) has a bad bug that it works just
76
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
77
avoids that problem."""
78
rp = os.path.abspath(path)
82
while len(head) >= len(base):
85
head, tail = os.path.split(head)
89
from errors import NotBranchError
90
raise NotBranchError("path %r is not within branch %r" % (rp, base))
95
def find_branch_root(f=None):
96
"""Find the branch root enclosing f, or pwd.
98
f may be a filename or a URL.
100
It is not necessary that f exists.
102
Basically we keep looking up until we find the control directory or
103
run into the root."""
106
elif hasattr(os.path, 'realpath'):
107
f = os.path.realpath(f)
109
f = os.path.abspath(f)
110
if not os.path.exists(f):
111
raise BzrError('%r does not exist' % f)
117
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
119
head, tail = os.path.split(f)
121
# reached the root, whatever that may be
122
raise BzrError('%r is not in a branch' % orig_f)
125
class DivergedBranches(Exception):
126
def __init__(self, branch1, branch2):
127
self.branch1 = branch1
128
self.branch2 = branch2
129
Exception.__init__(self, "These branches have diverged.")
132
class NoSuchRevision(BzrError):
133
def __init__(self, branch, revision):
135
self.revision = revision
136
msg = "Branch %s has no revision %d" % (branch, revision)
137
BzrError.__init__(self, msg)
140
######################################################################
143
class Branch(object):
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
34
revision as _mod_revision,
42
from bzrlib.config import BranchConfig, TransportConfig
43
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
44
from bzrlib.tag import (
50
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
51
from bzrlib.hooks import HookPoint, Hooks
52
from bzrlib.inter import InterObject
53
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
54
from bzrlib import registry
55
from bzrlib.symbol_versioning import (
59
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
63
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
64
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
67
class Branch(bzrdir.ControlComponent):
144
68
"""Branch holding a history of revisions.
147
Base directory of the branch.
153
If _lock_mode is true, a positive count of the number of times the
157
Lock object from bzrlib.lock.
71
Base directory/url of the branch; using control_url and
72
control_transport is more standardized.
74
hooks: An instance of BranchHooks.
76
# this is really an instance variable - FIXME move it there
164
# Map some sort of prefix into a namespace
165
# stuff like "revno:10", "revid:", etc.
166
# This should match a prefix with a function which accepts
167
REVISION_NAMESPACES = {}
169
def __init__(self, base, init=False, find_root=True):
170
"""Create new branch object at a particular location.
172
base -- Base directory for the branch.
174
init -- If True, create new control files in a previously
175
unversioned directory. If False, the branch must already
178
find_root -- If true and init is false, find the root of the
179
existing branch containing base.
181
In the test suite, creation of new trees is tested using the
182
`ScratchBranch` class.
184
from bzrlib.store import ImmutableStore
186
self.base = os.path.realpath(base)
189
self.base = find_branch_root(base)
191
self.base = os.path.realpath(base)
192
if not isdir(self.controlfilename('.')):
193
from errors import NotBranchError
194
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
195
['use "bzr init" to initialize a new working tree',
196
'current bzr can only operate from top-of-tree'])
199
self.text_store = ImmutableStore(self.controlfilename('text-store'))
200
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
201
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
205
return '%s(%r)' % (self.__class__.__name__, self.base)
212
if self._lock_mode or self._lock:
213
from warnings import warn
214
warn("branch %r was not explicitly unlocked" % self)
219
def lock_write(self):
221
if self._lock_mode != 'w':
222
from errors import LockError
223
raise LockError("can't upgrade to a write lock from %r" %
225
self._lock_count += 1
227
from bzrlib.lock import WriteLock
229
self._lock = WriteLock(self.controlfilename('branch-lock'))
230
self._lock_mode = 'w'
81
def control_transport(self):
82
return self._transport
85
def user_transport(self):
86
return self.bzrdir.user_transport
88
def __init__(self, *ignored, **ignored_too):
89
self.tags = self._format.make_tags(self)
90
self._revision_history_cache = None
91
self._revision_id_to_revno_cache = None
92
self._partial_revision_id_to_revno_cache = {}
93
self._partial_revision_history_cache = []
94
self._last_revision_info_cache = None
95
self._merge_sorted_revisions_cache = None
97
hooks = Branch.hooks['open']
101
def _open_hook(self):
102
"""Called by init to allow simpler extension of the base class."""
104
def _activate_fallback_location(self, url):
105
"""Activate the branch/repository from url as a fallback repository."""
106
repo = self._get_fallback_repository(url)
107
if repo.has_same_location(self.repository):
108
raise errors.UnstackableLocationError(self.user_url, url)
109
self.repository.add_fallback_repository(repo)
111
def break_lock(self):
112
"""Break a lock if one is present from another instance.
114
Uses the ui factory to ask for confirmation if the lock may be from
117
This will probe the repository for its lock as well.
119
self.control_files.break_lock()
120
self.repository.break_lock()
121
master = self.get_master_branch()
122
if master is not None:
125
def _check_stackable_repo(self):
126
if not self.repository._format.supports_external_lookups:
127
raise errors.UnstackableRepositoryFormat(self.repository._format,
128
self.repository.base)
130
def _extend_partial_history(self, stop_index=None, stop_revision=None):
131
"""Extend the partial history to include a given index
133
If a stop_index is supplied, stop when that index has been reached.
134
If a stop_revision is supplied, stop when that revision is
135
encountered. Otherwise, stop when the beginning of history is
138
:param stop_index: The index which should be present. When it is
139
present, history extension will stop.
140
:param stop_revision: The revision id which should be present. When
141
it is encountered, history extension will stop.
143
if len(self._partial_revision_history_cache) == 0:
144
self._partial_revision_history_cache = [self.last_revision()]
145
repository._iter_for_revno(
146
self.repository, self._partial_revision_history_cache,
147
stop_index=stop_index, stop_revision=stop_revision)
148
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
149
self._partial_revision_history_cache.pop()
151
def _get_check_refs(self):
152
"""Get the references needed for check().
156
revid = self.last_revision()
157
return [('revision-existence', revid), ('lefthand-distance', revid)]
160
def open(base, _unsupported=False, possible_transports=None):
161
"""Open the branch rooted at base.
163
For instance, if the branch is at URL/.bzr/branch,
164
Branch.open(URL) -> a Branch instance.
166
control = bzrdir.BzrDir.open(base, _unsupported,
167
possible_transports=possible_transports)
168
return control.open_branch(unsupported=_unsupported)
171
def open_from_transport(transport, name=None, _unsupported=False):
172
"""Open the branch rooted at transport"""
173
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
174
return control.open_branch(name=name, unsupported=_unsupported)
177
def open_containing(url, possible_transports=None):
178
"""Open an existing branch which contains url.
180
This probes for a branch at url, and searches upwards from there.
182
Basically we keep looking up until we find the control directory or
183
run into the root. If there isn't one, raises NotBranchError.
184
If there is one and it is either an unrecognised format or an unsupported
185
format, UnknownFormatError or UnsupportedFormatError are raised.
186
If there is one, it is returned, along with the unused portion of url.
188
control, relpath = bzrdir.BzrDir.open_containing(url,
190
return control.open_branch(), relpath
192
def _push_should_merge_tags(self):
193
"""Should _basic_push merge this branch's tags into the target?
195
The default implementation returns False if this branch has no tags,
196
and True the rest of the time. Subclasses may override this.
198
return self.supports_tags() and self.tags.get_tag_dict()
200
def get_config(self):
201
"""Get a bzrlib.config.BranchConfig for this Branch.
203
This can then be used to get and set configuration options for the
206
:return: A bzrlib.config.BranchConfig.
208
return BranchConfig(self)
210
def _get_config(self):
211
"""Get the concrete config for just the config in this branch.
213
This is not intended for client use; see Branch.get_config for the
218
:return: An object supporting get_option and set_option.
220
raise NotImplementedError(self._get_config)
222
def _get_fallback_repository(self, url):
223
"""Get the repository we fallback to at url."""
224
url = urlutils.join(self.base, url)
225
a_branch = Branch.open(url,
226
possible_transports=[self.bzrdir.root_transport])
227
return a_branch.repository
229
def _get_tags_bytes(self):
230
"""Get the bytes of a serialised tags dict.
232
Note that not all branches support tags, nor do all use the same tags
233
logic: this method is specific to BasicTags. Other tag implementations
234
may use the same method name and behave differently, safely, because
235
of the double-dispatch via
236
format.make_tags->tags_instance->get_tags_dict.
238
:return: The bytes of the tags file.
239
:seealso: Branch._set_tags_bytes.
241
return self._transport.get_bytes('tags')
243
def _get_nick(self, local=False, possible_transports=None):
244
config = self.get_config()
245
# explicit overrides master, but don't look for master if local is True
246
if not local and not config.has_explicit_nickname():
248
master = self.get_master_branch(possible_transports)
249
if master is not None:
250
# return the master branch value
252
except errors.BzrError, e:
253
# Silently fall back to local implicit nick if the master is
255
mutter("Could not connect to bound branch, "
256
"falling back to local nick.\n " + str(e))
257
return config.get_nickname()
259
def _set_nick(self, nick):
260
self.get_config().set_user_option('nickname', nick, warn_masked=True)
262
nick = property(_get_nick, _set_nick)
265
raise NotImplementedError(self.is_locked)
267
def _lefthand_history(self, revision_id, last_rev=None,
269
if 'evil' in debug.debug_flags:
270
mutter_callsite(4, "_lefthand_history scales with history.")
271
# stop_revision must be a descendant of last_revision
272
graph = self.repository.get_graph()
273
if last_rev is not None:
274
if not graph.is_ancestor(last_rev, revision_id):
275
# our previous tip is not merged into stop_revision
276
raise errors.DivergedBranches(self, other_branch)
277
# make a new revision history from the graph
278
parents_map = graph.get_parent_map([revision_id])
279
if revision_id not in parents_map:
280
raise errors.NoSuchRevision(self, revision_id)
281
current_rev_id = revision_id
283
check_not_reserved_id = _mod_revision.check_not_reserved_id
284
# Do not include ghosts or graph origin in revision_history
285
while (current_rev_id in parents_map and
286
len(parents_map[current_rev_id]) > 0):
287
check_not_reserved_id(current_rev_id)
288
new_history.append(current_rev_id)
289
current_rev_id = parents_map[current_rev_id][0]
290
parents_map = graph.get_parent_map([current_rev_id])
291
new_history.reverse()
294
def lock_write(self, token=None):
295
"""Lock the branch for write operations.
297
:param token: A token to permit reacquiring a previously held and
299
:return: A BranchWriteLockResult.
301
raise NotImplementedError(self.lock_write)
235
303
def lock_read(self):
237
assert self._lock_mode in ('r', 'w'), \
238
"invalid lock mode %r" % self._lock_mode
239
self._lock_count += 1
241
from bzrlib.lock import ReadLock
243
self._lock = ReadLock(self.controlfilename('branch-lock'))
244
self._lock_mode = 'r'
304
"""Lock the branch for read operations.
306
:return: A bzrlib.lock.LogicalLockResult.
308
raise NotImplementedError(self.lock_read)
249
310
def unlock(self):
250
if not self._lock_mode:
251
from errors import LockError
252
raise LockError('branch %r is not locked' % (self))
254
if self._lock_count > 1:
255
self._lock_count -= 1
259
self._lock_mode = self._lock_count = None
262
def abspath(self, name):
263
"""Return absolute filename for something in the branch"""
264
return os.path.join(self.base, name)
267
def relpath(self, path):
268
"""Return path relative to this branch of something inside it.
270
Raises an error if path is not in this branch."""
271
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)
308
def _make_control(self):
309
from bzrlib.inventory import Inventory
310
from bzrlib.xml import pack_xml
312
os.mkdir(self.controlfilename([]))
313
self.controlfile('README', 'w').write(
314
"This is a Bazaar-NG control directory.\n"
315
"Do not change any files in this directory.\n")
316
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
317
for d in ('text-store', 'inventory-store', 'revision-store'):
318
os.mkdir(self.controlfilename(d))
319
for f in ('revision-history', 'merged-patches',
320
'pending-merged-patches', 'branch-name',
323
self.controlfile(f, 'w').write('')
324
mutter('created control directory in ' + self.base)
326
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
329
def _check_format(self):
330
"""Check this branch format is supported.
332
The current tool only supports the current unstable format.
334
In the future, we might need different in-memory Branch
335
classes to support downlevel branches. But not yet.
337
# This ignores newlines so that we can open branches created
338
# on Windows from Linux and so on. I think it might be better
339
# to always make all internal files in unix format.
340
fmt = self.controlfile('branch-format', 'r').read()
341
fmt.replace('\r\n', '')
342
if fmt != BZR_BRANCH_FORMAT:
343
raise BzrError('sorry, branch format %r not supported' % fmt,
344
['use a different bzr version',
345
'or remove the .bzr directory and "bzr init" again'])
347
def get_root_id(self):
348
"""Return the id of this branches root"""
349
inv = self.read_working_inventory()
350
return inv.root.file_id
352
def set_root_id(self, file_id):
353
inv = self.read_working_inventory()
354
orig_root_id = inv.root.file_id
355
del inv._byid[inv.root.file_id]
356
inv.root.file_id = file_id
357
inv._byid[inv.root.file_id] = inv.root
360
if entry.parent_id in (None, orig_root_id):
361
entry.parent_id = inv.root.file_id
362
self._write_inventory(inv)
364
def read_working_inventory(self):
365
"""Read the working inventory."""
366
from bzrlib.inventory import Inventory
367
from bzrlib.xml import unpack_xml
368
from time import time
372
# ElementTree does its own conversion from UTF-8, so open in
374
inv = unpack_xml(Inventory,
375
self.controlfile('inventory', 'rb'))
376
mutter("loaded inventory of %d items in %f"
377
% (len(inv), time() - before))
383
def _write_inventory(self, inv):
384
"""Update the working inventory.
386
That is to say, the inventory describing changes underway, that
387
will be committed to the next revision.
389
from bzrlib.atomicfile import AtomicFile
390
from bzrlib.xml import pack_xml
394
f = AtomicFile(self.controlfilename('inventory'), 'wb')
403
mutter('wrote working inventory')
406
inventory = property(read_working_inventory, _write_inventory, None,
407
"""Inventory for the working copy.""")
410
def add(self, files, verbose=False, ids=None):
411
"""Make files versioned.
413
Note that the command line normally calls smart_add instead.
415
This puts the files in the Added state, so that they will be
416
recorded by the next commit.
419
List of paths to add, relative to the base of the tree.
422
If set, use these instead of automatically generated ids.
423
Must be the same length as the list of files, but may
424
contain None for ids that are to be autogenerated.
426
TODO: Perhaps have an option to add the ids even if the files do
429
TODO: Perhaps return the ids of the files? But then again it
430
is easy to retrieve them if they're needed.
432
TODO: Adding a directory should optionally recurse down and
433
add all non-ignored children. Perhaps do that in a
436
# TODO: Re-adding a file that is removed in the working copy
437
# should probably put it back with the previous ID.
438
if isinstance(files, basestring):
439
assert(ids is None or isinstance(ids, basestring))
445
ids = [None] * len(files)
447
assert(len(ids) == len(files))
451
inv = self.read_working_inventory()
452
for f,file_id in zip(files, ids):
453
if is_control_file(f):
454
raise BzrError("cannot add control file %s" % quotefn(f))
459
raise BzrError("cannot add top-level %r" % f)
461
fullpath = os.path.normpath(self.abspath(f))
464
kind = file_kind(fullpath)
466
# maybe something better?
467
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
469
if kind != 'file' and kind != 'directory':
470
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
473
file_id = gen_file_id(f)
474
inv.add_path(f, kind=kind, file_id=file_id)
477
print 'added', quotefn(f)
479
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
481
self._write_inventory(inv)
486
def print_file(self, file, revno):
487
"""Print `file` to stdout."""
490
tree = self.revision_tree(self.lookup_revision(revno))
491
# use inventory as it was in that revision
492
file_id = tree.inventory.path2id(file)
494
raise BzrError("%r is not present in revision %s" % (file, revno))
495
tree.print_file(file_id)
500
def remove(self, files, verbose=False):
501
"""Mark nominated files for removal from the inventory.
503
This does not remove their text. This does not run on
505
TODO: Refuse to remove modified files unless --force is given?
507
TODO: Do something useful with directories.
509
TODO: Should this remove the text or not? Tough call; not
510
removing may be useful and the user can just use use rm, and
511
is the opposite of add. Removing it is consistent with most
512
other tools. Maybe an option.
514
## TODO: Normalize names
515
## TODO: Remove nested loops; better scalability
516
if isinstance(files, basestring):
522
tree = self.working_tree()
525
# do this before any modifications
529
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
530
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
532
# having remove it, it must be either ignored or unknown
533
if tree.is_ignored(f):
537
show_status(new_status, inv[fid].kind, quotefn(f))
540
self._write_inventory(inv)
545
# FIXME: this doesn't need to be a branch method
546
def set_inventory(self, new_inventory_list):
547
from bzrlib.inventory import Inventory, InventoryEntry
548
inv = Inventory(self.get_root_id())
549
for path, file_id, parent, kind in new_inventory_list:
550
name = os.path.basename(path)
553
inv.add(InventoryEntry(file_id, name, kind, parent))
554
self._write_inventory(inv)
558
"""Return all unknown files.
560
These are files in the working directory that are not versioned or
561
control files or ignored.
563
>>> b = ScratchBranch(files=['foo', 'foo~'])
564
>>> list(b.unknowns())
567
>>> list(b.unknowns())
570
>>> list(b.unknowns())
573
return self.working_tree().unknowns()
576
def append_revision(self, *revision_ids):
577
from bzrlib.atomicfile import AtomicFile
579
for revision_id in revision_ids:
580
mutter("add {%s} to revision-history" % revision_id)
582
rev_history = self.revision_history()
583
rev_history.extend(revision_ids)
585
f = AtomicFile(self.controlfilename('revision-history'))
587
for rev_id in rev_history:
594
def get_revision(self, revision_id):
595
"""Return the Revision object for a named revision"""
598
if not revision_id or not isinstance(revision_id, basestring):
599
raise InvalidRevisionId(revision_id)
600
r = unpack_xml(Revision, self.revision_store[revision_id])
604
assert r.revision_id == revision_id
311
raise NotImplementedError(self.unlock)
313
def peek_lock_mode(self):
314
"""Return lock mode for the Branch: 'r', 'w' or None"""
315
raise NotImplementedError(self.peek_lock_mode)
317
def get_physical_lock_status(self):
318
raise NotImplementedError(self.get_physical_lock_status)
321
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
322
"""Return the revision_id for a dotted revno.
324
:param revno: a tuple like (1,) or (1,1,2)
325
:param _cache_reverse: a private parameter enabling storage
326
of the reverse mapping in a top level cache. (This should
327
only be done in selective circumstances as we want to
328
avoid having the mapping cached multiple times.)
329
:return: the revision_id
330
:raises errors.NoSuchRevision: if the revno doesn't exist
332
rev_id = self._do_dotted_revno_to_revision_id(revno)
334
self._partial_revision_id_to_revno_cache[rev_id] = revno
337
def _do_dotted_revno_to_revision_id(self, revno):
338
"""Worker function for dotted_revno_to_revision_id.
340
Subclasses should override this if they wish to
341
provide a more efficient implementation.
344
return self.get_rev_id(revno[0])
345
revision_id_to_revno = self.get_revision_id_to_revno_map()
346
revision_ids = [revision_id for revision_id, this_revno
347
in revision_id_to_revno.iteritems()
348
if revno == this_revno]
349
if len(revision_ids) == 1:
350
return revision_ids[0]
352
revno_str = '.'.join(map(str, revno))
353
raise errors.NoSuchRevision(self, revno_str)
356
def revision_id_to_dotted_revno(self, revision_id):
357
"""Given a revision id, return its dotted revno.
359
:return: a tuple like (1,) or (400,1,3).
361
return self._do_revision_id_to_dotted_revno(revision_id)
363
def _do_revision_id_to_dotted_revno(self, revision_id):
364
"""Worker function for revision_id_to_revno."""
365
# Try the caches if they are loaded
366
result = self._partial_revision_id_to_revno_cache.get(revision_id)
367
if result is not None:
369
if self._revision_id_to_revno_cache:
370
result = self._revision_id_to_revno_cache.get(revision_id)
372
raise errors.NoSuchRevision(self, revision_id)
373
# Try the mainline as it's optimised
375
revno = self.revision_id_to_revno(revision_id)
377
except errors.NoSuchRevision:
378
# We need to load and use the full revno map after all
379
result = self.get_revision_id_to_revno_map().get(revision_id)
381
raise errors.NoSuchRevision(self, revision_id)
385
def get_revision_id_to_revno_map(self):
386
"""Return the revision_id => dotted revno map.
388
This will be regenerated on demand, but will be cached.
390
:return: A dictionary mapping revision_id => dotted revno.
391
This dictionary should not be modified by the caller.
393
if self._revision_id_to_revno_cache is not None:
394
mapping = self._revision_id_to_revno_cache
396
mapping = self._gen_revno_map()
397
self._cache_revision_id_to_revno(mapping)
398
# TODO: jam 20070417 Since this is being cached, should we be returning
400
# I would rather not, and instead just declare that users should not
401
# modify the return value.
404
def _gen_revno_map(self):
405
"""Create a new mapping from revision ids to dotted revnos.
407
Dotted revnos are generated based on the current tip in the revision
409
This is the worker function for get_revision_id_to_revno_map, which
410
just caches the return value.
412
:return: A dictionary mapping revision_id => dotted revno.
414
revision_id_to_revno = dict((rev_id, revno)
415
for rev_id, depth, revno, end_of_merge
416
in self.iter_merge_sorted_revisions())
417
return revision_id_to_revno
420
def iter_merge_sorted_revisions(self, start_revision_id=None,
421
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
422
"""Walk the revisions for a branch in merge sorted order.
424
Merge sorted order is the output from a merge-aware,
425
topological sort, i.e. all parents come before their
426
children going forward; the opposite for reverse.
428
:param start_revision_id: the revision_id to begin walking from.
429
If None, the branch tip is used.
430
:param stop_revision_id: the revision_id to terminate the walk
431
after. If None, the rest of history is included.
432
:param stop_rule: if stop_revision_id is not None, the precise rule
433
to use for termination:
434
* 'exclude' - leave the stop revision out of the result (default)
435
* 'include' - the stop revision is the last item in the result
436
* 'with-merges' - include the stop revision and all of its
437
merged revisions in the result
438
* 'with-merges-without-common-ancestry' - filter out revisions
439
that are in both ancestries
440
:param direction: either 'reverse' or 'forward':
441
* reverse means return the start_revision_id first, i.e.
442
start at the most recent revision and go backwards in history
443
* forward returns tuples in the opposite order to reverse.
444
Note in particular that forward does *not* do any intelligent
445
ordering w.r.t. depth as some clients of this API may like.
446
(If required, that ought to be done at higher layers.)
448
:return: an iterator over (revision_id, depth, revno, end_of_merge)
451
* revision_id: the unique id of the revision
452
* depth: How many levels of merging deep this node has been
454
* revno_sequence: This field provides a sequence of
455
revision numbers for all revisions. The format is:
456
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
457
branch that the revno is on. From left to right the REVNO numbers
458
are the sequence numbers within that branch of the revision.
459
* end_of_merge: When True the next node (earlier in history) is
460
part of a different merge.
462
# Note: depth and revno values are in the context of the branch so
463
# we need the full graph to get stable numbers, regardless of the
465
if self._merge_sorted_revisions_cache is None:
466
last_revision = self.last_revision()
467
known_graph = self.repository.get_known_graph_ancestry(
469
self._merge_sorted_revisions_cache = known_graph.merge_sort(
471
filtered = self._filter_merge_sorted_revisions(
472
self._merge_sorted_revisions_cache, start_revision_id,
473
stop_revision_id, stop_rule)
474
# Make sure we don't return revisions that are not part of the
475
# start_revision_id ancestry.
476
filtered = self._filter_start_non_ancestors(filtered)
477
if direction == 'reverse':
479
if direction == 'forward':
480
return reversed(list(filtered))
482
raise ValueError('invalid direction %r' % direction)
484
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
485
start_revision_id, stop_revision_id, stop_rule):
486
"""Iterate over an inclusive range of sorted revisions."""
487
rev_iter = iter(merge_sorted_revisions)
488
if start_revision_id is not None:
489
for node in rev_iter:
490
rev_id = node.key[-1]
491
if rev_id != start_revision_id:
494
# The decision to include the start or not
495
# depends on the stop_rule if a stop is provided
496
# so pop this node back into the iterator
497
rev_iter = chain(iter([node]), rev_iter)
499
if stop_revision_id is None:
501
for node in rev_iter:
502
rev_id = node.key[-1]
503
yield (rev_id, node.merge_depth, node.revno,
505
elif stop_rule == 'exclude':
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
if rev_id == stop_revision_id:
510
yield (rev_id, node.merge_depth, node.revno,
512
elif stop_rule == 'include':
513
for node in rev_iter:
514
rev_id = node.key[-1]
515
yield (rev_id, node.merge_depth, node.revno,
517
if rev_id == stop_revision_id:
519
elif stop_rule == 'with-merges-without-common-ancestry':
520
# We want to exclude all revisions that are already part of the
521
# stop_revision_id ancestry.
522
graph = self.repository.get_graph()
523
ancestors = graph.find_unique_ancestors(start_revision_id,
525
for node in rev_iter:
526
rev_id = node.key[-1]
527
if rev_id not in ancestors:
529
yield (rev_id, node.merge_depth, node.revno,
531
elif stop_rule == 'with-merges':
532
stop_rev = self.repository.get_revision(stop_revision_id)
533
if stop_rev.parent_ids:
534
left_parent = stop_rev.parent_ids[0]
536
left_parent = _mod_revision.NULL_REVISION
537
# left_parent is the actual revision we want to stop logging at,
538
# since we want to show the merged revisions after the stop_rev too
539
reached_stop_revision_id = False
540
revision_id_whitelist = []
541
for node in rev_iter:
542
rev_id = node.key[-1]
543
if rev_id == left_parent:
544
# reached the left parent after the stop_revision
546
if (not reached_stop_revision_id or
547
rev_id in revision_id_whitelist):
548
yield (rev_id, node.merge_depth, node.revno,
550
if reached_stop_revision_id or rev_id == stop_revision_id:
551
# only do the merged revs of rev_id from now on
552
rev = self.repository.get_revision(rev_id)
554
reached_stop_revision_id = True
555
revision_id_whitelist.extend(rev.parent_ids)
557
raise ValueError('invalid stop_rule %r' % stop_rule)
559
def _filter_start_non_ancestors(self, rev_iter):
560
# If we started from a dotted revno, we want to consider it as a tip
561
# and don't want to yield revisions that are not part of its
562
# ancestry. Given the order guaranteed by the merge sort, we will see
563
# uninteresting descendants of the first parent of our tip before the
565
first = rev_iter.next()
566
(rev_id, merge_depth, revno, end_of_merge) = first
569
# We start at a mainline revision so by definition, all others
570
# revisions in rev_iter are ancestors
571
for node in rev_iter:
576
pmap = self.repository.get_parent_map([rev_id])
577
parents = pmap.get(rev_id, [])
579
whitelist.update(parents)
581
# If there is no parents, there is nothing of interest left
583
# FIXME: It's hard to test this scenario here as this code is never
584
# called in that case. -- vila 20100322
587
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
589
if rev_id in whitelist:
590
pmap = self.repository.get_parent_map([rev_id])
591
parents = pmap.get(rev_id, [])
592
whitelist.remove(rev_id)
593
whitelist.update(parents)
595
# We've reached the mainline, there is nothing left to
599
# A revision that is not part of the ancestry of our
602
yield (rev_id, merge_depth, revno, end_of_merge)
604
def leave_lock_in_place(self):
605
"""Tell this branch object not to release the physical lock when this
608
If lock_write doesn't return a token, then this method is not supported.
610
self.control_files.leave_in_place()
612
def dont_leave_lock_in_place(self):
613
"""Tell this branch object to release the physical lock when this
614
object is unlocked, even if it didn't originally acquire it.
616
If lock_write doesn't return a token, then this method is not supported.
618
self.control_files.dont_leave_in_place()
620
def bind(self, other):
621
"""Bind the local branch the other branch.
623
:param other: The branch to bind to
626
raise errors.UpgradeRequired(self.user_url)
628
def set_append_revisions_only(self, enabled):
629
if not self._format.supports_set_append_revisions_only():
630
raise errors.UpgradeRequired(self.user_url)
635
self.get_config().set_user_option('append_revisions_only', value,
638
def set_reference_info(self, file_id, tree_path, branch_location):
639
"""Set the branch location to use for a tree reference."""
640
raise errors.UnsupportedOperation(self.set_reference_info, self)
642
def get_reference_info(self, file_id):
643
"""Get the tree_path and branch_location for a tree reference."""
644
raise errors.UnsupportedOperation(self.get_reference_info, self)
647
def fetch(self, from_branch, last_revision=None, pb=None):
648
"""Copy revisions from from_branch into this branch.
650
:param from_branch: Where to copy from.
651
:param last_revision: What revision to stop at (None for at the end
653
:param pb: An optional progress bar to use.
656
if self.base == from_branch.base:
659
symbol_versioning.warn(
660
symbol_versioning.deprecated_in((1, 14, 0))
661
% "pb parameter to fetch()")
662
from_branch.lock_read()
664
if last_revision is None:
665
last_revision = from_branch.last_revision()
666
last_revision = _mod_revision.ensure_null(last_revision)
667
return self.repository.fetch(from_branch.repository,
668
revision_id=last_revision,
673
def get_bound_location(self):
674
"""Return the URL of the branch we are bound to.
676
Older format branches cannot bind, please be sure to use a metadir
681
def get_old_bound_location(self):
682
"""Return the URL of the branch we used to be bound to
684
raise errors.UpgradeRequired(self.user_url)
686
def get_commit_builder(self, parents, config=None, timestamp=None,
687
timezone=None, committer=None, revprops=None,
689
"""Obtain a CommitBuilder for this branch.
691
:param parents: Revision ids of the parents of the new revision.
692
:param config: Optional configuration to use.
693
:param timestamp: Optional timestamp recorded for commit.
694
:param timezone: Optional timezone for timestamp.
695
:param committer: Optional committer to set for commit.
696
:param revprops: Optional dictionary of revision properties.
697
:param revision_id: Optional revision id.
701
config = self.get_config()
703
return self.repository.get_commit_builder(self, parents, config,
704
timestamp, timezone, committer, revprops, revision_id)
706
def get_master_branch(self, possible_transports=None):
707
"""Return the branch we are bound to.
709
:return: Either a Branch, or None
608
713
def get_revision_delta(self, revno):
609
714
"""Return the delta for one revision.
780
988
common_index = min(self_len, other_len) -1
781
989
if common_index >= 0 and \
782
990
self_history[common_index] != other_history[common_index]:
783
raise DivergedBranches(self, other)
991
raise errors.DivergedBranches(self, other)
785
993
if stop_revision is None:
786
994
stop_revision = other_len
787
elif stop_revision > other_len:
788
raise NoSuchRevision(self, stop_revision)
996
if stop_revision > other_len:
997
raise errors.NoSuchRevision(self, stop_revision)
790
998
return other_history[self_len:stop_revision]
793
def update_revisions(self, other, stop_revision=None):
794
"""Pull in all new revisions from other branch.
796
>>> from bzrlib.commit import commit
797
>>> bzrlib.trace.silent = True
798
>>> br1 = ScratchBranch(files=['foo', 'bar'])
801
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
802
>>> br2 = ScratchBranch()
803
>>> br2.update_revisions(br1)
807
>>> br2.revision_history()
809
>>> br2.update_revisions(br1)
813
>>> br1.text_store.total_size() == br2.text_store.total_size()
816
from bzrlib.progress import ProgressBar
820
pb.update('comparing histories')
821
revision_ids = self.missing_revisions(other, stop_revision)
823
if hasattr(other.revision_store, "prefetch"):
824
other.revision_store.prefetch(revision_ids)
825
if hasattr(other.inventory_store, "prefetch"):
826
inventory_ids = [other.get_revision(r).inventory_id
827
for r in revision_ids]
828
other.inventory_store.prefetch(inventory_ids)
833
for rev_id in revision_ids:
835
pb.update('fetching revision', i, len(revision_ids))
836
rev = other.get_revision(rev_id)
837
revisions.append(rev)
838
inv = other.get_inventory(str(rev.inventory_id))
839
for key, entry in inv.iter_entries():
840
if entry.text_id is None:
842
if entry.text_id not in self.text_store:
843
needed_texts.add(entry.text_id)
847
count = self.text_store.copy_multi(other.text_store, needed_texts)
848
print "Added %d texts." % count
849
inventory_ids = [ f.inventory_id for f in revisions ]
850
count = self.inventory_store.copy_multi(other.inventory_store,
852
print "Added %d inventories." % count
853
revision_ids = [ f.revision_id for f in revisions]
854
count = self.revision_store.copy_multi(other.revision_store,
856
for revision_id in revision_ids:
857
self.append_revision(revision_id)
858
print "Added %d revisions." % count
861
def commit(self, *args, **kw):
862
from bzrlib.commit import commit
863
commit(self, *args, **kw)
866
def lookup_revision(self, revision):
867
"""Return the revision identifier for a given revision information."""
868
revno, info = self.get_revision_info(revision)
871
def get_revision_info(self, revision):
872
"""Return (revno, revision id) for revision identifier.
874
revision can be an integer, in which case it is assumed to be revno (though
875
this will translate negative values into positive ones)
876
revision can also be a string, in which case it is parsed for something like
877
'date:' or 'revid:' etc.
882
try:# Convert to int if possible
883
revision = int(revision)
886
revs = self.revision_history()
887
if isinstance(revision, int):
890
# Mabye we should do this first, but we don't need it if revision == 0
892
revno = len(revs) + revision + 1
895
elif isinstance(revision, basestring):
896
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
897
if revision.startswith(prefix):
898
revno = func(self, revs, revision)
901
raise BzrError('No namespace registered for string: %r' % revision)
903
if revno is None or revno <= 0 or revno > len(revs):
904
raise BzrError("no such revision %s" % revision)
905
return revno, revs[revno-1]
907
def _namespace_revno(self, revs, revision):
908
"""Lookup a revision by revision number"""
909
assert revision.startswith('revno:')
911
return int(revision[6:])
914
REVISION_NAMESPACES['revno:'] = _namespace_revno
916
def _namespace_revid(self, revs, revision):
917
assert revision.startswith('revid:')
919
return revs.index(revision[6:]) + 1
922
REVISION_NAMESPACES['revid:'] = _namespace_revid
924
def _namespace_last(self, revs, revision):
925
assert revision.startswith('last:')
927
offset = int(revision[5:])
932
raise BzrError('You must supply a positive value for --revision last:XXX')
933
return len(revs) - offset + 1
934
REVISION_NAMESPACES['last:'] = _namespace_last
936
def _namespace_tag(self, revs, revision):
937
assert revision.startswith('tag:')
938
raise BzrError('tag: namespace registered, but not implemented.')
939
REVISION_NAMESPACES['tag:'] = _namespace_tag
941
def _namespace_date(self, revs, revision):
942
assert revision.startswith('date:')
944
# Spec for date revisions:
946
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
947
# it can also start with a '+/-/='. '+' says match the first
948
# entry after the given date. '-' is match the first entry before the date
949
# '=' is match the first entry after, but still on the given date.
951
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
952
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
953
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
954
# May 13th, 2005 at 0:00
956
# So the proper way of saying 'give me all entries for today' is:
957
# -r {date:+today}:{date:-tomorrow}
958
# The default is '=' when not supplied
961
if val[:1] in ('+', '-', '='):
962
match_style = val[:1]
965
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
966
if val.lower() == 'yesterday':
967
dt = today - datetime.timedelta(days=1)
968
elif val.lower() == 'today':
970
elif val.lower() == 'tomorrow':
971
dt = today + datetime.timedelta(days=1)
974
# This should be done outside the function to avoid recompiling it.
975
_date_re = re.compile(
976
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
978
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
980
m = _date_re.match(val)
981
if not m or (not m.group('date') and not m.group('time')):
982
raise BzrError('Invalid revision date %r' % revision)
985
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
987
year, month, day = today.year, today.month, today.day
989
hour = int(m.group('hour'))
990
minute = int(m.group('minute'))
991
if m.group('second'):
992
second = int(m.group('second'))
996
hour, minute, second = 0,0,0
998
dt = datetime.datetime(year=year, month=month, day=day,
999
hour=hour, minute=minute, second=second)
1003
if match_style == '-':
1005
elif match_style == '=':
1006
last = dt + datetime.timedelta(days=1)
1009
for i in range(len(revs)-1, -1, -1):
1010
r = self.get_revision(revs[i])
1011
# TODO: Handle timezone.
1012
dt = datetime.datetime.fromtimestamp(r.timestamp)
1013
if first >= dt and (last is None or dt >= last):
1016
for i in range(len(revs)):
1017
r = self.get_revision(revs[i])
1018
# TODO: Handle timezone.
1019
dt = datetime.datetime.fromtimestamp(r.timestamp)
1020
if first <= dt and (last is None or dt <= last):
1022
REVISION_NAMESPACES['date:'] = _namespace_date
1024
def revision_tree(self, revision_id):
1025
"""Return Tree for a revision on this branch.
1027
`revision_id` may be None for the null revision, in which case
1028
an `EmptyTree` is returned."""
1029
# TODO: refactor this to use an existing revision object
1030
# so we don't need to read it in twice.
1031
if revision_id == None:
1032
return EmptyTree(self.get_root_id())
1034
inv = self.get_revision_inventory(revision_id)
1035
return RevisionTree(self.text_store, inv)
1038
def working_tree(self):
1039
"""Return a `Tree` for the working copy."""
1040
from workingtree import WorkingTree
1041
return WorkingTree(self.base, self.read_working_inventory())
1000
def update_revisions(self, other, stop_revision=None, overwrite=False,
1002
"""Pull in new perfect-fit revisions.
1004
:param other: Another Branch to pull from
1005
:param stop_revision: Updated until the given revision
1006
:param overwrite: Always set the branch pointer, rather than checking
1007
to see if it is a proper descendant.
1008
:param graph: A Graph object that can be used to query history
1009
information. This can be None.
1012
return InterBranch.get(other, self).update_revisions(stop_revision,
1015
def import_last_revision_info(self, source_repo, revno, revid):
1016
"""Set the last revision info, importing from another repo if necessary.
1018
This is used by the bound branch code to upload a revision to
1019
the master branch first before updating the tip of the local branch.
1021
:param source_repo: Source repository to optionally fetch from
1022
:param revno: Revision number of the new tip
1023
:param revid: Revision id of the new tip
1025
if not self.repository.has_same_location(source_repo):
1026
self.repository.fetch(source_repo, revision_id=revid)
1027
self.set_last_revision_info(revno, revid)
1029
def revision_id_to_revno(self, revision_id):
1030
"""Given a revision id, return its revno"""
1031
if _mod_revision.is_null(revision_id):
1033
history = self.revision_history()
1035
return history.index(revision_id) + 1
1037
raise errors.NoSuchRevision(self, revision_id)
1040
def get_rev_id(self, revno, history=None):
1041
"""Find the revision id of the specified revno."""
1043
return _mod_revision.NULL_REVISION
1044
last_revno, last_revid = self.last_revision_info()
1045
if revno == last_revno:
1047
if revno <= 0 or revno > last_revno:
1048
raise errors.NoSuchRevision(self, revno)
1049
distance_from_last = last_revno - revno
1050
if len(self._partial_revision_history_cache) <= distance_from_last:
1051
self._extend_partial_history(distance_from_last)
1052
return self._partial_revision_history_cache[distance_from_last]
1054
def pull(self, source, overwrite=False, stop_revision=None,
1055
possible_transports=None, *args, **kwargs):
1056
"""Mirror source into this branch.
1058
This branch is considered to be 'local', having low latency.
1060
:returns: PullResult instance
1062
return InterBranch.get(source, self).pull(overwrite=overwrite,
1063
stop_revision=stop_revision,
1064
possible_transports=possible_transports, *args, **kwargs)
1066
def push(self, target, overwrite=False, stop_revision=None, *args,
1068
"""Mirror this branch into target.
1070
This branch is considered to be 'local', having low latency.
1072
return InterBranch.get(self, target).push(overwrite, stop_revision,
1075
def lossy_push(self, target, stop_revision=None):
1076
"""Push deltas into another branch.
1078
:note: This does not, like push, retain the revision ids from
1079
the source branch and will, rather than adding bzr-specific
1080
metadata, push only those semantics of the revision that can be
1081
natively represented by this branch' VCS.
1083
:param target: Target branch
1084
:param stop_revision: Revision to push, defaults to last revision.
1085
:return: BranchPushResult with an extra member revidmap:
1086
A dictionary mapping revision ids from the target branch
1087
to new revision ids in the target branch, for each
1088
revision that was pushed.
1090
inter = InterBranch.get(self, target)
1091
lossy_push = getattr(inter, "lossy_push", None)
1092
if lossy_push is None:
1093
raise errors.LossyPushToSameVCS(self, target)
1094
return lossy_push(stop_revision)
1044
1096
def basis_tree(self):
1045
"""Return `Tree` object for last revision.
1047
If there are no revisions yet, return an `EmptyTree`.
1049
r = self.last_patch()
1051
return EmptyTree(self.get_root_id())
1053
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1057
def rename_one(self, from_rel, to_rel):
1060
This can change the directory or the filename or both.
1064
tree = self.working_tree()
1065
inv = tree.inventory
1066
if not tree.has_filename(from_rel):
1067
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1068
if tree.has_filename(to_rel):
1069
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1071
file_id = inv.path2id(from_rel)
1073
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1075
if inv.path2id(to_rel):
1076
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1078
to_dir, to_tail = os.path.split(to_rel)
1079
to_dir_id = inv.path2id(to_dir)
1080
if to_dir_id == None and to_dir != '':
1081
raise BzrError("can't determine destination directory id for %r" % to_dir)
1083
mutter("rename_one:")
1084
mutter(" file_id {%s}" % file_id)
1085
mutter(" from_rel %r" % from_rel)
1086
mutter(" to_rel %r" % to_rel)
1087
mutter(" to_dir %r" % to_dir)
1088
mutter(" to_dir_id {%s}" % to_dir_id)
1090
inv.rename(file_id, to_dir_id, to_tail)
1092
print "%s => %s" % (from_rel, to_rel)
1094
from_abs = self.abspath(from_rel)
1095
to_abs = self.abspath(to_rel)
1097
os.rename(from_abs, to_abs)
1099
raise BzrError("failed to rename %r to %r: %s"
1100
% (from_abs, to_abs, e[1]),
1101
["rename rolled back"])
1103
self._write_inventory(inv)
1108
def move(self, from_paths, to_name):
1111
to_name must exist as a versioned directory.
1113
If to_name exists and is a directory, the files are moved into
1114
it, keeping their old names. If it is a directory,
1116
Note that to_name is only the last component of the new name;
1117
this doesn't change the directory.
1121
## TODO: Option to move IDs only
1122
assert not isinstance(from_paths, basestring)
1123
tree = self.working_tree()
1124
inv = tree.inventory
1125
to_abs = self.abspath(to_name)
1126
if not isdir(to_abs):
1127
raise BzrError("destination %r is not a directory" % to_abs)
1128
if not tree.has_filename(to_name):
1129
raise BzrError("destination %r not in working directory" % to_abs)
1130
to_dir_id = inv.path2id(to_name)
1131
if to_dir_id == None and to_name != '':
1132
raise BzrError("destination %r is not a versioned directory" % to_name)
1133
to_dir_ie = inv[to_dir_id]
1134
if to_dir_ie.kind not in ('directory', 'root_directory'):
1135
raise BzrError("destination %r is not a directory" % to_abs)
1137
to_idpath = inv.get_idpath(to_dir_id)
1139
for f in from_paths:
1140
if not tree.has_filename(f):
1141
raise BzrError("%r does not exist in working tree" % f)
1142
f_id = inv.path2id(f)
1144
raise BzrError("%r is not versioned" % f)
1145
name_tail = splitpath(f)[-1]
1146
dest_path = appendpath(to_name, name_tail)
1147
if tree.has_filename(dest_path):
1148
raise BzrError("destination %r already exists" % dest_path)
1149
if f_id in to_idpath:
1150
raise BzrError("can't move %r to a subdirectory of itself" % f)
1152
# OK, so there's a race here, it's possible that someone will
1153
# create a file in this interval and then the rename might be
1154
# left half-done. But we should have caught most problems.
1156
for f in from_paths:
1157
name_tail = splitpath(f)[-1]
1158
dest_path = appendpath(to_name, name_tail)
1159
print "%s => %s" % (f, dest_path)
1160
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1162
os.rename(self.abspath(f), self.abspath(dest_path))
1164
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1165
["rename rolled back"])
1167
self._write_inventory(inv)
1172
def revert(self, filenames, old_tree=None, backups=True):
1173
"""Restore selected files to the versions from a previous tree.
1176
If true (default) backups are made of files before
1179
from bzrlib.errors import NotVersionedError, BzrError
1180
from bzrlib.atomicfile import AtomicFile
1181
from bzrlib.osutils import backup_file
1183
inv = self.read_working_inventory()
1184
if old_tree is None:
1185
old_tree = self.basis_tree()
1186
old_inv = old_tree.inventory
1189
for fn in filenames:
1190
file_id = inv.path2id(fn)
1192
raise NotVersionedError("not a versioned file", fn)
1193
if not old_inv.has_id(file_id):
1194
raise BzrError("file not present in old tree", fn, file_id)
1195
nids.append((fn, file_id))
1197
# TODO: Rename back if it was previously at a different location
1199
# TODO: If given a directory, restore the entire contents from
1200
# the previous version.
1202
# TODO: Make a backup to a temporary file.
1204
# TODO: If the file previously didn't exist, delete it?
1205
for fn, file_id in nids:
1208
f = AtomicFile(fn, 'wb')
1210
f.write(old_tree.get_file(file_id).read())
1216
def pending_merges(self):
1217
"""Return a list of pending merges.
1219
These are revisions that have been merged into the working
1220
directory but not yet committed.
1222
cfn = self.controlfilename('pending-merges')
1223
if not os.path.exists(cfn):
1226
for l in self.controlfile('pending-merges', 'r').readlines():
1227
p.append(l.rstrip('\n'))
1231
def add_pending_merge(self, revision_id):
1232
from bzrlib.revision import validate_revision_id
1234
validate_revision_id(revision_id)
1236
p = self.pending_merges()
1237
if revision_id in p:
1239
p.append(revision_id)
1240
self.set_pending_merges(p)
1243
def set_pending_merges(self, rev_list):
1244
from bzrlib.atomicfile import AtomicFile
1247
f = AtomicFile(self.controlfilename('pending-merges'))
1259
class ScratchBranch(Branch):
1260
"""Special test class: a branch that cleans up after itself.
1262
>>> b = ScratchBranch()
1097
"""Return `Tree` object for last revision."""
1098
return self.repository.revision_tree(self.last_revision())
1100
def get_parent(self):
1101
"""Return the parent location of the branch.
1103
This is the default location for pull/missing. The usual
1104
pattern is that the user can override it by specifying a
1107
parent = self._get_parent_location()
1110
# This is an old-format absolute path to a local branch
1111
# turn it into a url
1112
if parent.startswith('/'):
1113
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1115
return urlutils.join(self.base[:-1], parent)
1116
except errors.InvalidURLJoin, e:
1117
raise errors.InaccessibleParent(parent, self.user_url)
1119
def _get_parent_location(self):
1120
raise NotImplementedError(self._get_parent_location)
1122
def _set_config_location(self, name, url, config=None,
1123
make_relative=False):
1125
config = self.get_config()
1129
url = urlutils.relative_url(self.base, url)
1130
config.set_user_option(name, url, warn_masked=True)
1132
def _get_config_location(self, name, config=None):
1134
config = self.get_config()
1135
location = config.get_user_option(name)
1140
def get_child_submit_format(self):
1141
"""Return the preferred format of submissions to this branch."""
1142
return self.get_config().get_user_option("child_submit_format")
1144
def get_submit_branch(self):
1145
"""Return the submit location of the branch.
1147
This is the default location for bundle. The usual
1148
pattern is that the user can override it by specifying a
1151
return self.get_config().get_user_option('submit_branch')
1153
def set_submit_branch(self, location):
1154
"""Return the submit location of the branch.
1156
This is the default location for bundle. The usual
1157
pattern is that the user can override it by specifying a
1160
self.get_config().set_user_option('submit_branch', location,
1163
def get_public_branch(self):
1164
"""Return the public location of the branch.
1166
This is used by merge directives.
1168
return self._get_config_location('public_branch')
1170
def set_public_branch(self, location):
1171
"""Return the submit location of the branch.
1173
This is the default location for bundle. The usual
1174
pattern is that the user can override it by specifying a
1177
self._set_config_location('public_branch', location)
1179
def get_push_location(self):
1180
"""Return the None or the location to push this branch to."""
1181
push_loc = self.get_config().get_user_option('push_location')
1184
def set_push_location(self, location):
1185
"""Set a new push location for this branch."""
1186
raise NotImplementedError(self.set_push_location)
1188
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1189
"""Run the post_change_branch_tip hooks."""
1190
hooks = Branch.hooks['post_change_branch_tip']
1193
new_revno, new_revid = self.last_revision_info()
1194
params = ChangeBranchTipParams(
1195
self, old_revno, new_revno, old_revid, new_revid)
1199
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1200
"""Run the pre_change_branch_tip hooks."""
1201
hooks = Branch.hooks['pre_change_branch_tip']
1204
old_revno, old_revid = self.last_revision_info()
1205
params = ChangeBranchTipParams(
1206
self, old_revno, new_revno, old_revid, new_revid)
1212
"""Synchronise this branch with the master branch if any.
1214
:return: None or the last_revision pivoted out during the update.
1218
def check_revno(self, revno):
1220
Check whether a revno corresponds to any revision.
1221
Zero (the NULL revision) is considered valid.
1224
self.check_real_revno(revno)
1226
def check_real_revno(self, revno):
1228
Check whether a revno corresponds to a real revision.
1229
Zero (the NULL revision) is considered invalid
1231
if revno < 1 or revno > self.revno():
1232
raise errors.InvalidRevisionNumber(revno)
1235
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1236
"""Clone this branch into to_bzrdir preserving all semantic values.
1238
Most API users will want 'create_clone_on_transport', which creates a
1239
new bzrdir and branch on the fly.
1241
revision_id: if not None, the revision history in the new branch will
1242
be truncated to end with revision_id.
1244
result = to_bzrdir.create_branch()
1247
if repository_policy is not None:
1248
repository_policy.configure_branch(result)
1249
self.copy_content_into(result, revision_id=revision_id)
1255
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1256
"""Create a new line of development from the branch, into to_bzrdir.
1258
to_bzrdir controls the branch format.
1260
revision_id: if not None, the revision history in the new branch will
1261
be truncated to end with revision_id.
1263
if (repository_policy is not None and
1264
repository_policy.requires_stacking()):
1265
to_bzrdir._format.require_stacking(_skip_repo=True)
1266
result = to_bzrdir.create_branch()
1269
if repository_policy is not None:
1270
repository_policy.configure_branch(result)
1271
self.copy_content_into(result, revision_id=revision_id)
1272
result.set_parent(self.bzrdir.root_transport.base)
1277
def _synchronize_history(self, destination, revision_id):
1278
"""Synchronize last revision and revision history between branches.
1280
This version is most efficient when the destination is also a
1281
BzrBranch6, but works for BzrBranch5, as long as the destination's
1282
repository contains all the lefthand ancestors of the intended
1283
last_revision. If not, set_last_revision_info will fail.
1285
:param destination: The branch to copy the history into
1286
:param revision_id: The revision-id to truncate history at. May
1287
be None to copy complete history.
1289
source_revno, source_revision_id = self.last_revision_info()
1290
if revision_id is None:
1291
revno, revision_id = source_revno, source_revision_id
1293
graph = self.repository.get_graph()
1295
revno = graph.find_distance_to_null(revision_id,
1296
[(source_revision_id, source_revno)])
1297
except errors.GhostRevisionsHaveNoRevno:
1298
# Default to 1, if we can't find anything else
1300
destination.set_last_revision_info(revno, revision_id)
1302
def copy_content_into(self, destination, revision_id=None):
1303
"""Copy the content of self into destination.
1305
revision_id: if not None, the revision history in the new branch will
1306
be truncated to end with revision_id.
1308
return InterBranch.get(self, destination).copy_content_into(
1309
revision_id=revision_id)
1311
def update_references(self, target):
1312
if not getattr(self._format, 'supports_reference_locations', False):
1314
reference_dict = self._get_all_reference_info()
1315
if len(reference_dict) == 0:
1317
old_base = self.base
1318
new_base = target.base
1319
target_reference_dict = target._get_all_reference_info()
1320
for file_id, (tree_path, branch_location) in (
1321
reference_dict.items()):
1322
branch_location = urlutils.rebase_url(branch_location,
1324
target_reference_dict.setdefault(
1325
file_id, (tree_path, branch_location))
1326
target._set_all_reference_info(target_reference_dict)
1329
def check(self, refs):
1330
"""Check consistency of the branch.
1332
In particular this checks that revisions given in the revision-history
1333
do actually match up in the revision graph, and that they're all
1334
present in the repository.
1336
Callers will typically also want to check the repository.
1338
:param refs: Calculated refs for this branch as specified by
1339
branch._get_check_refs()
1340
:return: A BranchCheckResult.
1342
result = BranchCheckResult(self)
1343
last_revno, last_revision_id = self.last_revision_info()
1344
actual_revno = refs[('lefthand-distance', last_revision_id)]
1345
if actual_revno != last_revno:
1346
result.errors.append(errors.BzrCheckError(
1347
'revno does not match len(mainline) %s != %s' % (
1348
last_revno, actual_revno)))
1349
# TODO: We should probably also check that self.revision_history
1350
# matches the repository for older branch formats.
1351
# If looking for the code that cross-checks repository parents against
1352
# the iter_reverse_revision_history output, that is now a repository
1356
def _get_checkout_format(self):
1357
"""Return the most suitable metadir for a checkout of this branch.
1358
Weaves are used if this branch's repository uses weaves.
1360
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1361
from bzrlib.repofmt import weaverepo
1362
format = bzrdir.BzrDirMetaFormat1()
1363
format.repository_format = weaverepo.RepositoryFormat7()
1365
format = self.repository.bzrdir.checkout_metadir()
1366
format.set_branch_format(self._format)
1369
def create_clone_on_transport(self, to_transport, revision_id=None,
1370
stacked_on=None, create_prefix=False, use_existing_dir=False):
1371
"""Create a clone of this branch and its bzrdir.
1373
:param to_transport: The transport to clone onto.
1374
:param revision_id: The revision id to use as tip in the new branch.
1375
If None the tip is obtained from this branch.
1376
:param stacked_on: An optional URL to stack the clone on.
1377
:param create_prefix: Create any missing directories leading up to
1379
:param use_existing_dir: Use an existing directory if one exists.
1381
# XXX: Fix the bzrdir API to allow getting the branch back from the
1382
# clone call. Or something. 20090224 RBC/spiv.
1383
# XXX: Should this perhaps clone colocated branches as well,
1384
# rather than just the default branch? 20100319 JRV
1385
if revision_id is None:
1386
revision_id = self.last_revision()
1387
dir_to = self.bzrdir.clone_on_transport(to_transport,
1388
revision_id=revision_id, stacked_on=stacked_on,
1389
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1390
return dir_to.open_branch()
1392
def create_checkout(self, to_location, revision_id=None,
1393
lightweight=False, accelerator_tree=None,
1395
"""Create a checkout of a branch.
1397
:param to_location: The url to produce the checkout at
1398
:param revision_id: The revision to check out
1399
:param lightweight: If True, produce a lightweight checkout, otherwise,
1400
produce a bound branch (heavyweight checkout)
1401
:param accelerator_tree: A tree which can be used for retrieving file
1402
contents more quickly than the revision tree, i.e. a workingtree.
1403
The revision tree will be used for cases where accelerator_tree's
1404
content is different.
1405
:param hardlink: If true, hard-link files from accelerator_tree,
1407
:return: The tree of the created checkout
1409
t = transport.get_transport(to_location)
1412
format = self._get_checkout_format()
1413
checkout = format.initialize_on_transport(t)
1414
from_branch = BranchReferenceFormat().initialize(checkout,
1417
format = self._get_checkout_format()
1418
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1419
to_location, force_new_tree=False, format=format)
1420
checkout = checkout_branch.bzrdir
1421
checkout_branch.bind(self)
1422
# pull up to the specified revision_id to set the initial
1423
# branch tip correctly, and seed it with history.
1424
checkout_branch.pull(self, stop_revision=revision_id)
1426
tree = checkout.create_workingtree(revision_id,
1427
from_branch=from_branch,
1428
accelerator_tree=accelerator_tree,
1430
basis_tree = tree.basis_tree()
1431
basis_tree.lock_read()
1433
for path, file_id in basis_tree.iter_references():
1434
reference_parent = self.reference_parent(file_id, path)
1435
reference_parent.create_checkout(tree.abspath(path),
1436
basis_tree.get_reference_revision(file_id, path),
1443
def reconcile(self, thorough=True):
1444
"""Make sure the data stored in this branch is consistent."""
1445
from bzrlib.reconcile import BranchReconciler
1446
reconciler = BranchReconciler(self, thorough=thorough)
1447
reconciler.reconcile()
1450
def reference_parent(self, file_id, path, possible_transports=None):
1451
"""Return the parent branch for a tree-reference file_id
1452
:param file_id: The file_id of the tree reference
1453
:param path: The path of the file_id in the tree
1454
:return: A branch associated with the file_id
1456
# FIXME should provide multiple branches, based on config
1457
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1458
possible_transports=possible_transports)
1460
def supports_tags(self):
1461
return self._format.supports_tags()
1463
def automatic_tag_name(self, revision_id):
1464
"""Try to automatically find the tag name for a revision.
1466
:param revision_id: Revision id of the revision.
1467
:return: A tag name or None if no tag name could be determined.
1469
for hook in Branch.hooks['automatic_tag_name']:
1470
ret = hook(self, revision_id)
1475
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1477
"""Ensure that revision_b is a descendant of revision_a.
1479
This is a helper function for update_revisions.
1481
:raises: DivergedBranches if revision_b has diverged from revision_a.
1482
:returns: True if revision_b is a descendant of revision_a.
1484
relation = self._revision_relations(revision_a, revision_b, graph)
1485
if relation == 'b_descends_from_a':
1487
elif relation == 'diverged':
1488
raise errors.DivergedBranches(self, other_branch)
1489
elif relation == 'a_descends_from_b':
1492
raise AssertionError("invalid relation: %r" % (relation,))
1494
def _revision_relations(self, revision_a, revision_b, graph):
1495
"""Determine the relationship between two revisions.
1497
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1499
heads = graph.heads([revision_a, revision_b])
1500
if heads == set([revision_b]):
1501
return 'b_descends_from_a'
1502
elif heads == set([revision_a, revision_b]):
1503
# These branches have diverged
1505
elif heads == set([revision_a]):
1506
return 'a_descends_from_b'
1508
raise AssertionError("invalid heads: %r" % (heads,))
1511
class BranchFormat(object):
1512
"""An encapsulation of the initialization and open routines for a format.
1514
Formats provide three things:
1515
* An initialization routine,
1519
Formats are placed in an dict by their format string for reference
1520
during branch opening. Its not required that these be instances, they
1521
can be classes themselves with class methods - it simply depends on
1522
whether state is needed for a given format or not.
1524
Once a format is deprecated, just deprecate the initialize and open
1525
methods on the format class. Do not deprecate the object, as the
1526
object will be created every time regardless.
1270
def __init__(self, files=[], dirs=[], base=None):
1271
"""Make a test branch.
1273
This creates a temporary directory and runs init-tree in it.
1275
If any files are listed, they are created in the working copy.
1277
from tempfile import mkdtemp
1282
Branch.__init__(self, base, init=init)
1284
os.mkdir(self.abspath(d))
1287
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1292
>>> orig = ScratchBranch(files=["file1", "file2"])
1293
>>> clone = orig.clone()
1294
>>> os.path.samefile(orig.base, clone.base)
1296
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1299
from shutil import copytree
1300
from tempfile import mkdtemp
1303
copytree(self.base, base, symlinks=True)
1304
return ScratchBranch(base=base)
1310
"""Destroy the test branch, removing the scratch directory."""
1311
from shutil import rmtree
1314
mutter("delete ScratchBranch %s" % self.base)
1317
# Work around for shutil.rmtree failing on Windows when
1318
# readonly files are encountered
1319
mutter("hit exception in destroying ScratchBranch: %s" % e)
1320
for root, dirs, files in os.walk(self.base, topdown=False):
1322
os.chmod(os.path.join(root, name), 0700)
1529
_default_format = None
1530
"""The default format used for new branches."""
1533
"""The known formats."""
1535
can_set_append_revisions_only = True
1537
def __eq__(self, other):
1538
return self.__class__ is other.__class__
1540
def __ne__(self, other):
1541
return not (self == other)
1544
def find_format(klass, a_bzrdir, name=None):
1545
"""Return the format for the branch object in a_bzrdir."""
1547
transport = a_bzrdir.get_branch_transport(None, name=name)
1548
format_string = transport.get_bytes("format")
1549
format = klass._formats[format_string]
1550
if isinstance(format, MetaDirBranchFormatFactory):
1553
except errors.NoSuchFile:
1554
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1556
raise errors.UnknownFormatError(format=format_string, kind='branch')
1559
def get_default_format(klass):
1560
"""Return the current default format."""
1561
return klass._default_format
1564
def get_formats(klass):
1565
"""Get all the known formats.
1567
Warning: This triggers a load of all lazy registered formats: do not
1568
use except when that is desireed.
1571
for fmt in klass._formats.values():
1572
if isinstance(fmt, MetaDirBranchFormatFactory):
1577
def get_reference(self, a_bzrdir, name=None):
1578
"""Get the target reference of the branch in a_bzrdir.
1580
format probing must have been completed before calling
1581
this method - it is assumed that the format of the branch
1582
in a_bzrdir is correct.
1584
:param a_bzrdir: The bzrdir to get the branch data from.
1585
:param name: Name of the colocated branch to fetch
1586
:return: None if the branch is not a reference branch.
1591
def set_reference(self, a_bzrdir, name, to_branch):
1592
"""Set the target reference of the branch in a_bzrdir.
1594
format probing must have been completed before calling
1595
this method - it is assumed that the format of the branch
1596
in a_bzrdir is correct.
1598
:param a_bzrdir: The bzrdir to set the branch reference for.
1599
:param name: Name of colocated branch to set, None for default
1600
:param to_branch: branch that the checkout is to reference
1602
raise NotImplementedError(self.set_reference)
1604
def get_format_string(self):
1605
"""Return the ASCII format string that identifies this format."""
1606
raise NotImplementedError(self.get_format_string)
1608
def get_format_description(self):
1609
"""Return the short format description for this format."""
1610
raise NotImplementedError(self.get_format_description)
1612
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1613
hooks = Branch.hooks['post_branch_init']
1616
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1620
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1621
lock_type='metadir', set_format=True):
1622
"""Initialize a branch in a bzrdir, with specified files
1624
:param a_bzrdir: The bzrdir to initialize the branch in
1625
:param utf8_files: The files to create as a list of
1626
(filename, content) tuples
1627
:param name: Name of colocated branch to create, if any
1628
:param set_format: If True, set the format with
1629
self.get_format_string. (BzrBranch4 has its format set
1631
:return: a branch in this format
1633
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1634
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1636
'metadir': ('lock', lockdir.LockDir),
1637
'branch4': ('branch-lock', lockable_files.TransportLock),
1639
lock_name, lock_class = lock_map[lock_type]
1640
control_files = lockable_files.LockableFiles(branch_transport,
1641
lock_name, lock_class)
1642
control_files.create_lock()
1644
control_files.lock_write()
1645
except errors.LockContention:
1646
if lock_type != 'branch4':
1652
utf8_files += [('format', self.get_format_string())]
1654
for (filename, content) in utf8_files:
1655
branch_transport.put_bytes(
1657
mode=a_bzrdir._get_file_mode())
1660
control_files.unlock()
1661
branch = self.open(a_bzrdir, name, _found=True)
1662
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1665
def initialize(self, a_bzrdir, name=None):
1666
"""Create a branch of this format in a_bzrdir.
1668
:param name: Name of the colocated branch to create.
1670
raise NotImplementedError(self.initialize)
1672
def is_supported(self):
1673
"""Is this format supported?
1675
Supported formats can be initialized and opened.
1676
Unsupported formats may not support initialization or committing or
1677
some other features depending on the reason for not being supported.
1681
def make_tags(self, branch):
1682
"""Create a tags object for branch.
1684
This method is on BranchFormat, because BranchFormats are reflected
1685
over the wire via network_name(), whereas full Branch instances require
1686
multiple VFS method calls to operate at all.
1688
The default implementation returns a disabled-tags instance.
1690
Note that it is normal for branch to be a RemoteBranch when using tags
1693
return DisabledTags(branch)
1695
def network_name(self):
1696
"""A simple byte string uniquely identifying this format for RPC calls.
1698
MetaDir branch formats use their disk format string to identify the
1699
repository over the wire. All in one formats such as bzr < 0.8, and
1700
foreign formats like svn/git and hg should use some marker which is
1701
unique and immutable.
1703
raise NotImplementedError(self.network_name)
1705
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1706
"""Return the branch object for a_bzrdir
1708
:param a_bzrdir: A BzrDir that contains a branch.
1709
:param name: Name of colocated branch to open
1710
:param _found: a private parameter, do not use it. It is used to
1711
indicate if format probing has already be done.
1712
:param ignore_fallbacks: when set, no fallback branches will be opened
1713
(if there are any). Default is to open fallbacks.
1715
raise NotImplementedError(self.open)
1718
def register_format(klass, format):
1719
"""Register a metadir format.
1721
See MetaDirBranchFormatFactory for the ability to register a format
1722
without loading the code the format needs until it is actually used.
1724
klass._formats[format.get_format_string()] = format
1725
# Metadir formats have a network name of their format string, and get
1726
# registered as factories.
1727
if isinstance(format, MetaDirBranchFormatFactory):
1728
network_format_registry.register(format.get_format_string(), format)
1730
network_format_registry.register(format.get_format_string(),
1734
def set_default_format(klass, format):
1735
klass._default_format = format
1737
def supports_set_append_revisions_only(self):
1738
"""True if this format supports set_append_revisions_only."""
1741
def supports_stacking(self):
1742
"""True if this format records a stacked-on branch."""
1746
def unregister_format(klass, format):
1747
del klass._formats[format.get_format_string()]
1750
return self.get_format_description().rstrip()
1752
def supports_tags(self):
1753
"""True if this format supports tags stored in the branch"""
1754
return False # by default
1757
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1758
"""A factory for a BranchFormat object, permitting simple lazy registration.
1760
While none of the built in BranchFormats are lazy registered yet,
1761
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1762
use it, and the bzr-loom plugin uses it as well (see
1763
bzrlib.plugins.loom.formats).
1766
def __init__(self, format_string, module_name, member_name):
1767
"""Create a MetaDirBranchFormatFactory.
1769
:param format_string: The format string the format has.
1770
:param module_name: Module to load the format class from.
1771
:param member_name: Attribute name within the module for the format class.
1773
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1774
self._format_string = format_string
1776
def get_format_string(self):
1777
"""See BranchFormat.get_format_string."""
1778
return self._format_string
1781
"""Used for network_format_registry support."""
1782
return self.get_obj()()
1785
class BranchHooks(Hooks):
1786
"""A dictionary mapping hook name to a list of callables for branch hooks.
1788
e.g. ['set_rh'] Is the list of items to be called when the
1789
set_revision_history function is invoked.
1793
"""Create the default hooks.
1795
These are all empty initially, because by default nothing should get
1798
Hooks.__init__(self)
1799
self.create_hook(HookPoint('set_rh',
1800
"Invoked whenever the revision history has been set via "
1801
"set_revision_history. The api signature is (branch, "
1802
"revision_history), and the branch will be write-locked. "
1803
"The set_rh hook can be expensive for bzr to trigger, a better "
1804
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1805
self.create_hook(HookPoint('open',
1806
"Called with the Branch object that has been opened after a "
1807
"branch is opened.", (1, 8), None))
1808
self.create_hook(HookPoint('post_push',
1809
"Called after a push operation completes. post_push is called "
1810
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1811
"bzr client.", (0, 15), None))
1812
self.create_hook(HookPoint('post_pull',
1813
"Called after a pull operation completes. post_pull is called "
1814
"with a bzrlib.branch.PullResult object and only runs in the "
1815
"bzr client.", (0, 15), None))
1816
self.create_hook(HookPoint('pre_commit',
1817
"Called after a commit is calculated but before it is is "
1818
"completed. pre_commit is called with (local, master, old_revno, "
1819
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1820
"). old_revid is NULL_REVISION for the first commit to a branch, "
1821
"tree_delta is a TreeDelta object describing changes from the "
1822
"basis revision. hooks MUST NOT modify this delta. "
1823
" future_tree is an in-memory tree obtained from "
1824
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1825
"tree.", (0,91), None))
1826
self.create_hook(HookPoint('post_commit',
1827
"Called in the bzr client after a commit has completed. "
1828
"post_commit is called with (local, master, old_revno, old_revid, "
1829
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1830
"commit to a branch.", (0, 15), None))
1831
self.create_hook(HookPoint('post_uncommit',
1832
"Called in the bzr client after an uncommit completes. "
1833
"post_uncommit is called with (local, master, old_revno, "
1834
"old_revid, new_revno, new_revid) where local is the local branch "
1835
"or None, master is the target branch, and an empty branch "
1836
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1837
self.create_hook(HookPoint('pre_change_branch_tip',
1838
"Called in bzr client and server before a change to the tip of a "
1839
"branch is made. pre_change_branch_tip is called with a "
1840
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1841
"commit, uncommit will all trigger this hook.", (1, 6), None))
1842
self.create_hook(HookPoint('post_change_branch_tip',
1843
"Called in bzr client and server after a change to the tip of a "
1844
"branch is made. post_change_branch_tip is called with a "
1845
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1846
"commit, uncommit will all trigger this hook.", (1, 4), None))
1847
self.create_hook(HookPoint('transform_fallback_location',
1848
"Called when a stacked branch is activating its fallback "
1849
"locations. transform_fallback_location is called with (branch, "
1850
"url), and should return a new url. Returning the same url "
1851
"allows it to be used as-is, returning a different one can be "
1852
"used to cause the branch to stack on a closer copy of that "
1853
"fallback_location. Note that the branch cannot have history "
1854
"accessing methods called on it during this hook because the "
1855
"fallback locations have not been activated. When there are "
1856
"multiple hooks installed for transform_fallback_location, "
1857
"all are called with the url returned from the previous hook."
1858
"The order is however undefined.", (1, 9), None))
1859
self.create_hook(HookPoint('automatic_tag_name',
1860
"Called to determine an automatic tag name for a revision."
1861
"automatic_tag_name is called with (branch, revision_id) and "
1862
"should return a tag name or None if no tag name could be "
1863
"determined. The first non-None tag name returned will be used.",
1865
self.create_hook(HookPoint('post_branch_init',
1866
"Called after new branch initialization completes. "
1867
"post_branch_init is called with a "
1868
"bzrlib.branch.BranchInitHookParams. "
1869
"Note that init, branch and checkout (both heavyweight and "
1870
"lightweight) will all trigger this hook.", (2, 2), None))
1871
self.create_hook(HookPoint('post_switch',
1872
"Called after a checkout switches branch. "
1873
"post_switch is called with a "
1874
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1878
# install the default hooks into the Branch class.
1879
Branch.hooks = BranchHooks()
1882
class ChangeBranchTipParams(object):
1883
"""Object holding parameters passed to *_change_branch_tip hooks.
1885
There are 5 fields that hooks may wish to access:
1887
:ivar branch: the branch being changed
1888
:ivar old_revno: revision number before the change
1889
:ivar new_revno: revision number after the change
1890
:ivar old_revid: revision id before the change
1891
:ivar new_revid: revision id after the change
1893
The revid fields are strings. The revno fields are integers.
1896
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1897
"""Create a group of ChangeBranchTip parameters.
1899
:param branch: The branch being changed.
1900
:param old_revno: Revision number before the change.
1901
:param new_revno: Revision number after the change.
1902
:param old_revid: Tip revision id before the change.
1903
:param new_revid: Tip revision id after the change.
1905
self.branch = branch
1906
self.old_revno = old_revno
1907
self.new_revno = new_revno
1908
self.old_revid = old_revid
1909
self.new_revid = new_revid
1911
def __eq__(self, other):
1912
return self.__dict__ == other.__dict__
1915
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1916
self.__class__.__name__, self.branch,
1917
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1920
class BranchInitHookParams(object):
1921
"""Object holding parameters passed to *_branch_init hooks.
1923
There are 4 fields that hooks may wish to access:
1925
:ivar format: the branch format
1926
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1927
:ivar name: name of colocated branch, if any (or None)
1928
:ivar branch: the branch created
1930
Note that for lightweight checkouts, the bzrdir and format fields refer to
1931
the checkout, hence they are different from the corresponding fields in
1932
branch, which refer to the original branch.
1935
def __init__(self, format, a_bzrdir, name, branch):
1936
"""Create a group of BranchInitHook parameters.
1938
:param format: the branch format
1939
:param a_bzrdir: the BzrDir where the branch will be/has been
1941
:param name: name of colocated branch, if any (or None)
1942
:param branch: the branch created
1944
Note that for lightweight checkouts, the bzrdir and format fields refer
1945
to the checkout, hence they are different from the corresponding fields
1946
in branch, which refer to the original branch.
1948
self.format = format
1949
self.bzrdir = a_bzrdir
1951
self.branch = branch
1953
def __eq__(self, other):
1954
return self.__dict__ == other.__dict__
1958
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1960
return "<%s of format:%s bzrdir:%s>" % (
1961
self.__class__.__name__, self.branch,
1962
self.format, self.bzrdir)
1965
class SwitchHookParams(object):
1966
"""Object holding parameters passed to *_switch hooks.
1968
There are 4 fields that hooks may wish to access:
1970
:ivar control_dir: BzrDir of the checkout to change
1971
:ivar to_branch: branch that the checkout is to reference
1972
:ivar force: skip the check for local commits in a heavy checkout
1973
:ivar revision_id: revision ID to switch to (or None)
1976
def __init__(self, control_dir, to_branch, force, revision_id):
1977
"""Create a group of SwitchHook parameters.
1979
:param control_dir: BzrDir of the checkout to change
1980
:param to_branch: branch that the checkout is to reference
1981
:param force: skip the check for local commits in a heavy checkout
1982
:param revision_id: revision ID to switch to (or None)
1984
self.control_dir = control_dir
1985
self.to_branch = to_branch
1987
self.revision_id = revision_id
1989
def __eq__(self, other):
1990
return self.__dict__ == other.__dict__
1993
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1994
self.control_dir, self.to_branch,
1998
class BzrBranchFormat4(BranchFormat):
1999
"""Bzr branch format 4.
2002
- a revision-history file.
2003
- a branch-lock lock file [ to be shared with the bzrdir ]
2006
def get_format_description(self):
2007
"""See BranchFormat.get_format_description()."""
2008
return "Branch format 4"
2010
def initialize(self, a_bzrdir, name=None):
2011
"""Create a branch of this format in a_bzrdir."""
2012
utf8_files = [('revision-history', ''),
2013
('branch-name', ''),
2015
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
2016
lock_type='branch4', set_format=False)
2019
super(BzrBranchFormat4, self).__init__()
2020
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2022
def network_name(self):
2023
"""The network name for this format is the control dirs disk label."""
2024
return self._matchingbzrdir.get_format_string()
2026
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2027
"""See BranchFormat.open()."""
2029
# we are being called directly and must probe.
2030
raise NotImplementedError
2031
return BzrBranch(_format=self,
2032
_control_files=a_bzrdir._control_files,
2035
_repository=a_bzrdir.open_repository())
2038
return "Bazaar-NG branch format 4"
2041
class BranchFormatMetadir(BranchFormat):
2042
"""Common logic for meta-dir based branch formats."""
2044
def _branch_class(self):
2045
"""What class to instantiate on open calls."""
2046
raise NotImplementedError(self._branch_class)
2048
def network_name(self):
2049
"""A simple byte string uniquely identifying this format for RPC calls.
2051
Metadir branch formats use their format string.
2053
return self.get_format_string()
2055
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2056
"""See BranchFormat.open()."""
2058
format = BranchFormat.find_format(a_bzrdir, name=name)
2059
if format.__class__ != self.__class__:
2060
raise AssertionError("wrong format %r found for %r" %
2062
transport = a_bzrdir.get_branch_transport(None, name=name)
2064
control_files = lockable_files.LockableFiles(transport, 'lock',
2066
return self._branch_class()(_format=self,
2067
_control_files=control_files,
2070
_repository=a_bzrdir.find_repository(),
2071
ignore_fallbacks=ignore_fallbacks)
2072
except errors.NoSuchFile:
2073
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2076
super(BranchFormatMetadir, self).__init__()
2077
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2078
self._matchingbzrdir.set_branch_format(self)
2080
def supports_tags(self):
2084
class BzrBranchFormat5(BranchFormatMetadir):
2085
"""Bzr branch format 5.
2088
- a revision-history file.
2090
- a lock dir guarding the branch itself
2091
- all of this stored in a branch/ subdirectory
2092
- works with shared repositories.
2094
This format is new in bzr 0.8.
2097
def _branch_class(self):
2100
def get_format_string(self):
2101
"""See BranchFormat.get_format_string()."""
2102
return "Bazaar-NG branch format 5\n"
2104
def get_format_description(self):
2105
"""See BranchFormat.get_format_description()."""
2106
return "Branch format 5"
2108
def initialize(self, a_bzrdir, name=None):
2109
"""Create a branch of this format in a_bzrdir."""
2110
utf8_files = [('revision-history', ''),
2111
('branch-name', ''),
2113
return self._initialize_helper(a_bzrdir, utf8_files, name)
2115
def supports_tags(self):
2119
class BzrBranchFormat6(BranchFormatMetadir):
2120
"""Branch format with last-revision and tags.
2122
Unlike previous formats, this has no explicit revision history. Instead,
2123
this just stores the last-revision, and the left-hand history leading
2124
up to there is the history.
2126
This format was introduced in bzr 0.15
2127
and became the default in 0.91.
2130
def _branch_class(self):
2133
def get_format_string(self):
2134
"""See BranchFormat.get_format_string()."""
2135
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2137
def get_format_description(self):
2138
"""See BranchFormat.get_format_description()."""
2139
return "Branch format 6"
2141
def initialize(self, a_bzrdir, name=None):
2142
"""Create a branch of this format in a_bzrdir."""
2143
utf8_files = [('last-revision', '0 null:\n'),
2144
('branch.conf', ''),
2147
return self._initialize_helper(a_bzrdir, utf8_files, name)
2149
def make_tags(self, branch):
2150
"""See bzrlib.branch.BranchFormat.make_tags()."""
2151
return BasicTags(branch)
2153
def supports_set_append_revisions_only(self):
2157
class BzrBranchFormat8(BranchFormatMetadir):
2158
"""Metadir format supporting storing locations of subtree branches."""
2160
def _branch_class(self):
2163
def get_format_string(self):
2164
"""See BranchFormat.get_format_string()."""
2165
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2167
def get_format_description(self):
2168
"""See BranchFormat.get_format_description()."""
2169
return "Branch format 8"
2171
def initialize(self, a_bzrdir, name=None):
2172
"""Create a branch of this format in a_bzrdir."""
2173
utf8_files = [('last-revision', '0 null:\n'),
2174
('branch.conf', ''),
2178
return self._initialize_helper(a_bzrdir, utf8_files, name)
2181
super(BzrBranchFormat8, self).__init__()
2182
self._matchingbzrdir.repository_format = \
2183
RepositoryFormatKnitPack5RichRoot()
2185
def make_tags(self, branch):
2186
"""See bzrlib.branch.BranchFormat.make_tags()."""
2187
return BasicTags(branch)
2189
def supports_set_append_revisions_only(self):
2192
def supports_stacking(self):
2195
supports_reference_locations = True
2198
class BzrBranchFormat7(BzrBranchFormat8):
2199
"""Branch format with last-revision, tags, and a stacked location pointer.
2201
The stacked location pointer is passed down to the repository and requires
2202
a repository format with supports_external_lookups = True.
2204
This format was introduced in bzr 1.6.
2207
def initialize(self, a_bzrdir, name=None):
2208
"""Create a branch of this format in a_bzrdir."""
2209
utf8_files = [('last-revision', '0 null:\n'),
2210
('branch.conf', ''),
2213
return self._initialize_helper(a_bzrdir, utf8_files, name)
2215
def _branch_class(self):
2218
def get_format_string(self):
2219
"""See BranchFormat.get_format_string()."""
2220
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2222
def get_format_description(self):
2223
"""See BranchFormat.get_format_description()."""
2224
return "Branch format 7"
2226
def supports_set_append_revisions_only(self):
2229
supports_reference_locations = False
2232
class BranchReferenceFormat(BranchFormat):
2233
"""Bzr branch reference format.
2235
Branch references are used in implementing checkouts, they
2236
act as an alias to the real branch which is at some other url.
2243
def get_format_string(self):
2244
"""See BranchFormat.get_format_string()."""
2245
return "Bazaar-NG Branch Reference Format 1\n"
2247
def get_format_description(self):
2248
"""See BranchFormat.get_format_description()."""
2249
return "Checkout reference format 1"
2251
def get_reference(self, a_bzrdir, name=None):
2252
"""See BranchFormat.get_reference()."""
2253
transport = a_bzrdir.get_branch_transport(None, name=name)
2254
return transport.get_bytes('location')
2256
def set_reference(self, a_bzrdir, name, to_branch):
2257
"""See BranchFormat.set_reference()."""
2258
transport = a_bzrdir.get_branch_transport(None, name=name)
2259
location = transport.put_bytes('location', to_branch.base)
2261
def initialize(self, a_bzrdir, name=None, target_branch=None):
2262
"""Create a branch of this format in a_bzrdir."""
2263
if target_branch is None:
2264
# this format does not implement branch itself, thus the implicit
2265
# creation contract must see it as uninitializable
2266
raise errors.UninitializableFormat(self)
2267
mutter('creating branch reference in %s', a_bzrdir.user_url)
2268
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2269
branch_transport.put_bytes('location',
2270
target_branch.bzrdir.user_url)
2271
branch_transport.put_bytes('format', self.get_format_string())
2273
a_bzrdir, name, _found=True,
2274
possible_transports=[target_branch.bzrdir.root_transport])
2275
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2279
super(BranchReferenceFormat, self).__init__()
2280
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2281
self._matchingbzrdir.set_branch_format(self)
2283
def _make_reference_clone_function(format, a_branch):
2284
"""Create a clone() routine for a branch dynamically."""
2285
def clone(to_bzrdir, revision_id=None,
2286
repository_policy=None):
2287
"""See Branch.clone()."""
2288
return format.initialize(to_bzrdir, target_branch=a_branch)
2289
# cannot obey revision_id limits when cloning a reference ...
2290
# FIXME RBC 20060210 either nuke revision_id for clone, or
2291
# emit some sort of warning/error to the caller ?!
2294
def open(self, a_bzrdir, name=None, _found=False, location=None,
2295
possible_transports=None, ignore_fallbacks=False):
2296
"""Return the branch that the branch reference in a_bzrdir points at.
2298
:param a_bzrdir: A BzrDir that contains a branch.
2299
:param name: Name of colocated branch to open, if any
2300
:param _found: a private parameter, do not use it. It is used to
2301
indicate if format probing has already be done.
2302
:param ignore_fallbacks: when set, no fallback branches will be opened
2303
(if there are any). Default is to open fallbacks.
2304
:param location: The location of the referenced branch. If
2305
unspecified, this will be determined from the branch reference in
2307
:param possible_transports: An optional reusable transports list.
2310
format = BranchFormat.find_format(a_bzrdir, name=name)
2311
if format.__class__ != self.__class__:
2312
raise AssertionError("wrong format %r found for %r" %
2314
if location is None:
2315
location = self.get_reference(a_bzrdir, name)
2316
real_bzrdir = bzrdir.BzrDir.open(
2317
location, possible_transports=possible_transports)
2318
result = real_bzrdir.open_branch(name=name,
2319
ignore_fallbacks=ignore_fallbacks)
2320
# this changes the behaviour of result.clone to create a new reference
2321
# rather than a copy of the content of the branch.
2322
# I did not use a proxy object because that needs much more extensive
2323
# testing, and we are only changing one behaviour at the moment.
2324
# If we decide to alter more behaviours - i.e. the implicit nickname
2325
# then this should be refactored to introduce a tested proxy branch
2326
# and a subclass of that for use in overriding clone() and ....
2328
result.clone = self._make_reference_clone_function(result)
2332
network_format_registry = registry.FormatRegistry()
2333
"""Registry of formats indexed by their network name.
2335
The network name for a branch format is an identifier that can be used when
2336
referring to formats with smart server operations. See
2337
BranchFormat.network_name() for more detail.
2341
# formats which have no format string are not discoverable
2342
# and not independently creatable, so are not registered.
2343
__format5 = BzrBranchFormat5()
2344
__format6 = BzrBranchFormat6()
2345
__format7 = BzrBranchFormat7()
2346
__format8 = BzrBranchFormat8()
2347
BranchFormat.register_format(__format5)
2348
BranchFormat.register_format(BranchReferenceFormat())
2349
BranchFormat.register_format(__format6)
2350
BranchFormat.register_format(__format7)
2351
BranchFormat.register_format(__format8)
2352
BranchFormat.set_default_format(__format7)
2353
_legacy_formats = [BzrBranchFormat4(),
2355
network_format_registry.register(
2356
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2359
class BranchWriteLockResult(LogicalLockResult):
2360
"""The result of write locking a branch.
2362
:ivar branch_token: The token obtained from the underlying branch lock, or
2364
:ivar unlock: A callable which will unlock the lock.
2367
def __init__(self, unlock, branch_token):
2368
LogicalLockResult.__init__(self, unlock)
2369
self.branch_token = branch_token
2372
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2376
class BzrBranch(Branch, _RelockDebugMixin):
2377
"""A branch stored in the actual filesystem.
2379
Note that it's "local" in the context of the filesystem; it doesn't
2380
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2381
it's writable, and can be accessed via the normal filesystem API.
2383
:ivar _transport: Transport for file operations on this branch's
2384
control files, typically pointing to the .bzr/branch directory.
2385
:ivar repository: Repository for this branch.
2386
:ivar base: The url of the base directory for this branch; the one
2387
containing the .bzr directory.
2388
:ivar name: Optional colocated branch name as it exists in the control
2392
def __init__(self, _format=None,
2393
_control_files=None, a_bzrdir=None, name=None,
2394
_repository=None, ignore_fallbacks=False):
2395
"""Create new branch object at a particular location."""
2396
if a_bzrdir is None:
2397
raise ValueError('a_bzrdir must be supplied')
2399
self.bzrdir = a_bzrdir
2400
self._base = self.bzrdir.transport.clone('..').base
2402
# XXX: We should be able to just do
2403
# self.base = self.bzrdir.root_transport.base
2404
# but this does not quite work yet -- mbp 20080522
2405
self._format = _format
2406
if _control_files is None:
2407
raise ValueError('BzrBranch _control_files is None')
2408
self.control_files = _control_files
2409
self._transport = _control_files._transport
2410
self.repository = _repository
2411
Branch.__init__(self)
2414
if self.name is None:
2415
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2417
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2422
def _get_base(self):
2423
"""Returns the directory containing the control directory."""
2426
base = property(_get_base, doc="The URL for the root of this branch.")
2428
def _get_config(self):
2429
return TransportConfig(self._transport, 'branch.conf')
2431
def is_locked(self):
2432
return self.control_files.is_locked()
2434
def lock_write(self, token=None):
2435
"""Lock the branch for write operations.
2437
:param token: A token to permit reacquiring a previously held and
2439
:return: A BranchWriteLockResult.
2441
if not self.is_locked():
2442
self._note_lock('w')
2443
# All-in-one needs to always unlock/lock.
2444
repo_control = getattr(self.repository, 'control_files', None)
2445
if self.control_files == repo_control or not self.is_locked():
2446
self.repository._warn_if_deprecated(self)
2447
self.repository.lock_write()
2452
return BranchWriteLockResult(self.unlock,
2453
self.control_files.lock_write(token=token))
2456
self.repository.unlock()
2459
def lock_read(self):
2460
"""Lock the branch for read operations.
2462
:return: A bzrlib.lock.LogicalLockResult.
2464
if not self.is_locked():
2465
self._note_lock('r')
2466
# All-in-one needs to always unlock/lock.
2467
repo_control = getattr(self.repository, 'control_files', None)
2468
if self.control_files == repo_control or not self.is_locked():
2469
self.repository._warn_if_deprecated(self)
2470
self.repository.lock_read()
2475
self.control_files.lock_read()
2476
return LogicalLockResult(self.unlock)
2479
self.repository.unlock()
2482
@only_raises(errors.LockNotHeld, errors.LockBroken)
2485
self.control_files.unlock()
2487
# All-in-one needs to always unlock/lock.
2488
repo_control = getattr(self.repository, 'control_files', None)
2489
if (self.control_files == repo_control or
2490
not self.control_files.is_locked()):
2491
self.repository.unlock()
2492
if not self.control_files.is_locked():
2493
# we just released the lock
2494
self._clear_cached_state()
2496
def peek_lock_mode(self):
2497
if self.control_files._lock_count == 0:
2500
return self.control_files._lock_mode
2502
def get_physical_lock_status(self):
2503
return self.control_files.get_physical_lock_status()
2506
def print_file(self, file, revision_id):
2507
"""See Branch.print_file."""
2508
return self.repository.print_file(file, revision_id)
2510
def _write_revision_history(self, history):
2511
"""Factored out of set_revision_history.
2513
This performs the actual writing to disk.
2514
It is intended to be called by BzrBranch5.set_revision_history."""
2515
self._transport.put_bytes(
2516
'revision-history', '\n'.join(history),
2517
mode=self.bzrdir._get_file_mode())
2520
def set_revision_history(self, rev_history):
2521
"""See Branch.set_revision_history."""
2522
if 'evil' in debug.debug_flags:
2523
mutter_callsite(3, "set_revision_history scales with history.")
2524
check_not_reserved_id = _mod_revision.check_not_reserved_id
2525
for rev_id in rev_history:
2526
check_not_reserved_id(rev_id)
2527
if Branch.hooks['post_change_branch_tip']:
2528
# Don't calculate the last_revision_info() if there are no hooks
2530
old_revno, old_revid = self.last_revision_info()
2531
if len(rev_history) == 0:
2532
revid = _mod_revision.NULL_REVISION
2534
revid = rev_history[-1]
2535
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2536
self._write_revision_history(rev_history)
2537
self._clear_cached_state()
2538
self._cache_revision_history(rev_history)
2539
for hook in Branch.hooks['set_rh']:
2540
hook(self, rev_history)
2541
if Branch.hooks['post_change_branch_tip']:
2542
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2544
def _synchronize_history(self, destination, revision_id):
2545
"""Synchronize last revision and revision history between branches.
2547
This version is most efficient when the destination is also a
2548
BzrBranch5, but works for BzrBranch6 as long as the revision
2549
history is the true lefthand parent history, and all of the revisions
2550
are in the destination's repository. If not, set_revision_history
2553
:param destination: The branch to copy the history into
2554
:param revision_id: The revision-id to truncate history at. May
2555
be None to copy complete history.
2557
if not isinstance(destination._format, BzrBranchFormat5):
2558
super(BzrBranch, self)._synchronize_history(
2559
destination, revision_id)
2561
if revision_id == _mod_revision.NULL_REVISION:
2564
new_history = self.revision_history()
2565
if revision_id is not None and new_history != []:
2567
new_history = new_history[:new_history.index(revision_id) + 1]
2569
rev = self.repository.get_revision(revision_id)
2570
new_history = rev.get_history(self.repository)[1:]
2571
destination.set_revision_history(new_history)
2574
def set_last_revision_info(self, revno, revision_id):
2575
"""Set the last revision of this branch.
2577
The caller is responsible for checking that the revno is correct
2578
for this revision id.
2580
It may be possible to set the branch last revision to an id not
2581
present in the repository. However, branches can also be
2582
configured to check constraints on history, in which case this may not
2585
revision_id = _mod_revision.ensure_null(revision_id)
2586
# this old format stores the full history, but this api doesn't
2587
# provide it, so we must generate, and might as well check it's
2589
history = self._lefthand_history(revision_id)
2590
if len(history) != revno:
2591
raise AssertionError('%d != %d' % (len(history), revno))
2592
self.set_revision_history(history)
2594
def _gen_revision_history(self):
2595
history = self._transport.get_bytes('revision-history').split('\n')
2596
if history[-1:] == ['']:
2597
# There shouldn't be a trailing newline, but just in case.
2602
def generate_revision_history(self, revision_id, last_rev=None,
2604
"""Create a new revision history that will finish with revision_id.
2606
:param revision_id: the new tip to use.
2607
:param last_rev: The previous last_revision. If not None, then this
2608
must be a ancestory of revision_id, or DivergedBranches is raised.
2609
:param other_branch: The other branch that DivergedBranches should
2610
raise with respect to.
2612
self.set_revision_history(self._lefthand_history(revision_id,
2613
last_rev, other_branch))
2615
def basis_tree(self):
2616
"""See Branch.basis_tree."""
2617
return self.repository.revision_tree(self.last_revision())
2619
def _get_parent_location(self):
2620
_locs = ['parent', 'pull', 'x-pull']
2623
return self._transport.get_bytes(l).strip('\n')
2624
except errors.NoSuchFile:
2628
def _basic_push(self, target, overwrite, stop_revision):
2629
"""Basic implementation of push without bound branches or hooks.
2631
Must be called with source read locked and target write locked.
2633
result = BranchPushResult()
2634
result.source_branch = self
2635
result.target_branch = target
2636
result.old_revno, result.old_revid = target.last_revision_info()
2637
self.update_references(target)
2638
if result.old_revid != self.last_revision():
2639
# We assume that during 'push' this repository is closer than
2641
graph = self.repository.get_graph(target.repository)
2642
target.update_revisions(self, stop_revision,
2643
overwrite=overwrite, graph=graph)
2644
if self._push_should_merge_tags():
2645
result.tag_conflicts = self.tags.merge_to(target.tags,
2647
result.new_revno, result.new_revid = target.last_revision_info()
2650
def get_stacked_on_url(self):
2651
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2653
def set_push_location(self, location):
2654
"""See Branch.set_push_location."""
2655
self.get_config().set_user_option(
2656
'push_location', location,
2657
store=_mod_config.STORE_LOCATION_NORECURSE)
2659
def _set_parent_location(self, url):
2661
self._transport.delete('parent')
2663
self._transport.put_bytes('parent', url + '\n',
2664
mode=self.bzrdir._get_file_mode())
2667
class BzrBranch5(BzrBranch):
2668
"""A format 5 branch. This supports new features over plain branches.
2670
It has support for a master_branch which is the data for bound branches.
2673
def get_bound_location(self):
2675
return self._transport.get_bytes('bound')[:-1]
2676
except errors.NoSuchFile:
2680
def get_master_branch(self, possible_transports=None):
2681
"""Return the branch we are bound to.
2683
:return: Either a Branch, or None
2685
This could memoise the branch, but if thats done
2686
it must be revalidated on each new lock.
2687
So for now we just don't memoise it.
2688
# RBC 20060304 review this decision.
2690
bound_loc = self.get_bound_location()
2694
return Branch.open(bound_loc,
2695
possible_transports=possible_transports)
2696
except (errors.NotBranchError, errors.ConnectionError), e:
2697
raise errors.BoundBranchConnectionFailure(
2701
def set_bound_location(self, location):
2702
"""Set the target where this branch is bound to.
2704
:param location: URL to the target branch
2707
self._transport.put_bytes('bound', location+'\n',
2708
mode=self.bzrdir._get_file_mode())
2711
self._transport.delete('bound')
2712
except errors.NoSuchFile:
2717
def bind(self, other):
2718
"""Bind this branch to the branch other.
2720
This does not push or pull data between the branches, though it does
2721
check for divergence to raise an error when the branches are not
2722
either the same, or one a prefix of the other. That behaviour may not
2723
be useful, so that check may be removed in future.
2725
:param other: The branch to bind to
2728
# TODO: jam 20051230 Consider checking if the target is bound
2729
# It is debatable whether you should be able to bind to
2730
# a branch which is itself bound.
2731
# Committing is obviously forbidden,
2732
# but binding itself may not be.
2733
# Since we *have* to check at commit time, we don't
2734
# *need* to check here
2736
# we want to raise diverged if:
2737
# last_rev is not in the other_last_rev history, AND
2738
# other_last_rev is not in our history, and do it without pulling
2740
self.set_bound_location(other.base)
2744
"""If bound, unbind"""
2745
return self.set_bound_location(None)
2748
def update(self, possible_transports=None):
2749
"""Synchronise this branch with the master branch if any.
2751
:return: None or the last_revision that was pivoted out during the
2754
master = self.get_master_branch(possible_transports)
2755
if master is not None:
2756
old_tip = _mod_revision.ensure_null(self.last_revision())
2757
self.pull(master, overwrite=True)
2758
if self.repository.get_graph().is_ancestor(old_tip,
2759
_mod_revision.ensure_null(self.last_revision())):
2765
class BzrBranch8(BzrBranch5):
2766
"""A branch that stores tree-reference locations."""
2768
def _open_hook(self):
2769
if self._ignore_fallbacks:
2772
url = self.get_stacked_on_url()
2773
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2774
errors.UnstackableBranchFormat):
2777
for hook in Branch.hooks['transform_fallback_location']:
2778
url = hook(self, url)
2780
hook_name = Branch.hooks.get_hook_name(hook)
2781
raise AssertionError(
2782
"'transform_fallback_location' hook %s returned "
2783
"None, not a URL." % hook_name)
2784
self._activate_fallback_location(url)
2786
def __init__(self, *args, **kwargs):
2787
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2788
super(BzrBranch8, self).__init__(*args, **kwargs)
2789
self._last_revision_info_cache = None
2790
self._reference_info = None
2792
def _clear_cached_state(self):
2793
super(BzrBranch8, self)._clear_cached_state()
2794
self._last_revision_info_cache = None
2795
self._reference_info = None
2797
def _last_revision_info(self):
2798
revision_string = self._transport.get_bytes('last-revision')
2799
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2800
revision_id = cache_utf8.get_cached_utf8(revision_id)
2802
return revno, revision_id
2804
def _write_last_revision_info(self, revno, revision_id):
2805
"""Simply write out the revision id, with no checks.
2807
Use set_last_revision_info to perform this safely.
2809
Does not update the revision_history cache.
2810
Intended to be called by set_last_revision_info and
2811
_write_revision_history.
2813
revision_id = _mod_revision.ensure_null(revision_id)
2814
out_string = '%d %s\n' % (revno, revision_id)
2815
self._transport.put_bytes('last-revision', out_string,
2816
mode=self.bzrdir._get_file_mode())
2819
def set_last_revision_info(self, revno, revision_id):
2820
revision_id = _mod_revision.ensure_null(revision_id)
2821
old_revno, old_revid = self.last_revision_info()
2822
if self._get_append_revisions_only():
2823
self._check_history_violation(revision_id)
2824
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2825
self._write_last_revision_info(revno, revision_id)
2826
self._clear_cached_state()
2827
self._last_revision_info_cache = revno, revision_id
2828
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2830
def _synchronize_history(self, destination, revision_id):
2831
"""Synchronize last revision and revision history between branches.
2833
:see: Branch._synchronize_history
2835
# XXX: The base Branch has a fast implementation of this method based
2836
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2837
# that uses set_revision_history. This class inherits from BzrBranch5,
2838
# but wants the fast implementation, so it calls
2839
# Branch._synchronize_history directly.
2840
Branch._synchronize_history(self, destination, revision_id)
2842
def _check_history_violation(self, revision_id):
2843
last_revision = _mod_revision.ensure_null(self.last_revision())
2844
if _mod_revision.is_null(last_revision):
2846
if last_revision not in self._lefthand_history(revision_id):
2847
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2849
def _gen_revision_history(self):
2850
"""Generate the revision history from last revision
2852
last_revno, last_revision = self.last_revision_info()
2853
self._extend_partial_history(stop_index=last_revno-1)
2854
return list(reversed(self._partial_revision_history_cache))
2856
def _write_revision_history(self, history):
2857
"""Factored out of set_revision_history.
2859
This performs the actual writing to disk, with format-specific checks.
2860
It is intended to be called by BzrBranch5.set_revision_history.
2862
if len(history) == 0:
2863
last_revision = 'null:'
2865
if history != self._lefthand_history(history[-1]):
2866
raise errors.NotLefthandHistory(history)
2867
last_revision = history[-1]
2868
if self._get_append_revisions_only():
2869
self._check_history_violation(last_revision)
2870
self._write_last_revision_info(len(history), last_revision)
2873
def _set_parent_location(self, url):
2874
"""Set the parent branch"""
2875
self._set_config_location('parent_location', url, make_relative=True)
2878
def _get_parent_location(self):
2879
"""Set the parent branch"""
2880
return self._get_config_location('parent_location')
2883
def _set_all_reference_info(self, info_dict):
2884
"""Replace all reference info stored in a branch.
2886
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2889
writer = rio.RioWriter(s)
2890
for key, (tree_path, branch_location) in info_dict.iteritems():
2891
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2892
branch_location=branch_location)
2893
writer.write_stanza(stanza)
2894
self._transport.put_bytes('references', s.getvalue())
2895
self._reference_info = info_dict
2898
def _get_all_reference_info(self):
2899
"""Return all the reference info stored in a branch.
2901
:return: A dict of {file_id: (tree_path, branch_location)}
2903
if self._reference_info is not None:
2904
return self._reference_info
2905
rio_file = self._transport.get('references')
2907
stanzas = rio.read_stanzas(rio_file)
2908
info_dict = dict((s['file_id'], (s['tree_path'],
2909
s['branch_location'])) for s in stanzas)
2912
self._reference_info = info_dict
2915
def set_reference_info(self, file_id, tree_path, branch_location):
2916
"""Set the branch location to use for a tree reference.
2918
:param file_id: The file-id of the tree reference.
2919
:param tree_path: The path of the tree reference in the tree.
2920
:param branch_location: The location of the branch to retrieve tree
2923
info_dict = self._get_all_reference_info()
2924
info_dict[file_id] = (tree_path, branch_location)
2925
if None in (tree_path, branch_location):
2926
if tree_path is not None:
2927
raise ValueError('tree_path must be None when branch_location'
2929
if branch_location is not None:
2930
raise ValueError('branch_location must be None when tree_path'
2932
del info_dict[file_id]
2933
self._set_all_reference_info(info_dict)
2935
def get_reference_info(self, file_id):
2936
"""Get the tree_path and branch_location for a tree reference.
2938
:return: a tuple of (tree_path, branch_location)
2940
return self._get_all_reference_info().get(file_id, (None, None))
2942
def reference_parent(self, file_id, path, possible_transports=None):
2943
"""Return the parent branch for a tree-reference file_id.
2945
:param file_id: The file_id of the tree reference
2946
:param path: The path of the file_id in the tree
2947
:return: A branch associated with the file_id
2949
branch_location = self.get_reference_info(file_id)[1]
2950
if branch_location is None:
2951
return Branch.reference_parent(self, file_id, path,
2952
possible_transports)
2953
branch_location = urlutils.join(self.user_url, branch_location)
2954
return Branch.open(branch_location,
2955
possible_transports=possible_transports)
2957
def set_push_location(self, location):
2958
"""See Branch.set_push_location."""
2959
self._set_config_location('push_location', location)
2961
def set_bound_location(self, location):
2962
"""See Branch.set_push_location."""
2964
config = self.get_config()
2965
if location is None:
2966
if config.get_user_option('bound') != 'True':
2969
config.set_user_option('bound', 'False', warn_masked=True)
2972
self._set_config_location('bound_location', location,
2974
config.set_user_option('bound', 'True', warn_masked=True)
2977
def _get_bound_location(self, bound):
2978
"""Return the bound location in the config file.
2980
Return None if the bound parameter does not match"""
2981
config = self.get_config()
2982
config_bound = (config.get_user_option('bound') == 'True')
2983
if config_bound != bound:
2985
return self._get_config_location('bound_location', config=config)
2987
def get_bound_location(self):
2988
"""See Branch.set_push_location."""
2989
return self._get_bound_location(True)
2991
def get_old_bound_location(self):
2992
"""See Branch.get_old_bound_location"""
2993
return self._get_bound_location(False)
2995
def get_stacked_on_url(self):
2996
# you can always ask for the URL; but you might not be able to use it
2997
# if the repo can't support stacking.
2998
## self._check_stackable_repo()
2999
stacked_url = self._get_config_location('stacked_on_location')
3000
if stacked_url is None:
3001
raise errors.NotStacked(self)
3004
def _get_append_revisions_only(self):
3005
return self.get_config(
3006
).get_user_option_as_bool('append_revisions_only')
3009
def generate_revision_history(self, revision_id, last_rev=None,
3011
"""See BzrBranch5.generate_revision_history"""
3012
history = self._lefthand_history(revision_id, last_rev, other_branch)
3013
revno = len(history)
3014
self.set_last_revision_info(revno, revision_id)
3017
def get_rev_id(self, revno, history=None):
3018
"""Find the revision id of the specified revno."""
3020
return _mod_revision.NULL_REVISION
3022
last_revno, last_revision_id = self.last_revision_info()
3023
if revno <= 0 or revno > last_revno:
3024
raise errors.NoSuchRevision(self, revno)
3026
if history is not None:
3027
return history[revno - 1]
3029
index = last_revno - revno
3030
if len(self._partial_revision_history_cache) <= index:
3031
self._extend_partial_history(stop_index=index)
3032
if len(self._partial_revision_history_cache) > index:
3033
return self._partial_revision_history_cache[index]
3035
raise errors.NoSuchRevision(self, revno)
3038
def revision_id_to_revno(self, revision_id):
3039
"""Given a revision id, return its revno"""
3040
if _mod_revision.is_null(revision_id):
3043
index = self._partial_revision_history_cache.index(revision_id)
3045
self._extend_partial_history(stop_revision=revision_id)
3046
index = len(self._partial_revision_history_cache) - 1
3047
if self._partial_revision_history_cache[index] != revision_id:
3048
raise errors.NoSuchRevision(self, revision_id)
3049
return self.revno() - index
3052
class BzrBranch7(BzrBranch8):
3053
"""A branch with support for a fallback repository."""
3055
def set_reference_info(self, file_id, tree_path, branch_location):
3056
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3058
def get_reference_info(self, file_id):
3059
Branch.get_reference_info(self, file_id)
3061
def reference_parent(self, file_id, path, possible_transports=None):
3062
return Branch.reference_parent(self, file_id, path,
3063
possible_transports)
3066
class BzrBranch6(BzrBranch7):
3067
"""See BzrBranchFormat6 for the capabilities of this branch.
3069
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3073
def get_stacked_on_url(self):
3074
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1328
3077
######################################################################
1332
def is_control_file(filename):
1333
## FIXME: better check
1334
filename = os.path.normpath(filename)
1335
while filename != '':
1336
head, tail = os.path.split(filename)
1337
## mutter('check %r for control file' % ((head, tail), ))
1338
if tail == bzrlib.BZRDIR:
1340
if filename == head:
1347
def gen_file_id(name):
1348
"""Return new file id.
1350
This should probably generate proper UUIDs, but for the moment we
1351
cope with just randomness because running uuidgen every time is
1354
from binascii import hexlify
1355
from time import time
1357
# get last component
1358
idx = name.rfind('/')
1360
name = name[idx+1 : ]
1361
idx = name.rfind('\\')
1363
name = name[idx+1 : ]
1365
# make it not a hidden file
1366
name = name.lstrip('.')
1368
# remove any wierd characters; we don't escape them but rather
1369
# just pull them out
1370
name = re.sub(r'[^\w.]', '', name)
1372
s = hexlify(rand_bytes(8))
1373
return '-'.join((name, compact_date(time()), s))
1377
"""Return a new tree-root file id."""
1378
return gen_file_id('TREE_ROOT')
3078
# results of operations
3081
class _Result(object):
3083
def _show_tag_conficts(self, to_file):
3084
if not getattr(self, 'tag_conflicts', None):
3086
to_file.write('Conflicting tags:\n')
3087
for name, value1, value2 in self.tag_conflicts:
3088
to_file.write(' %s\n' % (name, ))
3091
class PullResult(_Result):
3092
"""Result of a Branch.pull operation.
3094
:ivar old_revno: Revision number before pull.
3095
:ivar new_revno: Revision number after pull.
3096
:ivar old_revid: Tip revision id before pull.
3097
:ivar new_revid: Tip revision id after pull.
3098
:ivar source_branch: Source (local) branch object. (read locked)
3099
:ivar master_branch: Master branch of the target, or the target if no
3101
:ivar local_branch: target branch if there is a Master, else None
3102
:ivar target_branch: Target/destination branch object. (write locked)
3103
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3107
# DEPRECATED: pull used to return the change in revno
3108
return self.new_revno - self.old_revno
3110
def report(self, to_file):
3112
if self.old_revid == self.new_revid:
3113
to_file.write('No revisions to pull.\n')
3115
to_file.write('Now on revision %d.\n' % self.new_revno)
3116
self._show_tag_conficts(to_file)
3119
class BranchPushResult(_Result):
3120
"""Result of a Branch.push operation.
3122
:ivar old_revno: Revision number (eg 10) of the target before push.
3123
:ivar new_revno: Revision number (eg 12) of the target after push.
3124
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3126
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3128
:ivar source_branch: Source branch object that the push was from. This is
3129
read locked, and generally is a local (and thus low latency) branch.
3130
:ivar master_branch: If target is a bound branch, the master branch of
3131
target, or target itself. Always write locked.
3132
:ivar target_branch: The direct Branch where data is being sent (write
3134
:ivar local_branch: If the target is a bound branch this will be the
3135
target, otherwise it will be None.
3139
# DEPRECATED: push used to return the change in revno
3140
return self.new_revno - self.old_revno
3142
def report(self, to_file):
3143
"""Write a human-readable description of the result."""
3144
if self.old_revid == self.new_revid:
3145
note('No new revisions to push.')
3147
note('Pushed up to revision %d.' % self.new_revno)
3148
self._show_tag_conficts(to_file)
3151
class BranchCheckResult(object):
3152
"""Results of checking branch consistency.
3157
def __init__(self, branch):
3158
self.branch = branch
3161
def report_results(self, verbose):
3162
"""Report the check results via trace.note.
3164
:param verbose: Requests more detailed display of what was checked,
3167
note('checked branch %s format %s', self.branch.user_url,
3168
self.branch._format)
3169
for error in self.errors:
3170
note('found error:%s', error)
3173
class Converter5to6(object):
3174
"""Perform an in-place upgrade of format 5 to format 6"""
3176
def convert(self, branch):
3177
# Data for 5 and 6 can peacefully coexist.
3178
format = BzrBranchFormat6()
3179
new_branch = format.open(branch.bzrdir, _found=True)
3181
# Copy source data into target
3182
new_branch._write_last_revision_info(*branch.last_revision_info())
3183
new_branch.set_parent(branch.get_parent())
3184
new_branch.set_bound_location(branch.get_bound_location())
3185
new_branch.set_push_location(branch.get_push_location())
3187
# New branch has no tags by default
3188
new_branch.tags._set_tag_dict({})
3190
# Copying done; now update target format
3191
new_branch._transport.put_bytes('format',
3192
format.get_format_string(),
3193
mode=new_branch.bzrdir._get_file_mode())
3195
# Clean up old files
3196
new_branch._transport.delete('revision-history')
3198
branch.set_parent(None)
3199
except errors.NoSuchFile:
3201
branch.set_bound_location(None)
3204
class Converter6to7(object):
3205
"""Perform an in-place upgrade of format 6 to format 7"""
3207
def convert(self, branch):
3208
format = BzrBranchFormat7()
3209
branch._set_config_location('stacked_on_location', '')
3210
# update target format
3211
branch._transport.put_bytes('format', format.get_format_string())
3214
class Converter7to8(object):
3215
"""Perform an in-place upgrade of format 6 to format 7"""
3217
def convert(self, branch):
3218
format = BzrBranchFormat8()
3219
branch._transport.put_bytes('references', '')
3220
# update target format
3221
branch._transport.put_bytes('format', format.get_format_string())
3224
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3225
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3228
_run_with_write_locked_target will attempt to release the lock it acquires.
3230
If an exception is raised by callable, then that exception *will* be
3231
propagated, even if the unlock attempt raises its own error. Thus
3232
_run_with_write_locked_target should be preferred to simply doing::
3236
return callable(*args, **kwargs)
3241
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3242
# should share code?
3245
result = callable(*args, **kwargs)
3247
exc_info = sys.exc_info()
3251
raise exc_info[0], exc_info[1], exc_info[2]
3257
class InterBranch(InterObject):
3258
"""This class represents operations taking place between two branches.
3260
Its instances have methods like pull() and push() and contain
3261
references to the source and target repositories these operations
3262
can be carried out on.
3266
"""The available optimised InterBranch types."""
3269
def _get_branch_formats_to_test(klass):
3270
"""Return an iterable of format tuples for testing.
3272
:return: An iterable of (from_format, to_format) to use when testing
3273
this InterBranch class. Each InterBranch class should define this
3276
raise NotImplementedError(klass._get_branch_formats_to_test)
3279
def pull(self, overwrite=False, stop_revision=None,
3280
possible_transports=None, local=False):
3281
"""Mirror source into target branch.
3283
The target branch is considered to be 'local', having low latency.
3285
:returns: PullResult instance
3287
raise NotImplementedError(self.pull)
3290
def update_revisions(self, stop_revision=None, overwrite=False,
3292
"""Pull in new perfect-fit revisions.
3294
:param stop_revision: Updated until the given revision
3295
:param overwrite: Always set the branch pointer, rather than checking
3296
to see if it is a proper descendant.
3297
:param graph: A Graph object that can be used to query history
3298
information. This can be None.
3301
raise NotImplementedError(self.update_revisions)
3304
def push(self, overwrite=False, stop_revision=None,
3305
_override_hook_source_branch=None):
3306
"""Mirror the source branch into the target branch.
3308
The source branch is considered to be 'local', having low latency.
3310
raise NotImplementedError(self.push)
3313
class GenericInterBranch(InterBranch):
3314
"""InterBranch implementation that uses public Branch functions."""
3317
def is_compatible(klass, source, target):
3318
# GenericBranch uses the public API, so always compatible
3322
def _get_branch_formats_to_test(klass):
3323
return [(BranchFormat._default_format, BranchFormat._default_format)]
3326
def unwrap_format(klass, format):
3327
if isinstance(format, remote.RemoteBranchFormat):
3328
format._ensure_real()
3329
return format._custom_format
3333
def copy_content_into(self, revision_id=None):
3334
"""Copy the content of source into target
3336
revision_id: if not None, the revision history in the new branch will
3337
be truncated to end with revision_id.
3339
self.source.update_references(self.target)
3340
self.source._synchronize_history(self.target, revision_id)
3342
parent = self.source.get_parent()
3343
except errors.InaccessibleParent, e:
3344
mutter('parent was not accessible to copy: %s', e)
3347
self.target.set_parent(parent)
3348
if self.source._push_should_merge_tags():
3349
self.source.tags.merge_to(self.target.tags)
3352
def update_revisions(self, stop_revision=None, overwrite=False,
3354
"""See InterBranch.update_revisions()."""
3355
other_revno, other_last_revision = self.source.last_revision_info()
3356
stop_revno = None # unknown
3357
if stop_revision is None:
3358
stop_revision = other_last_revision
3359
if _mod_revision.is_null(stop_revision):
3360
# if there are no commits, we're done.
3362
stop_revno = other_revno
3364
# what's the current last revision, before we fetch [and change it
3366
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3367
# we fetch here so that we don't process data twice in the common
3368
# case of having something to pull, and so that the check for
3369
# already merged can operate on the just fetched graph, which will
3370
# be cached in memory.
3371
self.target.fetch(self.source, stop_revision)
3372
# Check to see if one is an ancestor of the other
3375
graph = self.target.repository.get_graph()
3376
if self.target._check_if_descendant_or_diverged(
3377
stop_revision, last_rev, graph, self.source):
3378
# stop_revision is a descendant of last_rev, but we aren't
3379
# overwriting, so we're done.
3381
if stop_revno is None:
3383
graph = self.target.repository.get_graph()
3384
this_revno, this_last_revision = \
3385
self.target.last_revision_info()
3386
stop_revno = graph.find_distance_to_null(stop_revision,
3387
[(other_last_revision, other_revno),
3388
(this_last_revision, this_revno)])
3389
self.target.set_last_revision_info(stop_revno, stop_revision)
3392
def pull(self, overwrite=False, stop_revision=None,
3393
possible_transports=None, run_hooks=True,
3394
_override_hook_target=None, local=False):
3395
"""Pull from source into self, updating my master if any.
3397
:param run_hooks: Private parameter - if false, this branch
3398
is being called because it's the master of the primary branch,
3399
so it should not run its hooks.
3401
bound_location = self.target.get_bound_location()
3402
if local and not bound_location:
3403
raise errors.LocalRequiresBoundBranch()
3404
master_branch = None
3405
if not local and bound_location and self.source.user_url != bound_location:
3406
# not pulling from master, so we need to update master.
3407
master_branch = self.target.get_master_branch(possible_transports)
3408
master_branch.lock_write()
3411
# pull from source into master.
3412
master_branch.pull(self.source, overwrite, stop_revision,
3414
return self._pull(overwrite,
3415
stop_revision, _hook_master=master_branch,
3416
run_hooks=run_hooks,
3417
_override_hook_target=_override_hook_target)
3420
master_branch.unlock()
3422
def push(self, overwrite=False, stop_revision=None,
3423
_override_hook_source_branch=None):
3424
"""See InterBranch.push.
3426
This is the basic concrete implementation of push()
3428
:param _override_hook_source_branch: If specified, run
3429
the hooks passing this Branch as the source, rather than self.
3430
This is for use of RemoteBranch, where push is delegated to the
3431
underlying vfs-based Branch.
3433
# TODO: Public option to disable running hooks - should be trivial but
3435
self.source.lock_read()
3437
return _run_with_write_locked_target(
3438
self.target, self._push_with_bound_branches, overwrite,
3440
_override_hook_source_branch=_override_hook_source_branch)
3442
self.source.unlock()
3444
def _push_with_bound_branches(self, overwrite, stop_revision,
3445
_override_hook_source_branch=None):
3446
"""Push from source into target, and into target's master if any.
3449
if _override_hook_source_branch:
3450
result.source_branch = _override_hook_source_branch
3451
for hook in Branch.hooks['post_push']:
3454
bound_location = self.target.get_bound_location()
3455
if bound_location and self.target.base != bound_location:
3456
# there is a master branch.
3458
# XXX: Why the second check? Is it even supported for a branch to
3459
# be bound to itself? -- mbp 20070507
3460
master_branch = self.target.get_master_branch()
3461
master_branch.lock_write()
3463
# push into the master from the source branch.
3464
self.source._basic_push(master_branch, overwrite, stop_revision)
3465
# and push into the target branch from the source. Note that we
3466
# push from the source branch again, because its considered the
3467
# highest bandwidth repository.
3468
result = self.source._basic_push(self.target, overwrite,
3470
result.master_branch = master_branch
3471
result.local_branch = self.target
3475
master_branch.unlock()
3478
result = self.source._basic_push(self.target, overwrite,
3480
# TODO: Why set master_branch and local_branch if there's no
3481
# binding? Maybe cleaner to just leave them unset? -- mbp
3483
result.master_branch = self.target
3484
result.local_branch = None
3488
def _pull(self, overwrite=False, stop_revision=None,
3489
possible_transports=None, _hook_master=None, run_hooks=True,
3490
_override_hook_target=None, local=False):
3493
This function is the core worker, used by GenericInterBranch.pull to
3494
avoid duplication when pulling source->master and source->local.
3496
:param _hook_master: Private parameter - set the branch to
3497
be supplied as the master to pull hooks.
3498
:param run_hooks: Private parameter - if false, this branch
3499
is being called because it's the master of the primary branch,
3500
so it should not run its hooks.
3501
:param _override_hook_target: Private parameter - set the branch to be
3502
supplied as the target_branch to pull hooks.
3503
:param local: Only update the local branch, and not the bound branch.
3505
# This type of branch can't be bound.
3507
raise errors.LocalRequiresBoundBranch()
3508
result = PullResult()
3509
result.source_branch = self.source
3510
if _override_hook_target is None:
3511
result.target_branch = self.target
3513
result.target_branch = _override_hook_target
3514
self.source.lock_read()
3516
# We assume that during 'pull' the target repository is closer than
3518
self.source.update_references(self.target)
3519
graph = self.target.repository.get_graph(self.source.repository)
3520
# TODO: Branch formats should have a flag that indicates
3521
# that revno's are expensive, and pull() should honor that flag.
3523
result.old_revno, result.old_revid = \
3524
self.target.last_revision_info()
3525
self.target.update_revisions(self.source, stop_revision,
3526
overwrite=overwrite, graph=graph)
3527
# TODO: The old revid should be specified when merging tags,
3528
# so a tags implementation that versions tags can only
3529
# pull in the most recent changes. -- JRV20090506
3530
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3532
result.new_revno, result.new_revid = self.target.last_revision_info()
3534
result.master_branch = _hook_master
3535
result.local_branch = result.target_branch
3537
result.master_branch = result.target_branch
3538
result.local_branch = None
3540
for hook in Branch.hooks['post_pull']:
3543
self.source.unlock()
3547
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
