1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
import traceback, socket, fnmatch, difflib, time
22
from binascii import hexlify
25
from inventory import Inventory
26
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
28
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout
35
from textui import show_status
36
from diff import diff_trees
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
## TODO: Maybe include checks for common corruption of newlines, etc?
43
def find_branch_root(f=None):
44
"""Find the branch root enclosing f, or pwd.
46
It is not necessary that f exists.
48
Basically we keep looking up until we find the control directory or
52
elif hasattr(os.path, 'realpath'):
53
f = os.path.realpath(f)
55
f = os.path.abspath(f)
61
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
63
head, tail = os.path.split(f)
65
# reached the root, whatever that may be
66
bailout('%r is not in a branch' % orig_f)
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
# TODO: Maybe include checks for common corruption of newlines, etc?
68
# TODO: Some operations like log might retrieve the same revisions
69
# repeatedly to calculate deltas. We could perhaps have a weakref
70
# cache in memory to make this faster. In general anything can be
71
# cached in memory between lock and unlock operations. .. nb thats
72
# what the transaction identity map provides
71
75
######################################################################
75
79
"""Branch holding a history of revisions.
77
:todo: Perhaps use different stores for different classes of object,
78
so that we can keep track of how much space each one uses,
79
or garbage-collect them.
81
:todo: Add a RemoteBranch subclass. For the basic case of read-only
82
HTTP access this should be very easy by,
83
just redirecting controlfile access into HTTP requests.
84
We would need a RemoteStore working similarly.
86
:todo: Keep the on-disk branch locked while the object exists.
88
:todo: mkdir() method.
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
90
def __init__(self, base, init=False, find_root=True):
91
"""Create new branch object at a particular location.
93
:param base: Base directory for the branch.
95
:param init: If True, create new control files in a previously
96
unversioned directory. If False, the branch must already
99
:param find_root: If true and init is false, find the root of the
100
existing branch containing base.
102
In the test suite, creation of new trees is tested using the
103
`ScratchBranch` class.
106
self.base = os.path.realpath(base)
109
self.base = find_branch_root(base)
111
self.base = os.path.realpath(base)
112
if not isdir(self.controlfilename('.')):
113
bailout("not a bzr branch: %s" % quotefn(base),
114
['use "bzr init" to initialize a new working tree',
115
'current bzr can only operate from top-of-tree'])
118
self.text_store = ImmutableStore(self.controlfilename('text-store'))
119
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
120
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
124
return '%s(%r)' % (self.__class__.__name__, self.base)
130
def abspath(self, name):
131
"""Return absolute filename for something in the branch"""
132
return os.path.join(self.base, name)
135
def relpath(self, path):
136
"""Return path relative to this branch of something inside it.
138
Raises an error if path is not in this branch."""
139
rp = os.path.realpath(path)
141
if not rp.startswith(self.base):
142
bailout("path %r is not within branch %r" % (rp, self.base))
143
rp = rp[len(self.base):]
144
rp = rp.lstrip(os.sep)
148
def controlfilename(self, file_or_path):
149
"""Return location relative to branch."""
150
if isinstance(file_or_path, types.StringTypes):
151
file_or_path = [file_or_path]
152
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
155
def controlfile(self, file_or_path, mode='r'):
156
"""Open a control file for this branch"""
157
return file(self.controlfilename(file_or_path), mode)
160
def _make_control(self):
161
os.mkdir(self.controlfilename([]))
162
self.controlfile('README', 'w').write(
163
"This is a Bazaar-NG control directory.\n"
164
"Do not change any files in this directory.")
165
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
166
for d in ('text-store', 'inventory-store', 'revision-store'):
167
os.mkdir(self.controlfilename(d))
168
for f in ('revision-history', 'merged-patches',
169
'pending-merged-patches', 'branch-name'):
170
self.controlfile(f, 'w').write('')
171
mutter('created control directory in ' + self.base)
172
Inventory().write_xml(self.controlfile('inventory','w'))
175
def _check_format(self):
176
"""Check this branch format is supported.
178
The current tool only supports the current unstable format.
180
In the future, we might need different in-memory Branch
181
classes to support downlevel branches. But not yet.
183
# read in binary mode to detect newline wierdness.
184
fmt = self.controlfile('branch-format', 'rb').read()
185
if fmt != BZR_BRANCH_FORMAT:
186
bailout('sorry, branch format %r not supported' % fmt,
187
['use a different bzr version',
188
'or remove the .bzr directory and "bzr init" again'])
191
def read_working_inventory(self):
192
"""Read the working inventory."""
194
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
195
mutter("loaded inventory of %d items in %f"
196
% (len(inv), time.time() - before))
200
def _write_inventory(self, inv):
201
"""Update the working inventory.
203
That is to say, the inventory describing changes underway, that
204
will be committed to the next revision.
206
## TODO: factor out to atomicfile? is rename safe on windows?
207
## TODO: Maybe some kind of clean/dirty marker on inventory?
208
tmpfname = self.controlfilename('inventory.tmp')
209
tmpf = file(tmpfname, 'w')
212
os.rename(tmpfname, self.controlfilename('inventory'))
213
mutter('wrote working inventory')
216
inventory = property(read_working_inventory, _write_inventory, None,
217
"""Inventory for the working copy.""")
220
def add(self, files, verbose=False):
221
"""Make files versioned.
223
This puts the files in the Added state, so that they will be
224
recorded by the next commit.
226
:todo: Perhaps have an option to add the ids even if the files do
229
:todo: Perhaps return the ids of the files? But then again it
230
is easy to retrieve them if they're needed.
232
:todo: Option to specify file id.
234
:todo: Adding a directory should optionally recurse down and
235
add all non-ignored children. Perhaps do that in a
238
>>> b = ScratchBranch(files=['foo'])
239
>>> 'foo' in b.unknowns()
244
>>> 'foo' in b.unknowns()
246
>>> bool(b.inventory.path2id('foo'))
252
Traceback (most recent call last):
254
BzrError: ('foo is already versioned', [])
256
>>> b.add(['nothere'])
257
Traceback (most recent call last):
258
BzrError: ('cannot add: not a regular file or directory: nothere', [])
261
# TODO: Re-adding a file that is removed in the working copy
262
# should probably put it back with the previous ID.
263
if isinstance(files, types.StringTypes):
266
inv = self.read_working_inventory()
268
if is_control_file(f):
269
bailout("cannot add control file %s" % quotefn(f))
274
bailout("cannot add top-level %r" % f)
276
fullpath = os.path.normpath(self.abspath(f))
279
kind = file_kind(fullpath)
281
# maybe something better?
282
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
284
if kind != 'file' and kind != 'directory':
285
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
287
file_id = gen_file_id(f)
288
inv.add_path(f, kind=kind, file_id=file_id)
291
show_status('A', kind, quotefn(f))
293
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
295
self._write_inventory(inv)
299
def remove(self, files, verbose=False):
300
"""Mark nominated files for removal from the inventory.
302
This does not remove their text. This does not run on
304
:todo: Refuse to remove modified files unless --force is given?
306
>>> b = ScratchBranch(files=['foo'])
308
>>> b.inventory.has_filename('foo')
311
>>> b.working_tree().has_filename('foo')
313
>>> b.inventory.has_filename('foo')
316
>>> b = ScratchBranch(files=['foo'])
321
>>> b.inventory.has_filename('foo')
323
>>> b.basis_tree().has_filename('foo')
325
>>> b.working_tree().has_filename('foo')
328
:todo: Do something useful with directories.
330
:todo: Should this remove the text or not? Tough call; not
331
removing may be useful and the user can just use use rm, and
332
is the opposite of add. Removing it is consistent with most
333
other tools. Maybe an option.
335
## TODO: Normalize names
336
## TODO: Remove nested loops; better scalability
338
if isinstance(files, types.StringTypes):
341
tree = self.working_tree()
344
# do this before any modifications
348
bailout("cannot remove unversioned file %s" % quotefn(f))
349
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
351
# having remove it, it must be either ignored or unknown
352
if tree.is_ignored(f):
356
show_status(new_status, inv[fid].kind, quotefn(f))
359
self._write_inventory(inv)
363
"""Return all unknown files.
365
These are files in the working directory that are not versioned or
366
control files or ignored.
368
>>> b = ScratchBranch(files=['foo', 'foo~'])
369
>>> list(b.unknowns())
372
>>> list(b.unknowns())
375
>>> list(b.unknowns())
378
return self.working_tree().unknowns()
381
def commit(self, message, timestamp=None, timezone=None,
384
"""Commit working copy as a new revision.
386
The basic approach is to add all the file texts into the
387
store, then the inventory, then make a new revision pointing
388
to that inventory and store that.
390
This is not quite safe if the working copy changes during the
391
commit; for the moment that is simply not allowed. A better
392
approach is to make a temporary copy of the files before
393
computing their hashes, and then add those hashes in turn to
394
the inventory. This should mean at least that there are no
395
broken hash pointers. There is no way we can get a snapshot
396
of the whole directory at an instant. This would also have to
397
be robust against files disappearing, moving, etc. So the
398
whole thing is a bit hard.
400
:param timestamp: if not None, seconds-since-epoch for a
401
postdated/predated commit.
404
## TODO: Show branch names
406
# TODO: Don't commit if there are no changes, unless forced?
408
# First walk over the working inventory; and both update that
409
# and also build a new revision inventory. The revision
410
# inventory needs to hold the text-id, sha1 and size of the
411
# actual file versions committed in the revision. (These are
412
# not present in the working inventory.) We also need to
413
# detect missing/deleted files, and remove them from the
416
work_inv = self.read_working_inventory()
418
basis = self.basis_tree()
419
basis_inv = basis.inventory
421
for path, entry in work_inv.iter_entries():
422
## TODO: Cope with files that have gone missing.
424
## TODO: Check that the file kind has not changed from the previous
425
## revision of this file (if any).
429
p = self.abspath(path)
430
file_id = entry.file_id
431
mutter('commit prep file %s, id %r ' % (p, file_id))
433
if not os.path.exists(p):
434
mutter(" file is missing, removing from inventory")
436
show_status('D', entry.kind, quotefn(path))
437
missing_ids.append(file_id)
440
# TODO: Handle files that have been deleted
442
# TODO: Maybe a special case for empty files? Seems a
443
# waste to store them many times.
447
if basis_inv.has_id(file_id):
448
old_kind = basis_inv[file_id].kind
449
if old_kind != entry.kind:
450
bailout("entry %r changed kind from %r to %r"
451
% (file_id, old_kind, entry.kind))
453
if entry.kind == 'directory':
455
bailout("%s is entered as directory but not a directory" % quotefn(p))
456
elif entry.kind == 'file':
458
bailout("%s is entered as file but is not a file" % quotefn(p))
460
content = file(p, 'rb').read()
462
entry.text_sha1 = sha_string(content)
463
entry.text_size = len(content)
465
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
467
and (old_ie.text_size == entry.text_size)
468
and (old_ie.text_sha1 == entry.text_sha1)):
469
## assert content == basis.get_file(file_id).read()
470
entry.text_id = basis_inv[file_id].text_id
471
mutter(' unchanged from previous text_id {%s}' %
475
entry.text_id = gen_file_id(entry.name)
476
self.text_store.add(content, entry.text_id)
477
mutter(' stored with text_id {%s}' % entry.text_id)
481
elif (old_ie.name == entry.name
482
and old_ie.parent_id == entry.parent_id):
487
show_status(state, entry.kind, quotefn(path))
489
for file_id in missing_ids:
490
# have to do this later so we don't mess up the iterator.
491
# since parents may be removed before their children we
494
# FIXME: There's probably a better way to do this; perhaps
495
# the workingtree should know how to filter itself.
496
if work_inv.has_id(file_id):
497
del work_inv[file_id]
500
inv_id = rev_id = _gen_revision_id(time.time())
502
inv_tmp = tempfile.TemporaryFile()
503
inv.write_xml(inv_tmp)
505
self.inventory_store.add(inv_tmp, inv_id)
506
mutter('new inventory_id is {%s}' % inv_id)
508
self._write_inventory(work_inv)
510
if timestamp == None:
511
timestamp = time.time()
513
if committer == None:
514
committer = username()
517
timezone = local_time_offset()
519
mutter("building commit log message")
520
rev = Revision(timestamp=timestamp,
523
precursor = self.last_patch(),
528
rev_tmp = tempfile.TemporaryFile()
529
rev.write_xml(rev_tmp)
531
self.revision_store.add(rev_tmp, rev_id)
532
mutter("new revision_id is {%s}" % rev_id)
534
## XXX: Everything up to here can simply be orphaned if we abort
535
## the commit; it will leave junk files behind but that doesn't
538
## TODO: Read back the just-generated changeset, and make sure it
539
## applies and recreates the right state.
541
## TODO: Also calculate and store the inventory SHA1
542
mutter("committing patch r%d" % (self.revno() + 1))
544
mutter("append to revision-history")
545
f = self.controlfile('revision-history', 'at')
546
f.write(rev_id + '\n')
550
note("commited r%d" % self.revno())
553
def get_revision(self, revision_id):
554
"""Return the Revision object for a named revision"""
555
r = Revision.read_xml(self.revision_store[revision_id])
556
assert r.revision_id == revision_id
560
def get_inventory(self, inventory_id):
561
"""Get Inventory object by hash.
563
:todo: Perhaps for this and similar methods, take a revision
564
parameter which can be either an integer revno or a
566
i = Inventory.read_xml(self.inventory_store[inventory_id])
570
def get_revision_inventory(self, revision_id):
571
"""Return inventory of a past revision."""
572
if revision_id == None:
575
return self.get_inventory(self.get_revision(revision_id).inventory_id)
86
# this is really an instance variable - FIXME move it there
90
def __init__(self, *ignored, **ignored_too):
91
self.tags = self._format.make_tags(self)
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._partial_revision_history_cache = []
96
self._last_revision_info_cache = None
97
self._merge_sorted_revisions_cache = None
99
hooks = Branch.hooks['open']
103
def _open_hook(self):
104
"""Called by init to allow simpler extension of the base class."""
106
def _activate_fallback_location(self, url):
107
"""Activate the branch/repository from url as a fallback repository."""
108
repo = self._get_fallback_repository(url)
109
if repo.has_same_location(self.repository):
110
raise errors.UnstackableLocationError(self.base, url)
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
132
def _extend_partial_history(self, stop_index=None, stop_revision=None):
133
"""Extend the partial history to include a given index
135
If a stop_index is supplied, stop when that index has been reached.
136
If a stop_revision is supplied, stop when that revision is
137
encountered. Otherwise, stop when the beginning of history is
140
:param stop_index: The index which should be present. When it is
141
present, history extension will stop.
142
:param stop_revision: The revision id which should be present. When
143
it is encountered, history extension will stop.
145
if len(self._partial_revision_history_cache) == 0:
146
self._partial_revision_history_cache = [self.last_revision()]
147
repository._iter_for_revno(
148
self.repository, self._partial_revision_history_cache,
149
stop_index=stop_index, stop_revision=stop_revision)
150
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
151
self._partial_revision_history_cache.pop()
153
def _get_check_refs(self):
154
"""Get the references needed for check().
158
revid = self.last_revision()
159
return [('revision-existence', revid), ('lefthand-distance', revid)]
162
def open(base, _unsupported=False, possible_transports=None):
163
"""Open the branch rooted at base.
165
For instance, if the branch is at URL/.bzr/branch,
166
Branch.open(URL) -> a Branch instance.
168
control = bzrdir.BzrDir.open(base, _unsupported,
169
possible_transports=possible_transports)
170
return control.open_branch(_unsupported)
173
def open_from_transport(transport, _unsupported=False):
174
"""Open the branch rooted at transport"""
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(_unsupported)
179
def open_containing(url, possible_transports=None):
180
"""Open an existing branch which contains url.
182
This probes for a branch at url, and searches upwards from there.
184
Basically we keep looking up until we find the control directory or
185
run into the root. If there isn't one, raises NotBranchError.
186
If there is one and it is either an unrecognised format or an unsupported
187
format, UnknownFormatError or UnsupportedFormatError are raised.
188
If there is one, it is returned, along with the unused portion of url.
190
control, relpath = bzrdir.BzrDir.open_containing(url,
192
return control.open_branch(), relpath
194
def _push_should_merge_tags(self):
195
"""Should _basic_push merge this branch's tags into the target?
197
The default implementation returns False if this branch has no tags,
198
and True the rest of the time. Subclasses may override this.
200
return self.supports_tags() and self.tags.get_tag_dict()
202
def get_config(self):
203
return BranchConfig(self)
205
def _get_config(self):
206
"""Get the concrete config for just the config in this branch.
208
This is not intended for client use; see Branch.get_config for the
213
:return: An object supporting get_option and set_option.
215
raise NotImplementedError(self._get_config)
217
def _get_fallback_repository(self, url):
218
"""Get the repository we fallback to at url."""
219
url = urlutils.join(self.base, url)
220
a_bzrdir = bzrdir.BzrDir.open(url,
221
possible_transports=[self.bzrdir.root_transport])
222
return a_bzrdir.open_branch().repository
224
def _get_tags_bytes(self):
225
"""Get the bytes of a serialised tags dict.
227
Note that not all branches support tags, nor do all use the same tags
228
logic: this method is specific to BasicTags. Other tag implementations
229
may use the same method name and behave differently, safely, because
230
of the double-dispatch via
231
format.make_tags->tags_instance->get_tags_dict.
233
:return: The bytes of the tags file.
234
:seealso: Branch._set_tags_bytes.
236
return self._transport.get_bytes('tags')
238
def _get_nick(self, local=False, possible_transports=None):
239
config = self.get_config()
240
# explicit overrides master, but don't look for master if local is True
241
if not local and not config.has_explicit_nickname():
243
master = self.get_master_branch(possible_transports)
244
if master is not None:
245
# return the master branch value
247
except errors.BzrError, e:
248
# Silently fall back to local implicit nick if the master is
250
mutter("Could not connect to bound branch, "
251
"falling back to local nick.\n " + str(e))
252
return config.get_nickname()
254
def _set_nick(self, nick):
255
self.get_config().set_user_option('nickname', nick, warn_masked=True)
257
nick = property(_get_nick, _set_nick)
260
raise NotImplementedError(self.is_locked)
262
def _lefthand_history(self, revision_id, last_rev=None,
264
if 'evil' in debug.debug_flags:
265
mutter_callsite(4, "_lefthand_history scales with history.")
266
# stop_revision must be a descendant of last_revision
267
graph = self.repository.get_graph()
268
if last_rev is not None:
269
if not graph.is_ancestor(last_rev, revision_id):
270
# our previous tip is not merged into stop_revision
271
raise errors.DivergedBranches(self, other_branch)
272
# make a new revision history from the graph
273
parents_map = graph.get_parent_map([revision_id])
274
if revision_id not in parents_map:
275
raise errors.NoSuchRevision(self, revision_id)
276
current_rev_id = revision_id
278
check_not_reserved_id = _mod_revision.check_not_reserved_id
279
# Do not include ghosts or graph origin in revision_history
280
while (current_rev_id in parents_map and
281
len(parents_map[current_rev_id]) > 0):
282
check_not_reserved_id(current_rev_id)
283
new_history.append(current_rev_id)
284
current_rev_id = parents_map[current_rev_id][0]
285
parents_map = graph.get_parent_map([current_rev_id])
286
new_history.reverse()
289
def lock_write(self):
290
raise NotImplementedError(self.lock_write)
293
raise NotImplementedError(self.lock_read)
296
raise NotImplementedError(self.unlock)
298
def peek_lock_mode(self):
299
"""Return lock mode for the Branch: 'r', 'w' or None"""
300
raise NotImplementedError(self.peek_lock_mode)
302
def get_physical_lock_status(self):
303
raise NotImplementedError(self.get_physical_lock_status)
306
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
307
"""Return the revision_id for a dotted revno.
309
:param revno: a tuple like (1,) or (1,1,2)
310
:param _cache_reverse: a private parameter enabling storage
311
of the reverse mapping in a top level cache. (This should
312
only be done in selective circumstances as we want to
313
avoid having the mapping cached multiple times.)
314
:return: the revision_id
315
:raises errors.NoSuchRevision: if the revno doesn't exist
317
rev_id = self._do_dotted_revno_to_revision_id(revno)
319
self._partial_revision_id_to_revno_cache[rev_id] = revno
322
def _do_dotted_revno_to_revision_id(self, revno):
323
"""Worker function for dotted_revno_to_revision_id.
325
Subclasses should override this if they wish to
326
provide a more efficient implementation.
329
return self.get_rev_id(revno[0])
330
revision_id_to_revno = self.get_revision_id_to_revno_map()
331
revision_ids = [revision_id for revision_id, this_revno
332
in revision_id_to_revno.iteritems()
333
if revno == this_revno]
334
if len(revision_ids) == 1:
335
return revision_ids[0]
337
revno_str = '.'.join(map(str, revno))
338
raise errors.NoSuchRevision(self, revno_str)
341
def revision_id_to_dotted_revno(self, revision_id):
342
"""Given a revision id, return its dotted revno.
344
:return: a tuple like (1,) or (400,1,3).
346
return self._do_revision_id_to_dotted_revno(revision_id)
348
def _do_revision_id_to_dotted_revno(self, revision_id):
349
"""Worker function for revision_id_to_revno."""
350
# Try the caches if they are loaded
351
result = self._partial_revision_id_to_revno_cache.get(revision_id)
352
if result is not None:
354
if self._revision_id_to_revno_cache:
355
result = self._revision_id_to_revno_cache.get(revision_id)
357
raise errors.NoSuchRevision(self, revision_id)
358
# Try the mainline as it's optimised
360
revno = self.revision_id_to_revno(revision_id)
362
except errors.NoSuchRevision:
363
# We need to load and use the full revno map after all
364
result = self.get_revision_id_to_revno_map().get(revision_id)
366
raise errors.NoSuchRevision(self, revision_id)
370
def get_revision_id_to_revno_map(self):
371
"""Return the revision_id => dotted revno map.
373
This will be regenerated on demand, but will be cached.
375
:return: A dictionary mapping revision_id => dotted revno.
376
This dictionary should not be modified by the caller.
378
if self._revision_id_to_revno_cache is not None:
379
mapping = self._revision_id_to_revno_cache
381
mapping = self._gen_revno_map()
382
self._cache_revision_id_to_revno(mapping)
383
# TODO: jam 20070417 Since this is being cached, should we be returning
385
# I would rather not, and instead just declare that users should not
386
# modify the return value.
389
def _gen_revno_map(self):
390
"""Create a new mapping from revision ids to dotted revnos.
392
Dotted revnos are generated based on the current tip in the revision
394
This is the worker function for get_revision_id_to_revno_map, which
395
just caches the return value.
397
:return: A dictionary mapping revision_id => dotted revno.
399
revision_id_to_revno = dict((rev_id, revno)
400
for rev_id, depth, revno, end_of_merge
401
in self.iter_merge_sorted_revisions())
402
return revision_id_to_revno
405
def iter_merge_sorted_revisions(self, start_revision_id=None,
406
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
407
"""Walk the revisions for a branch in merge sorted order.
409
Merge sorted order is the output from a merge-aware,
410
topological sort, i.e. all parents come before their
411
children going forward; the opposite for reverse.
413
:param start_revision_id: the revision_id to begin walking from.
414
If None, the branch tip is used.
415
:param stop_revision_id: the revision_id to terminate the walk
416
after. If None, the rest of history is included.
417
:param stop_rule: if stop_revision_id is not None, the precise rule
418
to use for termination:
419
* 'exclude' - leave the stop revision out of the result (default)
420
* 'include' - the stop revision is the last item in the result
421
* 'with-merges' - include the stop revision and all of its
422
merged revisions in the result
423
:param direction: either 'reverse' or 'forward':
424
* reverse means return the start_revision_id first, i.e.
425
start at the most recent revision and go backwards in history
426
* forward returns tuples in the opposite order to reverse.
427
Note in particular that forward does *not* do any intelligent
428
ordering w.r.t. depth as some clients of this API may like.
429
(If required, that ought to be done at higher layers.)
431
:return: an iterator over (revision_id, depth, revno, end_of_merge)
434
* revision_id: the unique id of the revision
435
* depth: How many levels of merging deep this node has been
437
* revno_sequence: This field provides a sequence of
438
revision numbers for all revisions. The format is:
439
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
440
branch that the revno is on. From left to right the REVNO numbers
441
are the sequence numbers within that branch of the revision.
442
* end_of_merge: When True the next node (earlier in history) is
443
part of a different merge.
445
# Note: depth and revno values are in the context of the branch so
446
# we need the full graph to get stable numbers, regardless of the
448
if self._merge_sorted_revisions_cache is None:
449
last_revision = self.last_revision()
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
455
filtered = self._filter_merge_sorted_revisions(
456
self._merge_sorted_revisions_cache, start_revision_id,
457
stop_revision_id, stop_rule)
458
if direction == 'reverse':
460
if direction == 'forward':
461
return reversed(list(filtered))
463
raise ValueError('invalid direction %r' % direction)
465
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
466
start_revision_id, stop_revision_id, stop_rule):
467
"""Iterate over an inclusive range of sorted revisions."""
468
rev_iter = iter(merge_sorted_revisions)
469
if start_revision_id is not None:
470
for node in rev_iter:
471
rev_id = node.key[-1]
472
if rev_id != start_revision_id:
475
# The decision to include the start or not
476
# depends on the stop_rule if a stop is provided
477
# so pop this node back into the iterator
478
rev_iter = chain(iter([node]), rev_iter)
480
if stop_revision_id is None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
yield (rev_id, node.merge_depth, node.revno,
486
elif stop_rule == 'exclude':
487
for node in rev_iter:
488
rev_id = node.key[-1]
489
if rev_id == stop_revision_id:
491
yield (rev_id, node.merge_depth, node.revno,
493
elif stop_rule == 'include':
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
if rev_id == stop_revision_id:
500
elif stop_rule == 'with-merges':
501
stop_rev = self.repository.get_revision(stop_revision_id)
502
if stop_rev.parent_ids:
503
left_parent = stop_rev.parent_ids[0]
505
left_parent = _mod_revision.NULL_REVISION
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
if rev_id == left_parent:
510
yield (rev_id, node.merge_depth, node.revno,
513
raise ValueError('invalid stop_rule %r' % stop_rule)
515
def leave_lock_in_place(self):
516
"""Tell this branch object not to release the physical lock when this
519
If lock_write doesn't return a token, then this method is not supported.
521
self.control_files.leave_in_place()
523
def dont_leave_lock_in_place(self):
524
"""Tell this branch object to release the physical lock when this
525
object is unlocked, even if it didn't originally acquire it.
527
If lock_write doesn't return a token, then this method is not supported.
529
self.control_files.dont_leave_in_place()
531
def bind(self, other):
532
"""Bind the local branch the other branch.
534
:param other: The branch to bind to
537
raise errors.UpgradeRequired(self.base)
539
def set_append_revisions_only(self, enabled):
540
if not self._format.supports_set_append_revisions_only():
541
raise errors.UpgradeRequired(self.base)
546
self.get_config().set_user_option('append_revisions_only', value,
549
def set_reference_info(self, file_id, tree_path, branch_location):
550
"""Set the branch location to use for a tree reference."""
551
raise errors.UnsupportedOperation(self.set_reference_info, self)
553
def get_reference_info(self, file_id):
554
"""Get the tree_path and branch_location for a tree reference."""
555
raise errors.UnsupportedOperation(self.get_reference_info, self)
558
def fetch(self, from_branch, last_revision=None, pb=None):
559
"""Copy revisions from from_branch into this branch.
561
:param from_branch: Where to copy from.
562
:param last_revision: What revision to stop at (None for at the end
564
:param pb: An optional progress bar to use.
567
if self.base == from_branch.base:
570
symbol_versioning.warn(
571
symbol_versioning.deprecated_in((1, 14, 0))
572
% "pb parameter to fetch()")
573
from_branch.lock_read()
575
if last_revision is None:
576
last_revision = from_branch.last_revision()
577
last_revision = _mod_revision.ensure_null(last_revision)
578
return self.repository.fetch(from_branch.repository,
579
revision_id=last_revision,
584
def get_bound_location(self):
585
"""Return the URL of the branch we are bound to.
587
Older format branches cannot bind, please be sure to use a metadir
592
def get_old_bound_location(self):
593
"""Return the URL of the branch we used to be bound to
595
raise errors.UpgradeRequired(self.base)
597
def get_commit_builder(self, parents, config=None, timestamp=None,
598
timezone=None, committer=None, revprops=None,
600
"""Obtain a CommitBuilder for this branch.
602
:param parents: Revision ids of the parents of the new revision.
603
:param config: Optional configuration to use.
604
:param timestamp: Optional timestamp recorded for commit.
605
:param timezone: Optional timezone for timestamp.
606
:param committer: Optional committer to set for commit.
607
:param revprops: Optional dictionary of revision properties.
608
:param revision_id: Optional revision id.
612
config = self.get_config()
614
return self.repository.get_commit_builder(self, parents, config,
615
timestamp, timezone, committer, revprops, revision_id)
617
def get_master_branch(self, possible_transports=None):
618
"""Return the branch we are bound to.
620
:return: Either a Branch, or None
624
def get_revision_delta(self, revno):
625
"""Return the delta for one revision.
627
The delta is relative to its mainline predecessor, or the
628
empty tree for revision 1.
630
rh = self.revision_history()
631
if not (1 <= revno <= len(rh)):
632
raise errors.InvalidRevisionNumber(revno)
633
return self.repository.get_revision_delta(rh[revno-1])
635
def get_stacked_on_url(self):
636
"""Get the URL this branch is stacked against.
638
:raises NotStacked: If the branch is not stacked.
639
:raises UnstackableBranchFormat: If the branch does not support
642
raise NotImplementedError(self.get_stacked_on_url)
644
def print_file(self, file, revision_id):
645
"""Print `file` to stdout."""
646
raise NotImplementedError(self.print_file)
648
def set_revision_history(self, rev_history):
649
raise NotImplementedError(self.set_revision_history)
652
def set_parent(self, url):
653
"""See Branch.set_parent."""
654
# TODO: Maybe delete old location files?
655
# URLs should never be unicode, even on the local fs,
656
# FIXUP this and get_parent in a future branch format bump:
657
# read and rewrite the file. RBC 20060125
659
if isinstance(url, unicode):
661
url = url.encode('ascii')
662
except UnicodeEncodeError:
663
raise errors.InvalidURL(url,
664
"Urls must be 7-bit ascii, "
665
"use bzrlib.urlutils.escape")
666
url = urlutils.relative_url(self.base, url)
667
self._set_parent_location(url)
670
def set_stacked_on_url(self, url):
671
"""Set the URL this branch is stacked against.
673
:raises UnstackableBranchFormat: If the branch does not support
675
:raises UnstackableRepositoryFormat: If the repository does not support
678
if not self._format.supports_stacking():
679
raise errors.UnstackableBranchFormat(self._format, self.base)
680
# XXX: Changing from one fallback repository to another does not check
681
# that all the data you need is present in the new fallback.
682
# Possibly it should.
683
self._check_stackable_repo()
686
old_url = self.get_stacked_on_url()
687
except (errors.NotStacked, errors.UnstackableBranchFormat,
688
errors.UnstackableRepositoryFormat):
692
self._activate_fallback_location(url)
693
# write this out after the repository is stacked to avoid setting a
694
# stacked config that doesn't work.
695
self._set_config_location('stacked_on_location', url)
698
"""Change a branch to be unstacked, copying data as needed.
700
Don't call this directly, use set_stacked_on_url(None).
702
pb = ui.ui_factory.nested_progress_bar()
704
pb.update("Unstacking")
705
# The basic approach here is to fetch the tip of the branch,
706
# including all available ghosts, from the existing stacked
707
# repository into a new repository object without the fallbacks.
709
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
710
# correct for CHKMap repostiories
711
old_repository = self.repository
712
if len(old_repository._fallback_repositories) != 1:
713
raise AssertionError("can't cope with fallback repositories "
714
"of %r" % (self.repository,))
715
# unlock it, including unlocking the fallback
716
old_repository.unlock()
717
old_repository.lock_read()
719
# Repositories don't offer an interface to remove fallback
720
# repositories today; take the conceptually simpler option and just
721
# reopen it. We reopen it starting from the URL so that we
722
# get a separate connection for RemoteRepositories and can
723
# stream from one of them to the other. This does mean doing
724
# separate SSH connection setup, but unstacking is not a
725
# common operation so it's tolerable.
726
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
727
new_repository = new_bzrdir.find_repository()
728
self.repository = new_repository
729
if self.repository._fallback_repositories:
730
raise AssertionError("didn't expect %r to have "
731
"fallback_repositories"
732
% (self.repository,))
733
# this is not paired with an unlock because it's just restoring
734
# the previous state; the lock's released when set_stacked_on_url
736
self.repository.lock_write()
737
# XXX: If you unstack a branch while it has a working tree
738
# with a pending merge, the pending-merged revisions will no
739
# longer be present. You can (probably) revert and remerge.
741
# XXX: This only fetches up to the tip of the repository; it
742
# doesn't bring across any tags. That's fairly consistent
743
# with how branch works, but perhaps not ideal.
744
self.repository.fetch(old_repository,
745
revision_id=self.last_revision(),
748
old_repository.unlock()
752
def _set_tags_bytes(self, bytes):
753
"""Mirror method for _get_tags_bytes.
755
:seealso: Branch._get_tags_bytes.
757
return _run_with_write_locked_target(self, self._transport.put_bytes,
760
def _cache_revision_history(self, rev_history):
761
"""Set the cached revision history to rev_history.
763
The revision_history method will use this cache to avoid regenerating
764
the revision history.
766
This API is semi-public; it only for use by subclasses, all other code
767
should consider it to be private.
769
self._revision_history_cache = rev_history
771
def _cache_revision_id_to_revno(self, revision_id_to_revno):
772
"""Set the cached revision_id => revno map to revision_id_to_revno.
774
This API is semi-public; it only for use by subclasses, all other code
775
should consider it to be private.
777
self._revision_id_to_revno_cache = revision_id_to_revno
779
def _clear_cached_state(self):
780
"""Clear any cached data on this branch, e.g. cached revision history.
782
This means the next call to revision_history will need to call
783
_gen_revision_history.
785
This API is semi-public; it only for use by subclasses, all other code
786
should consider it to be private.
788
self._revision_history_cache = None
789
self._revision_id_to_revno_cache = None
790
self._last_revision_info_cache = None
791
self._merge_sorted_revisions_cache = None
792
self._partial_revision_history_cache = []
793
self._partial_revision_id_to_revno_cache = {}
795
def _gen_revision_history(self):
796
"""Return sequence of revision hashes on to this branch.
798
Unlike revision_history, this method always regenerates or rereads the
799
revision history, i.e. it does not cache the result, so repeated calls
802
Concrete subclasses should override this instead of revision_history so
803
that subclasses do not need to deal with caching logic.
805
This API is semi-public; it only for use by subclasses, all other code
806
should consider it to be private.
808
raise NotImplementedError(self._gen_revision_history)
578
811
def revision_history(self):
579
"""Return sequence of revision hashes on to this branch.
812
"""Return sequence of revision ids on this branch.
581
>>> ScratchBranch().revision_history()
814
This method will cache the revision history for as long as it is safe to
584
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
817
if 'evil' in debug.debug_flags:
818
mutter_callsite(3, "revision_history scales with history.")
819
if self._revision_history_cache is not None:
820
history = self._revision_history_cache
822
history = self._gen_revision_history()
823
self._cache_revision_history(history)
588
827
"""Return current revision number for this branch.
590
829
That is equivalent to the number of revisions committed to
593
>>> b = ScratchBranch()
596
>>> b.commit('no foo')
600
return len(self.revision_history())
603
def last_patch(self):
604
"""Return last patch hash, or None if no history.
606
>>> ScratchBranch().last_patch() == None
609
ph = self.revision_history()
614
def lookup_revision(self, revno):
615
"""Return revision hash for revision number."""
620
# list is 0-based; revisions are 1-based
621
return self.revision_history()[revno-1]
623
bailout("no such revision %s" % revno)
626
def revision_tree(self, revision_id):
627
"""Return Tree for a revision on this branch.
629
`revision_id` may be None for the null revision, in which case
630
an `EmptyTree` is returned."""
632
if revision_id == None:
635
inv = self.get_revision_inventory(revision_id)
636
return RevisionTree(self.text_store, inv)
639
def working_tree(self):
640
"""Return a `Tree` for the working copy."""
641
return WorkingTree(self.base, self.read_working_inventory())
644
def basis_tree(self):
645
"""Return `Tree` object for last revision.
647
If there are no revisions yet, return an `EmptyTree`.
649
>>> b = ScratchBranch(files=['foo'])
650
>>> b.basis_tree().has_filename('foo')
652
>>> b.working_tree().has_filename('foo')
655
>>> b.commit('add foo')
656
>>> b.basis_tree().has_filename('foo')
659
r = self.last_patch()
663
return RevisionTree(self.text_store, self.get_revision_inventory(r))
667
def write_log(self, show_timezone='original'):
668
"""Write out human-readable log of commits to this branch
670
:param utc: If true, show dates in universal time, not local time."""
671
## TODO: Option to choose either original, utc or local timezone
674
for p in self.revision_history():
676
print 'revno:', revno
677
## TODO: Show hash if --id is given.
678
##print 'revision-hash:', p
679
rev = self.get_revision(p)
680
print 'committer:', rev.committer
681
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
684
## opportunistic consistency check, same as check_patch_chaining
685
if rev.precursor != precursor:
686
bailout("mismatched precursor!")
690
print ' (no message)'
692
for l in rev.message.split('\n'):
700
def show_status(branch, show_all=False):
701
"""Display single-line status for non-ignored working files.
703
The list is show sorted in order by file name.
705
>>> b = ScratchBranch(files=['foo', 'foo~'])
711
>>> b.commit("add foo")
713
>>> os.unlink(b.abspath('foo'))
718
:todo: Get state for single files.
720
:todo: Perhaps show a slash at the end of directory names.
724
# We have to build everything into a list first so that it can
725
# sorted by name, incorporating all the different sources.
727
# FIXME: Rather than getting things in random order and then sorting,
728
# just step through in order.
730
# Interesting case: the old ID for a file has been removed,
731
# but a new file has been created under that name.
733
old = branch.basis_tree()
734
old_inv = old.inventory
735
new = branch.working_tree()
736
new_inv = new.inventory
738
for fs, fid, oldname, newname, kind in diff_trees(old, new):
740
show_status(fs, kind,
741
oldname + ' => ' + newname)
742
elif fs == 'A' or fs == 'M':
743
show_status(fs, kind, newname)
745
show_status(fs, kind, oldname)
748
show_status(fs, kind, newname)
751
show_status(fs, kind, newname)
753
show_status(fs, kind, newname)
755
bailout("wierd file state %r" % ((fs, fid),))
759
class ScratchBranch(Branch):
760
"""Special test class: a branch that cleans up after itself.
762
>>> b = ScratchBranch()
770
def __init__(self, files=[], dirs=[]):
771
"""Make a test branch.
773
This creates a temporary directory and runs init-tree in it.
775
If any files are listed, they are created in the working copy.
777
Branch.__init__(self, tempfile.mkdtemp(), init=True)
779
os.mkdir(self.abspath(d))
782
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
786
"""Destroy the test branch, removing the scratch directory."""
787
shutil.rmtree(self.base)
832
return self.last_revision_info()[0]
835
"""Older format branches cannot bind or unbind."""
836
raise errors.UpgradeRequired(self.base)
838
def last_revision(self):
839
"""Return last revision id, or NULL_REVISION."""
840
return self.last_revision_info()[1]
843
def last_revision_info(self):
844
"""Return information about the last revision.
846
:return: A tuple (revno, revision_id).
848
if self._last_revision_info_cache is None:
849
self._last_revision_info_cache = self._last_revision_info()
850
return self._last_revision_info_cache
852
def _last_revision_info(self):
853
rh = self.revision_history()
856
return (revno, rh[-1])
858
return (0, _mod_revision.NULL_REVISION)
860
@deprecated_method(deprecated_in((1, 6, 0)))
861
def missing_revisions(self, other, stop_revision=None):
862
"""Return a list of new revisions that would perfectly fit.
864
If self and other have not diverged, return a list of the revisions
865
present in other, but missing from self.
867
self_history = self.revision_history()
868
self_len = len(self_history)
869
other_history = other.revision_history()
870
other_len = len(other_history)
871
common_index = min(self_len, other_len) -1
872
if common_index >= 0 and \
873
self_history[common_index] != other_history[common_index]:
874
raise errors.DivergedBranches(self, other)
876
if stop_revision is None:
877
stop_revision = other_len
879
if stop_revision > other_len:
880
raise errors.NoSuchRevision(self, stop_revision)
881
return other_history[self_len:stop_revision]
884
def update_revisions(self, other, stop_revision=None, overwrite=False,
886
"""Pull in new perfect-fit revisions.
888
:param other: Another Branch to pull from
889
:param stop_revision: Updated until the given revision
890
:param overwrite: Always set the branch pointer, rather than checking
891
to see if it is a proper descendant.
892
:param graph: A Graph object that can be used to query history
893
information. This can be None.
896
return InterBranch.get(other, self).update_revisions(stop_revision,
899
def import_last_revision_info(self, source_repo, revno, revid):
900
"""Set the last revision info, importing from another repo if necessary.
902
This is used by the bound branch code to upload a revision to
903
the master branch first before updating the tip of the local branch.
905
:param source_repo: Source repository to optionally fetch from
906
:param revno: Revision number of the new tip
907
:param revid: Revision id of the new tip
909
if not self.repository.has_same_location(source_repo):
910
self.repository.fetch(source_repo, revision_id=revid)
911
self.set_last_revision_info(revno, revid)
913
def revision_id_to_revno(self, revision_id):
914
"""Given a revision id, return its revno"""
915
if _mod_revision.is_null(revision_id):
917
history = self.revision_history()
919
return history.index(revision_id) + 1
921
raise errors.NoSuchRevision(self, revision_id)
924
def get_rev_id(self, revno, history=None):
925
"""Find the revision id of the specified revno."""
927
return _mod_revision.NULL_REVISION
928
last_revno, last_revid = self.last_revision_info()
929
if revno == last_revno:
931
if revno <= 0 or revno > last_revno:
932
raise errors.NoSuchRevision(self, revno)
933
distance_from_last = last_revno - revno
934
if len(self._partial_revision_history_cache) <= distance_from_last:
935
self._extend_partial_history(distance_from_last)
936
return self._partial_revision_history_cache[distance_from_last]
939
def pull(self, source, overwrite=False, stop_revision=None,
940
possible_transports=None, *args, **kwargs):
941
"""Mirror source into this branch.
943
This branch is considered to be 'local', having low latency.
945
:returns: PullResult instance
947
return InterBranch.get(source, self).pull(overwrite=overwrite,
948
stop_revision=stop_revision,
949
possible_transports=possible_transports, *args, **kwargs)
951
def push(self, target, overwrite=False, stop_revision=None, *args,
953
"""Mirror this branch into target.
955
This branch is considered to be 'local', having low latency.
957
return InterBranch.get(self, target).push(overwrite, stop_revision,
960
def lossy_push(self, target, stop_revision=None):
961
"""Push deltas into another branch.
963
:note: This does not, like push, retain the revision ids from
964
the source branch and will, rather than adding bzr-specific
965
metadata, push only those semantics of the revision that can be
966
natively represented by this branch' VCS.
968
:param target: Target branch
969
:param stop_revision: Revision to push, defaults to last revision.
970
:return: BranchPushResult with an extra member revidmap:
971
A dictionary mapping revision ids from the target branch
972
to new revision ids in the target branch, for each
973
revision that was pushed.
975
inter = InterBranch.get(self, target)
976
lossy_push = getattr(inter, "lossy_push", None)
977
if lossy_push is None:
978
raise errors.LossyPushToSameVCS(self, target)
979
return lossy_push(stop_revision)
981
def basis_tree(self):
982
"""Return `Tree` object for last revision."""
983
return self.repository.revision_tree(self.last_revision())
985
def get_parent(self):
986
"""Return the parent location of the branch.
988
This is the default location for pull/missing. The usual
989
pattern is that the user can override it by specifying a
992
parent = self._get_parent_location()
995
# This is an old-format absolute path to a local branch
997
if parent.startswith('/'):
998
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1000
return urlutils.join(self.base[:-1], parent)
1001
except errors.InvalidURLJoin, e:
1002
raise errors.InaccessibleParent(parent, self.base)
1004
def _get_parent_location(self):
1005
raise NotImplementedError(self._get_parent_location)
1007
def _set_config_location(self, name, url, config=None,
1008
make_relative=False):
1010
config = self.get_config()
1014
url = urlutils.relative_url(self.base, url)
1015
config.set_user_option(name, url, warn_masked=True)
1017
def _get_config_location(self, name, config=None):
1019
config = self.get_config()
1020
location = config.get_user_option(name)
1025
def get_child_submit_format(self):
1026
"""Return the preferred format of submissions to this branch."""
1027
return self.get_config().get_user_option("child_submit_format")
1029
def get_submit_branch(self):
1030
"""Return the submit location of the branch.
1032
This is the default location for bundle. The usual
1033
pattern is that the user can override it by specifying a
1036
return self.get_config().get_user_option('submit_branch')
1038
def set_submit_branch(self, location):
1039
"""Return the submit location of the branch.
1041
This is the default location for bundle. The usual
1042
pattern is that the user can override it by specifying a
1045
self.get_config().set_user_option('submit_branch', location,
1048
def get_public_branch(self):
1049
"""Return the public location of the branch.
1051
This is used by merge directives.
1053
return self._get_config_location('public_branch')
1055
def set_public_branch(self, location):
1056
"""Return the submit location of the branch.
1058
This is the default location for bundle. The usual
1059
pattern is that the user can override it by specifying a
1062
self._set_config_location('public_branch', location)
1064
def get_push_location(self):
1065
"""Return the None or the location to push this branch to."""
1066
push_loc = self.get_config().get_user_option('push_location')
1069
def set_push_location(self, location):
1070
"""Set a new push location for this branch."""
1071
raise NotImplementedError(self.set_push_location)
1073
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1074
"""Run the post_change_branch_tip hooks."""
1075
hooks = Branch.hooks['post_change_branch_tip']
1078
new_revno, new_revid = self.last_revision_info()
1079
params = ChangeBranchTipParams(
1080
self, old_revno, new_revno, old_revid, new_revid)
1084
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1085
"""Run the pre_change_branch_tip hooks."""
1086
hooks = Branch.hooks['pre_change_branch_tip']
1089
old_revno, old_revid = self.last_revision_info()
1090
params = ChangeBranchTipParams(
1091
self, old_revno, new_revno, old_revid, new_revid)
1095
except errors.TipChangeRejected:
1098
exc_info = sys.exc_info()
1099
hook_name = Branch.hooks.get_hook_name(hook)
1100
raise errors.HookFailed(
1101
'pre_change_branch_tip', hook_name, exc_info)
1105
"""Synchronise this branch with the master branch if any.
1107
:return: None or the last_revision pivoted out during the update.
1111
def check_revno(self, revno):
1113
Check whether a revno corresponds to any revision.
1114
Zero (the NULL revision) is considered valid.
1117
self.check_real_revno(revno)
1119
def check_real_revno(self, revno):
1121
Check whether a revno corresponds to a real revision.
1122
Zero (the NULL revision) is considered invalid
1124
if revno < 1 or revno > self.revno():
1125
raise errors.InvalidRevisionNumber(revno)
1128
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1129
"""Clone this branch into to_bzrdir preserving all semantic values.
1131
Most API users will want 'create_clone_on_transport', which creates a
1132
new bzrdir and branch on the fly.
1134
revision_id: if not None, the revision history in the new branch will
1135
be truncated to end with revision_id.
1137
result = to_bzrdir.create_branch()
1140
if repository_policy is not None:
1141
repository_policy.configure_branch(result)
1142
self.copy_content_into(result, revision_id=revision_id)
1148
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1149
"""Create a new line of development from the branch, into to_bzrdir.
1151
to_bzrdir controls the branch format.
1153
revision_id: if not None, the revision history in the new branch will
1154
be truncated to end with revision_id.
1156
if (repository_policy is not None and
1157
repository_policy.requires_stacking()):
1158
to_bzrdir._format.require_stacking(_skip_repo=True)
1159
result = to_bzrdir.create_branch()
1162
if repository_policy is not None:
1163
repository_policy.configure_branch(result)
1164
self.copy_content_into(result, revision_id=revision_id)
1165
result.set_parent(self.bzrdir.root_transport.base)
1170
def _synchronize_history(self, destination, revision_id):
1171
"""Synchronize last revision and revision history between branches.
1173
This version is most efficient when the destination is also a
1174
BzrBranch6, but works for BzrBranch5, as long as the destination's
1175
repository contains all the lefthand ancestors of the intended
1176
last_revision. If not, set_last_revision_info will fail.
1178
:param destination: The branch to copy the history into
1179
:param revision_id: The revision-id to truncate history at. May
1180
be None to copy complete history.
1182
source_revno, source_revision_id = self.last_revision_info()
1183
if revision_id is None:
1184
revno, revision_id = source_revno, source_revision_id
1186
graph = self.repository.get_graph()
1188
revno = graph.find_distance_to_null(revision_id,
1189
[(source_revision_id, source_revno)])
1190
except errors.GhostRevisionsHaveNoRevno:
1191
# Default to 1, if we can't find anything else
1193
destination.set_last_revision_info(revno, revision_id)
1196
def copy_content_into(self, destination, revision_id=None):
1197
"""Copy the content of self into destination.
1199
revision_id: if not None, the revision history in the new branch will
1200
be truncated to end with revision_id.
1202
self.update_references(destination)
1203
self._synchronize_history(destination, revision_id)
1205
parent = self.get_parent()
1206
except errors.InaccessibleParent, e:
1207
mutter('parent was not accessible to copy: %s', e)
1210
destination.set_parent(parent)
1211
if self._push_should_merge_tags():
1212
self.tags.merge_to(destination.tags)
1214
def update_references(self, target):
1215
if not getattr(self._format, 'supports_reference_locations', False):
1217
reference_dict = self._get_all_reference_info()
1218
if len(reference_dict) == 0:
1220
old_base = self.base
1221
new_base = target.base
1222
target_reference_dict = target._get_all_reference_info()
1223
for file_id, (tree_path, branch_location) in (
1224
reference_dict.items()):
1225
branch_location = urlutils.rebase_url(branch_location,
1227
target_reference_dict.setdefault(
1228
file_id, (tree_path, branch_location))
1229
target._set_all_reference_info(target_reference_dict)
1232
def check(self, refs):
1233
"""Check consistency of the branch.
1235
In particular this checks that revisions given in the revision-history
1236
do actually match up in the revision graph, and that they're all
1237
present in the repository.
1239
Callers will typically also want to check the repository.
1241
:param refs: Calculated refs for this branch as specified by
1242
branch._get_check_refs()
1243
:return: A BranchCheckResult.
1245
result = BranchCheckResult(self)
1246
last_revno, last_revision_id = self.last_revision_info()
1247
actual_revno = refs[('lefthand-distance', last_revision_id)]
1248
if actual_revno != last_revno:
1249
result.errors.append(errors.BzrCheckError(
1250
'revno does not match len(mainline) %s != %s' % (
1251
last_revno, actual_revno)))
1252
# TODO: We should probably also check that self.revision_history
1253
# matches the repository for older branch formats.
1254
# If looking for the code that cross-checks repository parents against
1255
# the iter_reverse_revision_history output, that is now a repository
1259
def _get_checkout_format(self):
1260
"""Return the most suitable metadir for a checkout of this branch.
1261
Weaves are used if this branch's repository uses weaves.
1263
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1264
from bzrlib.repofmt import weaverepo
1265
format = bzrdir.BzrDirMetaFormat1()
1266
format.repository_format = weaverepo.RepositoryFormat7()
1268
format = self.repository.bzrdir.checkout_metadir()
1269
format.set_branch_format(self._format)
1272
def create_clone_on_transport(self, to_transport, revision_id=None,
1273
stacked_on=None, create_prefix=False, use_existing_dir=False):
1274
"""Create a clone of this branch and its bzrdir.
1276
:param to_transport: The transport to clone onto.
1277
:param revision_id: The revision id to use as tip in the new branch.
1278
If None the tip is obtained from this branch.
1279
:param stacked_on: An optional URL to stack the clone on.
1280
:param create_prefix: Create any missing directories leading up to
1282
:param use_existing_dir: Use an existing directory if one exists.
1284
# XXX: Fix the bzrdir API to allow getting the branch back from the
1285
# clone call. Or something. 20090224 RBC/spiv.
1286
if revision_id is None:
1287
revision_id = self.last_revision()
1289
dir_to = self.bzrdir.clone_on_transport(to_transport,
1290
revision_id=revision_id, stacked_on=stacked_on,
1291
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1292
except errors.FileExists:
1293
if not use_existing_dir:
1295
except errors.NoSuchFile:
1296
if not create_prefix:
1298
return dir_to.open_branch()
1300
def create_checkout(self, to_location, revision_id=None,
1301
lightweight=False, accelerator_tree=None,
1303
"""Create a checkout of a branch.
1305
:param to_location: The url to produce the checkout at
1306
:param revision_id: The revision to check out
1307
:param lightweight: If True, produce a lightweight checkout, otherwise,
1308
produce a bound branch (heavyweight checkout)
1309
:param accelerator_tree: A tree which can be used for retrieving file
1310
contents more quickly than the revision tree, i.e. a workingtree.
1311
The revision tree will be used for cases where accelerator_tree's
1312
content is different.
1313
:param hardlink: If true, hard-link files from accelerator_tree,
1315
:return: The tree of the created checkout
1317
t = transport.get_transport(to_location)
1320
format = self._get_checkout_format()
1321
checkout = format.initialize_on_transport(t)
1322
from_branch = BranchReferenceFormat().initialize(checkout, self)
1324
format = self._get_checkout_format()
1325
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1326
to_location, force_new_tree=False, format=format)
1327
checkout = checkout_branch.bzrdir
1328
checkout_branch.bind(self)
1329
# pull up to the specified revision_id to set the initial
1330
# branch tip correctly, and seed it with history.
1331
checkout_branch.pull(self, stop_revision=revision_id)
1333
tree = checkout.create_workingtree(revision_id,
1334
from_branch=from_branch,
1335
accelerator_tree=accelerator_tree,
1337
basis_tree = tree.basis_tree()
1338
basis_tree.lock_read()
1340
for path, file_id in basis_tree.iter_references():
1341
reference_parent = self.reference_parent(file_id, path)
1342
reference_parent.create_checkout(tree.abspath(path),
1343
basis_tree.get_reference_revision(file_id, path),
1350
def reconcile(self, thorough=True):
1351
"""Make sure the data stored in this branch is consistent."""
1352
from bzrlib.reconcile import BranchReconciler
1353
reconciler = BranchReconciler(self, thorough=thorough)
1354
reconciler.reconcile()
1357
def reference_parent(self, file_id, path, possible_transports=None):
1358
"""Return the parent branch for a tree-reference file_id
1359
:param file_id: The file_id of the tree reference
1360
:param path: The path of the file_id in the tree
1361
:return: A branch associated with the file_id
1363
# FIXME should provide multiple branches, based on config
1364
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1365
possible_transports=possible_transports)
1367
def supports_tags(self):
1368
return self._format.supports_tags()
1370
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1372
"""Ensure that revision_b is a descendant of revision_a.
1374
This is a helper function for update_revisions.
1376
:raises: DivergedBranches if revision_b has diverged from revision_a.
1377
:returns: True if revision_b is a descendant of revision_a.
1379
relation = self._revision_relations(revision_a, revision_b, graph)
1380
if relation == 'b_descends_from_a':
1382
elif relation == 'diverged':
1383
raise errors.DivergedBranches(self, other_branch)
1384
elif relation == 'a_descends_from_b':
1387
raise AssertionError("invalid relation: %r" % (relation,))
1389
def _revision_relations(self, revision_a, revision_b, graph):
1390
"""Determine the relationship between two revisions.
1392
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1394
heads = graph.heads([revision_a, revision_b])
1395
if heads == set([revision_b]):
1396
return 'b_descends_from_a'
1397
elif heads == set([revision_a, revision_b]):
1398
# These branches have diverged
1400
elif heads == set([revision_a]):
1401
return 'a_descends_from_b'
1403
raise AssertionError("invalid heads: %r" % (heads,))
1406
class BranchFormat(object):
1407
"""An encapsulation of the initialization and open routines for a format.
1409
Formats provide three things:
1410
* An initialization routine,
1414
Formats are placed in an dict by their format string for reference
1415
during branch opening. Its not required that these be instances, they
1416
can be classes themselves with class methods - it simply depends on
1417
whether state is needed for a given format or not.
1419
Once a format is deprecated, just deprecate the initialize and open
1420
methods on the format class. Do not deprecate the object, as the
1421
object will be created every time regardless.
1424
_default_format = None
1425
"""The default format used for new branches."""
1428
"""The known formats."""
1430
can_set_append_revisions_only = True
1432
def __eq__(self, other):
1433
return self.__class__ is other.__class__
1435
def __ne__(self, other):
1436
return not (self == other)
1439
def find_format(klass, a_bzrdir):
1440
"""Return the format for the branch object in a_bzrdir."""
1442
transport = a_bzrdir.get_branch_transport(None)
1443
format_string = transport.get("format").read()
1444
return klass._formats[format_string]
1445
except errors.NoSuchFile:
1446
raise errors.NotBranchError(path=transport.base)
1448
raise errors.UnknownFormatError(format=format_string, kind='branch')
1451
def get_default_format(klass):
1452
"""Return the current default format."""
1453
return klass._default_format
1455
def get_reference(self, a_bzrdir):
1456
"""Get the target reference of the branch in a_bzrdir.
1458
format probing must have been completed before calling
1459
this method - it is assumed that the format of the branch
1460
in a_bzrdir is correct.
1462
:param a_bzrdir: The bzrdir to get the branch data from.
1463
:return: None if the branch is not a reference branch.
1468
def set_reference(self, a_bzrdir, to_branch):
1469
"""Set the target reference of the branch in a_bzrdir.
1471
format probing must have been completed before calling
1472
this method - it is assumed that the format of the branch
1473
in a_bzrdir is correct.
1475
:param a_bzrdir: The bzrdir to set the branch reference for.
1476
:param to_branch: branch that the checkout is to reference
1478
raise NotImplementedError(self.set_reference)
1480
def get_format_string(self):
1481
"""Return the ASCII format string that identifies this format."""
1482
raise NotImplementedError(self.get_format_string)
1484
def get_format_description(self):
1485
"""Return the short format description for this format."""
1486
raise NotImplementedError(self.get_format_description)
1488
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1490
"""Initialize a branch in a bzrdir, with specified files
1492
:param a_bzrdir: The bzrdir to initialize the branch in
1493
:param utf8_files: The files to create as a list of
1494
(filename, content) tuples
1495
:param set_format: If True, set the format with
1496
self.get_format_string. (BzrBranch4 has its format set
1498
:return: a branch in this format
1500
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1501
branch_transport = a_bzrdir.get_branch_transport(self)
1503
'metadir': ('lock', lockdir.LockDir),
1504
'branch4': ('branch-lock', lockable_files.TransportLock),
1506
lock_name, lock_class = lock_map[lock_type]
1507
control_files = lockable_files.LockableFiles(branch_transport,
1508
lock_name, lock_class)
1509
control_files.create_lock()
1511
control_files.lock_write()
1512
except errors.LockContention:
1513
if lock_type != 'branch4':
1519
utf8_files += [('format', self.get_format_string())]
1521
for (filename, content) in utf8_files:
1522
branch_transport.put_bytes(
1524
mode=a_bzrdir._get_file_mode())
1527
control_files.unlock()
1528
return self.open(a_bzrdir, _found=True)
1530
def initialize(self, a_bzrdir):
1531
"""Create a branch of this format in a_bzrdir."""
1532
raise NotImplementedError(self.initialize)
1534
def is_supported(self):
1535
"""Is this format supported?
1537
Supported formats can be initialized and opened.
1538
Unsupported formats may not support initialization or committing or
1539
some other features depending on the reason for not being supported.
1543
def make_tags(self, branch):
1544
"""Create a tags object for branch.
1546
This method is on BranchFormat, because BranchFormats are reflected
1547
over the wire via network_name(), whereas full Branch instances require
1548
multiple VFS method calls to operate at all.
1550
The default implementation returns a disabled-tags instance.
1552
Note that it is normal for branch to be a RemoteBranch when using tags
1555
return DisabledTags(branch)
1557
def network_name(self):
1558
"""A simple byte string uniquely identifying this format for RPC calls.
1560
MetaDir branch formats use their disk format string to identify the
1561
repository over the wire. All in one formats such as bzr < 0.8, and
1562
foreign formats like svn/git and hg should use some marker which is
1563
unique and immutable.
1565
raise NotImplementedError(self.network_name)
1567
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1568
"""Return the branch object for a_bzrdir
1570
:param a_bzrdir: A BzrDir that contains a branch.
1571
:param _found: a private parameter, do not use it. It is used to
1572
indicate if format probing has already be done.
1573
:param ignore_fallbacks: when set, no fallback branches will be opened
1574
(if there are any). Default is to open fallbacks.
1576
raise NotImplementedError(self.open)
1579
def register_format(klass, format):
1580
"""Register a metadir format."""
1581
klass._formats[format.get_format_string()] = format
1582
# Metadir formats have a network name of their format string, and get
1583
# registered as class factories.
1584
network_format_registry.register(format.get_format_string(), format.__class__)
1587
def set_default_format(klass, format):
1588
klass._default_format = format
1590
def supports_set_append_revisions_only(self):
1591
"""True if this format supports set_append_revisions_only."""
1594
def supports_stacking(self):
1595
"""True if this format records a stacked-on branch."""
1599
def unregister_format(klass, format):
1600
del klass._formats[format.get_format_string()]
1603
return self.get_format_description().rstrip()
1605
def supports_tags(self):
1606
"""True if this format supports tags stored in the branch"""
1607
return False # by default
1610
class BranchHooks(Hooks):
1611
"""A dictionary mapping hook name to a list of callables for branch hooks.
1613
e.g. ['set_rh'] Is the list of items to be called when the
1614
set_revision_history function is invoked.
1618
"""Create the default hooks.
1620
These are all empty initially, because by default nothing should get
1623
Hooks.__init__(self)
1624
self.create_hook(HookPoint('set_rh',
1625
"Invoked whenever the revision history has been set via "
1626
"set_revision_history. The api signature is (branch, "
1627
"revision_history), and the branch will be write-locked. "
1628
"The set_rh hook can be expensive for bzr to trigger, a better "
1629
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1630
self.create_hook(HookPoint('open',
1631
"Called with the Branch object that has been opened after a "
1632
"branch is opened.", (1, 8), None))
1633
self.create_hook(HookPoint('post_push',
1634
"Called after a push operation completes. post_push is called "
1635
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1636
"bzr client.", (0, 15), None))
1637
self.create_hook(HookPoint('post_pull',
1638
"Called after a pull operation completes. post_pull is called "
1639
"with a bzrlib.branch.PullResult object and only runs in the "
1640
"bzr client.", (0, 15), None))
1641
self.create_hook(HookPoint('pre_commit',
1642
"Called after a commit is calculated but before it is is "
1643
"completed. pre_commit is called with (local, master, old_revno, "
1644
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1645
"). old_revid is NULL_REVISION for the first commit to a branch, "
1646
"tree_delta is a TreeDelta object describing changes from the "
1647
"basis revision. hooks MUST NOT modify this delta. "
1648
" future_tree is an in-memory tree obtained from "
1649
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1650
"tree.", (0,91), None))
1651
self.create_hook(HookPoint('post_commit',
1652
"Called in the bzr client after a commit has completed. "
1653
"post_commit is called with (local, master, old_revno, old_revid, "
1654
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1655
"commit to a branch.", (0, 15), None))
1656
self.create_hook(HookPoint('post_uncommit',
1657
"Called in the bzr client after an uncommit completes. "
1658
"post_uncommit is called with (local, master, old_revno, "
1659
"old_revid, new_revno, new_revid) where local is the local branch "
1660
"or None, master is the target branch, and an empty branch "
1661
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1662
self.create_hook(HookPoint('pre_change_branch_tip',
1663
"Called in bzr client and server before a change to the tip of a "
1664
"branch is made. pre_change_branch_tip is called with a "
1665
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1666
"commit, uncommit will all trigger this hook.", (1, 6), None))
1667
self.create_hook(HookPoint('post_change_branch_tip',
1668
"Called in bzr client and server after a change to the tip of a "
1669
"branch is made. post_change_branch_tip is called with a "
1670
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1671
"commit, uncommit will all trigger this hook.", (1, 4), None))
1672
self.create_hook(HookPoint('transform_fallback_location',
1673
"Called when a stacked branch is activating its fallback "
1674
"locations. transform_fallback_location is called with (branch, "
1675
"url), and should return a new url. Returning the same url "
1676
"allows it to be used as-is, returning a different one can be "
1677
"used to cause the branch to stack on a closer copy of that "
1678
"fallback_location. Note that the branch cannot have history "
1679
"accessing methods called on it during this hook because the "
1680
"fallback locations have not been activated. When there are "
1681
"multiple hooks installed for transform_fallback_location, "
1682
"all are called with the url returned from the previous hook."
1683
"The order is however undefined.", (1, 9), None))
1686
# install the default hooks into the Branch class.
1687
Branch.hooks = BranchHooks()
1690
class ChangeBranchTipParams(object):
1691
"""Object holding parameters passed to *_change_branch_tip hooks.
1693
There are 5 fields that hooks may wish to access:
1695
:ivar branch: the branch being changed
1696
:ivar old_revno: revision number before the change
1697
:ivar new_revno: revision number after the change
1698
:ivar old_revid: revision id before the change
1699
:ivar new_revid: revision id after the change
1701
The revid fields are strings. The revno fields are integers.
1704
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1705
"""Create a group of ChangeBranchTip parameters.
1707
:param branch: The branch being changed.
1708
:param old_revno: Revision number before the change.
1709
:param new_revno: Revision number after the change.
1710
:param old_revid: Tip revision id before the change.
1711
:param new_revid: Tip revision id after the change.
1713
self.branch = branch
1714
self.old_revno = old_revno
1715
self.new_revno = new_revno
1716
self.old_revid = old_revid
1717
self.new_revid = new_revid
1719
def __eq__(self, other):
1720
return self.__dict__ == other.__dict__
1723
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1724
self.__class__.__name__, self.branch,
1725
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1728
class BzrBranchFormat4(BranchFormat):
1729
"""Bzr branch format 4.
1732
- a revision-history file.
1733
- a branch-lock lock file [ to be shared with the bzrdir ]
1736
def get_format_description(self):
1737
"""See BranchFormat.get_format_description()."""
1738
return "Branch format 4"
1740
def initialize(self, a_bzrdir):
1741
"""Create a branch of this format in a_bzrdir."""
1742
utf8_files = [('revision-history', ''),
1743
('branch-name', ''),
1745
return self._initialize_helper(a_bzrdir, utf8_files,
1746
lock_type='branch4', set_format=False)
1749
super(BzrBranchFormat4, self).__init__()
1750
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1752
def network_name(self):
1753
"""The network name for this format is the control dirs disk label."""
1754
return self._matchingbzrdir.get_format_string()
1756
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1757
"""See BranchFormat.open()."""
1759
# we are being called directly and must probe.
1760
raise NotImplementedError
1761
return BzrBranch(_format=self,
1762
_control_files=a_bzrdir._control_files,
1764
_repository=a_bzrdir.open_repository())
1767
return "Bazaar-NG branch format 4"
1770
class BranchFormatMetadir(BranchFormat):
1771
"""Common logic for meta-dir based branch formats."""
1773
def _branch_class(self):
1774
"""What class to instantiate on open calls."""
1775
raise NotImplementedError(self._branch_class)
1777
def network_name(self):
1778
"""A simple byte string uniquely identifying this format for RPC calls.
1780
Metadir branch formats use their format string.
1782
return self.get_format_string()
1784
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1785
"""See BranchFormat.open()."""
1787
format = BranchFormat.find_format(a_bzrdir)
1788
if format.__class__ != self.__class__:
1789
raise AssertionError("wrong format %r found for %r" %
1792
transport = a_bzrdir.get_branch_transport(None)
1793
control_files = lockable_files.LockableFiles(transport, 'lock',
1795
return self._branch_class()(_format=self,
1796
_control_files=control_files,
1798
_repository=a_bzrdir.find_repository(),
1799
ignore_fallbacks=ignore_fallbacks)
1800
except errors.NoSuchFile:
1801
raise errors.NotBranchError(path=transport.base)
1804
super(BranchFormatMetadir, self).__init__()
1805
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1806
self._matchingbzrdir.set_branch_format(self)
1808
def supports_tags(self):
1812
class BzrBranchFormat5(BranchFormatMetadir):
1813
"""Bzr branch format 5.
1816
- a revision-history file.
1818
- a lock dir guarding the branch itself
1819
- all of this stored in a branch/ subdirectory
1820
- works with shared repositories.
1822
This format is new in bzr 0.8.
1825
def _branch_class(self):
1828
def get_format_string(self):
1829
"""See BranchFormat.get_format_string()."""
1830
return "Bazaar-NG branch format 5\n"
1832
def get_format_description(self):
1833
"""See BranchFormat.get_format_description()."""
1834
return "Branch format 5"
1836
def initialize(self, a_bzrdir):
1837
"""Create a branch of this format in a_bzrdir."""
1838
utf8_files = [('revision-history', ''),
1839
('branch-name', ''),
1841
return self._initialize_helper(a_bzrdir, utf8_files)
1843
def supports_tags(self):
1847
class BzrBranchFormat6(BranchFormatMetadir):
1848
"""Branch format with last-revision and tags.
1850
Unlike previous formats, this has no explicit revision history. Instead,
1851
this just stores the last-revision, and the left-hand history leading
1852
up to there is the history.
1854
This format was introduced in bzr 0.15
1855
and became the default in 0.91.
1858
def _branch_class(self):
1861
def get_format_string(self):
1862
"""See BranchFormat.get_format_string()."""
1863
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1865
def get_format_description(self):
1866
"""See BranchFormat.get_format_description()."""
1867
return "Branch format 6"
1869
def initialize(self, a_bzrdir):
1870
"""Create a branch of this format in a_bzrdir."""
1871
utf8_files = [('last-revision', '0 null:\n'),
1872
('branch.conf', ''),
1875
return self._initialize_helper(a_bzrdir, utf8_files)
1877
def make_tags(self, branch):
1878
"""See bzrlib.branch.BranchFormat.make_tags()."""
1879
return BasicTags(branch)
1881
def supports_set_append_revisions_only(self):
1885
class BzrBranchFormat8(BranchFormatMetadir):
1886
"""Metadir format supporting storing locations of subtree branches."""
1888
def _branch_class(self):
1891
def get_format_string(self):
1892
"""See BranchFormat.get_format_string()."""
1893
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1895
def get_format_description(self):
1896
"""See BranchFormat.get_format_description()."""
1897
return "Branch format 8"
1899
def initialize(self, a_bzrdir):
1900
"""Create a branch of this format in a_bzrdir."""
1901
utf8_files = [('last-revision', '0 null:\n'),
1902
('branch.conf', ''),
1906
return self._initialize_helper(a_bzrdir, utf8_files)
1909
super(BzrBranchFormat8, self).__init__()
1910
self._matchingbzrdir.repository_format = \
1911
RepositoryFormatKnitPack5RichRoot()
1913
def make_tags(self, branch):
1914
"""See bzrlib.branch.BranchFormat.make_tags()."""
1915
return BasicTags(branch)
1917
def supports_set_append_revisions_only(self):
1920
def supports_stacking(self):
1923
supports_reference_locations = True
1926
class BzrBranchFormat7(BzrBranchFormat8):
1927
"""Branch format with last-revision, tags, and a stacked location pointer.
1929
The stacked location pointer is passed down to the repository and requires
1930
a repository format with supports_external_lookups = True.
1932
This format was introduced in bzr 1.6.
1935
def initialize(self, a_bzrdir):
1936
"""Create a branch of this format in a_bzrdir."""
1937
utf8_files = [('last-revision', '0 null:\n'),
1938
('branch.conf', ''),
1941
return self._initialize_helper(a_bzrdir, utf8_files)
1943
def _branch_class(self):
1946
def get_format_string(self):
1947
"""See BranchFormat.get_format_string()."""
1948
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1950
def get_format_description(self):
1951
"""See BranchFormat.get_format_description()."""
1952
return "Branch format 7"
1954
def supports_set_append_revisions_only(self):
1957
supports_reference_locations = False
1960
class BranchReferenceFormat(BranchFormat):
1961
"""Bzr branch reference format.
1963
Branch references are used in implementing checkouts, they
1964
act as an alias to the real branch which is at some other url.
1971
def get_format_string(self):
1972
"""See BranchFormat.get_format_string()."""
1973
return "Bazaar-NG Branch Reference Format 1\n"
1975
def get_format_description(self):
1976
"""See BranchFormat.get_format_description()."""
1977
return "Checkout reference format 1"
1979
def get_reference(self, a_bzrdir):
1980
"""See BranchFormat.get_reference()."""
1981
transport = a_bzrdir.get_branch_transport(None)
1982
return transport.get('location').read()
1984
def set_reference(self, a_bzrdir, to_branch):
1985
"""See BranchFormat.set_reference()."""
1986
transport = a_bzrdir.get_branch_transport(None)
1987
location = transport.put_bytes('location', to_branch.base)
1989
def initialize(self, a_bzrdir, target_branch=None):
1990
"""Create a branch of this format in a_bzrdir."""
1991
if target_branch is None:
1992
# this format does not implement branch itself, thus the implicit
1993
# creation contract must see it as uninitializable
1994
raise errors.UninitializableFormat(self)
1995
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1996
branch_transport = a_bzrdir.get_branch_transport(self)
1997
branch_transport.put_bytes('location',
1998
target_branch.bzrdir.root_transport.base)
1999
branch_transport.put_bytes('format', self.get_format_string())
2001
a_bzrdir, _found=True,
2002
possible_transports=[target_branch.bzrdir.root_transport])
2005
super(BranchReferenceFormat, self).__init__()
2006
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2007
self._matchingbzrdir.set_branch_format(self)
2009
def _make_reference_clone_function(format, a_branch):
2010
"""Create a clone() routine for a branch dynamically."""
2011
def clone(to_bzrdir, revision_id=None,
2012
repository_policy=None):
2013
"""See Branch.clone()."""
2014
return format.initialize(to_bzrdir, a_branch)
2015
# cannot obey revision_id limits when cloning a reference ...
2016
# FIXME RBC 20060210 either nuke revision_id for clone, or
2017
# emit some sort of warning/error to the caller ?!
2020
def open(self, a_bzrdir, _found=False, location=None,
2021
possible_transports=None, ignore_fallbacks=False):
2022
"""Return the branch that the branch reference in a_bzrdir points at.
2024
:param a_bzrdir: A BzrDir that contains a branch.
2025
:param _found: a private parameter, do not use it. It is used to
2026
indicate if format probing has already be done.
2027
:param ignore_fallbacks: when set, no fallback branches will be opened
2028
(if there are any). Default is to open fallbacks.
2029
:param location: The location of the referenced branch. If
2030
unspecified, this will be determined from the branch reference in
2032
:param possible_transports: An optional reusable transports list.
2035
format = BranchFormat.find_format(a_bzrdir)
2036
if format.__class__ != self.__class__:
2037
raise AssertionError("wrong format %r found for %r" %
2039
if location is None:
2040
location = self.get_reference(a_bzrdir)
2041
real_bzrdir = bzrdir.BzrDir.open(
2042
location, possible_transports=possible_transports)
2043
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2044
# this changes the behaviour of result.clone to create a new reference
2045
# rather than a copy of the content of the branch.
2046
# I did not use a proxy object because that needs much more extensive
2047
# testing, and we are only changing one behaviour at the moment.
2048
# If we decide to alter more behaviours - i.e. the implicit nickname
2049
# then this should be refactored to introduce a tested proxy branch
2050
# and a subclass of that for use in overriding clone() and ....
2052
result.clone = self._make_reference_clone_function(result)
2056
network_format_registry = registry.FormatRegistry()
2057
"""Registry of formats indexed by their network name.
2059
The network name for a branch format is an identifier that can be used when
2060
referring to formats with smart server operations. See
2061
BranchFormat.network_name() for more detail.
2065
# formats which have no format string are not discoverable
2066
# and not independently creatable, so are not registered.
2067
__format5 = BzrBranchFormat5()
2068
__format6 = BzrBranchFormat6()
2069
__format7 = BzrBranchFormat7()
2070
__format8 = BzrBranchFormat8()
2071
BranchFormat.register_format(__format5)
2072
BranchFormat.register_format(BranchReferenceFormat())
2073
BranchFormat.register_format(__format6)
2074
BranchFormat.register_format(__format7)
2075
BranchFormat.register_format(__format8)
2076
BranchFormat.set_default_format(__format7)
2077
_legacy_formats = [BzrBranchFormat4(),
2079
network_format_registry.register(
2080
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2083
class BzrBranch(Branch, _RelockDebugMixin):
2084
"""A branch stored in the actual filesystem.
2086
Note that it's "local" in the context of the filesystem; it doesn't
2087
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2088
it's writable, and can be accessed via the normal filesystem API.
2090
:ivar _transport: Transport for file operations on this branch's
2091
control files, typically pointing to the .bzr/branch directory.
2092
:ivar repository: Repository for this branch.
2093
:ivar base: The url of the base directory for this branch; the one
2094
containing the .bzr directory.
2097
def __init__(self, _format=None,
2098
_control_files=None, a_bzrdir=None, _repository=None,
2099
ignore_fallbacks=False):
2100
"""Create new branch object at a particular location."""
2101
if a_bzrdir is None:
2102
raise ValueError('a_bzrdir must be supplied')
2104
self.bzrdir = a_bzrdir
2105
self._base = self.bzrdir.transport.clone('..').base
2106
# XXX: We should be able to just do
2107
# self.base = self.bzrdir.root_transport.base
2108
# but this does not quite work yet -- mbp 20080522
2109
self._format = _format
2110
if _control_files is None:
2111
raise ValueError('BzrBranch _control_files is None')
2112
self.control_files = _control_files
2113
self._transport = _control_files._transport
2114
self.repository = _repository
2115
Branch.__init__(self)
2118
return '%s(%r)' % (self.__class__.__name__, self.base)
2122
def _get_base(self):
2123
"""Returns the directory containing the control directory."""
2126
base = property(_get_base, doc="The URL for the root of this branch.")
2128
def _get_config(self):
2129
return TransportConfig(self._transport, 'branch.conf')
2131
def is_locked(self):
2132
return self.control_files.is_locked()
2134
def lock_write(self, token=None):
2135
if not self.is_locked():
2136
self._note_lock('w')
2137
# All-in-one needs to always unlock/lock.
2138
repo_control = getattr(self.repository, 'control_files', None)
2139
if self.control_files == repo_control or not self.is_locked():
2140
self.repository.lock_write()
2145
return self.control_files.lock_write(token=token)
2148
self.repository.unlock()
2151
def lock_read(self):
2152
if not self.is_locked():
2153
self._note_lock('r')
2154
# All-in-one needs to always unlock/lock.
2155
repo_control = getattr(self.repository, 'control_files', None)
2156
if self.control_files == repo_control or not self.is_locked():
2157
self.repository.lock_read()
2162
self.control_files.lock_read()
2165
self.repository.unlock()
2168
@only_raises(errors.LockNotHeld, errors.LockBroken)
2171
self.control_files.unlock()
2173
# All-in-one needs to always unlock/lock.
2174
repo_control = getattr(self.repository, 'control_files', None)
2175
if (self.control_files == repo_control or
2176
not self.control_files.is_locked()):
2177
self.repository.unlock()
2178
if not self.control_files.is_locked():
2179
# we just released the lock
2180
self._clear_cached_state()
2182
def peek_lock_mode(self):
2183
if self.control_files._lock_count == 0:
2186
return self.control_files._lock_mode
2188
def get_physical_lock_status(self):
2189
return self.control_files.get_physical_lock_status()
2192
def print_file(self, file, revision_id):
2193
"""See Branch.print_file."""
2194
return self.repository.print_file(file, revision_id)
2196
def _write_revision_history(self, history):
2197
"""Factored out of set_revision_history.
2199
This performs the actual writing to disk.
2200
It is intended to be called by BzrBranch5.set_revision_history."""
2201
self._transport.put_bytes(
2202
'revision-history', '\n'.join(history),
2203
mode=self.bzrdir._get_file_mode())
2206
def set_revision_history(self, rev_history):
2207
"""See Branch.set_revision_history."""
2208
if 'evil' in debug.debug_flags:
2209
mutter_callsite(3, "set_revision_history scales with history.")
2210
check_not_reserved_id = _mod_revision.check_not_reserved_id
2211
for rev_id in rev_history:
2212
check_not_reserved_id(rev_id)
2213
if Branch.hooks['post_change_branch_tip']:
2214
# Don't calculate the last_revision_info() if there are no hooks
2216
old_revno, old_revid = self.last_revision_info()
2217
if len(rev_history) == 0:
2218
revid = _mod_revision.NULL_REVISION
2220
revid = rev_history[-1]
2221
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2222
self._write_revision_history(rev_history)
2223
self._clear_cached_state()
2224
self._cache_revision_history(rev_history)
2225
for hook in Branch.hooks['set_rh']:
2226
hook(self, rev_history)
2227
if Branch.hooks['post_change_branch_tip']:
2228
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2230
def _synchronize_history(self, destination, revision_id):
2231
"""Synchronize last revision and revision history between branches.
2233
This version is most efficient when the destination is also a
2234
BzrBranch5, but works for BzrBranch6 as long as the revision
2235
history is the true lefthand parent history, and all of the revisions
2236
are in the destination's repository. If not, set_revision_history
2239
:param destination: The branch to copy the history into
2240
:param revision_id: The revision-id to truncate history at. May
2241
be None to copy complete history.
2243
if not isinstance(destination._format, BzrBranchFormat5):
2244
super(BzrBranch, self)._synchronize_history(
2245
destination, revision_id)
2247
if revision_id == _mod_revision.NULL_REVISION:
2250
new_history = self.revision_history()
2251
if revision_id is not None and new_history != []:
2253
new_history = new_history[:new_history.index(revision_id) + 1]
2255
rev = self.repository.get_revision(revision_id)
2256
new_history = rev.get_history(self.repository)[1:]
2257
destination.set_revision_history(new_history)
2260
def set_last_revision_info(self, revno, revision_id):
2261
"""Set the last revision of this branch.
2263
The caller is responsible for checking that the revno is correct
2264
for this revision id.
2266
It may be possible to set the branch last revision to an id not
2267
present in the repository. However, branches can also be
2268
configured to check constraints on history, in which case this may not
2271
revision_id = _mod_revision.ensure_null(revision_id)
2272
# this old format stores the full history, but this api doesn't
2273
# provide it, so we must generate, and might as well check it's
2275
history = self._lefthand_history(revision_id)
2276
if len(history) != revno:
2277
raise AssertionError('%d != %d' % (len(history), revno))
2278
self.set_revision_history(history)
2280
def _gen_revision_history(self):
2281
history = self._transport.get_bytes('revision-history').split('\n')
2282
if history[-1:] == ['']:
2283
# There shouldn't be a trailing newline, but just in case.
2288
def generate_revision_history(self, revision_id, last_rev=None,
2290
"""Create a new revision history that will finish with revision_id.
2292
:param revision_id: the new tip to use.
2293
:param last_rev: The previous last_revision. If not None, then this
2294
must be a ancestory of revision_id, or DivergedBranches is raised.
2295
:param other_branch: The other branch that DivergedBranches should
2296
raise with respect to.
2298
self.set_revision_history(self._lefthand_history(revision_id,
2299
last_rev, other_branch))
2301
def basis_tree(self):
2302
"""See Branch.basis_tree."""
2303
return self.repository.revision_tree(self.last_revision())
2305
def _get_parent_location(self):
2306
_locs = ['parent', 'pull', 'x-pull']
2309
return self._transport.get_bytes(l).strip('\n')
2310
except errors.NoSuchFile:
2314
def _basic_push(self, target, overwrite, stop_revision):
2315
"""Basic implementation of push without bound branches or hooks.
2317
Must be called with source read locked and target write locked.
2319
result = BranchPushResult()
2320
result.source_branch = self
2321
result.target_branch = target
2322
result.old_revno, result.old_revid = target.last_revision_info()
2323
self.update_references(target)
2324
if result.old_revid != self.last_revision():
2325
# We assume that during 'push' this repository is closer than
2327
graph = self.repository.get_graph(target.repository)
2328
target.update_revisions(self, stop_revision,
2329
overwrite=overwrite, graph=graph)
2330
if self._push_should_merge_tags():
2331
result.tag_conflicts = self.tags.merge_to(target.tags,
2333
result.new_revno, result.new_revid = target.last_revision_info()
2336
def get_stacked_on_url(self):
2337
raise errors.UnstackableBranchFormat(self._format, self.base)
2339
def set_push_location(self, location):
2340
"""See Branch.set_push_location."""
2341
self.get_config().set_user_option(
2342
'push_location', location,
2343
store=_mod_config.STORE_LOCATION_NORECURSE)
2345
def _set_parent_location(self, url):
2347
self._transport.delete('parent')
2349
self._transport.put_bytes('parent', url + '\n',
2350
mode=self.bzrdir._get_file_mode())
2353
class BzrBranch5(BzrBranch):
2354
"""A format 5 branch. This supports new features over plain branches.
2356
It has support for a master_branch which is the data for bound branches.
2359
def get_bound_location(self):
2361
return self._transport.get_bytes('bound')[:-1]
2362
except errors.NoSuchFile:
2366
def get_master_branch(self, possible_transports=None):
2367
"""Return the branch we are bound to.
2369
:return: Either a Branch, or None
2371
This could memoise the branch, but if thats done
2372
it must be revalidated on each new lock.
2373
So for now we just don't memoise it.
2374
# RBC 20060304 review this decision.
2376
bound_loc = self.get_bound_location()
2380
return Branch.open(bound_loc,
2381
possible_transports=possible_transports)
2382
except (errors.NotBranchError, errors.ConnectionError), e:
2383
raise errors.BoundBranchConnectionFailure(
2387
def set_bound_location(self, location):
2388
"""Set the target where this branch is bound to.
2390
:param location: URL to the target branch
2393
self._transport.put_bytes('bound', location+'\n',
2394
mode=self.bzrdir._get_file_mode())
2397
self._transport.delete('bound')
2398
except errors.NoSuchFile:
2403
def bind(self, other):
2404
"""Bind this branch to the branch other.
2406
This does not push or pull data between the branches, though it does
2407
check for divergence to raise an error when the branches are not
2408
either the same, or one a prefix of the other. That behaviour may not
2409
be useful, so that check may be removed in future.
2411
:param other: The branch to bind to
2414
# TODO: jam 20051230 Consider checking if the target is bound
2415
# It is debatable whether you should be able to bind to
2416
# a branch which is itself bound.
2417
# Committing is obviously forbidden,
2418
# but binding itself may not be.
2419
# Since we *have* to check at commit time, we don't
2420
# *need* to check here
2422
# we want to raise diverged if:
2423
# last_rev is not in the other_last_rev history, AND
2424
# other_last_rev is not in our history, and do it without pulling
2426
self.set_bound_location(other.base)
2430
"""If bound, unbind"""
2431
return self.set_bound_location(None)
2434
def update(self, possible_transports=None):
2435
"""Synchronise this branch with the master branch if any.
2437
:return: None or the last_revision that was pivoted out during the
2440
master = self.get_master_branch(possible_transports)
2441
if master is not None:
2442
old_tip = _mod_revision.ensure_null(self.last_revision())
2443
self.pull(master, overwrite=True)
2444
if self.repository.get_graph().is_ancestor(old_tip,
2445
_mod_revision.ensure_null(self.last_revision())):
2451
class BzrBranch8(BzrBranch5):
2452
"""A branch that stores tree-reference locations."""
2454
def _open_hook(self):
2455
if self._ignore_fallbacks:
2458
url = self.get_stacked_on_url()
2459
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2460
errors.UnstackableBranchFormat):
2463
for hook in Branch.hooks['transform_fallback_location']:
2464
url = hook(self, url)
2466
hook_name = Branch.hooks.get_hook_name(hook)
2467
raise AssertionError(
2468
"'transform_fallback_location' hook %s returned "
2469
"None, not a URL." % hook_name)
2470
self._activate_fallback_location(url)
2472
def __init__(self, *args, **kwargs):
2473
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2474
super(BzrBranch8, self).__init__(*args, **kwargs)
2475
self._last_revision_info_cache = None
2476
self._reference_info = None
2478
def _clear_cached_state(self):
2479
super(BzrBranch8, self)._clear_cached_state()
2480
self._last_revision_info_cache = None
2481
self._reference_info = None
2483
def _last_revision_info(self):
2484
revision_string = self._transport.get_bytes('last-revision')
2485
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2486
revision_id = cache_utf8.get_cached_utf8(revision_id)
2488
return revno, revision_id
2490
def _write_last_revision_info(self, revno, revision_id):
2491
"""Simply write out the revision id, with no checks.
2493
Use set_last_revision_info to perform this safely.
2495
Does not update the revision_history cache.
2496
Intended to be called by set_last_revision_info and
2497
_write_revision_history.
2499
revision_id = _mod_revision.ensure_null(revision_id)
2500
out_string = '%d %s\n' % (revno, revision_id)
2501
self._transport.put_bytes('last-revision', out_string,
2502
mode=self.bzrdir._get_file_mode())
2505
def set_last_revision_info(self, revno, revision_id):
2506
revision_id = _mod_revision.ensure_null(revision_id)
2507
old_revno, old_revid = self.last_revision_info()
2508
if self._get_append_revisions_only():
2509
self._check_history_violation(revision_id)
2510
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2511
self._write_last_revision_info(revno, revision_id)
2512
self._clear_cached_state()
2513
self._last_revision_info_cache = revno, revision_id
2514
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2516
def _synchronize_history(self, destination, revision_id):
2517
"""Synchronize last revision and revision history between branches.
2519
:see: Branch._synchronize_history
2521
# XXX: The base Branch has a fast implementation of this method based
2522
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2523
# that uses set_revision_history. This class inherits from BzrBranch5,
2524
# but wants the fast implementation, so it calls
2525
# Branch._synchronize_history directly.
2526
Branch._synchronize_history(self, destination, revision_id)
2528
def _check_history_violation(self, revision_id):
2529
last_revision = _mod_revision.ensure_null(self.last_revision())
2530
if _mod_revision.is_null(last_revision):
2532
if last_revision not in self._lefthand_history(revision_id):
2533
raise errors.AppendRevisionsOnlyViolation(self.base)
2535
def _gen_revision_history(self):
2536
"""Generate the revision history from last revision
2538
last_revno, last_revision = self.last_revision_info()
2539
self._extend_partial_history(stop_index=last_revno-1)
2540
return list(reversed(self._partial_revision_history_cache))
2542
def _write_revision_history(self, history):
2543
"""Factored out of set_revision_history.
2545
This performs the actual writing to disk, with format-specific checks.
2546
It is intended to be called by BzrBranch5.set_revision_history.
2548
if len(history) == 0:
2549
last_revision = 'null:'
2551
if history != self._lefthand_history(history[-1]):
2552
raise errors.NotLefthandHistory(history)
2553
last_revision = history[-1]
2554
if self._get_append_revisions_only():
2555
self._check_history_violation(last_revision)
2556
self._write_last_revision_info(len(history), last_revision)
2559
def _set_parent_location(self, url):
2560
"""Set the parent branch"""
2561
self._set_config_location('parent_location', url, make_relative=True)
2564
def _get_parent_location(self):
2565
"""Set the parent branch"""
2566
return self._get_config_location('parent_location')
2569
def _set_all_reference_info(self, info_dict):
2570
"""Replace all reference info stored in a branch.
2572
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2575
writer = rio.RioWriter(s)
2576
for key, (tree_path, branch_location) in info_dict.iteritems():
2577
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2578
branch_location=branch_location)
2579
writer.write_stanza(stanza)
2580
self._transport.put_bytes('references', s.getvalue())
2581
self._reference_info = info_dict
2584
def _get_all_reference_info(self):
2585
"""Return all the reference info stored in a branch.
2587
:return: A dict of {file_id: (tree_path, branch_location)}
2589
if self._reference_info is not None:
2590
return self._reference_info
2591
rio_file = self._transport.get('references')
2593
stanzas = rio.read_stanzas(rio_file)
2594
info_dict = dict((s['file_id'], (s['tree_path'],
2595
s['branch_location'])) for s in stanzas)
2598
self._reference_info = info_dict
2601
def set_reference_info(self, file_id, tree_path, branch_location):
2602
"""Set the branch location to use for a tree reference.
2604
:param file_id: The file-id of the tree reference.
2605
:param tree_path: The path of the tree reference in the tree.
2606
:param branch_location: The location of the branch to retrieve tree
2609
info_dict = self._get_all_reference_info()
2610
info_dict[file_id] = (tree_path, branch_location)
2611
if None in (tree_path, branch_location):
2612
if tree_path is not None:
2613
raise ValueError('tree_path must be None when branch_location'
2615
if branch_location is not None:
2616
raise ValueError('branch_location must be None when tree_path'
2618
del info_dict[file_id]
2619
self._set_all_reference_info(info_dict)
2621
def get_reference_info(self, file_id):
2622
"""Get the tree_path and branch_location for a tree reference.
2624
:return: a tuple of (tree_path, branch_location)
2626
return self._get_all_reference_info().get(file_id, (None, None))
2628
def reference_parent(self, file_id, path, possible_transports=None):
2629
"""Return the parent branch for a tree-reference file_id.
2631
:param file_id: The file_id of the tree reference
2632
:param path: The path of the file_id in the tree
2633
:return: A branch associated with the file_id
2635
branch_location = self.get_reference_info(file_id)[1]
2636
if branch_location is None:
2637
return Branch.reference_parent(self, file_id, path,
2638
possible_transports)
2639
branch_location = urlutils.join(self.base, branch_location)
2640
return Branch.open(branch_location,
2641
possible_transports=possible_transports)
2643
def set_push_location(self, location):
2644
"""See Branch.set_push_location."""
2645
self._set_config_location('push_location', location)
2647
def set_bound_location(self, location):
2648
"""See Branch.set_push_location."""
2650
config = self.get_config()
2651
if location is None:
2652
if config.get_user_option('bound') != 'True':
2655
config.set_user_option('bound', 'False', warn_masked=True)
2658
self._set_config_location('bound_location', location,
2660
config.set_user_option('bound', 'True', warn_masked=True)
2663
def _get_bound_location(self, bound):
2664
"""Return the bound location in the config file.
2666
Return None if the bound parameter does not match"""
2667
config = self.get_config()
2668
config_bound = (config.get_user_option('bound') == 'True')
2669
if config_bound != bound:
2671
return self._get_config_location('bound_location', config=config)
2673
def get_bound_location(self):
2674
"""See Branch.set_push_location."""
2675
return self._get_bound_location(True)
2677
def get_old_bound_location(self):
2678
"""See Branch.get_old_bound_location"""
2679
return self._get_bound_location(False)
2681
def get_stacked_on_url(self):
2682
# you can always ask for the URL; but you might not be able to use it
2683
# if the repo can't support stacking.
2684
## self._check_stackable_repo()
2685
stacked_url = self._get_config_location('stacked_on_location')
2686
if stacked_url is None:
2687
raise errors.NotStacked(self)
2690
def _get_append_revisions_only(self):
2691
value = self.get_config().get_user_option('append_revisions_only')
2692
return value == 'True'
2695
def generate_revision_history(self, revision_id, last_rev=None,
2697
"""See BzrBranch5.generate_revision_history"""
2698
history = self._lefthand_history(revision_id, last_rev, other_branch)
2699
revno = len(history)
2700
self.set_last_revision_info(revno, revision_id)
2703
def get_rev_id(self, revno, history=None):
2704
"""Find the revision id of the specified revno."""
2706
return _mod_revision.NULL_REVISION
2708
last_revno, last_revision_id = self.last_revision_info()
2709
if revno <= 0 or revno > last_revno:
2710
raise errors.NoSuchRevision(self, revno)
2712
if history is not None:
2713
return history[revno - 1]
2715
index = last_revno - revno
2716
if len(self._partial_revision_history_cache) <= index:
2717
self._extend_partial_history(stop_index=index)
2718
if len(self._partial_revision_history_cache) > index:
2719
return self._partial_revision_history_cache[index]
2721
raise errors.NoSuchRevision(self, revno)
2724
def revision_id_to_revno(self, revision_id):
2725
"""Given a revision id, return its revno"""
2726
if _mod_revision.is_null(revision_id):
2729
index = self._partial_revision_history_cache.index(revision_id)
2731
self._extend_partial_history(stop_revision=revision_id)
2732
index = len(self._partial_revision_history_cache) - 1
2733
if self._partial_revision_history_cache[index] != revision_id:
2734
raise errors.NoSuchRevision(self, revision_id)
2735
return self.revno() - index
2738
class BzrBranch7(BzrBranch8):
2739
"""A branch with support for a fallback repository."""
2741
def set_reference_info(self, file_id, tree_path, branch_location):
2742
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2744
def get_reference_info(self, file_id):
2745
Branch.get_reference_info(self, file_id)
2747
def reference_parent(self, file_id, path, possible_transports=None):
2748
return Branch.reference_parent(self, file_id, path,
2749
possible_transports)
2752
class BzrBranch6(BzrBranch7):
2753
"""See BzrBranchFormat6 for the capabilities of this branch.
2755
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2759
def get_stacked_on_url(self):
2760
raise errors.UnstackableBranchFormat(self._format, self.base)
791
2763
######################################################################
795
def is_control_file(filename):
796
## FIXME: better check
797
filename = os.path.normpath(filename)
798
while filename != '':
799
head, tail = os.path.split(filename)
800
## mutter('check %r for control file' % ((head, tail), ))
801
if tail == bzrlib.BZRDIR:
810
def _gen_revision_id(when):
811
"""Return new revision-id."""
812
s = '%s-%s-' % (user_email(), compact_date(when))
813
s += hexlify(rand_bytes(8))
817
def gen_file_id(name):
818
"""Return new file id.
820
This should probably generate proper UUIDs, but for the moment we
821
cope with just randomness because running uuidgen every time is
823
idx = name.rfind('/')
825
name = name[idx+1 : ]
827
name = name.lstrip('.')
829
s = hexlify(rand_bytes(8))
830
return '-'.join((name, compact_date(time.time()), s))
2764
# results of operations
2767
class _Result(object):
2769
def _show_tag_conficts(self, to_file):
2770
if not getattr(self, 'tag_conflicts', None):
2772
to_file.write('Conflicting tags:\n')
2773
for name, value1, value2 in self.tag_conflicts:
2774
to_file.write(' %s\n' % (name, ))
2777
class PullResult(_Result):
2778
"""Result of a Branch.pull operation.
2780
:ivar old_revno: Revision number before pull.
2781
:ivar new_revno: Revision number after pull.
2782
:ivar old_revid: Tip revision id before pull.
2783
:ivar new_revid: Tip revision id after pull.
2784
:ivar source_branch: Source (local) branch object. (read locked)
2785
:ivar master_branch: Master branch of the target, or the target if no
2787
:ivar local_branch: target branch if there is a Master, else None
2788
:ivar target_branch: Target/destination branch object. (write locked)
2789
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2793
# DEPRECATED: pull used to return the change in revno
2794
return self.new_revno - self.old_revno
2796
def report(self, to_file):
2798
if self.old_revid == self.new_revid:
2799
to_file.write('No revisions to pull.\n')
2801
to_file.write('Now on revision %d.\n' % self.new_revno)
2802
self._show_tag_conficts(to_file)
2805
class BranchPushResult(_Result):
2806
"""Result of a Branch.push operation.
2808
:ivar old_revno: Revision number (eg 10) of the target before push.
2809
:ivar new_revno: Revision number (eg 12) of the target after push.
2810
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2812
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2814
:ivar source_branch: Source branch object that the push was from. This is
2815
read locked, and generally is a local (and thus low latency) branch.
2816
:ivar master_branch: If target is a bound branch, the master branch of
2817
target, or target itself. Always write locked.
2818
:ivar target_branch: The direct Branch where data is being sent (write
2820
:ivar local_branch: If the target is a bound branch this will be the
2821
target, otherwise it will be None.
2825
# DEPRECATED: push used to return the change in revno
2826
return self.new_revno - self.old_revno
2828
def report(self, to_file):
2829
"""Write a human-readable description of the result."""
2830
if self.old_revid == self.new_revid:
2831
note('No new revisions to push.')
2833
note('Pushed up to revision %d.' % self.new_revno)
2834
self._show_tag_conficts(to_file)
2837
class BranchCheckResult(object):
2838
"""Results of checking branch consistency.
2843
def __init__(self, branch):
2844
self.branch = branch
2847
def report_results(self, verbose):
2848
"""Report the check results via trace.note.
2850
:param verbose: Requests more detailed display of what was checked,
2853
note('checked branch %s format %s', self.branch.base,
2854
self.branch._format)
2855
for error in self.errors:
2856
note('found error:%s', error)
2859
class Converter5to6(object):
2860
"""Perform an in-place upgrade of format 5 to format 6"""
2862
def convert(self, branch):
2863
# Data for 5 and 6 can peacefully coexist.
2864
format = BzrBranchFormat6()
2865
new_branch = format.open(branch.bzrdir, _found=True)
2867
# Copy source data into target
2868
new_branch._write_last_revision_info(*branch.last_revision_info())
2869
new_branch.set_parent(branch.get_parent())
2870
new_branch.set_bound_location(branch.get_bound_location())
2871
new_branch.set_push_location(branch.get_push_location())
2873
# New branch has no tags by default
2874
new_branch.tags._set_tag_dict({})
2876
# Copying done; now update target format
2877
new_branch._transport.put_bytes('format',
2878
format.get_format_string(),
2879
mode=new_branch.bzrdir._get_file_mode())
2881
# Clean up old files
2882
new_branch._transport.delete('revision-history')
2884
branch.set_parent(None)
2885
except errors.NoSuchFile:
2887
branch.set_bound_location(None)
2890
class Converter6to7(object):
2891
"""Perform an in-place upgrade of format 6 to format 7"""
2893
def convert(self, branch):
2894
format = BzrBranchFormat7()
2895
branch._set_config_location('stacked_on_location', '')
2896
# update target format
2897
branch._transport.put_bytes('format', format.get_format_string())
2900
class Converter7to8(object):
2901
"""Perform an in-place upgrade of format 6 to format 7"""
2903
def convert(self, branch):
2904
format = BzrBranchFormat8()
2905
branch._transport.put_bytes('references', '')
2906
# update target format
2907
branch._transport.put_bytes('format', format.get_format_string())
2910
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2911
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2914
_run_with_write_locked_target will attempt to release the lock it acquires.
2916
If an exception is raised by callable, then that exception *will* be
2917
propagated, even if the unlock attempt raises its own error. Thus
2918
_run_with_write_locked_target should be preferred to simply doing::
2922
return callable(*args, **kwargs)
2927
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2928
# should share code?
2931
result = callable(*args, **kwargs)
2933
exc_info = sys.exc_info()
2937
raise exc_info[0], exc_info[1], exc_info[2]
2943
class InterBranch(InterObject):
2944
"""This class represents operations taking place between two branches.
2946
Its instances have methods like pull() and push() and contain
2947
references to the source and target repositories these operations
2948
can be carried out on.
2952
"""The available optimised InterBranch types."""
2955
def _get_branch_formats_to_test():
2956
"""Return a tuple with the Branch formats to use when testing."""
2957
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2959
def pull(self, overwrite=False, stop_revision=None,
2960
possible_transports=None, local=False):
2961
"""Mirror source into target branch.
2963
The target branch is considered to be 'local', having low latency.
2965
:returns: PullResult instance
2967
raise NotImplementedError(self.pull)
2969
def update_revisions(self, stop_revision=None, overwrite=False,
2971
"""Pull in new perfect-fit revisions.
2973
:param stop_revision: Updated until the given revision
2974
:param overwrite: Always set the branch pointer, rather than checking
2975
to see if it is a proper descendant.
2976
:param graph: A Graph object that can be used to query history
2977
information. This can be None.
2980
raise NotImplementedError(self.update_revisions)
2982
def push(self, overwrite=False, stop_revision=None,
2983
_override_hook_source_branch=None):
2984
"""Mirror the source branch into the target branch.
2986
The source branch is considered to be 'local', having low latency.
2988
raise NotImplementedError(self.push)
2991
class GenericInterBranch(InterBranch):
2992
"""InterBranch implementation that uses public Branch functions.
2996
def _get_branch_formats_to_test():
2997
return BranchFormat._default_format, BranchFormat._default_format
2999
def update_revisions(self, stop_revision=None, overwrite=False,
3001
"""See InterBranch.update_revisions()."""
3002
self.source.lock_read()
3004
other_revno, other_last_revision = self.source.last_revision_info()
3005
stop_revno = None # unknown
3006
if stop_revision is None:
3007
stop_revision = other_last_revision
3008
if _mod_revision.is_null(stop_revision):
3009
# if there are no commits, we're done.
3011
stop_revno = other_revno
3013
# what's the current last revision, before we fetch [and change it
3015
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3016
# we fetch here so that we don't process data twice in the common
3017
# case of having something to pull, and so that the check for
3018
# already merged can operate on the just fetched graph, which will
3019
# be cached in memory.
3020
self.target.fetch(self.source, stop_revision)
3021
# Check to see if one is an ancestor of the other
3024
graph = self.target.repository.get_graph()
3025
if self.target._check_if_descendant_or_diverged(
3026
stop_revision, last_rev, graph, self.source):
3027
# stop_revision is a descendant of last_rev, but we aren't
3028
# overwriting, so we're done.
3030
if stop_revno is None:
3032
graph = self.target.repository.get_graph()
3033
this_revno, this_last_revision = \
3034
self.target.last_revision_info()
3035
stop_revno = graph.find_distance_to_null(stop_revision,
3036
[(other_last_revision, other_revno),
3037
(this_last_revision, this_revno)])
3038
self.target.set_last_revision_info(stop_revno, stop_revision)
3040
self.source.unlock()
3042
def pull(self, overwrite=False, stop_revision=None,
3043
possible_transports=None, _hook_master=None, run_hooks=True,
3044
_override_hook_target=None, local=False):
3047
:param _hook_master: Private parameter - set the branch to
3048
be supplied as the master to pull hooks.
3049
:param run_hooks: Private parameter - if false, this branch
3050
is being called because it's the master of the primary branch,
3051
so it should not run its hooks.
3052
:param _override_hook_target: Private parameter - set the branch to be
3053
supplied as the target_branch to pull hooks.
3054
:param local: Only update the local branch, and not the bound branch.
3056
# This type of branch can't be bound.
3058
raise errors.LocalRequiresBoundBranch()
3059
result = PullResult()
3060
result.source_branch = self.source
3061
if _override_hook_target is None:
3062
result.target_branch = self.target
3064
result.target_branch = _override_hook_target
3065
self.source.lock_read()
3067
# We assume that during 'pull' the target repository is closer than
3069
self.source.update_references(self.target)
3070
graph = self.target.repository.get_graph(self.source.repository)
3071
# TODO: Branch formats should have a flag that indicates
3072
# that revno's are expensive, and pull() should honor that flag.
3074
result.old_revno, result.old_revid = \
3075
self.target.last_revision_info()
3076
self.target.update_revisions(self.source, stop_revision,
3077
overwrite=overwrite, graph=graph)
3078
# TODO: The old revid should be specified when merging tags,
3079
# so a tags implementation that versions tags can only
3080
# pull in the most recent changes. -- JRV20090506
3081
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3083
result.new_revno, result.new_revid = self.target.last_revision_info()
3085
result.master_branch = _hook_master
3086
result.local_branch = result.target_branch
3088
result.master_branch = result.target_branch
3089
result.local_branch = None
3091
for hook in Branch.hooks['post_pull']:
3094
self.source.unlock()
3097
def push(self, overwrite=False, stop_revision=None,
3098
_override_hook_source_branch=None):
3099
"""See InterBranch.push.
3101
This is the basic concrete implementation of push()
3103
:param _override_hook_source_branch: If specified, run
3104
the hooks passing this Branch as the source, rather than self.
3105
This is for use of RemoteBranch, where push is delegated to the
3106
underlying vfs-based Branch.
3108
# TODO: Public option to disable running hooks - should be trivial but
3110
self.source.lock_read()
3112
return _run_with_write_locked_target(
3113
self.target, self._push_with_bound_branches, overwrite,
3115
_override_hook_source_branch=_override_hook_source_branch)
3117
self.source.unlock()
3119
def _push_with_bound_branches(self, overwrite, stop_revision,
3120
_override_hook_source_branch=None):
3121
"""Push from source into target, and into target's master if any.
3124
if _override_hook_source_branch:
3125
result.source_branch = _override_hook_source_branch
3126
for hook in Branch.hooks['post_push']:
3129
bound_location = self.target.get_bound_location()
3130
if bound_location and self.target.base != bound_location:
3131
# there is a master branch.
3133
# XXX: Why the second check? Is it even supported for a branch to
3134
# be bound to itself? -- mbp 20070507
3135
master_branch = self.target.get_master_branch()
3136
master_branch.lock_write()
3138
# push into the master from the source branch.
3139
self.source._basic_push(master_branch, overwrite, stop_revision)
3140
# and push into the target branch from the source. Note that we
3141
# push from the source branch again, because its considered the
3142
# highest bandwidth repository.
3143
result = self.source._basic_push(self.target, overwrite,
3145
result.master_branch = master_branch
3146
result.local_branch = self.target
3150
master_branch.unlock()
3153
result = self.source._basic_push(self.target, overwrite,
3155
# TODO: Why set master_branch and local_branch if there's no
3156
# binding? Maybe cleaner to just leave them unset? -- mbp
3158
result.master_branch = self.target
3159
result.local_branch = None
3164
def is_compatible(self, source, target):
3165
# GenericBranch uses the public API, so always compatible
3169
class InterToBranch5(GenericInterBranch):
3172
def _get_branch_formats_to_test():
3173
return BranchFormat._default_format, BzrBranchFormat5()
3175
def pull(self, overwrite=False, stop_revision=None,
3176
possible_transports=None, run_hooks=True,
3177
_override_hook_target=None, local=False):
3178
"""Pull from source into self, updating my master if any.
3180
:param run_hooks: Private parameter - if false, this branch
3181
is being called because it's the master of the primary branch,
3182
so it should not run its hooks.
3184
bound_location = self.target.get_bound_location()
3185
if local and not bound_location:
3186
raise errors.LocalRequiresBoundBranch()
3187
master_branch = None
3188
if not local and bound_location and self.source.base != bound_location:
3189
# not pulling from master, so we need to update master.
3190
master_branch = self.target.get_master_branch(possible_transports)
3191
master_branch.lock_write()
3194
# pull from source into master.
3195
master_branch.pull(self.source, overwrite, stop_revision,
3197
return super(InterToBranch5, self).pull(overwrite,
3198
stop_revision, _hook_master=master_branch,
3199
run_hooks=run_hooks,
3200
_override_hook_target=_override_hook_target)
3203
master_branch.unlock()
3206
InterBranch.register_optimiser(GenericInterBranch)
3207
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
