137
68
"""Branch holding a history of revisions.
140
Base directory of the branch.
146
If _lock_mode is true, a positive count of the number of times the
150
Lock object from bzrlib.lock.
71
Base directory/url of the branch.
73
hooks: An instance of BranchHooks.
75
# this is really an instance variable - FIXME move it there
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
165
base -- Base directory for the branch.
79
# override this to set the strategy for storing tags
81
return DisabledTags(self)
83
def __init__(self, *ignored, **ignored_too):
84
self.tags = self._make_tags()
85
self._revision_history_cache = None
86
self._revision_id_to_revno_cache = None
89
"""Break a lock if one is present from another instance.
91
Uses the ui factory to ask for confirmation if the lock may be from
94
This will probe the repository for its lock as well.
96
self.control_files.break_lock()
97
self.repository.break_lock()
98
master = self.get_master_branch()
99
if master is not None:
103
def open(base, _unsupported=False, possible_transports=None):
104
"""Open the branch rooted at base.
106
For instance, if the branch is at URL/.bzr/branch,
107
Branch.open(URL) -> a Branch instance.
109
control = bzrdir.BzrDir.open(base, _unsupported,
110
possible_transports=possible_transports)
111
return control.open_branch(_unsupported)
114
def open_from_transport(transport, _unsupported=False):
115
"""Open the branch rooted at transport"""
116
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
117
return control.open_branch(_unsupported)
120
def open_containing(url, possible_transports=None):
121
"""Open an existing branch which contains url.
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
123
This probes for a branch at url, and searches upwards from there.
125
Basically we keep looking up until we find the control directory or
126
run into the root. If there isn't one, raises NotBranchError.
127
If there is one and it is either an unrecognised format or an unsupported
128
format, UnknownFormatError or UnsupportedFormatError are raised.
129
If there is one, it is returned, along with the unused portion of url.
177
from bzrlib.store import ImmutableStore
179
self.base = os.path.realpath(base)
182
self.base = find_branch_root(base)
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
198
return '%s(%r)' % (self.__class__.__name__, self.base)
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
131
control, relpath = bzrdir.BzrDir.open_containing(url,
133
return control.open_branch(), relpath
135
def get_config(self):
136
return BranchConfig(self)
139
return self.get_config().get_nickname()
141
def _set_nick(self, nick):
142
self.get_config().set_user_option('nickname', nick, warn_masked=True)
144
nick = property(_get_nick, _set_nick)
147
raise NotImplementedError(self.is_locked)
212
149
def lock_write(self):
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
218
self._lock_count += 1
220
from bzrlib.lock import WriteLock
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
150
raise NotImplementedError(self.lock_write)
228
152
def lock_read(self):
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
234
from bzrlib.lock import ReadLock
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
153
raise NotImplementedError(self.lock_read)
242
155
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
247
if self._lock_count > 1:
248
self._lock_count -= 1
156
raise NotImplementedError(self.unlock)
158
def peek_lock_mode(self):
159
"""Return lock mode for the Branch: 'r', 'w' or None"""
160
raise NotImplementedError(self.peek_lock_mode)
162
def get_physical_lock_status(self):
163
raise NotImplementedError(self.get_physical_lock_status)
166
def get_revision_id_to_revno_map(self):
167
"""Return the revision_id => dotted revno map.
169
This will be regenerated on demand, but will be cached.
171
:return: A dictionary mapping revision_id => dotted revno.
172
This dictionary should not be modified by the caller.
174
if self._revision_id_to_revno_cache is not None:
175
mapping = self._revision_id_to_revno_cache
252
self._lock_mode = self._lock_count = None
177
mapping = self._gen_revno_map()
178
self._cache_revision_id_to_revno(mapping)
179
# TODO: jam 20070417 Since this is being cached, should we be returning
181
# I would rather not, and instead just declare that users should not
182
# modify the return value.
185
def _gen_revno_map(self):
186
"""Create a new mapping from revision ids to dotted revnos.
188
Dotted revnos are generated based on the current tip in the revision
190
This is the worker function for get_revision_id_to_revno_map, which
191
just caches the return value.
193
:return: A dictionary mapping revision_id => dotted revno.
195
last_revision = self.last_revision()
196
revision_graph = repository._old_get_graph(self.repository,
198
merge_sorted_revisions = tsort.merge_sort(
203
revision_id_to_revno = dict((rev_id, revno)
204
for seq_num, rev_id, depth, revno, end_of_merge
205
in merge_sorted_revisions)
206
return revision_id_to_revno
208
def leave_lock_in_place(self):
209
"""Tell this branch object not to release the physical lock when this
212
If lock_write doesn't return a token, then this method is not supported.
214
self.control_files.leave_in_place()
216
def dont_leave_lock_in_place(self):
217
"""Tell this branch object to release the physical lock when this
218
object is unlocked, even if it didn't originally acquire it.
220
If lock_write doesn't return a token, then this method is not supported.
222
self.control_files.dont_leave_in_place()
255
224
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
286
fn = self.controlfilename(file_or_path)
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
294
return codecs.open(fn, mode + 'b', 'utf-8',
297
raise BzrError("invalid controlfile mode %r" % mode)
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
322
def _check_format(self):
323
"""Check this branch format is supported.
325
The current tool only supports the current unstable format.
327
In the future, we might need different in-memory Branch
328
classes to support downlevel branches. But not yet.
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
340
def get_root_id(self):
341
"""Return the id of this branches root"""
342
inv = self.read_working_inventory()
343
return inv.root.file_id
345
def set_root_id(self, file_id):
346
inv = self.read_working_inventory()
347
orig_root_id = inv.root.file_id
348
del inv._byid[inv.root.file_id]
349
inv.root.file_id = file_id
350
inv._byid[inv.root.file_id] = inv.root
353
if entry.parent_id in (None, orig_root_id):
354
entry.parent_id = inv.root.file_id
355
self._write_inventory(inv)
357
def read_working_inventory(self):
358
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
365
# ElementTree does its own conversion from UTF-8, so open in
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
382
from bzrlib.atomicfile import AtomicFile
383
from bzrlib.xml import pack_xml
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
396
mutter('wrote working inventory')
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
403
def add(self, files, verbose=False, ids=None):
404
"""Make files versioned.
406
Note that the command line normally calls smart_add instead.
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
412
List of paths to add, relative to the base of the tree.
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
419
TODO: Perhaps have an option to add the ids even if the files do
422
TODO: Perhaps return the ids of the files? But then again it
423
is easy to retrieve them if they're needed.
425
TODO: Adding a directory should optionally recurse down and
426
add all non-ignored children. Perhaps do that in a
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
438
ids = [None] * len(files)
440
assert(len(ids) == len(files))
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
452
raise BzrError("cannot add top-level %r" % f)
454
fullpath = os.path.normpath(self.abspath(f))
457
kind = file_kind(fullpath)
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
470
print 'added', quotefn(f)
472
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
474
self._write_inventory(inv)
479
def print_file(self, file, revno):
480
"""Print `file` to stdout."""
483
tree = self.revision_tree(self.lookup_revision(revno))
484
# use inventory as it was in that revision
485
file_id = tree.inventory.path2id(file)
487
raise BzrError("%r is not present in revision %s" % (file, revno))
488
tree.print_file(file_id)
493
def remove(self, files, verbose=False):
494
"""Mark nominated files for removal from the inventory.
496
This does not remove their text. This does not run on
498
TODO: Refuse to remove modified files unless --force is given?
500
TODO: Do something useful with directories.
502
TODO: Should this remove the text or not? Tough call; not
503
removing may be useful and the user can just use use rm, and
504
is the opposite of add. Removing it is consistent with most
505
other tools. Maybe an option.
507
## TODO: Normalize names
508
## TODO: Remove nested loops; better scalability
509
if isinstance(files, basestring):
515
tree = self.working_tree()
518
# do this before any modifications
522
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
525
# having remove it, it must be either ignored or unknown
526
if tree.is_ignored(f):
530
show_status(new_status, inv[fid].kind, quotefn(f))
533
self._write_inventory(inv)
538
# FIXME: this doesn't need to be a branch method
539
def set_inventory(self, new_inventory_list):
540
from bzrlib.inventory import Inventory, InventoryEntry
541
inv = Inventory(self.get_root_id())
542
for path, file_id, parent, kind in new_inventory_list:
543
name = os.path.basename(path)
546
inv.add(InventoryEntry(file_id, name, kind, parent))
547
self._write_inventory(inv)
551
"""Return all unknown files.
553
These are files in the working directory that are not versioned or
554
control files or ignored.
556
>>> b = ScratchBranch(files=['foo', 'foo~'])
557
>>> list(b.unknowns())
560
>>> list(b.unknowns())
563
>>> list(b.unknowns())
566
return self.working_tree().unknowns()
569
def append_revision(self, *revision_ids):
570
from bzrlib.atomicfile import AtomicFile
572
for revision_id in revision_ids:
573
mutter("add {%s} to revision-history" % revision_id)
575
rev_history = self.revision_history()
576
rev_history.extend(revision_ids)
578
f = AtomicFile(self.controlfilename('revision-history'))
580
for rev_id in rev_history:
587
def get_revision_xml(self, revision_id):
588
"""Return XML file object for revision object."""
589
if not revision_id or not isinstance(revision_id, basestring):
590
raise InvalidRevisionId(revision_id)
595
return self.revision_store[revision_id]
597
raise bzrlib.errors.NoSuchRevision(revision_id)
602
def get_revision(self, revision_id):
603
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
607
r = unpack_xml(Revision, xml_file)
608
except SyntaxError, e:
609
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
assert r.revision_id == revision_id
225
"""Return absolute filename for something in the branch
227
XXX: Robert Collins 20051017 what is this used for? why is it a branch
228
method and not a tree method.
230
raise NotImplementedError(self.abspath)
232
def bind(self, other):
233
"""Bind the local branch the other branch.
235
:param other: The branch to bind to
238
raise errors.UpgradeRequired(self.base)
241
def fetch(self, from_branch, last_revision=None, pb=None):
242
"""Copy revisions from from_branch into this branch.
244
:param from_branch: Where to copy from.
245
:param last_revision: What revision to stop at (None for at the end
247
:param pb: An optional progress bar to use.
249
Returns the copied revision count and the failed revisions in a tuple:
252
if self.base == from_branch.base:
255
nested_pb = ui.ui_factory.nested_progress_bar()
260
from_branch.lock_read()
262
if last_revision is None:
263
pb.update('get source history')
264
last_revision = from_branch.last_revision()
265
last_revision = _mod_revision.ensure_null(last_revision)
266
return self.repository.fetch(from_branch.repository,
267
revision_id=last_revision,
270
if nested_pb is not None:
274
def get_bound_location(self):
275
"""Return the URL of the branch we are bound to.
277
Older format branches cannot bind, please be sure to use a metadir
282
def get_old_bound_location(self):
283
"""Return the URL of the branch we used to be bound to
285
raise errors.UpgradeRequired(self.base)
287
def get_commit_builder(self, parents, config=None, timestamp=None,
288
timezone=None, committer=None, revprops=None,
290
"""Obtain a CommitBuilder for this branch.
292
:param parents: Revision ids of the parents of the new revision.
293
:param config: Optional configuration to use.
294
:param timestamp: Optional timestamp recorded for commit.
295
:param timezone: Optional timezone for timestamp.
296
:param committer: Optional committer to set for commit.
297
:param revprops: Optional dictionary of revision properties.
298
:param revision_id: Optional revision id.
302
config = self.get_config()
304
return self.repository.get_commit_builder(self, parents, config,
305
timestamp, timezone, committer, revprops, revision_id)
307
def get_master_branch(self, possible_transports=None):
308
"""Return the branch we are bound to.
310
:return: Either a Branch, or None
617
314
def get_revision_delta(self, revno):
618
315
"""Return the delta for one revision.
1125
524
Note that to_name is only the last component of the new name;
1126
525
this doesn't change the directory.
1130
## TODO: Option to move IDs only
1131
assert not isinstance(from_paths, basestring)
1132
tree = self.working_tree()
1133
inv = tree.inventory
1134
to_abs = self.abspath(to_name)
1135
if not isdir(to_abs):
1136
raise BzrError("destination %r is not a directory" % to_abs)
1137
if not tree.has_filename(to_name):
1138
raise BzrError("destination %r not in working directory" % to_abs)
1139
to_dir_id = inv.path2id(to_name)
1140
if to_dir_id == None and to_name != '':
1141
raise BzrError("destination %r is not a versioned directory" % to_name)
1142
to_dir_ie = inv[to_dir_id]
1143
if to_dir_ie.kind not in ('directory', 'root_directory'):
1144
raise BzrError("destination %r is not a directory" % to_abs)
1146
to_idpath = inv.get_idpath(to_dir_id)
1148
for f in from_paths:
1149
if not tree.has_filename(f):
1150
raise BzrError("%r does not exist in working tree" % f)
1151
f_id = inv.path2id(f)
1153
raise BzrError("%r is not versioned" % f)
1154
name_tail = splitpath(f)[-1]
1155
dest_path = appendpath(to_name, name_tail)
1156
if tree.has_filename(dest_path):
1157
raise BzrError("destination %r already exists" % dest_path)
1158
if f_id in to_idpath:
1159
raise BzrError("can't move %r to a subdirectory of itself" % f)
1161
# OK, so there's a race here, it's possible that someone will
1162
# create a file in this interval and then the rename might be
1163
# left half-done. But we should have caught most problems.
1165
for f in from_paths:
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
print "%s => %s" % (f, dest_path)
1169
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1171
os.rename(self.abspath(f), self.abspath(dest_path))
1173
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
["rename rolled back"])
1176
self._write_inventory(inv)
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1185
If true (default) backups are made of files before
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1206
# TODO: Rename back if it was previously at a different location
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1211
# TODO: Make a backup to a temporary file.
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1217
f = AtomicFile(fn, 'wb')
1219
f.write(old_tree.get_file(file_id).read())
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1243
validate_revision_id(revision_id)
1245
p = self.pending_merges()
1246
if revision_id in p:
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
1256
f = AtomicFile(self.controlfilename('pending-merges'))
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1271
>>> b = ScratchBranch()
1279
def __init__(self, files=[], dirs=[], base=None):
1280
"""Make a test branch.
1282
This creates a temporary directory and runs init-tree in it.
1284
If any files are listed, they are created in the working copy.
1286
from tempfile import mkdtemp
1291
Branch.__init__(self, base, init=init)
1293
os.mkdir(self.abspath(d))
1296
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1301
>>> orig = ScratchBranch(files=["file1", "file2"])
1302
>>> clone = orig.clone()
1303
>>> os.path.samefile(orig.base, clone.base)
1305
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1308
from shutil import copytree
1309
from tempfile import mkdtemp
1312
copytree(self.base, base, symlinks=True)
1313
return ScratchBranch(base=base)
1319
"""Destroy the test branch, removing the scratch directory."""
1320
from shutil import rmtree
1323
mutter("delete ScratchBranch %s" % self.base)
1326
# Work around for shutil.rmtree failing on Windows when
1327
# readonly files are encountered
1328
mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
for root, dirs, files in os.walk(self.base, topdown=False):
1331
os.chmod(os.path.join(root, name), 0700)
1337
######################################################################
1341
def is_control_file(filename):
1342
## FIXME: better check
1343
filename = os.path.normpath(filename)
1344
while filename != '':
1345
head, tail = os.path.split(filename)
1346
## mutter('check %r for control file' % ((head, tail), ))
1347
if tail == bzrlib.BZRDIR:
527
This returns a list of (from_path, to_path) pairs for each
530
raise NotImplementedError(self.move)
532
def get_parent(self):
533
"""Return the parent location of the branch.
535
This is the default location for push/pull/missing. The usual
536
pattern is that the user can override it by specifying a
539
raise NotImplementedError(self.get_parent)
541
def _set_config_location(self, name, url, config=None,
542
make_relative=False):
544
config = self.get_config()
548
url = urlutils.relative_url(self.base, url)
549
config.set_user_option(name, url, warn_masked=True)
551
def _get_config_location(self, name, config=None):
553
config = self.get_config()
554
location = config.get_user_option(name)
559
def get_submit_branch(self):
560
"""Return the submit location of the branch.
562
This is the default location for bundle. The usual
563
pattern is that the user can override it by specifying a
566
return self.get_config().get_user_option('submit_branch')
568
def set_submit_branch(self, location):
569
"""Return the submit location of the branch.
571
This is the default location for bundle. The usual
572
pattern is that the user can override it by specifying a
575
self.get_config().set_user_option('submit_branch', location,
578
def get_public_branch(self):
579
"""Return the public location of the branch.
581
This is is used by merge directives.
583
return self._get_config_location('public_branch')
585
def set_public_branch(self, location):
586
"""Return the submit location of the branch.
588
This is the default location for bundle. The usual
589
pattern is that the user can override it by specifying a
592
self._set_config_location('public_branch', location)
594
def get_push_location(self):
595
"""Return the None or the location to push this branch to."""
596
push_loc = self.get_config().get_user_option('push_location')
599
def set_push_location(self, location):
600
"""Set a new push location for this branch."""
601
raise NotImplementedError(self.set_push_location)
603
def set_parent(self, url):
604
raise NotImplementedError(self.set_parent)
608
"""Synchronise this branch with the master branch if any.
610
:return: None or the last_revision pivoted out during the update.
614
def check_revno(self, revno):
616
Check whether a revno corresponds to any revision.
617
Zero (the NULL revision) is considered valid.
620
self.check_real_revno(revno)
622
def check_real_revno(self, revno):
624
Check whether a revno corresponds to a real revision.
625
Zero (the NULL revision) is considered invalid
627
if revno < 1 or revno > self.revno():
628
raise errors.InvalidRevisionNumber(revno)
631
def clone(self, to_bzrdir, revision_id=None):
632
"""Clone this branch into to_bzrdir preserving all semantic values.
634
revision_id: if not None, the revision history in the new branch will
635
be truncated to end with revision_id.
637
result = self._format.initialize(to_bzrdir)
638
self.copy_content_into(result, revision_id=revision_id)
642
def sprout(self, to_bzrdir, revision_id=None):
643
"""Create a new line of development from the branch, into to_bzrdir.
645
revision_id: if not None, the revision history in the new branch will
646
be truncated to end with revision_id.
648
result = self._format.initialize(to_bzrdir)
649
self.copy_content_into(result, revision_id=revision_id)
650
result.set_parent(self.bzrdir.root_transport.base)
653
def _synchronize_history(self, destination, revision_id):
654
"""Synchronize last revision and revision history between branches.
656
This version is most efficient when the destination is also a
657
BzrBranch5, but works for BzrBranch6 as long as the revision
658
history is the true lefthand parent history, and all of the revisions
659
are in the destination's repository. If not, set_revision_history
662
:param destination: The branch to copy the history into
663
:param revision_id: The revision-id to truncate history at. May
664
be None to copy complete history.
666
if revision_id == _mod_revision.NULL_REVISION:
668
new_history = self.revision_history()
669
if revision_id is not None and new_history != []:
671
new_history = new_history[:new_history.index(revision_id) + 1]
673
rev = self.repository.get_revision(revision_id)
674
new_history = rev.get_history(self.repository)[1:]
675
destination.set_revision_history(new_history)
678
def copy_content_into(self, destination, revision_id=None):
679
"""Copy the content of self into destination.
681
revision_id: if not None, the revision history in the new branch will
682
be truncated to end with revision_id.
684
self._synchronize_history(destination, revision_id)
686
parent = self.get_parent()
687
except errors.InaccessibleParent, e:
688
mutter('parent was not accessible to copy: %s', e)
691
destination.set_parent(parent)
692
self.tags.merge_to(destination.tags)
696
"""Check consistency of the branch.
698
In particular this checks that revisions given in the revision-history
699
do actually match up in the revision graph, and that they're all
700
present in the repository.
702
Callers will typically also want to check the repository.
704
:return: A BranchCheckResult.
706
mainline_parent_id = None
707
for revision_id in self.revision_history():
709
revision = self.repository.get_revision(revision_id)
710
except errors.NoSuchRevision, e:
711
raise errors.BzrCheckError("mainline revision {%s} not in repository"
713
# In general the first entry on the revision history has no parents.
714
# But it's not illegal for it to have parents listed; this can happen
715
# in imports from Arch when the parents weren't reachable.
716
if mainline_parent_id is not None:
717
if mainline_parent_id not in revision.parent_ids:
718
raise errors.BzrCheckError("previous revision {%s} not listed among "
720
% (mainline_parent_id, revision_id))
721
mainline_parent_id = revision_id
722
return BranchCheckResult(self)
724
def _get_checkout_format(self):
725
"""Return the most suitable metadir for a checkout of this branch.
726
Weaves are used if this branch's repository uses weaves.
728
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
729
from bzrlib.repofmt import weaverepo
730
format = bzrdir.BzrDirMetaFormat1()
731
format.repository_format = weaverepo.RepositoryFormat7()
733
format = self.repository.bzrdir.checkout_metadir()
734
format.set_branch_format(self._format)
737
def create_checkout(self, to_location, revision_id=None,
738
lightweight=False, accelerator_tree=None,
740
"""Create a checkout of a branch.
742
:param to_location: The url to produce the checkout at
743
:param revision_id: The revision to check out
744
:param lightweight: If True, produce a lightweight checkout, otherwise,
745
produce a bound branch (heavyweight checkout)
746
:param accelerator_tree: A tree which can be used for retrieving file
747
contents more quickly than the revision tree, i.e. a workingtree.
748
The revision tree will be used for cases where accelerator_tree's
749
content is different.
750
:param hardlink: If true, hard-link files from accelerator_tree,
752
:return: The tree of the created checkout
754
t = transport.get_transport(to_location)
757
format = self._get_checkout_format()
758
checkout = format.initialize_on_transport(t)
759
from_branch = BranchReferenceFormat().initialize(checkout, self)
761
format = self._get_checkout_format()
762
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
763
to_location, force_new_tree=False, format=format)
764
checkout = checkout_branch.bzrdir
765
checkout_branch.bind(self)
766
# pull up to the specified revision_id to set the initial
767
# branch tip correctly, and seed it with history.
768
checkout_branch.pull(self, stop_revision=revision_id)
770
tree = checkout.create_workingtree(revision_id,
771
from_branch=from_branch,
772
accelerator_tree=accelerator_tree,
774
basis_tree = tree.basis_tree()
775
basis_tree.lock_read()
777
for path, file_id in basis_tree.iter_references():
778
reference_parent = self.reference_parent(file_id, path)
779
reference_parent.create_checkout(tree.abspath(path),
780
basis_tree.get_reference_revision(file_id, path),
786
def reference_parent(self, file_id, path):
787
"""Return the parent branch for a tree-reference file_id
788
:param file_id: The file_id of the tree reference
789
:param path: The path of the file_id in the tree
790
:return: A branch associated with the file_id
792
# FIXME should provide multiple branches, based on config
793
return Branch.open(self.bzrdir.root_transport.clone(path).base)
795
def supports_tags(self):
796
return self._format.supports_tags()
799
class BranchFormat(object):
800
"""An encapsulation of the initialization and open routines for a format.
802
Formats provide three things:
803
* An initialization routine,
807
Formats are placed in an dict by their format string for reference
808
during branch opening. Its not required that these be instances, they
809
can be classes themselves with class methods - it simply depends on
810
whether state is needed for a given format or not.
812
Once a format is deprecated, just deprecate the initialize and open
813
methods on the format class. Do not deprecate the object, as the
814
object will be created every time regardless.
817
_default_format = None
818
"""The default format used for new branches."""
821
"""The known formats."""
823
def __eq__(self, other):
824
return self.__class__ is other.__class__
826
def __ne__(self, other):
827
return not (self == other)
830
def find_format(klass, a_bzrdir):
831
"""Return the format for the branch object in a_bzrdir."""
833
transport = a_bzrdir.get_branch_transport(None)
834
format_string = transport.get("format").read()
835
return klass._formats[format_string]
836
except errors.NoSuchFile:
837
raise errors.NotBranchError(path=transport.base)
839
raise errors.UnknownFormatError(format=format_string, kind='branch')
842
def get_default_format(klass):
843
"""Return the current default format."""
844
return klass._default_format
846
def get_reference(self, a_bzrdir):
847
"""Get the target reference of the branch in a_bzrdir.
849
format probing must have been completed before calling
850
this method - it is assumed that the format of the branch
851
in a_bzrdir is correct.
853
:param a_bzrdir: The bzrdir to get the branch data from.
854
:return: None if the branch is not a reference branch.
859
def set_reference(self, a_bzrdir, to_branch):
860
"""Set the target reference of the branch in a_bzrdir.
862
format probing must have been completed before calling
863
this method - it is assumed that the format of the branch
864
in a_bzrdir is correct.
866
:param a_bzrdir: The bzrdir to set the branch reference for.
867
:param to_branch: branch that the checkout is to reference
869
raise NotImplementedError(self.set_reference)
871
def get_format_string(self):
872
"""Return the ASCII format string that identifies this format."""
873
raise NotImplementedError(self.get_format_string)
875
def get_format_description(self):
876
"""Return the short format description for this format."""
877
raise NotImplementedError(self.get_format_description)
879
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
881
"""Initialize a branch in a bzrdir, with specified files
883
:param a_bzrdir: The bzrdir to initialize the branch in
884
:param utf8_files: The files to create as a list of
885
(filename, content) tuples
886
:param set_format: If True, set the format with
887
self.get_format_string. (BzrBranch4 has its format set
889
:return: a branch in this format
891
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
892
branch_transport = a_bzrdir.get_branch_transport(self)
894
'metadir': ('lock', lockdir.LockDir),
895
'branch4': ('branch-lock', lockable_files.TransportLock),
897
lock_name, lock_class = lock_map[lock_type]
898
control_files = lockable_files.LockableFiles(branch_transport,
899
lock_name, lock_class)
900
control_files.create_lock()
901
control_files.lock_write()
903
control_files.put_utf8('format', self.get_format_string())
905
for file, content in utf8_files:
906
control_files.put_utf8(file, content)
908
control_files.unlock()
909
return self.open(a_bzrdir, _found=True)
911
def initialize(self, a_bzrdir):
912
"""Create a branch of this format in a_bzrdir."""
913
raise NotImplementedError(self.initialize)
915
def is_supported(self):
916
"""Is this format supported?
918
Supported formats can be initialized and opened.
919
Unsupported formats may not support initialization or committing or
920
some other features depending on the reason for not being supported.
924
def open(self, a_bzrdir, _found=False):
925
"""Return the branch object for a_bzrdir
927
_found is a private parameter, do not use it. It is used to indicate
928
if format probing has already be done.
930
raise NotImplementedError(self.open)
933
def register_format(klass, format):
934
klass._formats[format.get_format_string()] = format
937
def set_default_format(klass, format):
938
klass._default_format = format
941
def unregister_format(klass, format):
942
assert klass._formats[format.get_format_string()] is format
943
del klass._formats[format.get_format_string()]
946
return self.get_format_string().rstrip()
948
def supports_tags(self):
949
"""True if this format supports tags stored in the branch"""
950
return False # by default
952
# XXX: Probably doesn't really belong here -- mbp 20070212
953
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
955
branch_transport = a_bzrdir.get_branch_transport(self)
956
control_files = lockable_files.LockableFiles(branch_transport,
957
lock_filename, lock_class)
958
control_files.create_lock()
959
control_files.lock_write()
961
for filename, content in utf8_files:
962
control_files.put_utf8(filename, content)
964
control_files.unlock()
967
class BranchHooks(Hooks):
968
"""A dictionary mapping hook name to a list of callables for branch hooks.
970
e.g. ['set_rh'] Is the list of items to be called when the
971
set_revision_history function is invoked.
975
"""Create the default hooks.
977
These are all empty initially, because by default nothing should get
981
# Introduced in 0.15:
982
# invoked whenever the revision history has been set
983
# with set_revision_history. The api signature is
984
# (branch, revision_history), and the branch will
987
# invoked after a push operation completes.
988
# the api signature is
990
# containing the members
991
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
992
# where local is the local target branch or None, master is the target
993
# master branch, and the rest should be self explanatory. The source
994
# is read locked and the target branches write locked. Source will
995
# be the local low-latency branch.
996
self['post_push'] = []
997
# invoked after a pull operation completes.
998
# the api signature is
1000
# containing the members
1001
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1002
# where local is the local branch or None, master is the target
1003
# master branch, and the rest should be self explanatory. The source
1004
# is read locked and the target branches write locked. The local
1005
# branch is the low-latency branch.
1006
self['post_pull'] = []
1007
# invoked before a commit operation takes place.
1008
# the api signature is
1009
# (local, master, old_revno, old_revid, future_revno, future_revid,
1010
# tree_delta, future_tree).
1011
# old_revid is NULL_REVISION for the first commit to a branch
1012
# tree_delta is a TreeDelta object describing changes from the basis
1013
# revision, hooks MUST NOT modify this delta
1014
# future_tree is an in-memory tree obtained from
1015
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1016
self['pre_commit'] = []
1017
# invoked after a commit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid)
1020
# old_revid is NULL_REVISION for the first commit to a branch.
1021
self['post_commit'] = []
1022
# invoked after a uncommit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1025
# local is the local branch or None, master is the target branch,
1026
# and an empty branch recieves new_revno of 0, new_revid of None.
1027
self['post_uncommit'] = []
1030
# install the default hooks into the Branch class.
1031
Branch.hooks = BranchHooks()
1034
class BzrBranchFormat4(BranchFormat):
1035
"""Bzr branch format 4.
1038
- a revision-history file.
1039
- a branch-lock lock file [ to be shared with the bzrdir ]
1042
def get_format_description(self):
1043
"""See BranchFormat.get_format_description()."""
1044
return "Branch format 4"
1046
def initialize(self, a_bzrdir):
1047
"""Create a branch of this format in a_bzrdir."""
1048
utf8_files = [('revision-history', ''),
1049
('branch-name', ''),
1051
return self._initialize_helper(a_bzrdir, utf8_files,
1052
lock_type='branch4', set_format=False)
1055
super(BzrBranchFormat4, self).__init__()
1056
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1058
def open(self, a_bzrdir, _found=False):
1059
"""Return the branch object for a_bzrdir
1061
_found is a private parameter, do not use it. It is used to indicate
1062
if format probing has already be done.
1065
# we are being called directly and must probe.
1066
raise NotImplementedError
1067
return BzrBranch(_format=self,
1068
_control_files=a_bzrdir._control_files,
1070
_repository=a_bzrdir.open_repository())
1073
return "Bazaar-NG branch format 4"
1076
class BzrBranchFormat5(BranchFormat):
1077
"""Bzr branch format 5.
1080
- a revision-history file.
1082
- a lock dir guarding the branch itself
1083
- all of this stored in a branch/ subdirectory
1084
- works with shared repositories.
1086
This format is new in bzr 0.8.
1089
def get_format_string(self):
1090
"""See BranchFormat.get_format_string()."""
1091
return "Bazaar-NG branch format 5\n"
1093
def get_format_description(self):
1094
"""See BranchFormat.get_format_description()."""
1095
return "Branch format 5"
1097
def initialize(self, a_bzrdir):
1098
"""Create a branch of this format in a_bzrdir."""
1099
utf8_files = [('revision-history', ''),
1100
('branch-name', ''),
1102
return self._initialize_helper(a_bzrdir, utf8_files)
1105
super(BzrBranchFormat5, self).__init__()
1106
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1108
def open(self, a_bzrdir, _found=False):
1109
"""Return the branch object for a_bzrdir
1111
_found is a private parameter, do not use it. It is used to indicate
1112
if format probing has already be done.
1115
format = BranchFormat.find_format(a_bzrdir)
1116
assert format.__class__ == self.__class__
1118
transport = a_bzrdir.get_branch_transport(None)
1119
control_files = lockable_files.LockableFiles(transport, 'lock',
1121
return BzrBranch5(_format=self,
1122
_control_files=control_files,
1124
_repository=a_bzrdir.find_repository())
1125
except errors.NoSuchFile:
1126
raise errors.NotBranchError(path=transport.base)
1129
class BzrBranchFormat6(BzrBranchFormat5):
1130
"""Branch format with last-revision and tags.
1132
Unlike previous formats, this has no explicit revision history. Instead,
1133
this just stores the last-revision, and the left-hand history leading
1134
up to there is the history.
1136
This format was introduced in bzr 0.15
1137
and became the default in 0.91.
1140
def get_format_string(self):
1141
"""See BranchFormat.get_format_string()."""
1142
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1144
def get_format_description(self):
1145
"""See BranchFormat.get_format_description()."""
1146
return "Branch format 6"
1148
def initialize(self, a_bzrdir):
1149
"""Create a branch of this format in a_bzrdir."""
1150
utf8_files = [('last-revision', '0 null:\n'),
1151
('branch.conf', ''),
1154
return self._initialize_helper(a_bzrdir, utf8_files)
1156
def open(self, a_bzrdir, _found=False):
1157
"""Return the branch object for a_bzrdir
1159
_found is a private parameter, do not use it. It is used to indicate
1160
if format probing has already be done.
1163
format = BranchFormat.find_format(a_bzrdir)
1164
assert format.__class__ == self.__class__
1165
transport = a_bzrdir.get_branch_transport(None)
1166
control_files = lockable_files.LockableFiles(transport, 'lock',
1168
return BzrBranch6(_format=self,
1169
_control_files=control_files,
1171
_repository=a_bzrdir.find_repository())
1173
def supports_tags(self):
1177
class BranchReferenceFormat(BranchFormat):
1178
"""Bzr branch reference format.
1180
Branch references are used in implementing checkouts, they
1181
act as an alias to the real branch which is at some other url.
1188
def get_format_string(self):
1189
"""See BranchFormat.get_format_string()."""
1190
return "Bazaar-NG Branch Reference Format 1\n"
1192
def get_format_description(self):
1193
"""See BranchFormat.get_format_description()."""
1194
return "Checkout reference format 1"
1196
def get_reference(self, a_bzrdir):
1197
"""See BranchFormat.get_reference()."""
1198
transport = a_bzrdir.get_branch_transport(None)
1199
return transport.get('location').read()
1201
def set_reference(self, a_bzrdir, to_branch):
1202
"""See BranchFormat.set_reference()."""
1203
transport = a_bzrdir.get_branch_transport(None)
1204
location = transport.put_bytes('location', to_branch.base)
1206
def initialize(self, a_bzrdir, target_branch=None):
1207
"""Create a branch of this format in a_bzrdir."""
1208
if target_branch is None:
1209
# this format does not implement branch itself, thus the implicit
1210
# creation contract must see it as uninitializable
1211
raise errors.UninitializableFormat(self)
1212
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1213
branch_transport = a_bzrdir.get_branch_transport(self)
1214
branch_transport.put_bytes('location',
1215
target_branch.bzrdir.root_transport.base)
1216
branch_transport.put_bytes('format', self.get_format_string())
1218
a_bzrdir, _found=True,
1219
possible_transports=[target_branch.bzrdir.root_transport])
1222
super(BranchReferenceFormat, self).__init__()
1223
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1225
def _make_reference_clone_function(format, a_branch):
1226
"""Create a clone() routine for a branch dynamically."""
1227
def clone(to_bzrdir, revision_id=None):
1228
"""See Branch.clone()."""
1229
return format.initialize(to_bzrdir, a_branch)
1230
# cannot obey revision_id limits when cloning a reference ...
1231
# FIXME RBC 20060210 either nuke revision_id for clone, or
1232
# emit some sort of warning/error to the caller ?!
1235
def open(self, a_bzrdir, _found=False, location=None,
1236
possible_transports=None):
1237
"""Return the branch that the branch reference in a_bzrdir points at.
1239
_found is a private parameter, do not use it. It is used to indicate
1240
if format probing has already be done.
1243
format = BranchFormat.find_format(a_bzrdir)
1244
assert format.__class__ == self.__class__
1245
if location is None:
1246
location = self.get_reference(a_bzrdir)
1247
real_bzrdir = bzrdir.BzrDir.open(
1248
location, possible_transports=possible_transports)
1249
result = real_bzrdir.open_branch()
1250
# this changes the behaviour of result.clone to create a new reference
1251
# rather than a copy of the content of the branch.
1252
# I did not use a proxy object because that needs much more extensive
1253
# testing, and we are only changing one behaviour at the moment.
1254
# If we decide to alter more behaviours - i.e. the implicit nickname
1255
# then this should be refactored to introduce a tested proxy branch
1256
# and a subclass of that for use in overriding clone() and ....
1258
result.clone = self._make_reference_clone_function(result)
1262
# formats which have no format string are not discoverable
1263
# and not independently creatable, so are not registered.
1264
__format5 = BzrBranchFormat5()
1265
__format6 = BzrBranchFormat6()
1266
BranchFormat.register_format(__format5)
1267
BranchFormat.register_format(BranchReferenceFormat())
1268
BranchFormat.register_format(__format6)
1269
BranchFormat.set_default_format(__format6)
1270
_legacy_formats = [BzrBranchFormat4(),
1273
class BzrBranch(Branch):
1274
"""A branch stored in the actual filesystem.
1276
Note that it's "local" in the context of the filesystem; it doesn't
1277
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1278
it's writable, and can be accessed via the normal filesystem API.
1281
def __init__(self, _format=None,
1282
_control_files=None, a_bzrdir=None, _repository=None):
1283
"""Create new branch object at a particular location."""
1284
Branch.__init__(self)
1285
if a_bzrdir is None:
1286
raise ValueError('a_bzrdir must be supplied')
1288
self.bzrdir = a_bzrdir
1289
# self._transport used to point to the directory containing the
1290
# control directory, but was not used - now it's just the transport
1291
# for the branch control files. mbp 20070212
1292
self._base = self.bzrdir.transport.clone('..').base
1293
self._format = _format
1294
if _control_files is None:
1295
raise ValueError('BzrBranch _control_files is None')
1296
self.control_files = _control_files
1297
self._transport = _control_files._transport
1298
self.repository = _repository
1301
return '%s(%r)' % (self.__class__.__name__, self.base)
1305
def _get_base(self):
1306
"""Returns the directory containing the control directory."""
1309
base = property(_get_base, doc="The URL for the root of this branch.")
1311
def abspath(self, name):
1312
"""See Branch.abspath."""
1313
return self.control_files._transport.abspath(name)
1316
@deprecated_method(zero_sixteen)
1318
def get_root_id(self):
1319
"""See Branch.get_root_id."""
1320
tree = self.repository.revision_tree(self.last_revision())
1321
return tree.get_root_id()
1323
def is_locked(self):
1324
return self.control_files.is_locked()
1326
def lock_write(self, token=None):
1327
repo_token = self.repository.lock_write()
1329
token = self.control_files.lock_write(token=token)
1331
self.repository.unlock()
1335
def lock_read(self):
1336
self.repository.lock_read()
1338
self.control_files.lock_read()
1340
self.repository.unlock()
1344
# TODO: test for failed two phase locks. This is known broken.
1346
self.control_files.unlock()
1348
self.repository.unlock()
1349
if not self.control_files.is_locked():
1350
# we just released the lock
1351
self._clear_cached_state()
1353
def peek_lock_mode(self):
1354
if self.control_files._lock_count == 0:
1357
return self.control_files._lock_mode
1359
def get_physical_lock_status(self):
1360
return self.control_files.get_physical_lock_status()
1363
def print_file(self, file, revision_id):
1364
"""See Branch.print_file."""
1365
return self.repository.print_file(file, revision_id)
1367
def _write_revision_history(self, history):
1368
"""Factored out of set_revision_history.
1370
This performs the actual writing to disk.
1371
It is intended to be called by BzrBranch5.set_revision_history."""
1372
self.control_files.put_bytes(
1373
'revision-history', '\n'.join(history))
1376
def set_revision_history(self, rev_history):
1377
"""See Branch.set_revision_history."""
1378
if 'evil' in debug.debug_flags:
1379
mutter_callsite(3, "set_revision_history scales with history.")
1380
self._write_revision_history(rev_history)
1381
self._clear_cached_state()
1382
self._cache_revision_history(rev_history)
1383
for hook in Branch.hooks['set_rh']:
1384
hook(self, rev_history)
1387
def set_last_revision_info(self, revno, revision_id):
1388
"""Set the last revision of this branch.
1390
The caller is responsible for checking that the revno is correct
1391
for this revision id.
1393
It may be possible to set the branch last revision to an id not
1394
present in the repository. However, branches can also be
1395
configured to check constraints on history, in which case this may not
1398
revision_id = _mod_revision.ensure_null(revision_id)
1399
history = self._lefthand_history(revision_id)
1400
assert len(history) == revno, '%d != %d' % (len(history), revno)
1401
self.set_revision_history(history)
1403
def _gen_revision_history(self):
1404
history = self.control_files.get('revision-history').read().split('\n')
1405
if history[-1:] == ['']:
1406
# There shouldn't be a trailing newline, but just in case.
1410
def _lefthand_history(self, revision_id, last_rev=None,
1412
if 'evil' in debug.debug_flags:
1413
mutter_callsite(4, "_lefthand_history scales with history.")
1414
# stop_revision must be a descendant of last_revision
1415
graph = self.repository.get_graph()
1416
if last_rev is not None:
1417
if not graph.is_ancestor(last_rev, revision_id):
1418
# our previous tip is not merged into stop_revision
1419
raise errors.DivergedBranches(self, other_branch)
1420
# make a new revision history from the graph
1421
parents_map = graph.get_parent_map([revision_id])
1422
if revision_id not in parents_map:
1423
raise errors.NoSuchRevision(self, revision_id)
1424
current_rev_id = revision_id
1426
# Do not include ghosts or graph origin in revision_history
1427
while (current_rev_id in parents_map and
1428
len(parents_map[current_rev_id]) > 0):
1429
new_history.append(current_rev_id)
1430
current_rev_id = parents_map[current_rev_id][0]
1431
parents_map = graph.get_parent_map([current_rev_id])
1432
new_history.reverse()
1436
def generate_revision_history(self, revision_id, last_rev=None,
1438
"""Create a new revision history that will finish with revision_id.
1440
:param revision_id: the new tip to use.
1441
:param last_rev: The previous last_revision. If not None, then this
1442
must be a ancestory of revision_id, or DivergedBranches is raised.
1443
:param other_branch: The other branch that DivergedBranches should
1444
raise with respect to.
1446
self.set_revision_history(self._lefthand_history(revision_id,
1447
last_rev, other_branch))
1450
def update_revisions(self, other, stop_revision=None, overwrite=False):
1451
"""See Branch.update_revisions."""
1454
other_last_revno, other_last_revision = other.last_revision_info()
1455
if stop_revision is None:
1456
stop_revision = other_last_revision
1457
if _mod_revision.is_null(stop_revision):
1458
# if there are no commits, we're done.
1460
# whats the current last revision, before we fetch [and change it
1462
last_rev = _mod_revision.ensure_null(self.last_revision())
1463
# we fetch here so that we don't process data twice in the common
1464
# case of having something to pull, and so that the check for
1465
# already merged can operate on the just fetched graph, which will
1466
# be cached in memory.
1467
self.fetch(other, stop_revision)
1468
# Check to see if one is an ancestor of the other
1470
heads = self.repository.get_graph().heads([stop_revision,
1472
if heads == set([last_rev]):
1473
# The current revision is a decendent of the target,
1476
elif heads == set([stop_revision, last_rev]):
1477
# These branches have diverged
1478
raise errors.DivergedBranches(self, other)
1479
assert heads == set([stop_revision])
1480
if other_last_revision == stop_revision:
1481
self.set_last_revision_info(other_last_revno,
1482
other_last_revision)
1484
# TODO: jam 2007-11-29 Is there a way to determine the
1485
# revno without searching all of history??
1487
self.generate_revision_history(stop_revision)
1489
self.generate_revision_history(stop_revision,
1490
last_rev=last_rev, other_branch=other)
1494
def basis_tree(self):
1495
"""See Branch.basis_tree."""
1496
return self.repository.revision_tree(self.last_revision())
1499
def pull(self, source, overwrite=False, stop_revision=None,
1500
_hook_master=None, run_hooks=True, possible_transports=None):
1503
:param _hook_master: Private parameter - set the branch to
1504
be supplied as the master to push hooks.
1505
:param run_hooks: Private parameter - if false, this branch
1506
is being called because it's the master of the primary branch,
1507
so it should not run its hooks.
1509
result = PullResult()
1510
result.source_branch = source
1511
result.target_branch = self
1514
result.old_revno, result.old_revid = self.last_revision_info()
1515
self.update_revisions(source, stop_revision, overwrite=overwrite)
1516
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1517
result.new_revno, result.new_revid = self.last_revision_info()
1519
result.master_branch = _hook_master
1520
result.local_branch = self
1522
result.master_branch = self
1523
result.local_branch = None
1525
for hook in Branch.hooks['post_pull']:
1531
def _get_parent_location(self):
1532
_locs = ['parent', 'pull', 'x-pull']
1535
return self.control_files.get(l).read().strip('\n')
1536
except errors.NoSuchFile:
1541
def push(self, target, overwrite=False, stop_revision=None,
1542
_override_hook_source_branch=None):
1545
This is the basic concrete implementation of push()
1547
:param _override_hook_source_branch: If specified, run
1548
the hooks passing this Branch as the source, rather than self.
1549
This is for use of RemoteBranch, where push is delegated to the
1550
underlying vfs-based Branch.
1552
# TODO: Public option to disable running hooks - should be trivial but
1556
result = self._push_with_bound_branches(target, overwrite,
1558
_override_hook_source_branch=_override_hook_source_branch)
1563
def _push_with_bound_branches(self, target, overwrite,
1565
_override_hook_source_branch=None):
1566
"""Push from self into target, and into target's master if any.
1568
This is on the base BzrBranch class even though it doesn't support
1569
bound branches because the *target* might be bound.
1572
if _override_hook_source_branch:
1573
result.source_branch = _override_hook_source_branch
1574
for hook in Branch.hooks['post_push']:
1577
bound_location = target.get_bound_location()
1578
if bound_location and target.base != bound_location:
1579
# there is a master branch.
1581
# XXX: Why the second check? Is it even supported for a branch to
1582
# be bound to itself? -- mbp 20070507
1583
master_branch = target.get_master_branch()
1584
master_branch.lock_write()
1586
# push into the master from this branch.
1587
self._basic_push(master_branch, overwrite, stop_revision)
1588
# and push into the target branch from this. Note that we push from
1589
# this branch again, because its considered the highest bandwidth
1591
result = self._basic_push(target, overwrite, stop_revision)
1592
result.master_branch = master_branch
1593
result.local_branch = target
1597
master_branch.unlock()
1600
result = self._basic_push(target, overwrite, stop_revision)
1601
# TODO: Why set master_branch and local_branch if there's no
1602
# binding? Maybe cleaner to just leave them unset? -- mbp
1604
result.master_branch = target
1605
result.local_branch = None
1609
def _basic_push(self, target, overwrite, stop_revision):
1610
"""Basic implementation of push without bound branches or hooks.
1612
Must be called with self read locked and target write locked.
1614
result = PushResult()
1615
result.source_branch = self
1616
result.target_branch = target
1617
result.old_revno, result.old_revid = target.last_revision_info()
1619
target.update_revisions(self, stop_revision)
1620
except errors.DivergedBranches:
1624
target.set_revision_history(self.revision_history())
1625
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1626
result.new_revno, result.new_revid = target.last_revision_info()
1629
def get_parent(self):
1630
"""See Branch.get_parent."""
1632
assert self.base[-1] == '/'
1633
parent = self._get_parent_location()
1636
# This is an old-format absolute path to a local branch
1637
# turn it into a url
1638
if parent.startswith('/'):
1639
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1641
return urlutils.join(self.base[:-1], parent)
1642
except errors.InvalidURLJoin, e:
1643
raise errors.InaccessibleParent(parent, self.base)
1645
def set_push_location(self, location):
1646
"""See Branch.set_push_location."""
1647
self.get_config().set_user_option(
1648
'push_location', location,
1649
store=_mod_config.STORE_LOCATION_NORECURSE)
1652
def set_parent(self, url):
1653
"""See Branch.set_parent."""
1654
# TODO: Maybe delete old location files?
1655
# URLs should never be unicode, even on the local fs,
1656
# FIXUP this and get_parent in a future branch format bump:
1657
# read and rewrite the file, and have the new format code read
1658
# using .get not .get_utf8. RBC 20060125
1660
if isinstance(url, unicode):
1662
url = url.encode('ascii')
1663
except UnicodeEncodeError:
1664
raise errors.InvalidURL(url,
1665
"Urls must be 7-bit ascii, "
1666
"use bzrlib.urlutils.escape")
1667
url = urlutils.relative_url(self.base, url)
1668
self._set_parent_location(url)
1670
def _set_parent_location(self, url):
1672
self.control_files._transport.delete('parent')
1674
assert isinstance(url, str)
1675
self.control_files.put_bytes('parent', url + '\n')
1678
class BzrBranch5(BzrBranch):
1679
"""A format 5 branch. This supports new features over plain branches.
1681
It has support for a master_branch which is the data for bound branches.
1689
super(BzrBranch5, self).__init__(_format=_format,
1690
_control_files=_control_files,
1692
_repository=_repository)
1695
def pull(self, source, overwrite=False, stop_revision=None,
1696
run_hooks=True, possible_transports=None):
1697
"""Pull from source into self, updating my master if any.
1699
:param run_hooks: Private parameter - if false, this branch
1700
is being called because it's the master of the primary branch,
1701
so it should not run its hooks.
1703
bound_location = self.get_bound_location()
1704
master_branch = None
1705
if bound_location and source.base != bound_location:
1706
# not pulling from master, so we need to update master.
1707
master_branch = self.get_master_branch(possible_transports)
1708
master_branch.lock_write()
1711
# pull from source into master.
1712
master_branch.pull(source, overwrite, stop_revision,
1714
return super(BzrBranch5, self).pull(source, overwrite,
1715
stop_revision, _hook_master=master_branch,
1716
run_hooks=run_hooks)
1719
master_branch.unlock()
1721
def get_bound_location(self):
1723
return self.control_files.get_utf8('bound').read()[:-1]
1724
except errors.NoSuchFile:
1728
def get_master_branch(self, possible_transports=None):
1729
"""Return the branch we are bound to.
1731
:return: Either a Branch, or None
1733
This could memoise the branch, but if thats done
1734
it must be revalidated on each new lock.
1735
So for now we just don't memoise it.
1736
# RBC 20060304 review this decision.
1738
bound_loc = self.get_bound_location()
1742
return Branch.open(bound_loc,
1743
possible_transports=possible_transports)
1744
except (errors.NotBranchError, errors.ConnectionError), e:
1745
raise errors.BoundBranchConnectionFailure(
1749
def set_bound_location(self, location):
1750
"""Set the target where this branch is bound to.
1752
:param location: URL to the target branch
1755
self.control_files.put_utf8('bound', location+'\n')
1758
self.control_files._transport.delete('bound')
1759
except errors.NoSuchFile:
1349
if filename == head:
1356
def gen_file_id(name):
1357
"""Return new file id.
1359
This should probably generate proper UUIDs, but for the moment we
1360
cope with just randomness because running uuidgen every time is
1363
from binascii import hexlify
1364
from time import time
1366
# get last component
1367
idx = name.rfind('/')
1369
name = name[idx+1 : ]
1370
idx = name.rfind('\\')
1372
name = name[idx+1 : ]
1374
# make it not a hidden file
1375
name = name.lstrip('.')
1377
# remove any wierd characters; we don't escape them but rather
1378
# just pull them out
1379
name = re.sub(r'[^\w.]', '', name)
1381
s = hexlify(rand_bytes(8))
1382
return '-'.join((name, compact_date(time()), s))
1386
"""Return a new tree-root file id."""
1387
return gen_file_id('TREE_ROOT')
1764
def bind(self, other):
1765
"""Bind this branch to the branch other.
1767
This does not push or pull data between the branches, though it does
1768
check for divergence to raise an error when the branches are not
1769
either the same, or one a prefix of the other. That behaviour may not
1770
be useful, so that check may be removed in future.
1772
:param other: The branch to bind to
1775
# TODO: jam 20051230 Consider checking if the target is bound
1776
# It is debatable whether you should be able to bind to
1777
# a branch which is itself bound.
1778
# Committing is obviously forbidden,
1779
# but binding itself may not be.
1780
# Since we *have* to check at commit time, we don't
1781
# *need* to check here
1783
# we want to raise diverged if:
1784
# last_rev is not in the other_last_rev history, AND
1785
# other_last_rev is not in our history, and do it without pulling
1787
self.set_bound_location(other.base)
1791
"""If bound, unbind"""
1792
return self.set_bound_location(None)
1795
def update(self, possible_transports=None):
1796
"""Synchronise this branch with the master branch if any.
1798
:return: None or the last_revision that was pivoted out during the
1801
master = self.get_master_branch(possible_transports)
1802
if master is not None:
1803
old_tip = _mod_revision.ensure_null(self.last_revision())
1804
self.pull(master, overwrite=True)
1805
if self.repository.get_graph().is_ancestor(old_tip,
1806
_mod_revision.ensure_null(self.last_revision())):
1812
class BzrBranch6(BzrBranch5):
1814
def __init__(self, *args, **kwargs):
1815
super(BzrBranch6, self).__init__(*args, **kwargs)
1816
self._last_revision_info_cache = None
1817
self._partial_revision_history_cache = []
1819
def _clear_cached_state(self):
1820
super(BzrBranch6, self)._clear_cached_state()
1821
self._last_revision_info_cache = None
1822
self._partial_revision_history_cache = []
1825
def last_revision_info(self):
1826
"""Return information about the last revision.
1828
:return: A tuple (revno, revision_id).
1830
if self._last_revision_info_cache is None:
1831
self._last_revision_info_cache = self._last_revision_info()
1832
return self._last_revision_info_cache
1834
def _last_revision_info(self):
1835
revision_string = self.control_files.get('last-revision').read()
1836
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1837
revision_id = cache_utf8.get_cached_utf8(revision_id)
1839
return revno, revision_id
1841
def _write_last_revision_info(self, revno, revision_id):
1842
"""Simply write out the revision id, with no checks.
1844
Use set_last_revision_info to perform this safely.
1846
Does not update the revision_history cache.
1847
Intended to be called by set_last_revision_info and
1848
_write_revision_history.
1850
assert revision_id is not None, "Use NULL_REVISION, not None"
1851
out_string = '%d %s\n' % (revno, revision_id)
1852
self.control_files.put_bytes('last-revision', out_string)
1855
def set_last_revision_info(self, revno, revision_id):
1856
revision_id = _mod_revision.ensure_null(revision_id)
1857
if self._get_append_revisions_only():
1858
self._check_history_violation(revision_id)
1859
self._write_last_revision_info(revno, revision_id)
1860
self._clear_cached_state()
1861
self._last_revision_info_cache = revno, revision_id
1863
def _check_history_violation(self, revision_id):
1864
last_revision = _mod_revision.ensure_null(self.last_revision())
1865
if _mod_revision.is_null(last_revision):
1867
if last_revision not in self._lefthand_history(revision_id):
1868
raise errors.AppendRevisionsOnlyViolation(self.base)
1870
def _gen_revision_history(self):
1871
"""Generate the revision history from last revision
1873
self._extend_partial_history()
1874
return list(reversed(self._partial_revision_history_cache))
1876
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1877
"""Extend the partial history to include a given index
1879
If a stop_index is supplied, stop when that index has been reached.
1880
If a stop_revision is supplied, stop when that revision is
1881
encountered. Otherwise, stop when the beginning of history is
1884
:param stop_index: The index which should be present. When it is
1885
present, history extension will stop.
1886
:param revision_id: The revision id which should be present. When
1887
it is encountered, history extension will stop.
1889
repo = self.repository
1890
if len(self._partial_revision_history_cache) == 0:
1891
iterator = repo.iter_reverse_revision_history(self.last_revision())
1893
start_revision = self._partial_revision_history_cache[-1]
1894
iterator = repo.iter_reverse_revision_history(start_revision)
1895
#skip the last revision in the list
1896
next_revision = iterator.next()
1897
assert next_revision == start_revision
1898
for revision_id in iterator:
1899
self._partial_revision_history_cache.append(revision_id)
1900
if (stop_index is not None and
1901
len(self._partial_revision_history_cache) > stop_index):
1903
if revision_id == stop_revision:
1906
def _write_revision_history(self, history):
1907
"""Factored out of set_revision_history.
1909
This performs the actual writing to disk, with format-specific checks.
1910
It is intended to be called by BzrBranch5.set_revision_history.
1912
if len(history) == 0:
1913
last_revision = 'null:'
1915
if history != self._lefthand_history(history[-1]):
1916
raise errors.NotLefthandHistory(history)
1917
last_revision = history[-1]
1918
if self._get_append_revisions_only():
1919
self._check_history_violation(last_revision)
1920
self._write_last_revision_info(len(history), last_revision)
1923
def _set_parent_location(self, url):
1924
"""Set the parent branch"""
1925
self._set_config_location('parent_location', url, make_relative=True)
1928
def _get_parent_location(self):
1929
"""Set the parent branch"""
1930
return self._get_config_location('parent_location')
1932
def set_push_location(self, location):
1933
"""See Branch.set_push_location."""
1934
self._set_config_location('push_location', location)
1936
def set_bound_location(self, location):
1937
"""See Branch.set_push_location."""
1939
config = self.get_config()
1940
if location is None:
1941
if config.get_user_option('bound') != 'True':
1944
config.set_user_option('bound', 'False', warn_masked=True)
1947
self._set_config_location('bound_location', location,
1949
config.set_user_option('bound', 'True', warn_masked=True)
1952
def _get_bound_location(self, bound):
1953
"""Return the bound location in the config file.
1955
Return None if the bound parameter does not match"""
1956
config = self.get_config()
1957
config_bound = (config.get_user_option('bound') == 'True')
1958
if config_bound != bound:
1960
return self._get_config_location('bound_location', config=config)
1962
def get_bound_location(self):
1963
"""See Branch.set_push_location."""
1964
return self._get_bound_location(True)
1966
def get_old_bound_location(self):
1967
"""See Branch.get_old_bound_location"""
1968
return self._get_bound_location(False)
1970
def set_append_revisions_only(self, enabled):
1975
self.get_config().set_user_option('append_revisions_only', value,
1978
def _get_append_revisions_only(self):
1979
value = self.get_config().get_user_option('append_revisions_only')
1980
return value == 'True'
1982
def _synchronize_history(self, destination, revision_id):
1983
"""Synchronize last revision and revision history between branches.
1985
This version is most efficient when the destination is also a
1986
BzrBranch6, but works for BzrBranch5, as long as the destination's
1987
repository contains all the lefthand ancestors of the intended
1988
last_revision. If not, set_last_revision_info will fail.
1990
:param destination: The branch to copy the history into
1991
:param revision_id: The revision-id to truncate history at. May
1992
be None to copy complete history.
1994
source_revno, source_revision_id = self.last_revision_info()
1995
if revision_id is None:
1996
revno, revision_id = source_revno, source_revision_id
1997
elif source_revision_id == revision_id:
1998
# we know the revno without needing to walk all of history
1999
revno = source_revno
2001
# To figure out the revno for a random revision, we need to build
2002
# the revision history, and count its length.
2003
# We don't care about the order, just how long it is.
2004
# Alternatively, we could start at the current location, and count
2005
# backwards. But there is no guarantee that we will find it since
2006
# it may be a merged revision.
2007
revno = len(list(self.repository.iter_reverse_revision_history(
2009
destination.set_last_revision_info(revno, revision_id)
2011
def _make_tags(self):
2012
return BasicTags(self)
2015
def generate_revision_history(self, revision_id, last_rev=None,
2017
"""See BzrBranch5.generate_revision_history"""
2018
history = self._lefthand_history(revision_id, last_rev, other_branch)
2019
revno = len(history)
2020
self.set_last_revision_info(revno, revision_id)
2023
def get_rev_id(self, revno, history=None):
2024
"""Find the revision id of the specified revno."""
2026
return _mod_revision.NULL_REVISION
2028
last_revno, last_revision_id = self.last_revision_info()
2029
if revno <= 0 or revno > last_revno:
2030
raise errors.NoSuchRevision(self, revno)
2032
if history is not None:
2033
assert len(history) == last_revno, 'revno/history mismatch'
2034
return history[revno - 1]
2036
index = last_revno - revno
2037
if len(self._partial_revision_history_cache) <= index:
2038
self._extend_partial_history(stop_index=index)
2039
if len(self._partial_revision_history_cache) > index:
2040
return self._partial_revision_history_cache[index]
2042
raise errors.NoSuchRevision(self, revno)
2045
def revision_id_to_revno(self, revision_id):
2046
"""Given a revision id, return its revno"""
2047
if _mod_revision.is_null(revision_id):
2050
index = self._partial_revision_history_cache.index(revision_id)
2052
self._extend_partial_history(stop_revision=revision_id)
2053
index = len(self._partial_revision_history_cache) - 1
2054
if self._partial_revision_history_cache[index] != revision_id:
2055
raise errors.NoSuchRevision(self, revision_id)
2056
return self.revno() - index
2059
######################################################################
2060
# results of operations
2063
class _Result(object):
2065
def _show_tag_conficts(self, to_file):
2066
if not getattr(self, 'tag_conflicts', None):
2068
to_file.write('Conflicting tags:\n')
2069
for name, value1, value2 in self.tag_conflicts:
2070
to_file.write(' %s\n' % (name, ))
2073
class PullResult(_Result):
2074
"""Result of a Branch.pull operation.
2076
:ivar old_revno: Revision number before pull.
2077
:ivar new_revno: Revision number after pull.
2078
:ivar old_revid: Tip revision id before pull.
2079
:ivar new_revid: Tip revision id after pull.
2080
:ivar source_branch: Source (local) branch object.
2081
:ivar master_branch: Master branch of the target, or None.
2082
:ivar target_branch: Target/destination branch object.
2086
# DEPRECATED: pull used to return the change in revno
2087
return self.new_revno - self.old_revno
2089
def report(self, to_file):
2091
if self.old_revid == self.new_revid:
2092
to_file.write('No revisions to pull.\n')
2094
to_file.write('Now on revision %d.\n' % self.new_revno)
2095
self._show_tag_conficts(to_file)
2098
class PushResult(_Result):
2099
"""Result of a Branch.push operation.
2101
:ivar old_revno: Revision number before push.
2102
:ivar new_revno: Revision number after push.
2103
:ivar old_revid: Tip revision id before push.
2104
:ivar new_revid: Tip revision id after push.
2105
:ivar source_branch: Source branch object.
2106
:ivar master_branch: Master branch of the target, or None.
2107
:ivar target_branch: Target/destination branch object.
2111
# DEPRECATED: push used to return the change in revno
2112
return self.new_revno - self.old_revno
2114
def report(self, to_file):
2115
"""Write a human-readable description of the result."""
2116
if self.old_revid == self.new_revid:
2117
to_file.write('No new revisions to push.\n')
2119
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2120
self._show_tag_conficts(to_file)
2123
class BranchCheckResult(object):
2124
"""Results of checking branch consistency.
2129
def __init__(self, branch):
2130
self.branch = branch
2132
def report_results(self, verbose):
2133
"""Report the check results via trace.note.
2135
:param verbose: Requests more detailed display of what was checked,
2138
note('checked branch %s format %s',
2140
self.branch._format)
2143
class Converter5to6(object):
2144
"""Perform an in-place upgrade of format 5 to format 6"""
2146
def convert(self, branch):
2147
# Data for 5 and 6 can peacefully coexist.
2148
format = BzrBranchFormat6()
2149
new_branch = format.open(branch.bzrdir, _found=True)
2151
# Copy source data into target
2152
new_branch.set_last_revision_info(*branch.last_revision_info())
2153
new_branch.set_parent(branch.get_parent())
2154
new_branch.set_bound_location(branch.get_bound_location())
2155
new_branch.set_push_location(branch.get_push_location())
2157
# New branch has no tags by default
2158
new_branch.tags._set_tag_dict({})
2160
# Copying done; now update target format
2161
new_branch.control_files.put_utf8('format',
2162
format.get_format_string())
2164
# Clean up old files
2165
new_branch.control_files._transport.delete('revision-history')
2167
branch.set_parent(None)
2168
except errors.NoSuchFile:
2170
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
