1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
19
import traceback, socket, fnmatch, difflib, time
20
from binascii import hexlify
23
from inventory import Inventory
24
from trace import mutter, note
25
from tree import Tree, EmptyTree, RevisionTree
26
from inventory import InventoryEntry, Inventory
27
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
28
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
29
joinpath, sha_file, sha_string, file_kind, local_time_offset, appendpath
30
from store import ImmutableStore
31
from revision import Revision
32
from errors import BzrError
33
from textui import show_status
35
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
36
## TODO: Maybe include checks for common corruption of newlines, etc?
40
def find_branch(f, **args):
41
if f and (f.startswith('http://') or f.startswith('https://')):
43
return remotebranch.RemoteBranch(f, **args)
45
return Branch(f, **args)
49
def _relpath(base, path):
50
"""Return path relative to base, or raise exception.
52
The path may be either an absolute path or a path relative to the
53
current working directory.
55
Lifted out of Branch.relpath for ease of testing.
57
os.path.commonprefix (python2.4) has a bad bug that it works just
58
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
59
avoids that problem."""
60
rp = os.path.abspath(path)
64
while len(head) >= len(base):
67
head, tail = os.path.split(head)
71
from errors import NotBranchError
72
raise NotBranchError("path %r is not within branch %r" % (rp, base))
77
def find_branch_root(f=None):
78
"""Find the branch root enclosing f, or pwd.
80
f may be a filename or a URL.
82
It is not necessary that f exists.
84
Basically we keep looking up until we find the control directory or
88
elif hasattr(os.path, 'realpath'):
89
f = os.path.realpath(f)
91
f = os.path.abspath(f)
92
if not os.path.exists(f):
93
raise BzrError('%r does not exist' % f)
99
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
101
head, tail = os.path.split(f)
103
# reached the root, whatever that may be
104
raise BzrError('%r is not in a branch' % orig_f)
107
class DivergedBranches(Exception):
108
def __init__(self, branch1, branch2):
109
self.branch1 = branch1
110
self.branch2 = branch2
111
Exception.__init__(self, "These branches have diverged.")
114
class NoSuchRevision(BzrError):
115
def __init__(self, branch, revision):
117
self.revision = revision
118
msg = "Branch %s has no revision %d" % (branch, revision)
119
BzrError.__init__(self, msg)
122
######################################################################
125
class Branch(object):
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
29
config as _mod_config,
38
revision as _mod_revision,
45
from bzrlib.i18n import gettext, ngettext
51
from bzrlib.decorators import (
56
from bzrlib.hooks import Hooks
57
from bzrlib.inter import InterObject
58
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
59
from bzrlib import registry
60
from bzrlib.symbol_versioning import (
64
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
67
class Branch(controldir.ControlComponent):
126
68
"""Branch holding a history of revisions.
129
Base directory of the branch.
135
If _lock_mode is true, a positive count of the number of times the
139
Lock object from bzrlib.lock.
71
Base directory/url of the branch; using control_url and
72
control_transport is more standardized.
73
:ivar hooks: An instance of BranchHooks.
74
:ivar _master_branch_cache: cached result of get_master_branch, see
77
# this is really an instance variable - FIXME move it there
146
def __init__(self, base, init=False, find_root=True):
147
"""Create new branch object at a particular location.
149
base -- Base directory for the branch.
151
init -- If True, create new control files in a previously
152
unversioned directory. If False, the branch must already
155
find_root -- If true and init is false, find the root of the
156
existing branch containing base.
158
In the test suite, creation of new trees is tested using the
159
`ScratchBranch` class.
162
self.base = os.path.realpath(base)
165
self.base = find_branch_root(base)
167
self.base = os.path.realpath(base)
168
if not isdir(self.controlfilename('.')):
169
from errors import NotBranchError
170
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
171
['use "bzr init" to initialize a new working tree',
172
'current bzr can only operate from top-of-tree'])
175
self.text_store = ImmutableStore(self.controlfilename('text-store'))
176
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
177
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
181
return '%s(%r)' % (self.__class__.__name__, self.base)
188
if self._lock_mode or self._lock:
189
from warnings import warn
190
warn("branch %r was not explicitly unlocked" % self)
195
def lock_write(self):
197
if self._lock_mode != 'w':
198
from errors import LockError
199
raise LockError("can't upgrade to a write lock from %r" %
201
self._lock_count += 1
203
from bzrlib.lock import WriteLock
205
self._lock = WriteLock(self.controlfilename('branch-lock'))
206
self._lock_mode = 'w'
82
def control_transport(self):
83
return self._transport
86
def user_transport(self):
87
return self.bzrdir.user_transport
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._partial_revision_history_cache = []
95
self._tags_bytes = None
96
self._last_revision_info_cache = None
97
self._master_branch_cache = None
98
self._merge_sorted_revisions_cache = None
100
hooks = Branch.hooks['open']
104
def _open_hook(self):
105
"""Called by init to allow simpler extension of the base class."""
107
def _activate_fallback_location(self, url):
108
"""Activate the branch/repository from url as a fallback repository."""
109
for existing_fallback_repo in self.repository._fallback_repositories:
110
if existing_fallback_repo.user_url == url:
111
# This fallback is already configured. This probably only
112
# happens because ControlDir.sprout is a horrible mess. To avoid
113
# confusing _unstack we don't add this a second time.
114
mutter('duplicate activation of fallback %r on %r', url, self)
116
repo = self._get_fallback_repository(url)
117
if repo.has_same_location(self.repository):
118
raise errors.UnstackableLocationError(self.user_url, url)
119
self.repository.add_fallback_repository(repo)
121
def break_lock(self):
122
"""Break a lock if one is present from another instance.
124
Uses the ui factory to ask for confirmation if the lock may be from
127
This will probe the repository for its lock as well.
129
self.control_files.break_lock()
130
self.repository.break_lock()
131
master = self.get_master_branch()
132
if master is not None:
135
def _check_stackable_repo(self):
136
if not self.repository._format.supports_external_lookups:
137
raise errors.UnstackableRepositoryFormat(self.repository._format,
138
self.repository.base)
140
def _extend_partial_history(self, stop_index=None, stop_revision=None):
141
"""Extend the partial history to include a given index
143
If a stop_index is supplied, stop when that index has been reached.
144
If a stop_revision is supplied, stop when that revision is
145
encountered. Otherwise, stop when the beginning of history is
148
:param stop_index: The index which should be present. When it is
149
present, history extension will stop.
150
:param stop_revision: The revision id which should be present. When
151
it is encountered, history extension will stop.
153
if len(self._partial_revision_history_cache) == 0:
154
self._partial_revision_history_cache = [self.last_revision()]
155
repository._iter_for_revno(
156
self.repository, self._partial_revision_history_cache,
157
stop_index=stop_index, stop_revision=stop_revision)
158
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
159
self._partial_revision_history_cache.pop()
161
def _get_check_refs(self):
162
"""Get the references needed for check().
166
revid = self.last_revision()
167
return [('revision-existence', revid), ('lefthand-distance', revid)]
170
def open(base, _unsupported=False, possible_transports=None):
171
"""Open the branch rooted at base.
173
For instance, if the branch is at URL/.bzr/branch,
174
Branch.open(URL) -> a Branch instance.
176
control = controldir.ControlDir.open(base, _unsupported,
177
possible_transports=possible_transports)
178
return control.open_branch(unsupported=_unsupported)
181
def open_from_transport(transport, name=None, _unsupported=False):
182
"""Open the branch rooted at transport"""
183
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
184
return control.open_branch(name=name, unsupported=_unsupported)
187
def open_containing(url, possible_transports=None):
188
"""Open an existing branch which contains url.
190
This probes for a branch at url, and searches upwards from there.
192
Basically we keep looking up until we find the control directory or
193
run into the root. If there isn't one, raises NotBranchError.
194
If there is one and it is either an unrecognised format or an unsupported
195
format, UnknownFormatError or UnsupportedFormatError are raised.
196
If there is one, it is returned, along with the unused portion of url.
198
control, relpath = controldir.ControlDir.open_containing(url,
200
return control.open_branch(), relpath
202
def _push_should_merge_tags(self):
203
"""Should _basic_push merge this branch's tags into the target?
205
The default implementation returns False if this branch has no tags,
206
and True the rest of the time. Subclasses may override this.
208
return self.supports_tags() and self.tags.get_tag_dict()
210
def get_config(self):
211
"""Get a bzrlib.config.BranchConfig for this Branch.
213
This can then be used to get and set configuration options for the
216
:return: A bzrlib.config.BranchConfig.
218
return _mod_config.BranchConfig(self)
220
def get_config_stack(self):
221
"""Get a bzrlib.config.BranchStack for this Branch.
223
This can then be used to get and set configuration options for the
226
:return: A bzrlib.config.BranchStack.
228
return _mod_config.BranchStack(self)
230
def _get_config(self):
231
"""Get the concrete config for just the config in this branch.
233
This is not intended for client use; see Branch.get_config for the
238
:return: An object supporting get_option and set_option.
240
raise NotImplementedError(self._get_config)
242
def _get_fallback_repository(self, url):
243
"""Get the repository we fallback to at url."""
244
url = urlutils.join(self.base, url)
245
a_branch = Branch.open(url,
246
possible_transports=[self.bzrdir.root_transport])
247
return a_branch.repository
250
def _get_tags_bytes(self):
251
"""Get the bytes of a serialised tags dict.
253
Note that not all branches support tags, nor do all use the same tags
254
logic: this method is specific to BasicTags. Other tag implementations
255
may use the same method name and behave differently, safely, because
256
of the double-dispatch via
257
format.make_tags->tags_instance->get_tags_dict.
259
:return: The bytes of the tags file.
260
:seealso: Branch._set_tags_bytes.
262
if self._tags_bytes is None:
263
self._tags_bytes = self._transport.get_bytes('tags')
264
return self._tags_bytes
266
def _get_nick(self, local=False, possible_transports=None):
267
config = self.get_config()
268
# explicit overrides master, but don't look for master if local is True
269
if not local and not config.has_explicit_nickname():
271
master = self.get_master_branch(possible_transports)
272
if master and self.user_url == master.user_url:
273
raise errors.RecursiveBind(self.user_url)
274
if master is not None:
275
# return the master branch value
277
except errors.RecursiveBind, e:
279
except errors.BzrError, e:
280
# Silently fall back to local implicit nick if the master is
282
mutter("Could not connect to bound branch, "
283
"falling back to local nick.\n " + str(e))
284
return config.get_nickname()
286
def _set_nick(self, nick):
287
self.get_config().set_user_option('nickname', nick, warn_masked=True)
289
nick = property(_get_nick, _set_nick)
292
raise NotImplementedError(self.is_locked)
294
def _lefthand_history(self, revision_id, last_rev=None,
296
if 'evil' in debug.debug_flags:
297
mutter_callsite(4, "_lefthand_history scales with history.")
298
# stop_revision must be a descendant of last_revision
299
graph = self.repository.get_graph()
300
if last_rev is not None:
301
if not graph.is_ancestor(last_rev, revision_id):
302
# our previous tip is not merged into stop_revision
303
raise errors.DivergedBranches(self, other_branch)
304
# make a new revision history from the graph
305
parents_map = graph.get_parent_map([revision_id])
306
if revision_id not in parents_map:
307
raise errors.NoSuchRevision(self, revision_id)
308
current_rev_id = revision_id
310
check_not_reserved_id = _mod_revision.check_not_reserved_id
311
# Do not include ghosts or graph origin in revision_history
312
while (current_rev_id in parents_map and
313
len(parents_map[current_rev_id]) > 0):
314
check_not_reserved_id(current_rev_id)
315
new_history.append(current_rev_id)
316
current_rev_id = parents_map[current_rev_id][0]
317
parents_map = graph.get_parent_map([current_rev_id])
318
new_history.reverse()
321
def lock_write(self, token=None):
322
"""Lock the branch for write operations.
324
:param token: A token to permit reacquiring a previously held and
326
:return: A BranchWriteLockResult.
328
raise NotImplementedError(self.lock_write)
211
330
def lock_read(self):
213
assert self._lock_mode in ('r', 'w'), \
214
"invalid lock mode %r" % self._lock_mode
215
self._lock_count += 1
217
from bzrlib.lock import ReadLock
219
self._lock = ReadLock(self.controlfilename('branch-lock'))
220
self._lock_mode = 'r'
331
"""Lock the branch for read operations.
333
:return: A bzrlib.lock.LogicalLockResult.
335
raise NotImplementedError(self.lock_read)
225
337
def unlock(self):
226
if not self._lock_mode:
227
from errors import LockError
228
raise LockError('branch %r is not locked' % (self))
230
if self._lock_count > 1:
231
self._lock_count -= 1
235
self._lock_mode = self._lock_count = None
238
def abspath(self, name):
239
"""Return absolute filename for something in the branch"""
240
return os.path.join(self.base, name)
243
def relpath(self, path):
244
"""Return path relative to this branch of something inside it.
246
Raises an error if path is not in this branch."""
247
return _relpath(self.base, path)
250
def controlfilename(self, file_or_path):
251
"""Return location relative to branch."""
252
if isinstance(file_or_path, types.StringTypes):
253
file_or_path = [file_or_path]
254
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
257
def controlfile(self, file_or_path, mode='r'):
258
"""Open a control file for this branch.
260
There are two classes of file in the control directory: text
261
and binary. binary files are untranslated byte streams. Text
262
control files are stored with Unix newlines and in UTF-8, even
263
if the platform or locale defaults are different.
265
Controlfiles should almost never be opened in write mode but
266
rather should be atomically copied and replaced using atomicfile.
269
fn = self.controlfilename(file_or_path)
271
if mode == 'rb' or mode == 'wb':
272
return file(fn, mode)
273
elif mode == 'r' or mode == 'w':
274
# open in binary mode anyhow so there's no newline translation;
275
# codecs uses line buffering by default; don't want that.
277
return codecs.open(fn, mode + 'b', 'utf-8',
280
raise BzrError("invalid controlfile mode %r" % mode)
284
def _make_control(self):
285
os.mkdir(self.controlfilename([]))
286
self.controlfile('README', 'w').write(
287
"This is a Bazaar-NG control directory.\n"
288
"Do not change any files in this directory.\n")
289
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
290
for d in ('text-store', 'inventory-store', 'revision-store'):
291
os.mkdir(self.controlfilename(d))
292
for f in ('revision-history', 'merged-patches',
293
'pending-merged-patches', 'branch-name',
295
self.controlfile(f, 'w').write('')
296
mutter('created control directory in ' + self.base)
297
Inventory().write_xml(self.controlfile('inventory','w'))
300
def _check_format(self):
301
"""Check this branch format is supported.
303
The current tool only supports the current unstable format.
305
In the future, we might need different in-memory Branch
306
classes to support downlevel branches. But not yet.
308
# This ignores newlines so that we can open branches created
309
# on Windows from Linux and so on. I think it might be better
310
# to always make all internal files in unix format.
311
fmt = self.controlfile('branch-format', 'r').read()
312
fmt.replace('\r\n', '')
313
if fmt != BZR_BRANCH_FORMAT:
314
raise BzrError('sorry, branch format %r not supported' % fmt,
315
['use a different bzr version',
316
'or remove the .bzr directory and "bzr init" again'])
320
def read_working_inventory(self):
321
"""Read the working inventory."""
323
# ElementTree does its own conversion from UTF-8, so open in
327
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
328
mutter("loaded inventory of %d items in %f"
329
% (len(inv), time.time() - before))
335
def _write_inventory(self, inv):
336
"""Update the working inventory.
338
That is to say, the inventory describing changes underway, that
339
will be committed to the next revision.
341
## TODO: factor out to atomicfile? is rename safe on windows?
342
## TODO: Maybe some kind of clean/dirty marker on inventory?
343
tmpfname = self.controlfilename('inventory.tmp')
344
tmpf = file(tmpfname, 'wb')
347
inv_fname = self.controlfilename('inventory')
348
if sys.platform == 'win32':
350
os.rename(tmpfname, inv_fname)
351
mutter('wrote working inventory')
354
inventory = property(read_working_inventory, _write_inventory, None,
355
"""Inventory for the working copy.""")
358
def add(self, files, verbose=False, ids=None):
359
"""Make files versioned.
361
Note that the command line normally calls smart_add instead.
363
This puts the files in the Added state, so that they will be
364
recorded by the next commit.
367
List of paths to add, relative to the base of the tree.
370
If set, use these instead of automatically generated ids.
371
Must be the same length as the list of files, but may
372
contain None for ids that are to be autogenerated.
374
TODO: Perhaps have an option to add the ids even if the files do
377
TODO: Perhaps return the ids of the files? But then again it
378
is easy to retrieve them if they're needed.
380
TODO: Adding a directory should optionally recurse down and
381
add all non-ignored children. Perhaps do that in a
384
# TODO: Re-adding a file that is removed in the working copy
385
# should probably put it back with the previous ID.
386
if isinstance(files, types.StringTypes):
387
assert(ids is None or isinstance(ids, types.StringTypes))
393
ids = [None] * len(files)
395
assert(len(ids) == len(files))
399
inv = self.read_working_inventory()
400
for f,file_id in zip(files, ids):
401
if is_control_file(f):
402
raise BzrError("cannot add control file %s" % quotefn(f))
407
raise BzrError("cannot add top-level %r" % f)
409
fullpath = os.path.normpath(self.abspath(f))
412
kind = file_kind(fullpath)
414
# maybe something better?
415
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
417
if kind != 'file' and kind != 'directory':
418
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
421
file_id = gen_file_id(f)
422
inv.add_path(f, kind=kind, file_id=file_id)
425
show_status('A', kind, quotefn(f))
427
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
429
self._write_inventory(inv)
434
def print_file(self, file, revno):
338
raise NotImplementedError(self.unlock)
340
def peek_lock_mode(self):
341
"""Return lock mode for the Branch: 'r', 'w' or None"""
342
raise NotImplementedError(self.peek_lock_mode)
344
def get_physical_lock_status(self):
345
raise NotImplementedError(self.get_physical_lock_status)
348
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
349
"""Return the revision_id for a dotted revno.
351
:param revno: a tuple like (1,) or (1,1,2)
352
:param _cache_reverse: a private parameter enabling storage
353
of the reverse mapping in a top level cache. (This should
354
only be done in selective circumstances as we want to
355
avoid having the mapping cached multiple times.)
356
:return: the revision_id
357
:raises errors.NoSuchRevision: if the revno doesn't exist
359
rev_id = self._do_dotted_revno_to_revision_id(revno)
361
self._partial_revision_id_to_revno_cache[rev_id] = revno
364
def _do_dotted_revno_to_revision_id(self, revno):
365
"""Worker function for dotted_revno_to_revision_id.
367
Subclasses should override this if they wish to
368
provide a more efficient implementation.
371
return self.get_rev_id(revno[0])
372
revision_id_to_revno = self.get_revision_id_to_revno_map()
373
revision_ids = [revision_id for revision_id, this_revno
374
in revision_id_to_revno.iteritems()
375
if revno == this_revno]
376
if len(revision_ids) == 1:
377
return revision_ids[0]
379
revno_str = '.'.join(map(str, revno))
380
raise errors.NoSuchRevision(self, revno_str)
383
def revision_id_to_dotted_revno(self, revision_id):
384
"""Given a revision id, return its dotted revno.
386
:return: a tuple like (1,) or (400,1,3).
388
return self._do_revision_id_to_dotted_revno(revision_id)
390
def _do_revision_id_to_dotted_revno(self, revision_id):
391
"""Worker function for revision_id_to_revno."""
392
# Try the caches if they are loaded
393
result = self._partial_revision_id_to_revno_cache.get(revision_id)
394
if result is not None:
396
if self._revision_id_to_revno_cache:
397
result = self._revision_id_to_revno_cache.get(revision_id)
399
raise errors.NoSuchRevision(self, revision_id)
400
# Try the mainline as it's optimised
402
revno = self.revision_id_to_revno(revision_id)
404
except errors.NoSuchRevision:
405
# We need to load and use the full revno map after all
406
result = self.get_revision_id_to_revno_map().get(revision_id)
408
raise errors.NoSuchRevision(self, revision_id)
412
def get_revision_id_to_revno_map(self):
413
"""Return the revision_id => dotted revno map.
415
This will be regenerated on demand, but will be cached.
417
:return: A dictionary mapping revision_id => dotted revno.
418
This dictionary should not be modified by the caller.
420
if self._revision_id_to_revno_cache is not None:
421
mapping = self._revision_id_to_revno_cache
423
mapping = self._gen_revno_map()
424
self._cache_revision_id_to_revno(mapping)
425
# TODO: jam 20070417 Since this is being cached, should we be returning
427
# I would rather not, and instead just declare that users should not
428
# modify the return value.
431
def _gen_revno_map(self):
432
"""Create a new mapping from revision ids to dotted revnos.
434
Dotted revnos are generated based on the current tip in the revision
436
This is the worker function for get_revision_id_to_revno_map, which
437
just caches the return value.
439
:return: A dictionary mapping revision_id => dotted revno.
441
revision_id_to_revno = dict((rev_id, revno)
442
for rev_id, depth, revno, end_of_merge
443
in self.iter_merge_sorted_revisions())
444
return revision_id_to_revno
447
def iter_merge_sorted_revisions(self, start_revision_id=None,
448
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
449
"""Walk the revisions for a branch in merge sorted order.
451
Merge sorted order is the output from a merge-aware,
452
topological sort, i.e. all parents come before their
453
children going forward; the opposite for reverse.
455
:param start_revision_id: the revision_id to begin walking from.
456
If None, the branch tip is used.
457
:param stop_revision_id: the revision_id to terminate the walk
458
after. If None, the rest of history is included.
459
:param stop_rule: if stop_revision_id is not None, the precise rule
460
to use for termination:
462
* 'exclude' - leave the stop revision out of the result (default)
463
* 'include' - the stop revision is the last item in the result
464
* 'with-merges' - include the stop revision and all of its
465
merged revisions in the result
466
* 'with-merges-without-common-ancestry' - filter out revisions
467
that are in both ancestries
468
:param direction: either 'reverse' or 'forward':
470
* reverse means return the start_revision_id first, i.e.
471
start at the most recent revision and go backwards in history
472
* forward returns tuples in the opposite order to reverse.
473
Note in particular that forward does *not* do any intelligent
474
ordering w.r.t. depth as some clients of this API may like.
475
(If required, that ought to be done at higher layers.)
477
:return: an iterator over (revision_id, depth, revno, end_of_merge)
480
* revision_id: the unique id of the revision
481
* depth: How many levels of merging deep this node has been
483
* revno_sequence: This field provides a sequence of
484
revision numbers for all revisions. The format is:
485
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
486
branch that the revno is on. From left to right the REVNO numbers
487
are the sequence numbers within that branch of the revision.
488
* end_of_merge: When True the next node (earlier in history) is
489
part of a different merge.
491
# Note: depth and revno values are in the context of the branch so
492
# we need the full graph to get stable numbers, regardless of the
494
if self._merge_sorted_revisions_cache is None:
495
last_revision = self.last_revision()
496
known_graph = self.repository.get_known_graph_ancestry(
498
self._merge_sorted_revisions_cache = known_graph.merge_sort(
500
filtered = self._filter_merge_sorted_revisions(
501
self._merge_sorted_revisions_cache, start_revision_id,
502
stop_revision_id, stop_rule)
503
# Make sure we don't return revisions that are not part of the
504
# start_revision_id ancestry.
505
filtered = self._filter_start_non_ancestors(filtered)
506
if direction == 'reverse':
508
if direction == 'forward':
509
return reversed(list(filtered))
511
raise ValueError('invalid direction %r' % direction)
513
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
514
start_revision_id, stop_revision_id, stop_rule):
515
"""Iterate over an inclusive range of sorted revisions."""
516
rev_iter = iter(merge_sorted_revisions)
517
if start_revision_id is not None:
518
for node in rev_iter:
520
if rev_id != start_revision_id:
523
# The decision to include the start or not
524
# depends on the stop_rule if a stop is provided
525
# so pop this node back into the iterator
526
rev_iter = itertools.chain(iter([node]), rev_iter)
528
if stop_revision_id is None:
530
for node in rev_iter:
532
yield (rev_id, node.merge_depth, node.revno,
534
elif stop_rule == 'exclude':
535
for node in rev_iter:
537
if rev_id == stop_revision_id:
539
yield (rev_id, node.merge_depth, node.revno,
541
elif stop_rule == 'include':
542
for node in rev_iter:
544
yield (rev_id, node.merge_depth, node.revno,
546
if rev_id == stop_revision_id:
548
elif stop_rule == 'with-merges-without-common-ancestry':
549
# We want to exclude all revisions that are already part of the
550
# stop_revision_id ancestry.
551
graph = self.repository.get_graph()
552
ancestors = graph.find_unique_ancestors(start_revision_id,
554
for node in rev_iter:
556
if rev_id not in ancestors:
558
yield (rev_id, node.merge_depth, node.revno,
560
elif stop_rule == 'with-merges':
561
stop_rev = self.repository.get_revision(stop_revision_id)
562
if stop_rev.parent_ids:
563
left_parent = stop_rev.parent_ids[0]
565
left_parent = _mod_revision.NULL_REVISION
566
# left_parent is the actual revision we want to stop logging at,
567
# since we want to show the merged revisions after the stop_rev too
568
reached_stop_revision_id = False
569
revision_id_whitelist = []
570
for node in rev_iter:
572
if rev_id == left_parent:
573
# reached the left parent after the stop_revision
575
if (not reached_stop_revision_id or
576
rev_id in revision_id_whitelist):
577
yield (rev_id, node.merge_depth, node.revno,
579
if reached_stop_revision_id or rev_id == stop_revision_id:
580
# only do the merged revs of rev_id from now on
581
rev = self.repository.get_revision(rev_id)
583
reached_stop_revision_id = True
584
revision_id_whitelist.extend(rev.parent_ids)
586
raise ValueError('invalid stop_rule %r' % stop_rule)
588
def _filter_start_non_ancestors(self, rev_iter):
589
# If we started from a dotted revno, we want to consider it as a tip
590
# and don't want to yield revisions that are not part of its
591
# ancestry. Given the order guaranteed by the merge sort, we will see
592
# uninteresting descendants of the first parent of our tip before the
594
first = rev_iter.next()
595
(rev_id, merge_depth, revno, end_of_merge) = first
598
# We start at a mainline revision so by definition, all others
599
# revisions in rev_iter are ancestors
600
for node in rev_iter:
605
pmap = self.repository.get_parent_map([rev_id])
606
parents = pmap.get(rev_id, [])
608
whitelist.update(parents)
610
# If there is no parents, there is nothing of interest left
612
# FIXME: It's hard to test this scenario here as this code is never
613
# called in that case. -- vila 20100322
616
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
618
if rev_id in whitelist:
619
pmap = self.repository.get_parent_map([rev_id])
620
parents = pmap.get(rev_id, [])
621
whitelist.remove(rev_id)
622
whitelist.update(parents)
624
# We've reached the mainline, there is nothing left to
628
# A revision that is not part of the ancestry of our
631
yield (rev_id, merge_depth, revno, end_of_merge)
633
def leave_lock_in_place(self):
634
"""Tell this branch object not to release the physical lock when this
637
If lock_write doesn't return a token, then this method is not supported.
639
self.control_files.leave_in_place()
641
def dont_leave_lock_in_place(self):
642
"""Tell this branch object to release the physical lock when this
643
object is unlocked, even if it didn't originally acquire it.
645
If lock_write doesn't return a token, then this method is not supported.
647
self.control_files.dont_leave_in_place()
649
def bind(self, other):
650
"""Bind the local branch the other branch.
652
:param other: The branch to bind to
655
raise errors.UpgradeRequired(self.user_url)
657
def get_append_revisions_only(self):
658
"""Whether it is only possible to append revisions to the history.
660
if not self._format.supports_set_append_revisions_only():
662
return self.get_config(
663
).get_user_option_as_bool('append_revisions_only')
665
def set_append_revisions_only(self, enabled):
666
if not self._format.supports_set_append_revisions_only():
667
raise errors.UpgradeRequired(self.user_url)
672
self.get_config().set_user_option('append_revisions_only', value,
675
def set_reference_info(self, file_id, tree_path, branch_location):
676
"""Set the branch location to use for a tree reference."""
677
raise errors.UnsupportedOperation(self.set_reference_info, self)
679
def get_reference_info(self, file_id):
680
"""Get the tree_path and branch_location for a tree reference."""
681
raise errors.UnsupportedOperation(self.get_reference_info, self)
684
def fetch(self, from_branch, last_revision=None, limit=None):
685
"""Copy revisions from from_branch into this branch.
687
:param from_branch: Where to copy from.
688
:param last_revision: What revision to stop at (None for at the end
690
:param limit: Optional rough limit of revisions to fetch
693
return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
695
def get_bound_location(self):
696
"""Return the URL of the branch we are bound to.
698
Older format branches cannot bind, please be sure to use a metadir
703
def get_old_bound_location(self):
704
"""Return the URL of the branch we used to be bound to
706
raise errors.UpgradeRequired(self.user_url)
708
def get_commit_builder(self, parents, config=None, timestamp=None,
709
timezone=None, committer=None, revprops=None,
710
revision_id=None, lossy=False):
711
"""Obtain a CommitBuilder for this branch.
713
:param parents: Revision ids of the parents of the new revision.
714
:param config: Optional configuration to use.
715
:param timestamp: Optional timestamp recorded for commit.
716
:param timezone: Optional timezone for timestamp.
717
:param committer: Optional committer to set for commit.
718
:param revprops: Optional dictionary of revision properties.
719
:param revision_id: Optional revision id.
720
:param lossy: Whether to discard data that can not be natively
721
represented, when pushing to a foreign VCS
725
config = self.get_config()
727
return self.repository.get_commit_builder(self, parents, config,
728
timestamp, timezone, committer, revprops, revision_id,
731
def get_master_branch(self, possible_transports=None):
732
"""Return the branch we are bound to.
734
:return: Either a Branch, or None
738
@deprecated_method(deprecated_in((2, 5, 0)))
739
def get_revision_delta(self, revno):
740
"""Return the delta for one revision.
742
The delta is relative to its mainline predecessor, or the
743
empty tree for revision 1.
746
revid = self.get_rev_id(revno)
747
except errors.NoSuchRevision:
748
raise errors.InvalidRevisionNumber(revno)
749
return self.repository.get_revision_delta(revid)
751
def get_stacked_on_url(self):
752
"""Get the URL this branch is stacked against.
754
:raises NotStacked: If the branch is not stacked.
755
:raises UnstackableBranchFormat: If the branch does not support
758
raise NotImplementedError(self.get_stacked_on_url)
760
def print_file(self, file, revision_id):
435
761
"""Print `file` to stdout."""
438
tree = self.revision_tree(self.lookup_revision(revno))
439
# use inventory as it was in that revision
440
file_id = tree.inventory.path2id(file)
442
raise BzrError("%r is not present in revision %d" % (file, revno))
443
tree.print_file(file_id)
448
def remove(self, files, verbose=False):
449
"""Mark nominated files for removal from the inventory.
451
This does not remove their text. This does not run on
453
TODO: Refuse to remove modified files unless --force is given?
455
TODO: Do something useful with directories.
457
TODO: Should this remove the text or not? Tough call; not
458
removing may be useful and the user can just use use rm, and
459
is the opposite of add. Removing it is consistent with most
460
other tools. Maybe an option.
462
## TODO: Normalize names
463
## TODO: Remove nested loops; better scalability
464
if isinstance(files, types.StringTypes):
470
tree = self.working_tree()
473
# do this before any modifications
477
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
478
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
480
# having remove it, it must be either ignored or unknown
481
if tree.is_ignored(f):
485
show_status(new_status, inv[fid].kind, quotefn(f))
488
self._write_inventory(inv)
493
# FIXME: this doesn't need to be a branch method
494
def set_inventory(self, new_inventory_list):
496
for path, file_id, parent, kind in new_inventory_list:
497
name = os.path.basename(path)
500
inv.add(InventoryEntry(file_id, name, kind, parent))
501
self._write_inventory(inv)
505
"""Return all unknown files.
507
These are files in the working directory that are not versioned or
508
control files or ignored.
510
>>> b = ScratchBranch(files=['foo', 'foo~'])
511
>>> list(b.unknowns())
514
>>> list(b.unknowns())
517
>>> list(b.unknowns())
520
return self.working_tree().unknowns()
523
def append_revision(self, revision_id):
524
mutter("add {%s} to revision-history" % revision_id)
525
rev_history = self.revision_history()
527
tmprhname = self.controlfilename('revision-history.tmp')
528
rhname = self.controlfilename('revision-history')
530
f = file(tmprhname, 'wt')
531
rev_history.append(revision_id)
532
f.write('\n'.join(rev_history))
536
if sys.platform == 'win32':
538
os.rename(tmprhname, rhname)
542
def get_revision(self, revision_id):
543
"""Return the Revision object for a named revision"""
544
if not revision_id or not isinstance(revision_id, basestring):
545
raise ValueError('invalid revision-id: %r' % revision_id)
546
r = Revision.read_xml(self.revision_store[revision_id])
547
assert r.revision_id == revision_id
550
def get_revision_sha1(self, revision_id):
551
"""Hash the stored value of a revision, and return it."""
552
# In the future, revision entries will be signed. At that
553
# point, it is probably best *not* to include the signature
554
# in the revision hash. Because that lets you re-sign
555
# the revision, (add signatures/remove signatures) and still
556
# have all hash pointers stay consistent.
557
# But for now, just hash the contents.
558
return sha_file(self.revision_store[revision_id])
561
def get_inventory(self, inventory_id):
562
"""Get Inventory object by hash.
564
TODO: Perhaps for this and similar methods, take a revision
565
parameter which can be either an integer revno or a
567
i = Inventory.read_xml(self.inventory_store[inventory_id])
570
def get_inventory_sha1(self, inventory_id):
571
"""Return the sha1 hash of the inventory entry
573
return sha_file(self.inventory_store[inventory_id])
576
def get_revision_inventory(self, revision_id):
577
"""Return inventory of a past revision."""
578
if revision_id == None:
581
return self.get_inventory(self.get_revision(revision_id).inventory_id)
762
raise NotImplementedError(self.print_file)
764
@deprecated_method(deprecated_in((2, 4, 0)))
765
def set_revision_history(self, rev_history):
766
"""See Branch.set_revision_history."""
767
self._set_revision_history(rev_history)
770
def _set_revision_history(self, rev_history):
771
if len(rev_history) == 0:
772
revid = _mod_revision.NULL_REVISION
774
revid = rev_history[-1]
775
if rev_history != self._lefthand_history(revid):
776
raise errors.NotLefthandHistory(rev_history)
777
self.set_last_revision_info(len(rev_history), revid)
778
self._cache_revision_history(rev_history)
779
for hook in Branch.hooks['set_rh']:
780
hook(self, rev_history)
783
def set_last_revision_info(self, revno, revision_id):
784
"""Set the last revision of this branch.
786
The caller is responsible for checking that the revno is correct
787
for this revision id.
789
It may be possible to set the branch last revision to an id not
790
present in the repository. However, branches can also be
791
configured to check constraints on history, in which case this may not
794
raise NotImplementedError(self.set_last_revision_info)
797
def generate_revision_history(self, revision_id, last_rev=None,
799
"""See Branch.generate_revision_history"""
800
graph = self.repository.get_graph()
801
(last_revno, last_revid) = self.last_revision_info()
802
known_revision_ids = [
803
(last_revid, last_revno),
804
(_mod_revision.NULL_REVISION, 0),
806
if last_rev is not None:
807
if not graph.is_ancestor(last_rev, revision_id):
808
# our previous tip is not merged into stop_revision
809
raise errors.DivergedBranches(self, other_branch)
810
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
811
self.set_last_revision_info(revno, revision_id)
814
def set_parent(self, url):
815
"""See Branch.set_parent."""
816
# TODO: Maybe delete old location files?
817
# URLs should never be unicode, even on the local fs,
818
# FIXUP this and get_parent in a future branch format bump:
819
# read and rewrite the file. RBC 20060125
821
if isinstance(url, unicode):
823
url = url.encode('ascii')
824
except UnicodeEncodeError:
825
raise errors.InvalidURL(url,
826
"Urls must be 7-bit ascii, "
827
"use bzrlib.urlutils.escape")
828
url = urlutils.relative_url(self.base, url)
829
self._set_parent_location(url)
832
def set_stacked_on_url(self, url):
833
"""Set the URL this branch is stacked against.
835
:raises UnstackableBranchFormat: If the branch does not support
837
:raises UnstackableRepositoryFormat: If the repository does not support
840
if not self._format.supports_stacking():
841
raise errors.UnstackableBranchFormat(self._format, self.user_url)
842
# XXX: Changing from one fallback repository to another does not check
843
# that all the data you need is present in the new fallback.
844
# Possibly it should.
845
self._check_stackable_repo()
848
old_url = self.get_stacked_on_url()
849
except (errors.NotStacked, errors.UnstackableBranchFormat,
850
errors.UnstackableRepositoryFormat):
854
self._activate_fallback_location(url)
855
# write this out after the repository is stacked to avoid setting a
856
# stacked config that doesn't work.
857
self._set_config_location('stacked_on_location', url)
860
"""Change a branch to be unstacked, copying data as needed.
862
Don't call this directly, use set_stacked_on_url(None).
864
pb = ui.ui_factory.nested_progress_bar()
866
pb.update(gettext("Unstacking"))
867
# The basic approach here is to fetch the tip of the branch,
868
# including all available ghosts, from the existing stacked
869
# repository into a new repository object without the fallbacks.
871
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
872
# correct for CHKMap repostiories
873
old_repository = self.repository
874
if len(old_repository._fallback_repositories) != 1:
875
raise AssertionError("can't cope with fallback repositories "
876
"of %r (fallbacks: %r)" % (old_repository,
877
old_repository._fallback_repositories))
878
# Open the new repository object.
879
# Repositories don't offer an interface to remove fallback
880
# repositories today; take the conceptually simpler option and just
881
# reopen it. We reopen it starting from the URL so that we
882
# get a separate connection for RemoteRepositories and can
883
# stream from one of them to the other. This does mean doing
884
# separate SSH connection setup, but unstacking is not a
885
# common operation so it's tolerable.
886
new_bzrdir = controldir.ControlDir.open(
887
self.bzrdir.root_transport.base)
888
new_repository = new_bzrdir.find_repository()
889
if new_repository._fallback_repositories:
890
raise AssertionError("didn't expect %r to have "
891
"fallback_repositories"
892
% (self.repository,))
893
# Replace self.repository with the new repository.
894
# Do our best to transfer the lock state (i.e. lock-tokens and
895
# lock count) of self.repository to the new repository.
896
lock_token = old_repository.lock_write().repository_token
897
self.repository = new_repository
898
if isinstance(self, remote.RemoteBranch):
899
# Remote branches can have a second reference to the old
900
# repository that need to be replaced.
901
if self._real_branch is not None:
902
self._real_branch.repository = new_repository
903
self.repository.lock_write(token=lock_token)
904
if lock_token is not None:
905
old_repository.leave_lock_in_place()
906
old_repository.unlock()
907
if lock_token is not None:
908
# XXX: self.repository.leave_lock_in_place() before this
909
# function will not be preserved. Fortunately that doesn't
910
# affect the current default format (2a), and would be a
911
# corner-case anyway.
912
# - Andrew Bennetts, 2010/06/30
913
self.repository.dont_leave_lock_in_place()
917
old_repository.unlock()
918
except errors.LockNotHeld:
921
if old_lock_count == 0:
922
raise AssertionError(
923
'old_repository should have been locked at least once.')
924
for i in range(old_lock_count-1):
925
self.repository.lock_write()
926
# Fetch from the old repository into the new.
927
old_repository.lock_read()
929
# XXX: If you unstack a branch while it has a working tree
930
# with a pending merge, the pending-merged revisions will no
931
# longer be present. You can (probably) revert and remerge.
933
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
934
except errors.TagsNotSupported:
935
tags_to_fetch = set()
936
fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
937
old_repository, required_ids=[self.last_revision()],
938
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
939
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
941
old_repository.unlock()
945
def _set_tags_bytes(self, bytes):
946
"""Mirror method for _get_tags_bytes.
948
:seealso: Branch._get_tags_bytes.
950
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
951
op.add_cleanup(self.lock_write().unlock)
952
return op.run_simple(bytes)
954
def _set_tags_bytes_locked(self, bytes):
955
self._tags_bytes = bytes
956
return self._transport.put_bytes('tags', bytes)
958
def _cache_revision_history(self, rev_history):
959
"""Set the cached revision history to rev_history.
961
The revision_history method will use this cache to avoid regenerating
962
the revision history.
964
This API is semi-public; it only for use by subclasses, all other code
965
should consider it to be private.
967
self._revision_history_cache = rev_history
969
def _cache_revision_id_to_revno(self, revision_id_to_revno):
970
"""Set the cached revision_id => revno map to revision_id_to_revno.
972
This API is semi-public; it only for use by subclasses, all other code
973
should consider it to be private.
975
self._revision_id_to_revno_cache = revision_id_to_revno
977
def _clear_cached_state(self):
978
"""Clear any cached data on this branch, e.g. cached revision history.
980
This means the next call to revision_history will need to call
981
_gen_revision_history.
983
This API is semi-public; it only for use by subclasses, all other code
984
should consider it to be private.
986
self._revision_history_cache = None
987
self._revision_id_to_revno_cache = None
988
self._last_revision_info_cache = None
989
self._master_branch_cache = None
990
self._merge_sorted_revisions_cache = None
991
self._partial_revision_history_cache = []
992
self._partial_revision_id_to_revno_cache = {}
993
self._tags_bytes = None
995
def _gen_revision_history(self):
996
"""Return sequence of revision hashes on to this branch.
998
Unlike revision_history, this method always regenerates or rereads the
999
revision history, i.e. it does not cache the result, so repeated calls
1002
Concrete subclasses should override this instead of revision_history so
1003
that subclasses do not need to deal with caching logic.
1005
This API is semi-public; it only for use by subclasses, all other code
1006
should consider it to be private.
1008
raise NotImplementedError(self._gen_revision_history)
1010
@deprecated_method(deprecated_in((2, 5, 0)))
584
1012
def revision_history(self):
585
"""Return sequence of revision hashes on to this branch.
587
>>> ScratchBranch().revision_history()
592
return [l.rstrip('\r\n') for l in
593
self.controlfile('revision-history', 'r').readlines()]
598
def common_ancestor(self, other, self_revno=None, other_revno=None):
601
>>> sb = ScratchBranch(files=['foo', 'foo~'])
602
>>> sb.common_ancestor(sb) == (None, None)
604
>>> commit.commit(sb, "Committing first revision", verbose=False)
605
>>> sb.common_ancestor(sb)[0]
607
>>> clone = sb.clone()
608
>>> commit.commit(sb, "Committing second revision", verbose=False)
609
>>> sb.common_ancestor(sb)[0]
611
>>> sb.common_ancestor(clone)[0]
613
>>> commit.commit(clone, "Committing divergent second revision",
615
>>> sb.common_ancestor(clone)[0]
617
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
619
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
621
>>> clone2 = sb.clone()
622
>>> sb.common_ancestor(clone2)[0]
624
>>> sb.common_ancestor(clone2, self_revno=1)[0]
626
>>> sb.common_ancestor(clone2, other_revno=1)[0]
629
my_history = self.revision_history()
630
other_history = other.revision_history()
631
if self_revno is None:
632
self_revno = len(my_history)
633
if other_revno is None:
634
other_revno = len(other_history)
635
indices = range(min((self_revno, other_revno)))
638
if my_history[r] == other_history[r]:
639
return r+1, my_history[r]
642
def enum_history(self, direction):
643
"""Return (revno, revision_id) for history of branch.
646
'forward' is from earliest to latest
647
'reverse' is from latest to earliest
649
rh = self.revision_history()
650
if direction == 'forward':
655
elif direction == 'reverse':
1013
"""Return sequence of revision ids on this branch.
1015
This method will cache the revision history for as long as it is safe to
1018
return self._revision_history()
1020
def _revision_history(self):
1021
if 'evil' in debug.debug_flags:
1022
mutter_callsite(3, "revision_history scales with history.")
1023
if self._revision_history_cache is not None:
1024
history = self._revision_history_cache
661
raise ValueError('invalid history direction', direction)
1026
history = self._gen_revision_history()
1027
self._cache_revision_history(history)
1028
return list(history)
664
1030
def revno(self):
665
1031
"""Return current revision number for this branch.
667
1033
That is equivalent to the number of revisions committed to
670
return len(self.revision_history())
673
def last_patch(self):
674
"""Return last patch hash, or None if no history.
676
ph = self.revision_history()
683
def missing_revisions(self, other, stop_revision=None):
685
If self and other have not diverged, return a list of the revisions
686
present in other, but missing from self.
688
>>> from bzrlib.commit import commit
689
>>> bzrlib.trace.silent = True
690
>>> br1 = ScratchBranch()
691
>>> br2 = ScratchBranch()
692
>>> br1.missing_revisions(br2)
694
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
695
>>> br1.missing_revisions(br2)
697
>>> br2.missing_revisions(br1)
699
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
700
>>> br1.missing_revisions(br2)
702
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
703
>>> br1.missing_revisions(br2)
705
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
706
>>> br1.missing_revisions(br2)
707
Traceback (most recent call last):
708
DivergedBranches: These branches have diverged.
710
self_history = self.revision_history()
711
self_len = len(self_history)
712
other_history = other.revision_history()
713
other_len = len(other_history)
714
common_index = min(self_len, other_len) -1
715
if common_index >= 0 and \
716
self_history[common_index] != other_history[common_index]:
717
raise DivergedBranches(self, other)
1036
return self.last_revision_info()[0]
1039
"""Older format branches cannot bind or unbind."""
1040
raise errors.UpgradeRequired(self.user_url)
1042
def last_revision(self):
1043
"""Return last revision id, or NULL_REVISION."""
1044
return self.last_revision_info()[1]
1047
def last_revision_info(self):
1048
"""Return information about the last revision.
1050
:return: A tuple (revno, revision_id).
1052
if self._last_revision_info_cache is None:
1053
self._last_revision_info_cache = self._read_last_revision_info()
1054
return self._last_revision_info_cache
1056
def _read_last_revision_info(self):
1057
raise NotImplementedError(self._read_last_revision_info)
1059
@deprecated_method(deprecated_in((2, 4, 0)))
1060
def import_last_revision_info(self, source_repo, revno, revid):
1061
"""Set the last revision info, importing from another repo if necessary.
1063
:param source_repo: Source repository to optionally fetch from
1064
:param revno: Revision number of the new tip
1065
:param revid: Revision id of the new tip
1067
if not self.repository.has_same_location(source_repo):
1068
self.repository.fetch(source_repo, revision_id=revid)
1069
self.set_last_revision_info(revno, revid)
1071
def import_last_revision_info_and_tags(self, source, revno, revid,
1073
"""Set the last revision info, importing from another repo if necessary.
1075
This is used by the bound branch code to upload a revision to
1076
the master branch first before updating the tip of the local branch.
1077
Revisions referenced by source's tags are also transferred.
1079
:param source: Source branch to optionally fetch from
1080
:param revno: Revision number of the new tip
1081
:param revid: Revision id of the new tip
1082
:param lossy: Whether to discard metadata that can not be
1083
natively represented
1084
:return: Tuple with the new revision number and revision id
1085
(should only be different from the arguments when lossy=True)
1087
if not self.repository.has_same_location(source.repository):
1088
self.fetch(source, revid)
1089
self.set_last_revision_info(revno, revid)
1090
return (revno, revid)
1092
def revision_id_to_revno(self, revision_id):
1093
"""Given a revision id, return its revno"""
1094
if _mod_revision.is_null(revision_id):
1096
history = self._revision_history()
1098
return history.index(revision_id) + 1
1100
raise errors.NoSuchRevision(self, revision_id)
1103
def get_rev_id(self, revno, history=None):
1104
"""Find the revision id of the specified revno."""
1106
return _mod_revision.NULL_REVISION
1107
last_revno, last_revid = self.last_revision_info()
1108
if revno == last_revno:
1110
if revno <= 0 or revno > last_revno:
1111
raise errors.NoSuchRevision(self, revno)
1112
distance_from_last = last_revno - revno
1113
if len(self._partial_revision_history_cache) <= distance_from_last:
1114
self._extend_partial_history(distance_from_last)
1115
return self._partial_revision_history_cache[distance_from_last]
1117
def pull(self, source, overwrite=False, stop_revision=None,
1118
possible_transports=None, *args, **kwargs):
1119
"""Mirror source into this branch.
1121
This branch is considered to be 'local', having low latency.
1123
:returns: PullResult instance
1125
return InterBranch.get(source, self).pull(overwrite=overwrite,
1126
stop_revision=stop_revision,
1127
possible_transports=possible_transports, *args, **kwargs)
1129
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1131
"""Mirror this branch into target.
1133
This branch is considered to be 'local', having low latency.
1135
return InterBranch.get(self, target).push(overwrite, stop_revision,
1136
lossy, *args, **kwargs)
1138
def basis_tree(self):
1139
"""Return `Tree` object for last revision."""
1140
return self.repository.revision_tree(self.last_revision())
1142
def get_parent(self):
1143
"""Return the parent location of the branch.
1145
This is the default location for pull/missing. The usual
1146
pattern is that the user can override it by specifying a
1149
parent = self._get_parent_location()
1152
# This is an old-format absolute path to a local branch
1153
# turn it into a url
1154
if parent.startswith('/'):
1155
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1157
return urlutils.join(self.base[:-1], parent)
1158
except errors.InvalidURLJoin, e:
1159
raise errors.InaccessibleParent(parent, self.user_url)
1161
def _get_parent_location(self):
1162
raise NotImplementedError(self._get_parent_location)
1164
def _set_config_location(self, name, url, config=None,
1165
make_relative=False):
1167
config = self.get_config()
1171
url = urlutils.relative_url(self.base, url)
1172
config.set_user_option(name, url, warn_masked=True)
1174
def _get_config_location(self, name, config=None):
1176
config = self.get_config()
1177
location = config.get_user_option(name)
1182
def get_child_submit_format(self):
1183
"""Return the preferred format of submissions to this branch."""
1184
return self.get_config().get_user_option("child_submit_format")
1186
def get_submit_branch(self):
1187
"""Return the submit location of the branch.
1189
This is the default location for bundle. The usual
1190
pattern is that the user can override it by specifying a
1193
return self.get_config().get_user_option('submit_branch')
1195
def set_submit_branch(self, location):
1196
"""Return the submit location of the branch.
1198
This is the default location for bundle. The usual
1199
pattern is that the user can override it by specifying a
1202
self.get_config().set_user_option('submit_branch', location,
1205
def get_public_branch(self):
1206
"""Return the public location of the branch.
1208
This is used by merge directives.
1210
return self._get_config_location('public_branch')
1212
def set_public_branch(self, location):
1213
"""Return the submit location of the branch.
1215
This is the default location for bundle. The usual
1216
pattern is that the user can override it by specifying a
1219
self._set_config_location('public_branch', location)
1221
def get_push_location(self):
1222
"""Return the None or the location to push this branch to."""
1223
push_loc = self.get_config().get_user_option('push_location')
1226
def set_push_location(self, location):
1227
"""Set a new push location for this branch."""
1228
raise NotImplementedError(self.set_push_location)
1230
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1231
"""Run the post_change_branch_tip hooks."""
1232
hooks = Branch.hooks['post_change_branch_tip']
1235
new_revno, new_revid = self.last_revision_info()
1236
params = ChangeBranchTipParams(
1237
self, old_revno, new_revno, old_revid, new_revid)
1241
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1242
"""Run the pre_change_branch_tip hooks."""
1243
hooks = Branch.hooks['pre_change_branch_tip']
1246
old_revno, old_revid = self.last_revision_info()
1247
params = ChangeBranchTipParams(
1248
self, old_revno, new_revno, old_revid, new_revid)
1254
"""Synchronise this branch with the master branch if any.
1256
:return: None or the last_revision pivoted out during the update.
1260
def check_revno(self, revno):
1262
Check whether a revno corresponds to any revision.
1263
Zero (the NULL revision) is considered valid.
1266
self.check_real_revno(revno)
1268
def check_real_revno(self, revno):
1270
Check whether a revno corresponds to a real revision.
1271
Zero (the NULL revision) is considered invalid
1273
if revno < 1 or revno > self.revno():
1274
raise errors.InvalidRevisionNumber(revno)
1277
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1278
"""Clone this branch into to_bzrdir preserving all semantic values.
1280
Most API users will want 'create_clone_on_transport', which creates a
1281
new bzrdir and branch on the fly.
1283
revision_id: if not None, the revision history in the new branch will
1284
be truncated to end with revision_id.
1286
result = to_bzrdir.create_branch()
1289
if repository_policy is not None:
1290
repository_policy.configure_branch(result)
1291
self.copy_content_into(result, revision_id=revision_id)
1297
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1299
"""Create a new line of development from the branch, into to_bzrdir.
1301
to_bzrdir controls the branch format.
1303
revision_id: if not None, the revision history in the new branch will
1304
be truncated to end with revision_id.
1306
if (repository_policy is not None and
1307
repository_policy.requires_stacking()):
1308
to_bzrdir._format.require_stacking(_skip_repo=True)
1309
result = to_bzrdir.create_branch(repository=repository)
1312
if repository_policy is not None:
1313
repository_policy.configure_branch(result)
1314
self.copy_content_into(result, revision_id=revision_id)
1315
master_url = self.get_bound_location()
1316
if master_url is None:
1317
result.set_parent(self.bzrdir.root_transport.base)
1319
result.set_parent(master_url)
1324
def _synchronize_history(self, destination, revision_id):
1325
"""Synchronize last revision and revision history between branches.
1327
This version is most efficient when the destination is also a
1328
BzrBranch6, but works for BzrBranch5, as long as the destination's
1329
repository contains all the lefthand ancestors of the intended
1330
last_revision. If not, set_last_revision_info will fail.
1332
:param destination: The branch to copy the history into
1333
:param revision_id: The revision-id to truncate history at. May
1334
be None to copy complete history.
1336
source_revno, source_revision_id = self.last_revision_info()
1337
if revision_id is None:
1338
revno, revision_id = source_revno, source_revision_id
1340
graph = self.repository.get_graph()
1342
revno = graph.find_distance_to_null(revision_id,
1343
[(source_revision_id, source_revno)])
1344
except errors.GhostRevisionsHaveNoRevno:
1345
# Default to 1, if we can't find anything else
1347
destination.set_last_revision_info(revno, revision_id)
1349
def copy_content_into(self, destination, revision_id=None):
1350
"""Copy the content of self into destination.
1352
revision_id: if not None, the revision history in the new branch will
1353
be truncated to end with revision_id.
1355
return InterBranch.get(self, destination).copy_content_into(
1356
revision_id=revision_id)
1358
def update_references(self, target):
1359
if not getattr(self._format, 'supports_reference_locations', False):
1361
reference_dict = self._get_all_reference_info()
1362
if len(reference_dict) == 0:
1364
old_base = self.base
1365
new_base = target.base
1366
target_reference_dict = target._get_all_reference_info()
1367
for file_id, (tree_path, branch_location) in (
1368
reference_dict.items()):
1369
branch_location = urlutils.rebase_url(branch_location,
1371
target_reference_dict.setdefault(
1372
file_id, (tree_path, branch_location))
1373
target._set_all_reference_info(target_reference_dict)
1376
def check(self, refs):
1377
"""Check consistency of the branch.
1379
In particular this checks that revisions given in the revision-history
1380
do actually match up in the revision graph, and that they're all
1381
present in the repository.
1383
Callers will typically also want to check the repository.
1385
:param refs: Calculated refs for this branch as specified by
1386
branch._get_check_refs()
1387
:return: A BranchCheckResult.
1389
result = BranchCheckResult(self)
1390
last_revno, last_revision_id = self.last_revision_info()
1391
actual_revno = refs[('lefthand-distance', last_revision_id)]
1392
if actual_revno != last_revno:
1393
result.errors.append(errors.BzrCheckError(
1394
'revno does not match len(mainline) %s != %s' % (
1395
last_revno, actual_revno)))
1396
# TODO: We should probably also check that self.revision_history
1397
# matches the repository for older branch formats.
1398
# If looking for the code that cross-checks repository parents against
1399
# the Graph.iter_lefthand_ancestry output, that is now a repository
1403
def _get_checkout_format(self, lightweight=False):
1404
"""Return the most suitable metadir for a checkout of this branch.
1405
Weaves are used if this branch's repository uses weaves.
1407
format = self.repository.bzrdir.checkout_metadir()
1408
format.set_branch_format(self._format)
1411
def create_clone_on_transport(self, to_transport, revision_id=None,
1412
stacked_on=None, create_prefix=False, use_existing_dir=False,
1414
"""Create a clone of this branch and its bzrdir.
1416
:param to_transport: The transport to clone onto.
1417
:param revision_id: The revision id to use as tip in the new branch.
1418
If None the tip is obtained from this branch.
1419
:param stacked_on: An optional URL to stack the clone on.
1420
:param create_prefix: Create any missing directories leading up to
1422
:param use_existing_dir: Use an existing directory if one exists.
1424
# XXX: Fix the bzrdir API to allow getting the branch back from the
1425
# clone call. Or something. 20090224 RBC/spiv.
1426
# XXX: Should this perhaps clone colocated branches as well,
1427
# rather than just the default branch? 20100319 JRV
1428
if revision_id is None:
1429
revision_id = self.last_revision()
1430
dir_to = self.bzrdir.clone_on_transport(to_transport,
1431
revision_id=revision_id, stacked_on=stacked_on,
1432
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1434
return dir_to.open_branch()
1436
def create_checkout(self, to_location, revision_id=None,
1437
lightweight=False, accelerator_tree=None,
1439
"""Create a checkout of a branch.
1441
:param to_location: The url to produce the checkout at
1442
:param revision_id: The revision to check out
1443
:param lightweight: If True, produce a lightweight checkout, otherwise,
1444
produce a bound branch (heavyweight checkout)
1445
:param accelerator_tree: A tree which can be used for retrieving file
1446
contents more quickly than the revision tree, i.e. a workingtree.
1447
The revision tree will be used for cases where accelerator_tree's
1448
content is different.
1449
:param hardlink: If true, hard-link files from accelerator_tree,
1451
:return: The tree of the created checkout
1453
t = transport.get_transport(to_location)
1455
format = self._get_checkout_format(lightweight=lightweight)
1457
checkout = format.initialize_on_transport(t)
1458
from_branch = BranchReferenceFormat().initialize(checkout,
1461
checkout_branch = controldir.ControlDir.create_branch_convenience(
1462
to_location, force_new_tree=False, format=format)
1463
checkout = checkout_branch.bzrdir
1464
checkout_branch.bind(self)
1465
# pull up to the specified revision_id to set the initial
1466
# branch tip correctly, and seed it with history.
1467
checkout_branch.pull(self, stop_revision=revision_id)
1469
tree = checkout.create_workingtree(revision_id,
1470
from_branch=from_branch,
1471
accelerator_tree=accelerator_tree,
1473
basis_tree = tree.basis_tree()
1474
basis_tree.lock_read()
1476
for path, file_id in basis_tree.iter_references():
1477
reference_parent = self.reference_parent(file_id, path)
1478
reference_parent.create_checkout(tree.abspath(path),
1479
basis_tree.get_reference_revision(file_id, path),
1486
def reconcile(self, thorough=True):
1487
"""Make sure the data stored in this branch is consistent."""
1488
from bzrlib.reconcile import BranchReconciler
1489
reconciler = BranchReconciler(self, thorough=thorough)
1490
reconciler.reconcile()
1493
def reference_parent(self, file_id, path, possible_transports=None):
1494
"""Return the parent branch for a tree-reference file_id
1496
:param file_id: The file_id of the tree reference
1497
:param path: The path of the file_id in the tree
1498
:return: A branch associated with the file_id
1500
# FIXME should provide multiple branches, based on config
1501
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1502
possible_transports=possible_transports)
1504
def supports_tags(self):
1505
return self._format.supports_tags()
1507
def automatic_tag_name(self, revision_id):
1508
"""Try to automatically find the tag name for a revision.
1510
:param revision_id: Revision id of the revision.
1511
:return: A tag name or None if no tag name could be determined.
1513
for hook in Branch.hooks['automatic_tag_name']:
1514
ret = hook(self, revision_id)
1519
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1521
"""Ensure that revision_b is a descendant of revision_a.
1523
This is a helper function for update_revisions.
1525
:raises: DivergedBranches if revision_b has diverged from revision_a.
1526
:returns: True if revision_b is a descendant of revision_a.
1528
relation = self._revision_relations(revision_a, revision_b, graph)
1529
if relation == 'b_descends_from_a':
1531
elif relation == 'diverged':
1532
raise errors.DivergedBranches(self, other_branch)
1533
elif relation == 'a_descends_from_b':
1536
raise AssertionError("invalid relation: %r" % (relation,))
1538
def _revision_relations(self, revision_a, revision_b, graph):
1539
"""Determine the relationship between two revisions.
1541
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1543
heads = graph.heads([revision_a, revision_b])
1544
if heads == set([revision_b]):
1545
return 'b_descends_from_a'
1546
elif heads == set([revision_a, revision_b]):
1547
# These branches have diverged
1549
elif heads == set([revision_a]):
1550
return 'a_descends_from_b'
1552
raise AssertionError("invalid heads: %r" % (heads,))
1554
def heads_to_fetch(self):
1555
"""Return the heads that must and that should be fetched to copy this
1556
branch into another repo.
1558
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1559
set of heads that must be fetched. if_present_fetch is a set of
1560
heads that must be fetched if present, but no error is necessary if
1561
they are not present.
1563
# For bzr native formats must_fetch is just the tip, and if_present_fetch
1565
must_fetch = set([self.last_revision()])
1566
if_present_fetch = set()
1567
c = self.get_config()
1568
include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1572
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1573
except errors.TagsNotSupported:
1575
must_fetch.discard(_mod_revision.NULL_REVISION)
1576
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1577
return must_fetch, if_present_fetch
1580
class BranchFormat(controldir.ControlComponentFormat):
1581
"""An encapsulation of the initialization and open routines for a format.
1583
Formats provide three things:
1584
* An initialization routine,
1588
Formats are placed in an dict by their format string for reference
1589
during branch opening. It's not required that these be instances, they
1590
can be classes themselves with class methods - it simply depends on
1591
whether state is needed for a given format or not.
1593
Once a format is deprecated, just deprecate the initialize and open
1594
methods on the format class. Do not deprecate the object, as the
1595
object will be created every time regardless.
1598
def __eq__(self, other):
1599
return self.__class__ is other.__class__
1601
def __ne__(self, other):
1602
return not (self == other)
1605
def find_format(klass, controldir, name=None):
1606
"""Return the format for the branch object in controldir."""
1608
transport = controldir.get_branch_transport(None, name=name)
1609
format_string = transport.get_bytes("format")
1610
return format_registry.get(format_string)
1611
except errors.NoSuchFile:
1612
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1614
raise errors.UnknownFormatError(format=format_string, kind='branch')
1617
@deprecated_method(deprecated_in((2, 4, 0)))
1618
def get_default_format(klass):
1619
"""Return the current default format."""
1620
return format_registry.get_default()
1623
@deprecated_method(deprecated_in((2, 4, 0)))
1624
def get_formats(klass):
1625
"""Get all the known formats.
1627
Warning: This triggers a load of all lazy registered formats: do not
1628
use except when that is desireed.
1630
return format_registry._get_all()
1632
def get_reference(self, controldir, name=None):
1633
"""Get the target reference of the branch in controldir.
1635
format probing must have been completed before calling
1636
this method - it is assumed that the format of the branch
1637
in controldir is correct.
1639
:param controldir: The controldir to get the branch data from.
1640
:param name: Name of the colocated branch to fetch
1641
:return: None if the branch is not a reference branch.
1646
def set_reference(self, controldir, name, to_branch):
1647
"""Set the target reference of the branch in controldir.
1649
format probing must have been completed before calling
1650
this method - it is assumed that the format of the branch
1651
in controldir is correct.
1653
:param controldir: The controldir to set the branch reference for.
1654
:param name: Name of colocated branch to set, None for default
1655
:param to_branch: branch that the checkout is to reference
1657
raise NotImplementedError(self.set_reference)
1659
def get_format_string(self):
1660
"""Return the ASCII format string that identifies this format."""
1661
raise NotImplementedError(self.get_format_string)
1663
def get_format_description(self):
1664
"""Return the short format description for this format."""
1665
raise NotImplementedError(self.get_format_description)
1667
def _run_post_branch_init_hooks(self, controldir, name, branch):
1668
hooks = Branch.hooks['post_branch_init']
1671
params = BranchInitHookParams(self, controldir, name, branch)
1675
def initialize(self, controldir, name=None, repository=None,
1676
append_revisions_only=None):
1677
"""Create a branch of this format in controldir.
1679
:param name: Name of the colocated branch to create.
1681
raise NotImplementedError(self.initialize)
1683
def is_supported(self):
1684
"""Is this format supported?
1686
Supported formats can be initialized and opened.
1687
Unsupported formats may not support initialization or committing or
1688
some other features depending on the reason for not being supported.
1692
def make_tags(self, branch):
1693
"""Create a tags object for branch.
1695
This method is on BranchFormat, because BranchFormats are reflected
1696
over the wire via network_name(), whereas full Branch instances require
1697
multiple VFS method calls to operate at all.
1699
The default implementation returns a disabled-tags instance.
1701
Note that it is normal for branch to be a RemoteBranch when using tags
1704
return _mod_tag.DisabledTags(branch)
1706
def network_name(self):
1707
"""A simple byte string uniquely identifying this format for RPC calls.
1709
MetaDir branch formats use their disk format string to identify the
1710
repository over the wire. All in one formats such as bzr < 0.8, and
1711
foreign formats like svn/git and hg should use some marker which is
1712
unique and immutable.
1714
raise NotImplementedError(self.network_name)
1716
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1717
found_repository=None):
1718
"""Return the branch object for controldir.
1720
:param controldir: A ControlDir that contains a branch.
1721
:param name: Name of colocated branch to open
1722
:param _found: a private parameter, do not use it. It is used to
1723
indicate if format probing has already be done.
1724
:param ignore_fallbacks: when set, no fallback branches will be opened
1725
(if there are any). Default is to open fallbacks.
1727
raise NotImplementedError(self.open)
1730
@deprecated_method(deprecated_in((2, 4, 0)))
1731
def register_format(klass, format):
1732
"""Register a metadir format.
1734
See MetaDirBranchFormatFactory for the ability to register a format
1735
without loading the code the format needs until it is actually used.
1737
format_registry.register(format)
1740
@deprecated_method(deprecated_in((2, 4, 0)))
1741
def set_default_format(klass, format):
1742
format_registry.set_default(format)
1744
def supports_set_append_revisions_only(self):
1745
"""True if this format supports set_append_revisions_only."""
1748
def supports_stacking(self):
1749
"""True if this format records a stacked-on branch."""
1752
def supports_leaving_lock(self):
1753
"""True if this format supports leaving locks in place."""
1754
return False # by default
1757
@deprecated_method(deprecated_in((2, 4, 0)))
1758
def unregister_format(klass, format):
1759
format_registry.remove(format)
1762
return self.get_format_description().rstrip()
1764
def supports_tags(self):
1765
"""True if this format supports tags stored in the branch"""
1766
return False # by default
1768
def tags_are_versioned(self):
1769
"""Whether the tag container for this branch versions tags."""
1772
def supports_tags_referencing_ghosts(self):
1773
"""True if tags can reference ghost revisions."""
1777
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1778
"""A factory for a BranchFormat object, permitting simple lazy registration.
1780
While none of the built in BranchFormats are lazy registered yet,
1781
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1782
use it, and the bzr-loom plugin uses it as well (see
1783
bzrlib.plugins.loom.formats).
1786
def __init__(self, format_string, module_name, member_name):
1787
"""Create a MetaDirBranchFormatFactory.
1789
:param format_string: The format string the format has.
1790
:param module_name: Module to load the format class from.
1791
:param member_name: Attribute name within the module for the format class.
1793
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1794
self._format_string = format_string
1796
def get_format_string(self):
1797
"""See BranchFormat.get_format_string."""
1798
return self._format_string
1801
"""Used for network_format_registry support."""
1802
return self.get_obj()()
1805
class BranchHooks(Hooks):
1806
"""A dictionary mapping hook name to a list of callables for branch hooks.
1808
e.g. ['set_rh'] Is the list of items to be called when the
1809
set_revision_history function is invoked.
1813
"""Create the default hooks.
1815
These are all empty initially, because by default nothing should get
1818
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1819
self.add_hook('set_rh',
1820
"Invoked whenever the revision history has been set via "
1821
"set_revision_history. The api signature is (branch, "
1822
"revision_history), and the branch will be write-locked. "
1823
"The set_rh hook can be expensive for bzr to trigger, a better "
1824
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1825
self.add_hook('open',
1826
"Called with the Branch object that has been opened after a "
1827
"branch is opened.", (1, 8))
1828
self.add_hook('post_push',
1829
"Called after a push operation completes. post_push is called "
1830
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1831
"bzr client.", (0, 15))
1832
self.add_hook('post_pull',
1833
"Called after a pull operation completes. post_pull is called "
1834
"with a bzrlib.branch.PullResult object and only runs in the "
1835
"bzr client.", (0, 15))
1836
self.add_hook('pre_commit',
1837
"Called after a commit is calculated but before it is "
1838
"completed. pre_commit is called with (local, master, old_revno, "
1839
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1840
"). old_revid is NULL_REVISION for the first commit to a branch, "
1841
"tree_delta is a TreeDelta object describing changes from the "
1842
"basis revision. hooks MUST NOT modify this delta. "
1843
" future_tree is an in-memory tree obtained from "
1844
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1846
self.add_hook('post_commit',
1847
"Called in the bzr client after a commit has completed. "
1848
"post_commit is called with (local, master, old_revno, old_revid, "
1849
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1850
"commit to a branch.", (0, 15))
1851
self.add_hook('post_uncommit',
1852
"Called in the bzr client after an uncommit completes. "
1853
"post_uncommit is called with (local, master, old_revno, "
1854
"old_revid, new_revno, new_revid) where local is the local branch "
1855
"or None, master is the target branch, and an empty branch "
1856
"receives new_revno of 0, new_revid of None.", (0, 15))
1857
self.add_hook('pre_change_branch_tip',
1858
"Called in bzr client and server before a change to the tip of a "
1859
"branch is made. pre_change_branch_tip is called with a "
1860
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1861
"commit, uncommit will all trigger this hook.", (1, 6))
1862
self.add_hook('post_change_branch_tip',
1863
"Called in bzr client and server after a change to the tip of a "
1864
"branch is made. post_change_branch_tip is called with a "
1865
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1866
"commit, uncommit will all trigger this hook.", (1, 4))
1867
self.add_hook('transform_fallback_location',
1868
"Called when a stacked branch is activating its fallback "
1869
"locations. transform_fallback_location is called with (branch, "
1870
"url), and should return a new url. Returning the same url "
1871
"allows it to be used as-is, returning a different one can be "
1872
"used to cause the branch to stack on a closer copy of that "
1873
"fallback_location. Note that the branch cannot have history "
1874
"accessing methods called on it during this hook because the "
1875
"fallback locations have not been activated. When there are "
1876
"multiple hooks installed for transform_fallback_location, "
1877
"all are called with the url returned from the previous hook."
1878
"The order is however undefined.", (1, 9))
1879
self.add_hook('automatic_tag_name',
1880
"Called to determine an automatic tag name for a revision. "
1881
"automatic_tag_name is called with (branch, revision_id) and "
1882
"should return a tag name or None if no tag name could be "
1883
"determined. The first non-None tag name returned will be used.",
1885
self.add_hook('post_branch_init',
1886
"Called after new branch initialization completes. "
1887
"post_branch_init is called with a "
1888
"bzrlib.branch.BranchInitHookParams. "
1889
"Note that init, branch and checkout (both heavyweight and "
1890
"lightweight) will all trigger this hook.", (2, 2))
1891
self.add_hook('post_switch',
1892
"Called after a checkout switches branch. "
1893
"post_switch is called with a "
1894
"bzrlib.branch.SwitchHookParams.", (2, 2))
1898
# install the default hooks into the Branch class.
1899
Branch.hooks = BranchHooks()
1902
class ChangeBranchTipParams(object):
1903
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1905
There are 5 fields that hooks may wish to access:
1907
:ivar branch: the branch being changed
1908
:ivar old_revno: revision number before the change
1909
:ivar new_revno: revision number after the change
1910
:ivar old_revid: revision id before the change
1911
:ivar new_revid: revision id after the change
1913
The revid fields are strings. The revno fields are integers.
1916
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1917
"""Create a group of ChangeBranchTip parameters.
1919
:param branch: The branch being changed.
1920
:param old_revno: Revision number before the change.
1921
:param new_revno: Revision number after the change.
1922
:param old_revid: Tip revision id before the change.
1923
:param new_revid: Tip revision id after the change.
1925
self.branch = branch
1926
self.old_revno = old_revno
1927
self.new_revno = new_revno
1928
self.old_revid = old_revid
1929
self.new_revid = new_revid
1931
def __eq__(self, other):
1932
return self.__dict__ == other.__dict__
1935
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1936
self.__class__.__name__, self.branch,
1937
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1940
class BranchInitHookParams(object):
1941
"""Object holding parameters passed to `*_branch_init` hooks.
1943
There are 4 fields that hooks may wish to access:
1945
:ivar format: the branch format
1946
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1947
:ivar name: name of colocated branch, if any (or None)
1948
:ivar branch: the branch created
1950
Note that for lightweight checkouts, the bzrdir and format fields refer to
1951
the checkout, hence they are different from the corresponding fields in
1952
branch, which refer to the original branch.
1955
def __init__(self, format, controldir, name, branch):
1956
"""Create a group of BranchInitHook parameters.
1958
:param format: the branch format
1959
:param controldir: the ControlDir where the branch will be/has been
1961
:param name: name of colocated branch, if any (or None)
1962
:param branch: the branch created
1964
Note that for lightweight checkouts, the bzrdir and format fields refer
1965
to the checkout, hence they are different from the corresponding fields
1966
in branch, which refer to the original branch.
1968
self.format = format
1969
self.bzrdir = controldir
1971
self.branch = branch
1973
def __eq__(self, other):
1974
return self.__dict__ == other.__dict__
1977
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1980
class SwitchHookParams(object):
1981
"""Object holding parameters passed to `*_switch` hooks.
1983
There are 4 fields that hooks may wish to access:
1985
:ivar control_dir: ControlDir of the checkout to change
1986
:ivar to_branch: branch that the checkout is to reference
1987
:ivar force: skip the check for local commits in a heavy checkout
1988
:ivar revision_id: revision ID to switch to (or None)
1991
def __init__(self, control_dir, to_branch, force, revision_id):
1992
"""Create a group of SwitchHook parameters.
1994
:param control_dir: ControlDir of the checkout to change
1995
:param to_branch: branch that the checkout is to reference
1996
:param force: skip the check for local commits in a heavy checkout
1997
:param revision_id: revision ID to switch to (or None)
1999
self.control_dir = control_dir
2000
self.to_branch = to_branch
2002
self.revision_id = revision_id
2004
def __eq__(self, other):
2005
return self.__dict__ == other.__dict__
2008
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
2009
self.control_dir, self.to_branch,
2013
class BranchFormatMetadir(BranchFormat):
2014
"""Common logic for meta-dir based branch formats."""
2016
def _branch_class(self):
2017
"""What class to instantiate on open calls."""
2018
raise NotImplementedError(self._branch_class)
2020
def _get_initial_config(self, append_revisions_only=None):
2021
if append_revisions_only:
2022
return "append_revisions_only = True\n"
2024
# Avoid writing anything if append_revisions_only is disabled,
2025
# as that is the default.
2028
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2030
"""Initialize a branch in a bzrdir, with specified files
2032
:param a_bzrdir: The bzrdir to initialize the branch in
2033
:param utf8_files: The files to create as a list of
2034
(filename, content) tuples
2035
:param name: Name of colocated branch to create, if any
2036
:return: a branch in this format
2038
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2039
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2040
control_files = lockable_files.LockableFiles(branch_transport,
2041
'lock', lockdir.LockDir)
2042
control_files.create_lock()
2043
control_files.lock_write()
2045
utf8_files += [('format', self.get_format_string())]
2046
for (filename, content) in utf8_files:
2047
branch_transport.put_bytes(
2049
mode=a_bzrdir._get_file_mode())
2051
control_files.unlock()
2052
branch = self.open(a_bzrdir, name, _found=True,
2053
found_repository=repository)
2054
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2057
def network_name(self):
2058
"""A simple byte string uniquely identifying this format for RPC calls.
2060
Metadir branch formats use their format string.
2062
return self.get_format_string()
2064
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2065
found_repository=None):
2066
"""See BranchFormat.open()."""
2068
format = BranchFormat.find_format(a_bzrdir, name=name)
2069
if format.__class__ != self.__class__:
2070
raise AssertionError("wrong format %r found for %r" %
2072
transport = a_bzrdir.get_branch_transport(None, name=name)
2074
control_files = lockable_files.LockableFiles(transport, 'lock',
2076
if found_repository is None:
2077
found_repository = a_bzrdir.find_repository()
2078
return self._branch_class()(_format=self,
2079
_control_files=control_files,
2082
_repository=found_repository,
2083
ignore_fallbacks=ignore_fallbacks)
2084
except errors.NoSuchFile:
2085
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2088
def _matchingbzrdir(self):
2089
ret = bzrdir.BzrDirMetaFormat1()
2090
ret.set_branch_format(self)
2093
def supports_tags(self):
2096
def supports_leaving_lock(self):
2100
class BzrBranchFormat5(BranchFormatMetadir):
2101
"""Bzr branch format 5.
2104
- a revision-history file.
2106
- a lock dir guarding the branch itself
2107
- all of this stored in a branch/ subdirectory
2108
- works with shared repositories.
2110
This format is new in bzr 0.8.
2113
def _branch_class(self):
2116
def get_format_string(self):
2117
"""See BranchFormat.get_format_string()."""
2118
return "Bazaar-NG branch format 5\n"
2120
def get_format_description(self):
2121
"""See BranchFormat.get_format_description()."""
2122
return "Branch format 5"
2124
def initialize(self, a_bzrdir, name=None, repository=None,
2125
append_revisions_only=None):
2126
"""Create a branch of this format in a_bzrdir."""
2127
if append_revisions_only:
2128
raise errors.UpgradeRequired(a_bzrdir.user_url)
2129
utf8_files = [('revision-history', ''),
2130
('branch-name', ''),
2132
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2134
def supports_tags(self):
2138
class BzrBranchFormat6(BranchFormatMetadir):
2139
"""Branch format with last-revision and tags.
2141
Unlike previous formats, this has no explicit revision history. Instead,
2142
this just stores the last-revision, and the left-hand history leading
2143
up to there is the history.
2145
This format was introduced in bzr 0.15
2146
and became the default in 0.91.
2149
def _branch_class(self):
2152
def get_format_string(self):
2153
"""See BranchFormat.get_format_string()."""
2154
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2156
def get_format_description(self):
2157
"""See BranchFormat.get_format_description()."""
2158
return "Branch format 6"
2160
def initialize(self, a_bzrdir, name=None, repository=None,
2161
append_revisions_only=None):
2162
"""Create a branch of this format in a_bzrdir."""
2163
utf8_files = [('last-revision', '0 null:\n'),
2165
self._get_initial_config(append_revisions_only)),
2168
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2170
def make_tags(self, branch):
2171
"""See bzrlib.branch.BranchFormat.make_tags()."""
2172
return _mod_tag.BasicTags(branch)
2174
def supports_set_append_revisions_only(self):
2178
class BzrBranchFormat8(BranchFormatMetadir):
2179
"""Metadir format supporting storing locations of subtree branches."""
2181
def _branch_class(self):
2184
def get_format_string(self):
2185
"""See BranchFormat.get_format_string()."""
2186
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2188
def get_format_description(self):
2189
"""See BranchFormat.get_format_description()."""
2190
return "Branch format 8"
2192
def initialize(self, a_bzrdir, name=None, repository=None,
2193
append_revisions_only=None):
2194
"""Create a branch of this format in a_bzrdir."""
2195
utf8_files = [('last-revision', '0 null:\n'),
2197
self._get_initial_config(append_revisions_only)),
2201
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2203
def make_tags(self, branch):
2204
"""See bzrlib.branch.BranchFormat.make_tags()."""
2205
return _mod_tag.BasicTags(branch)
2207
def supports_set_append_revisions_only(self):
2210
def supports_stacking(self):
2213
supports_reference_locations = True
2216
class BzrBranchFormat7(BranchFormatMetadir):
2217
"""Branch format with last-revision, tags, and a stacked location pointer.
2219
The stacked location pointer is passed down to the repository and requires
2220
a repository format with supports_external_lookups = True.
2222
This format was introduced in bzr 1.6.
2225
def initialize(self, a_bzrdir, name=None, repository=None,
2226
append_revisions_only=None):
2227
"""Create a branch of this format in a_bzrdir."""
2228
utf8_files = [('last-revision', '0 null:\n'),
2230
self._get_initial_config(append_revisions_only)),
2233
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2235
def _branch_class(self):
2238
def get_format_string(self):
2239
"""See BranchFormat.get_format_string()."""
2240
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2242
def get_format_description(self):
2243
"""See BranchFormat.get_format_description()."""
2244
return "Branch format 7"
2246
def supports_set_append_revisions_only(self):
2249
def supports_stacking(self):
2252
def make_tags(self, branch):
2253
"""See bzrlib.branch.BranchFormat.make_tags()."""
2254
return _mod_tag.BasicTags(branch)
2256
supports_reference_locations = False
2259
class BranchReferenceFormat(BranchFormatMetadir):
2260
"""Bzr branch reference format.
2262
Branch references are used in implementing checkouts, they
2263
act as an alias to the real branch which is at some other url.
2270
def get_format_string(self):
2271
"""See BranchFormat.get_format_string()."""
2272
return "Bazaar-NG Branch Reference Format 1\n"
2274
def get_format_description(self):
2275
"""See BranchFormat.get_format_description()."""
2276
return "Checkout reference format 1"
2278
def get_reference(self, a_bzrdir, name=None):
2279
"""See BranchFormat.get_reference()."""
2280
transport = a_bzrdir.get_branch_transport(None, name=name)
2281
return transport.get_bytes('location')
2283
def set_reference(self, a_bzrdir, name, to_branch):
2284
"""See BranchFormat.set_reference()."""
2285
transport = a_bzrdir.get_branch_transport(None, name=name)
2286
location = transport.put_bytes('location', to_branch.base)
2288
def initialize(self, a_bzrdir, name=None, target_branch=None,
2289
repository=None, append_revisions_only=None):
2290
"""Create a branch of this format in a_bzrdir."""
2291
if target_branch is None:
2292
# this format does not implement branch itself, thus the implicit
2293
# creation contract must see it as uninitializable
2294
raise errors.UninitializableFormat(self)
2295
mutter('creating branch reference in %s', a_bzrdir.user_url)
2296
if a_bzrdir._format.fixed_components:
2297
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2298
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2299
branch_transport.put_bytes('location',
2300
target_branch.bzrdir.user_url)
2301
branch_transport.put_bytes('format', self.get_format_string())
2303
a_bzrdir, name, _found=True,
2304
possible_transports=[target_branch.bzrdir.root_transport])
2305
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2308
def _make_reference_clone_function(format, a_branch):
2309
"""Create a clone() routine for a branch dynamically."""
2310
def clone(to_bzrdir, revision_id=None,
2311
repository_policy=None):
2312
"""See Branch.clone()."""
2313
return format.initialize(to_bzrdir, target_branch=a_branch)
2314
# cannot obey revision_id limits when cloning a reference ...
2315
# FIXME RBC 20060210 either nuke revision_id for clone, or
2316
# emit some sort of warning/error to the caller ?!
2319
def open(self, a_bzrdir, name=None, _found=False, location=None,
2320
possible_transports=None, ignore_fallbacks=False,
2321
found_repository=None):
2322
"""Return the branch that the branch reference in a_bzrdir points at.
2324
:param a_bzrdir: A BzrDir that contains a branch.
2325
:param name: Name of colocated branch to open, if any
2326
:param _found: a private parameter, do not use it. It is used to
2327
indicate if format probing has already be done.
2328
:param ignore_fallbacks: when set, no fallback branches will be opened
2329
(if there are any). Default is to open fallbacks.
2330
:param location: The location of the referenced branch. If
2331
unspecified, this will be determined from the branch reference in
2333
:param possible_transports: An optional reusable transports list.
2336
format = BranchFormat.find_format(a_bzrdir, name=name)
2337
if format.__class__ != self.__class__:
2338
raise AssertionError("wrong format %r found for %r" %
2340
if location is None:
2341
location = self.get_reference(a_bzrdir, name)
2342
real_bzrdir = controldir.ControlDir.open(
2343
location, possible_transports=possible_transports)
2344
result = real_bzrdir.open_branch(name=name,
2345
ignore_fallbacks=ignore_fallbacks)
2346
# this changes the behaviour of result.clone to create a new reference
2347
# rather than a copy of the content of the branch.
2348
# I did not use a proxy object because that needs much more extensive
2349
# testing, and we are only changing one behaviour at the moment.
2350
# If we decide to alter more behaviours - i.e. the implicit nickname
2351
# then this should be refactored to introduce a tested proxy branch
2352
# and a subclass of that for use in overriding clone() and ....
2354
result.clone = self._make_reference_clone_function(result)
2358
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2359
"""Branch format registry."""
2361
def __init__(self, other_registry=None):
2362
super(BranchFormatRegistry, self).__init__(other_registry)
2363
self._default_format = None
2365
def set_default(self, format):
2366
self._default_format = format
2368
def get_default(self):
2369
return self._default_format
2372
network_format_registry = registry.FormatRegistry()
2373
"""Registry of formats indexed by their network name.
2375
The network name for a branch format is an identifier that can be used when
2376
referring to formats with smart server operations. See
2377
BranchFormat.network_name() for more detail.
2380
format_registry = BranchFormatRegistry(network_format_registry)
2383
# formats which have no format string are not discoverable
2384
# and not independently creatable, so are not registered.
2385
__format5 = BzrBranchFormat5()
2386
__format6 = BzrBranchFormat6()
2387
__format7 = BzrBranchFormat7()
2388
__format8 = BzrBranchFormat8()
2389
format_registry.register(__format5)
2390
format_registry.register(BranchReferenceFormat())
2391
format_registry.register(__format6)
2392
format_registry.register(__format7)
2393
format_registry.register(__format8)
2394
format_registry.set_default(__format7)
2397
class BranchWriteLockResult(LogicalLockResult):
2398
"""The result of write locking a branch.
2400
:ivar branch_token: The token obtained from the underlying branch lock, or
2402
:ivar unlock: A callable which will unlock the lock.
2405
def __init__(self, unlock, branch_token):
2406
LogicalLockResult.__init__(self, unlock)
2407
self.branch_token = branch_token
2410
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2414
class BzrBranch(Branch, _RelockDebugMixin):
2415
"""A branch stored in the actual filesystem.
2417
Note that it's "local" in the context of the filesystem; it doesn't
2418
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2419
it's writable, and can be accessed via the normal filesystem API.
2421
:ivar _transport: Transport for file operations on this branch's
2422
control files, typically pointing to the .bzr/branch directory.
2423
:ivar repository: Repository for this branch.
2424
:ivar base: The url of the base directory for this branch; the one
2425
containing the .bzr directory.
2426
:ivar name: Optional colocated branch name as it exists in the control
2430
def __init__(self, _format=None,
2431
_control_files=None, a_bzrdir=None, name=None,
2432
_repository=None, ignore_fallbacks=False):
2433
"""Create new branch object at a particular location."""
2434
if a_bzrdir is None:
2435
raise ValueError('a_bzrdir must be supplied')
2437
self.bzrdir = a_bzrdir
2438
self._base = self.bzrdir.transport.clone('..').base
2440
# XXX: We should be able to just do
2441
# self.base = self.bzrdir.root_transport.base
2442
# but this does not quite work yet -- mbp 20080522
2443
self._format = _format
2444
if _control_files is None:
2445
raise ValueError('BzrBranch _control_files is None')
2446
self.control_files = _control_files
2447
self._transport = _control_files._transport
2448
self.repository = _repository
2449
Branch.__init__(self)
2452
if self.name is None:
2453
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2455
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2460
def _get_base(self):
2461
"""Returns the directory containing the control directory."""
2464
base = property(_get_base, doc="The URL for the root of this branch.")
2466
def _get_config(self):
2467
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2469
def is_locked(self):
2470
return self.control_files.is_locked()
2472
def lock_write(self, token=None):
2473
"""Lock the branch for write operations.
2475
:param token: A token to permit reacquiring a previously held and
2477
:return: A BranchWriteLockResult.
2479
if not self.is_locked():
2480
self._note_lock('w')
2481
# All-in-one needs to always unlock/lock.
2482
repo_control = getattr(self.repository, 'control_files', None)
2483
if self.control_files == repo_control or not self.is_locked():
2484
self.repository._warn_if_deprecated(self)
2485
self.repository.lock_write()
2490
return BranchWriteLockResult(self.unlock,
2491
self.control_files.lock_write(token=token))
2494
self.repository.unlock()
2497
def lock_read(self):
2498
"""Lock the branch for read operations.
2500
:return: A bzrlib.lock.LogicalLockResult.
2502
if not self.is_locked():
2503
self._note_lock('r')
2504
# All-in-one needs to always unlock/lock.
2505
repo_control = getattr(self.repository, 'control_files', None)
2506
if self.control_files == repo_control or not self.is_locked():
2507
self.repository._warn_if_deprecated(self)
2508
self.repository.lock_read()
2513
self.control_files.lock_read()
2514
return LogicalLockResult(self.unlock)
2517
self.repository.unlock()
2520
@only_raises(errors.LockNotHeld, errors.LockBroken)
2523
self.control_files.unlock()
2525
# All-in-one needs to always unlock/lock.
2526
repo_control = getattr(self.repository, 'control_files', None)
2527
if (self.control_files == repo_control or
2528
not self.control_files.is_locked()):
2529
self.repository.unlock()
2530
if not self.control_files.is_locked():
2531
# we just released the lock
2532
self._clear_cached_state()
2534
def peek_lock_mode(self):
2535
if self.control_files._lock_count == 0:
2538
return self.control_files._lock_mode
2540
def get_physical_lock_status(self):
2541
return self.control_files.get_physical_lock_status()
2544
def print_file(self, file, revision_id):
2545
"""See Branch.print_file."""
2546
return self.repository.print_file(file, revision_id)
2549
def set_last_revision_info(self, revno, revision_id):
2550
if not revision_id or not isinstance(revision_id, basestring):
2551
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2552
revision_id = _mod_revision.ensure_null(revision_id)
2553
old_revno, old_revid = self.last_revision_info()
2554
if self.get_append_revisions_only():
2555
self._check_history_violation(revision_id)
2556
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2557
self._write_last_revision_info(revno, revision_id)
2558
self._clear_cached_state()
2559
self._last_revision_info_cache = revno, revision_id
2560
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2562
def basis_tree(self):
2563
"""See Branch.basis_tree."""
2564
return self.repository.revision_tree(self.last_revision())
2566
def _get_parent_location(self):
2567
_locs = ['parent', 'pull', 'x-pull']
2570
return self._transport.get_bytes(l).strip('\n')
2571
except errors.NoSuchFile:
2575
def get_stacked_on_url(self):
2576
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2578
def set_push_location(self, location):
2579
"""See Branch.set_push_location."""
2580
self.get_config().set_user_option(
2581
'push_location', location,
2582
store=_mod_config.STORE_LOCATION_NORECURSE)
2584
def _set_parent_location(self, url):
2586
self._transport.delete('parent')
2588
self._transport.put_bytes('parent', url + '\n',
2589
mode=self.bzrdir._get_file_mode())
2593
"""If bound, unbind"""
2594
return self.set_bound_location(None)
2597
def bind(self, other):
2598
"""Bind this branch to the branch other.
2600
This does not push or pull data between the branches, though it does
2601
check for divergence to raise an error when the branches are not
2602
either the same, or one a prefix of the other. That behaviour may not
2603
be useful, so that check may be removed in future.
2605
:param other: The branch to bind to
2608
# TODO: jam 20051230 Consider checking if the target is bound
2609
# It is debatable whether you should be able to bind to
2610
# a branch which is itself bound.
2611
# Committing is obviously forbidden,
2612
# but binding itself may not be.
2613
# Since we *have* to check at commit time, we don't
2614
# *need* to check here
2616
# we want to raise diverged if:
2617
# last_rev is not in the other_last_rev history, AND
2618
# other_last_rev is not in our history, and do it without pulling
2620
self.set_bound_location(other.base)
2622
def get_bound_location(self):
2624
return self._transport.get_bytes('bound')[:-1]
2625
except errors.NoSuchFile:
2629
def get_master_branch(self, possible_transports=None):
2630
"""Return the branch we are bound to.
2632
:return: Either a Branch, or None
2634
if self._master_branch_cache is None:
2635
self._master_branch_cache = self._get_master_branch(
2636
possible_transports)
2637
return self._master_branch_cache
2639
def _get_master_branch(self, possible_transports):
2640
bound_loc = self.get_bound_location()
2644
return Branch.open(bound_loc,
2645
possible_transports=possible_transports)
2646
except (errors.NotBranchError, errors.ConnectionError), e:
2647
raise errors.BoundBranchConnectionFailure(
2651
def set_bound_location(self, location):
2652
"""Set the target where this branch is bound to.
2654
:param location: URL to the target branch
2656
self._master_branch_cache = None
2658
self._transport.put_bytes('bound', location+'\n',
2659
mode=self.bzrdir._get_file_mode())
2662
self._transport.delete('bound')
2663
except errors.NoSuchFile:
2668
def update(self, possible_transports=None):
2669
"""Synchronise this branch with the master branch if any.
2671
:return: None or the last_revision that was pivoted out during the
2674
master = self.get_master_branch(possible_transports)
2675
if master is not None:
2676
old_tip = _mod_revision.ensure_null(self.last_revision())
2677
self.pull(master, overwrite=True)
2678
if self.repository.get_graph().is_ancestor(old_tip,
2679
_mod_revision.ensure_null(self.last_revision())):
2684
def _read_last_revision_info(self):
2685
revision_string = self._transport.get_bytes('last-revision')
2686
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2687
revision_id = cache_utf8.get_cached_utf8(revision_id)
2689
return revno, revision_id
2691
def _write_last_revision_info(self, revno, revision_id):
2692
"""Simply write out the revision id, with no checks.
2694
Use set_last_revision_info to perform this safely.
2696
Does not update the revision_history cache.
2698
revision_id = _mod_revision.ensure_null(revision_id)
2699
out_string = '%d %s\n' % (revno, revision_id)
2700
self._transport.put_bytes('last-revision', out_string,
2701
mode=self.bzrdir._get_file_mode())
2704
class FullHistoryBzrBranch(BzrBranch):
2705
"""Bzr branch which contains the full revision history."""
2708
def set_last_revision_info(self, revno, revision_id):
2709
if not revision_id or not isinstance(revision_id, basestring):
2710
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2711
revision_id = _mod_revision.ensure_null(revision_id)
2712
# this old format stores the full history, but this api doesn't
2713
# provide it, so we must generate, and might as well check it's
2715
history = self._lefthand_history(revision_id)
2716
if len(history) != revno:
2717
raise AssertionError('%d != %d' % (len(history), revno))
2718
self._set_revision_history(history)
2720
def _read_last_revision_info(self):
2721
rh = self._revision_history()
2724
return (revno, rh[-1])
2726
return (0, _mod_revision.NULL_REVISION)
2728
@deprecated_method(deprecated_in((2, 4, 0)))
2730
def set_revision_history(self, rev_history):
2731
"""See Branch.set_revision_history."""
2732
self._set_revision_history(rev_history)
2734
def _set_revision_history(self, rev_history):
2735
if 'evil' in debug.debug_flags:
2736
mutter_callsite(3, "set_revision_history scales with history.")
2737
check_not_reserved_id = _mod_revision.check_not_reserved_id
2738
for rev_id in rev_history:
2739
check_not_reserved_id(rev_id)
2740
if Branch.hooks['post_change_branch_tip']:
2741
# Don't calculate the last_revision_info() if there are no hooks
2743
old_revno, old_revid = self.last_revision_info()
2744
if len(rev_history) == 0:
2745
revid = _mod_revision.NULL_REVISION
2747
revid = rev_history[-1]
2748
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2749
self._write_revision_history(rev_history)
2750
self._clear_cached_state()
2751
self._cache_revision_history(rev_history)
2752
for hook in Branch.hooks['set_rh']:
2753
hook(self, rev_history)
2754
if Branch.hooks['post_change_branch_tip']:
2755
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2757
def _write_revision_history(self, history):
2758
"""Factored out of set_revision_history.
2760
This performs the actual writing to disk.
2761
It is intended to be called by set_revision_history."""
2762
self._transport.put_bytes(
2763
'revision-history', '\n'.join(history),
2764
mode=self.bzrdir._get_file_mode())
2766
def _gen_revision_history(self):
2767
history = self._transport.get_bytes('revision-history').split('\n')
2768
if history[-1:] == ['']:
2769
# There shouldn't be a trailing newline, but just in case.
2773
def _synchronize_history(self, destination, revision_id):
2774
if not isinstance(destination, FullHistoryBzrBranch):
2775
super(BzrBranch, self)._synchronize_history(
2776
destination, revision_id)
2778
if revision_id == _mod_revision.NULL_REVISION:
2781
new_history = self._revision_history()
2782
if revision_id is not None and new_history != []:
2784
new_history = new_history[:new_history.index(revision_id) + 1]
2786
rev = self.repository.get_revision(revision_id)
2787
new_history = rev.get_history(self.repository)[1:]
2788
destination._set_revision_history(new_history)
2791
def generate_revision_history(self, revision_id, last_rev=None,
2793
"""Create a new revision history that will finish with revision_id.
2795
:param revision_id: the new tip to use.
2796
:param last_rev: The previous last_revision. If not None, then this
2797
must be a ancestory of revision_id, or DivergedBranches is raised.
2798
:param other_branch: The other branch that DivergedBranches should
2799
raise with respect to.
2801
self._set_revision_history(self._lefthand_history(revision_id,
2802
last_rev, other_branch))
2805
class BzrBranch5(FullHistoryBzrBranch):
2806
"""A format 5 branch. This supports new features over plain branches.
2808
It has support for a master_branch which is the data for bound branches.
2812
class BzrBranch8(BzrBranch):
2813
"""A branch that stores tree-reference locations."""
2815
def _open_hook(self):
2816
if self._ignore_fallbacks:
2819
url = self.get_stacked_on_url()
2820
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2821
errors.UnstackableBranchFormat):
2824
for hook in Branch.hooks['transform_fallback_location']:
2825
url = hook(self, url)
2827
hook_name = Branch.hooks.get_hook_name(hook)
2828
raise AssertionError(
2829
"'transform_fallback_location' hook %s returned "
2830
"None, not a URL." % hook_name)
2831
self._activate_fallback_location(url)
2833
def __init__(self, *args, **kwargs):
2834
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2835
super(BzrBranch8, self).__init__(*args, **kwargs)
2836
self._last_revision_info_cache = None
2837
self._reference_info = None
2839
def _clear_cached_state(self):
2840
super(BzrBranch8, self)._clear_cached_state()
2841
self._last_revision_info_cache = None
2842
self._reference_info = None
2844
def _check_history_violation(self, revision_id):
2845
current_revid = self.last_revision()
2846
last_revision = _mod_revision.ensure_null(current_revid)
2847
if _mod_revision.is_null(last_revision):
2849
graph = self.repository.get_graph()
2850
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2851
if lh_ancestor == current_revid:
2853
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2855
def _gen_revision_history(self):
2856
"""Generate the revision history from last revision
2858
last_revno, last_revision = self.last_revision_info()
2859
self._extend_partial_history(stop_index=last_revno-1)
2860
return list(reversed(self._partial_revision_history_cache))
2863
def _set_parent_location(self, url):
2864
"""Set the parent branch"""
2865
self._set_config_location('parent_location', url, make_relative=True)
2868
def _get_parent_location(self):
2869
"""Set the parent branch"""
2870
return self._get_config_location('parent_location')
2873
def _set_all_reference_info(self, info_dict):
2874
"""Replace all reference info stored in a branch.
2876
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2879
writer = rio.RioWriter(s)
2880
for key, (tree_path, branch_location) in info_dict.iteritems():
2881
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2882
branch_location=branch_location)
2883
writer.write_stanza(stanza)
2884
self._transport.put_bytes('references', s.getvalue())
2885
self._reference_info = info_dict
2888
def _get_all_reference_info(self):
2889
"""Return all the reference info stored in a branch.
2891
:return: A dict of {file_id: (tree_path, branch_location)}
2893
if self._reference_info is not None:
2894
return self._reference_info
2895
rio_file = self._transport.get('references')
2897
stanzas = rio.read_stanzas(rio_file)
2898
info_dict = dict((s['file_id'], (s['tree_path'],
2899
s['branch_location'])) for s in stanzas)
2902
self._reference_info = info_dict
2905
def set_reference_info(self, file_id, tree_path, branch_location):
2906
"""Set the branch location to use for a tree reference.
2908
:param file_id: The file-id of the tree reference.
2909
:param tree_path: The path of the tree reference in the tree.
2910
:param branch_location: The location of the branch to retrieve tree
2913
info_dict = self._get_all_reference_info()
2914
info_dict[file_id] = (tree_path, branch_location)
2915
if None in (tree_path, branch_location):
2916
if tree_path is not None:
2917
raise ValueError('tree_path must be None when branch_location'
2919
if branch_location is not None:
2920
raise ValueError('branch_location must be None when tree_path'
2922
del info_dict[file_id]
2923
self._set_all_reference_info(info_dict)
2925
def get_reference_info(self, file_id):
2926
"""Get the tree_path and branch_location for a tree reference.
2928
:return: a tuple of (tree_path, branch_location)
2930
return self._get_all_reference_info().get(file_id, (None, None))
2932
def reference_parent(self, file_id, path, possible_transports=None):
2933
"""Return the parent branch for a tree-reference file_id.
2935
:param file_id: The file_id of the tree reference
2936
:param path: The path of the file_id in the tree
2937
:return: A branch associated with the file_id
2939
branch_location = self.get_reference_info(file_id)[1]
2940
if branch_location is None:
2941
return Branch.reference_parent(self, file_id, path,
2942
possible_transports)
2943
branch_location = urlutils.join(self.user_url, branch_location)
2944
return Branch.open(branch_location,
2945
possible_transports=possible_transports)
2947
def set_push_location(self, location):
2948
"""See Branch.set_push_location."""
2949
self._set_config_location('push_location', location)
2951
def set_bound_location(self, location):
2952
"""See Branch.set_push_location."""
2953
self._master_branch_cache = None
2955
config = self.get_config()
2956
if location is None:
2957
if config.get_user_option('bound') != 'True':
2960
config.set_user_option('bound', 'False', warn_masked=True)
2963
self._set_config_location('bound_location', location,
2965
config.set_user_option('bound', 'True', warn_masked=True)
2968
def _get_bound_location(self, bound):
2969
"""Return the bound location in the config file.
2971
Return None if the bound parameter does not match"""
2972
config = self.get_config()
2973
config_bound = (config.get_user_option('bound') == 'True')
2974
if config_bound != bound:
2976
return self._get_config_location('bound_location', config=config)
2978
def get_bound_location(self):
2979
"""See Branch.set_push_location."""
2980
return self._get_bound_location(True)
2982
def get_old_bound_location(self):
2983
"""See Branch.get_old_bound_location"""
2984
return self._get_bound_location(False)
2986
def get_stacked_on_url(self):
2987
# you can always ask for the URL; but you might not be able to use it
2988
# if the repo can't support stacking.
2989
## self._check_stackable_repo()
2990
# stacked_on_location is only ever defined in branch.conf, so don't
2991
# waste effort reading the whole stack of config files.
2992
config = self.get_config()._get_branch_data_config()
2993
stacked_url = self._get_config_location('stacked_on_location',
2995
if stacked_url is None:
2996
raise errors.NotStacked(self)
3000
def get_rev_id(self, revno, history=None):
3001
"""Find the revision id of the specified revno."""
3003
return _mod_revision.NULL_REVISION
3005
last_revno, last_revision_id = self.last_revision_info()
3006
if revno <= 0 or revno > last_revno:
3007
raise errors.NoSuchRevision(self, revno)
3009
if history is not None:
3010
return history[revno - 1]
3012
index = last_revno - revno
3013
if len(self._partial_revision_history_cache) <= index:
3014
self._extend_partial_history(stop_index=index)
3015
if len(self._partial_revision_history_cache) > index:
3016
return self._partial_revision_history_cache[index]
3018
raise errors.NoSuchRevision(self, revno)
3021
def revision_id_to_revno(self, revision_id):
3022
"""Given a revision id, return its revno"""
3023
if _mod_revision.is_null(revision_id):
3026
index = self._partial_revision_history_cache.index(revision_id)
3029
self._extend_partial_history(stop_revision=revision_id)
3030
except errors.RevisionNotPresent, e:
3031
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3032
index = len(self._partial_revision_history_cache) - 1
3033
if self._partial_revision_history_cache[index] != revision_id:
3034
raise errors.NoSuchRevision(self, revision_id)
3035
return self.revno() - index
3038
class BzrBranch7(BzrBranch8):
3039
"""A branch with support for a fallback repository."""
3041
def set_reference_info(self, file_id, tree_path, branch_location):
3042
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3044
def get_reference_info(self, file_id):
3045
Branch.get_reference_info(self, file_id)
3047
def reference_parent(self, file_id, path, possible_transports=None):
3048
return Branch.reference_parent(self, file_id, path,
3049
possible_transports)
3052
class BzrBranch6(BzrBranch7):
3053
"""See BzrBranchFormat6 for the capabilities of this branch.
3055
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3059
def get_stacked_on_url(self):
3060
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3063
######################################################################
3064
# results of operations
3067
class _Result(object):
3069
def _show_tag_conficts(self, to_file):
3070
if not getattr(self, 'tag_conflicts', None):
3072
to_file.write('Conflicting tags:\n')
3073
for name, value1, value2 in self.tag_conflicts:
3074
to_file.write(' %s\n' % (name, ))
3077
class PullResult(_Result):
3078
"""Result of a Branch.pull operation.
3080
:ivar old_revno: Revision number before pull.
3081
:ivar new_revno: Revision number after pull.
3082
:ivar old_revid: Tip revision id before pull.
3083
:ivar new_revid: Tip revision id after pull.
3084
:ivar source_branch: Source (local) branch object. (read locked)
3085
:ivar master_branch: Master branch of the target, or the target if no
3087
:ivar local_branch: target branch if there is a Master, else None
3088
:ivar target_branch: Target/destination branch object. (write locked)
3089
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3090
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3093
@deprecated_method(deprecated_in((2, 3, 0)))
3095
"""Return the relative change in revno.
3097
:deprecated: Use `new_revno` and `old_revno` instead.
3099
return self.new_revno - self.old_revno
3101
def report(self, to_file):
3102
tag_conflicts = getattr(self, "tag_conflicts", None)
3103
tag_updates = getattr(self, "tag_updates", None)
3105
if self.old_revid != self.new_revid:
3106
to_file.write('Now on revision %d.\n' % self.new_revno)
3108
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3109
if self.old_revid == self.new_revid and not tag_updates:
3110
if not tag_conflicts:
3111
to_file.write('No revisions or tags to pull.\n')
3113
to_file.write('No revisions to pull.\n')
3114
self._show_tag_conficts(to_file)
3117
class BranchPushResult(_Result):
3118
"""Result of a Branch.push operation.
3120
:ivar old_revno: Revision number (eg 10) of the target before push.
3121
:ivar new_revno: Revision number (eg 12) of the target after push.
3122
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3124
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3126
:ivar source_branch: Source branch object that the push was from. This is
3127
read locked, and generally is a local (and thus low latency) branch.
3128
:ivar master_branch: If target is a bound branch, the master branch of
3129
target, or target itself. Always write locked.
3130
:ivar target_branch: The direct Branch where data is being sent (write
3132
:ivar local_branch: If the target is a bound branch this will be the
3133
target, otherwise it will be None.
3136
@deprecated_method(deprecated_in((2, 3, 0)))
3138
"""Return the relative change in revno.
3140
:deprecated: Use `new_revno` and `old_revno` instead.
3142
return self.new_revno - self.old_revno
3144
def report(self, to_file):
3145
# TODO: This function gets passed a to_file, but then
3146
# ignores it and calls note() instead. This is also
3147
# inconsistent with PullResult(), which writes to stdout.
3148
# -- JRV20110901, bug #838853
3149
tag_conflicts = getattr(self, "tag_conflicts", None)
3150
tag_updates = getattr(self, "tag_updates", None)
3152
if self.old_revid != self.new_revid:
3153
note(gettext('Pushed up to revision %d.') % self.new_revno)
3155
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3156
if self.old_revid == self.new_revid and not tag_updates:
3157
if not tag_conflicts:
3158
note(gettext('No new revisions or tags to push.'))
3160
note(gettext('No new revisions to push.'))
3161
self._show_tag_conficts(to_file)
3164
class BranchCheckResult(object):
3165
"""Results of checking branch consistency.
3170
def __init__(self, branch):
3171
self.branch = branch
3174
def report_results(self, verbose):
3175
"""Report the check results via trace.note.
3177
:param verbose: Requests more detailed display of what was checked,
3180
note(gettext('checked branch {0} format {1}').format(
3181
self.branch.user_url, self.branch._format))
3182
for error in self.errors:
3183
note(gettext('found error:%s'), error)
3186
class Converter5to6(object):
3187
"""Perform an in-place upgrade of format 5 to format 6"""
3189
def convert(self, branch):
3190
# Data for 5 and 6 can peacefully coexist.
3191
format = BzrBranchFormat6()
3192
new_branch = format.open(branch.bzrdir, _found=True)
3194
# Copy source data into target
3195
new_branch._write_last_revision_info(*branch.last_revision_info())
3196
new_branch.set_parent(branch.get_parent())
3197
new_branch.set_bound_location(branch.get_bound_location())
3198
new_branch.set_push_location(branch.get_push_location())
3200
# New branch has no tags by default
3201
new_branch.tags._set_tag_dict({})
3203
# Copying done; now update target format
3204
new_branch._transport.put_bytes('format',
3205
format.get_format_string(),
3206
mode=new_branch.bzrdir._get_file_mode())
3208
# Clean up old files
3209
new_branch._transport.delete('revision-history')
3211
branch.set_parent(None)
3212
except errors.NoSuchFile:
3214
branch.set_bound_location(None)
3217
class Converter6to7(object):
3218
"""Perform an in-place upgrade of format 6 to format 7"""
3220
def convert(self, branch):
3221
format = BzrBranchFormat7()
3222
branch._set_config_location('stacked_on_location', '')
3223
# update target format
3224
branch._transport.put_bytes('format', format.get_format_string())
3227
class Converter7to8(object):
3228
"""Perform an in-place upgrade of format 7 to format 8"""
3230
def convert(self, branch):
3231
format = BzrBranchFormat8()
3232
branch._transport.put_bytes('references', '')
3233
# update target format
3234
branch._transport.put_bytes('format', format.get_format_string())
3237
class InterBranch(InterObject):
3238
"""This class represents operations taking place between two branches.
3240
Its instances have methods like pull() and push() and contain
3241
references to the source and target repositories these operations
3242
can be carried out on.
3246
"""The available optimised InterBranch types."""
3249
def _get_branch_formats_to_test(klass):
3250
"""Return an iterable of format tuples for testing.
3252
:return: An iterable of (from_format, to_format) to use when testing
3253
this InterBranch class. Each InterBranch class should define this
3256
raise NotImplementedError(klass._get_branch_formats_to_test)
3259
def pull(self, overwrite=False, stop_revision=None,
3260
possible_transports=None, local=False):
3261
"""Mirror source into target branch.
3263
The target branch is considered to be 'local', having low latency.
3265
:returns: PullResult instance
3267
raise NotImplementedError(self.pull)
3270
def push(self, overwrite=False, stop_revision=None, lossy=False,
3271
_override_hook_source_branch=None):
3272
"""Mirror the source branch into the target branch.
3274
The source branch is considered to be 'local', having low latency.
3276
raise NotImplementedError(self.push)
3279
def copy_content_into(self, revision_id=None):
3280
"""Copy the content of source into target
3282
revision_id: if not None, the revision history in the new branch will
3283
be truncated to end with revision_id.
3285
raise NotImplementedError(self.copy_content_into)
3288
def fetch(self, stop_revision=None, limit=None):
3291
:param stop_revision: Last revision to fetch
3292
:param limit: Optional rough limit of revisions to fetch
3294
raise NotImplementedError(self.fetch)
3297
class GenericInterBranch(InterBranch):
3298
"""InterBranch implementation that uses public Branch functions."""
3301
def is_compatible(klass, source, target):
3302
# GenericBranch uses the public API, so always compatible
3306
def _get_branch_formats_to_test(klass):
3307
return [(format_registry.get_default(), format_registry.get_default())]
3310
def unwrap_format(klass, format):
3311
if isinstance(format, remote.RemoteBranchFormat):
3312
format._ensure_real()
3313
return format._custom_format
3317
def copy_content_into(self, revision_id=None):
3318
"""Copy the content of source into target
3320
revision_id: if not None, the revision history in the new branch will
3321
be truncated to end with revision_id.
3323
self.source.update_references(self.target)
3324
self.source._synchronize_history(self.target, revision_id)
3326
parent = self.source.get_parent()
3327
except errors.InaccessibleParent, e:
3328
mutter('parent was not accessible to copy: %s', e)
3331
self.target.set_parent(parent)
3332
if self.source._push_should_merge_tags():
3333
self.source.tags.merge_to(self.target.tags)
3336
def fetch(self, stop_revision=None, limit=None):
3337
if self.target.base == self.source.base:
3339
self.source.lock_read()
3341
fetch_spec_factory = fetch.FetchSpecFactory()
3342
fetch_spec_factory.source_branch = self.source
3343
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3344
fetch_spec_factory.source_repo = self.source.repository
3345
fetch_spec_factory.target_repo = self.target.repository
3346
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3347
fetch_spec_factory.limit = limit
3348
fetch_spec = fetch_spec_factory.make_fetch_spec()
3349
return self.target.repository.fetch(self.source.repository,
3350
fetch_spec=fetch_spec)
3352
self.source.unlock()
3355
def _update_revisions(self, stop_revision=None, overwrite=False,
3357
other_revno, other_last_revision = self.source.last_revision_info()
3358
stop_revno = None # unknown
719
3359
if stop_revision is None:
720
stop_revision = other_len
721
elif stop_revision > other_len:
722
raise NoSuchRevision(self, stop_revision)
724
return other_history[self_len:stop_revision]
727
def update_revisions(self, other, stop_revision=None):
728
"""Pull in all new revisions from other branch.
730
>>> from bzrlib.commit import commit
731
>>> bzrlib.trace.silent = True
732
>>> br1 = ScratchBranch(files=['foo', 'bar'])
735
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
736
>>> br2 = ScratchBranch()
737
>>> br2.update_revisions(br1)
741
>>> br2.revision_history()
743
>>> br2.update_revisions(br1)
747
>>> br1.text_store.total_size() == br2.text_store.total_size()
750
from bzrlib.progress import ProgressBar
754
pb.update('comparing histories')
755
revision_ids = self.missing_revisions(other, stop_revision)
757
needed_texts = sets.Set()
759
for rev_id in revision_ids:
761
pb.update('fetching revision', i, len(revision_ids))
762
rev = other.get_revision(rev_id)
763
revisions.append(rev)
764
inv = other.get_inventory(str(rev.inventory_id))
765
for key, entry in inv.iter_entries():
766
if entry.text_id is None:
768
if entry.text_id not in self.text_store:
769
needed_texts.add(entry.text_id)
773
count = self.text_store.copy_multi(other.text_store, needed_texts)
774
print "Added %d texts." % count
775
inventory_ids = [ f.inventory_id for f in revisions ]
776
count = self.inventory_store.copy_multi(other.inventory_store,
778
print "Added %d inventories." % count
779
revision_ids = [ f.revision_id for f in revisions]
780
count = self.revision_store.copy_multi(other.revision_store,
782
for revision_id in revision_ids:
783
self.append_revision(revision_id)
784
print "Added %d revisions." % count
787
def commit(self, *args, **kw):
789
from bzrlib.commit import commit
790
commit(self, *args, **kw)
793
def lookup_revision(self, revno):
794
"""Return revision hash for revision number."""
799
# list is 0-based; revisions are 1-based
800
return self.revision_history()[revno-1]
802
raise BzrError("no such revision %s" % revno)
805
def revision_tree(self, revision_id):
806
"""Return Tree for a revision on this branch.
808
`revision_id` may be None for the null revision, in which case
809
an `EmptyTree` is returned."""
810
# TODO: refactor this to use an existing revision object
811
# so we don't need to read it in twice.
812
if revision_id == None:
815
inv = self.get_revision_inventory(revision_id)
816
return RevisionTree(self.text_store, inv)
819
def working_tree(self):
820
"""Return a `Tree` for the working copy."""
821
from workingtree import WorkingTree
822
return WorkingTree(self.base, self.read_working_inventory())
825
def basis_tree(self):
826
"""Return `Tree` object for last revision.
828
If there are no revisions yet, return an `EmptyTree`.
830
r = self.last_patch()
834
return RevisionTree(self.text_store, self.get_revision_inventory(r))
838
def rename_one(self, from_rel, to_rel):
841
This can change the directory or the filename or both.
845
tree = self.working_tree()
847
if not tree.has_filename(from_rel):
848
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
849
if tree.has_filename(to_rel):
850
raise BzrError("can't rename: new working file %r already exists" % to_rel)
852
file_id = inv.path2id(from_rel)
854
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
856
if inv.path2id(to_rel):
857
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
859
to_dir, to_tail = os.path.split(to_rel)
860
to_dir_id = inv.path2id(to_dir)
861
if to_dir_id == None and to_dir != '':
862
raise BzrError("can't determine destination directory id for %r" % to_dir)
864
mutter("rename_one:")
865
mutter(" file_id {%s}" % file_id)
866
mutter(" from_rel %r" % from_rel)
867
mutter(" to_rel %r" % to_rel)
868
mutter(" to_dir %r" % to_dir)
869
mutter(" to_dir_id {%s}" % to_dir_id)
871
inv.rename(file_id, to_dir_id, to_tail)
873
print "%s => %s" % (from_rel, to_rel)
875
from_abs = self.abspath(from_rel)
876
to_abs = self.abspath(to_rel)
3360
stop_revision = other_last_revision
3361
if _mod_revision.is_null(stop_revision):
3362
# if there are no commits, we're done.
3364
stop_revno = other_revno
3366
# what's the current last revision, before we fetch [and change it
3368
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3369
# we fetch here so that we don't process data twice in the common
3370
# case of having something to pull, and so that the check for
3371
# already merged can operate on the just fetched graph, which will
3372
# be cached in memory.
3373
self.fetch(stop_revision=stop_revision)
3374
# Check to see if one is an ancestor of the other
3377
graph = self.target.repository.get_graph()
3378
if self.target._check_if_descendant_or_diverged(
3379
stop_revision, last_rev, graph, self.source):
3380
# stop_revision is a descendant of last_rev, but we aren't
3381
# overwriting, so we're done.
3383
if stop_revno is None:
3385
graph = self.target.repository.get_graph()
3386
this_revno, this_last_revision = \
3387
self.target.last_revision_info()
3388
stop_revno = graph.find_distance_to_null(stop_revision,
3389
[(other_last_revision, other_revno),
3390
(this_last_revision, this_revno)])
3391
self.target.set_last_revision_info(stop_revno, stop_revision)
3394
def pull(self, overwrite=False, stop_revision=None,
3395
possible_transports=None, run_hooks=True,
3396
_override_hook_target=None, local=False):
3397
"""Pull from source into self, updating my master if any.
3399
:param run_hooks: Private parameter - if false, this branch
3400
is being called because it's the master of the primary branch,
3401
so it should not run its hooks.
3403
bound_location = self.target.get_bound_location()
3404
if local and not bound_location:
3405
raise errors.LocalRequiresBoundBranch()
3406
master_branch = None
3407
source_is_master = False
3409
# bound_location comes from a config file, some care has to be
3410
# taken to relate it to source.user_url
3411
normalized = urlutils.normalize_url(bound_location)
878
os.rename(from_abs, to_abs)
880
raise BzrError("failed to rename %r to %r: %s"
881
% (from_abs, to_abs, e[1]),
882
["rename rolled back"])
884
self._write_inventory(inv)
889
def move(self, from_paths, to_name):
892
to_name must exist as a versioned directory.
894
If to_name exists and is a directory, the files are moved into
895
it, keeping their old names. If it is a directory,
897
Note that to_name is only the last component of the new name;
898
this doesn't change the directory.
902
## TODO: Option to move IDs only
903
assert not isinstance(from_paths, basestring)
904
tree = self.working_tree()
906
to_abs = self.abspath(to_name)
907
if not isdir(to_abs):
908
raise BzrError("destination %r is not a directory" % to_abs)
909
if not tree.has_filename(to_name):
910
raise BzrError("destination %r not in working directory" % to_abs)
911
to_dir_id = inv.path2id(to_name)
912
if to_dir_id == None and to_name != '':
913
raise BzrError("destination %r is not a versioned directory" % to_name)
914
to_dir_ie = inv[to_dir_id]
915
if to_dir_ie.kind not in ('directory', 'root_directory'):
916
raise BzrError("destination %r is not a directory" % to_abs)
918
to_idpath = inv.get_idpath(to_dir_id)
921
if not tree.has_filename(f):
922
raise BzrError("%r does not exist in working tree" % f)
923
f_id = inv.path2id(f)
925
raise BzrError("%r is not versioned" % f)
926
name_tail = splitpath(f)[-1]
927
dest_path = appendpath(to_name, name_tail)
928
if tree.has_filename(dest_path):
929
raise BzrError("destination %r already exists" % dest_path)
930
if f_id in to_idpath:
931
raise BzrError("can't move %r to a subdirectory of itself" % f)
933
# OK, so there's a race here, it's possible that someone will
934
# create a file in this interval and then the rename might be
935
# left half-done. But we should have caught most problems.
938
name_tail = splitpath(f)[-1]
939
dest_path = appendpath(to_name, name_tail)
940
print "%s => %s" % (f, dest_path)
941
inv.rename(inv.path2id(f), to_dir_id, name_tail)
943
os.rename(self.abspath(f), self.abspath(dest_path))
945
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
946
["rename rolled back"])
948
self._write_inventory(inv)
954
class ScratchBranch(Branch):
955
"""Special test class: a branch that cleans up after itself.
957
>>> b = ScratchBranch()
965
def __init__(self, files=[], dirs=[], base=None):
966
"""Make a test branch.
968
This creates a temporary directory and runs init-tree in it.
970
If any files are listed, they are created in the working copy.
974
base = tempfile.mkdtemp()
976
Branch.__init__(self, base, init=init)
978
os.mkdir(self.abspath(d))
981
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
986
>>> orig = ScratchBranch(files=["file1", "file2"])
987
>>> clone = orig.clone()
988
>>> os.path.samefile(orig.base, clone.base)
990
>>> os.path.isfile(os.path.join(clone.base, "file1"))
993
base = tempfile.mkdtemp()
995
shutil.copytree(self.base, base, symlinks=True)
996
return ScratchBranch(base=base)
1002
"""Destroy the test branch, removing the scratch directory."""
1005
mutter("delete ScratchBranch %s" % self.base)
1006
shutil.rmtree(self.base)
1008
# Work around for shutil.rmtree failing on Windows when
1009
# readonly files are encountered
1010
mutter("hit exception in destroying ScratchBranch: %s" % e)
1011
for root, dirs, files in os.walk(self.base, topdown=False):
1013
os.chmod(os.path.join(root, name), 0700)
1014
shutil.rmtree(self.base)
1019
######################################################################
1023
def is_control_file(filename):
1024
## FIXME: better check
1025
filename = os.path.normpath(filename)
1026
while filename != '':
1027
head, tail = os.path.split(filename)
1028
## mutter('check %r for control file' % ((head, tail), ))
1029
if tail == bzrlib.BZRDIR:
1031
if filename == head:
1038
def gen_file_id(name):
1039
"""Return new file id.
1041
This should probably generate proper UUIDs, but for the moment we
1042
cope with just randomness because running uuidgen every time is
1046
# get last component
1047
idx = name.rfind('/')
1049
name = name[idx+1 : ]
1050
idx = name.rfind('\\')
1052
name = name[idx+1 : ]
1054
# make it not a hidden file
1055
name = name.lstrip('.')
1057
# remove any wierd characters; we don't escape them but rather
1058
# just pull them out
1059
name = re.sub(r'[^\w.]', '', name)
1061
s = hexlify(rand_bytes(8))
1062
return '-'.join((name, compact_date(time.time()), s))
3413
relpath = self.source.user_transport.relpath(normalized)
3414
source_is_master = (relpath == '')
3415
except (errors.PathNotChild, errors.InvalidURL):
3416
source_is_master = False
3417
if not local and bound_location and not source_is_master:
3418
# not pulling from master, so we need to update master.
3419
master_branch = self.target.get_master_branch(possible_transports)
3420
master_branch.lock_write()
3423
# pull from source into master.
3424
master_branch.pull(self.source, overwrite, stop_revision,
3426
return self._pull(overwrite,
3427
stop_revision, _hook_master=master_branch,
3428
run_hooks=run_hooks,
3429
_override_hook_target=_override_hook_target,
3430
merge_tags_to_master=not source_is_master)
3433
master_branch.unlock()
3435
def push(self, overwrite=False, stop_revision=None, lossy=False,
3436
_override_hook_source_branch=None):
3437
"""See InterBranch.push.
3439
This is the basic concrete implementation of push()
3441
:param _override_hook_source_branch: If specified, run the hooks
3442
passing this Branch as the source, rather than self. This is for
3443
use of RemoteBranch, where push is delegated to the underlying
3447
raise errors.LossyPushToSameVCS(self.source, self.target)
3448
# TODO: Public option to disable running hooks - should be trivial but
3451
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3452
op.add_cleanup(self.source.lock_read().unlock)
3453
op.add_cleanup(self.target.lock_write().unlock)
3454
return op.run(overwrite, stop_revision,
3455
_override_hook_source_branch=_override_hook_source_branch)
3457
def _basic_push(self, overwrite, stop_revision):
3458
"""Basic implementation of push without bound branches or hooks.
3460
Must be called with source read locked and target write locked.
3462
result = BranchPushResult()
3463
result.source_branch = self.source
3464
result.target_branch = self.target
3465
result.old_revno, result.old_revid = self.target.last_revision_info()
3466
self.source.update_references(self.target)
3467
if result.old_revid != stop_revision:
3468
# We assume that during 'push' this repository is closer than
3470
graph = self.source.repository.get_graph(self.target.repository)
3471
self._update_revisions(stop_revision, overwrite=overwrite,
3473
if self.source._push_should_merge_tags():
3474
result.tag_updates, result.tag_conflicts = (
3475
self.source.tags.merge_to(self.target.tags, overwrite))
3476
result.new_revno, result.new_revid = self.target.last_revision_info()
3479
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3480
_override_hook_source_branch=None):
3481
"""Push from source into target, and into target's master if any.
3484
if _override_hook_source_branch:
3485
result.source_branch = _override_hook_source_branch
3486
for hook in Branch.hooks['post_push']:
3489
bound_location = self.target.get_bound_location()
3490
if bound_location and self.target.base != bound_location:
3491
# there is a master branch.
3493
# XXX: Why the second check? Is it even supported for a branch to
3494
# be bound to itself? -- mbp 20070507
3495
master_branch = self.target.get_master_branch()
3496
master_branch.lock_write()
3497
operation.add_cleanup(master_branch.unlock)
3498
# push into the master from the source branch.
3499
master_inter = InterBranch.get(self.source, master_branch)
3500
master_inter._basic_push(overwrite, stop_revision)
3501
# and push into the target branch from the source. Note that
3502
# we push from the source branch again, because it's considered
3503
# the highest bandwidth repository.
3504
result = self._basic_push(overwrite, stop_revision)
3505
result.master_branch = master_branch
3506
result.local_branch = self.target
3508
master_branch = None
3510
result = self._basic_push(overwrite, stop_revision)
3511
# TODO: Why set master_branch and local_branch if there's no
3512
# binding? Maybe cleaner to just leave them unset? -- mbp
3514
result.master_branch = self.target
3515
result.local_branch = None
3519
def _pull(self, overwrite=False, stop_revision=None,
3520
possible_transports=None, _hook_master=None, run_hooks=True,
3521
_override_hook_target=None, local=False,
3522
merge_tags_to_master=True):
3525
This function is the core worker, used by GenericInterBranch.pull to
3526
avoid duplication when pulling source->master and source->local.
3528
:param _hook_master: Private parameter - set the branch to
3529
be supplied as the master to pull hooks.
3530
:param run_hooks: Private parameter - if false, this branch
3531
is being called because it's the master of the primary branch,
3532
so it should not run its hooks.
3533
is being called because it's the master of the primary branch,
3534
so it should not run its hooks.
3535
:param _override_hook_target: Private parameter - set the branch to be
3536
supplied as the target_branch to pull hooks.
3537
:param local: Only update the local branch, and not the bound branch.
3539
# This type of branch can't be bound.
3541
raise errors.LocalRequiresBoundBranch()
3542
result = PullResult()
3543
result.source_branch = self.source
3544
if _override_hook_target is None:
3545
result.target_branch = self.target
3547
result.target_branch = _override_hook_target
3548
self.source.lock_read()
3550
# We assume that during 'pull' the target repository is closer than
3552
self.source.update_references(self.target)
3553
graph = self.target.repository.get_graph(self.source.repository)
3554
# TODO: Branch formats should have a flag that indicates
3555
# that revno's are expensive, and pull() should honor that flag.
3557
result.old_revno, result.old_revid = \
3558
self.target.last_revision_info()
3559
self._update_revisions(stop_revision, overwrite=overwrite,
3561
# TODO: The old revid should be specified when merging tags,
3562
# so a tags implementation that versions tags can only
3563
# pull in the most recent changes. -- JRV20090506
3564
result.tag_updates, result.tag_conflicts = (
3565
self.source.tags.merge_to(self.target.tags, overwrite,
3566
ignore_master=not merge_tags_to_master))
3567
result.new_revno, result.new_revid = self.target.last_revision_info()
3569
result.master_branch = _hook_master
3570
result.local_branch = result.target_branch
3572
result.master_branch = result.target_branch
3573
result.local_branch = None
3575
for hook in Branch.hooks['post_pull']:
3578
self.source.unlock()
3582
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
