137
86
"""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.
89
Base directory/url of the branch.
91
hooks: An instance of BranchHooks.
93
# 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.
97
# override this to set the strategy for storing tags
99
return DisabledTags(self)
101
def __init__(self, *ignored, **ignored_too):
102
self.tags = self._make_tags()
103
self._revision_history_cache = None
104
self._revision_id_to_revno_cache = None
106
def break_lock(self):
107
"""Break a lock if one is present from another instance.
109
Uses the ui factory to ask for confirmation if the lock may be from
112
This will probe the repository for its lock as well.
114
self.control_files.break_lock()
115
self.repository.break_lock()
116
master = self.get_master_branch()
117
if master is not None:
121
def open(base, _unsupported=False, possible_transports=None):
122
"""Open the branch rooted at base.
124
For instance, if the branch is at URL/.bzr/branch,
125
Branch.open(URL) -> a Branch instance.
127
control = bzrdir.BzrDir.open(base, _unsupported,
128
possible_transports=possible_transports)
129
return control.open_branch(_unsupported)
132
def open_from_transport(transport, _unsupported=False):
133
"""Open the branch rooted at transport"""
134
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
135
return control.open_branch(_unsupported)
138
def open_containing(url, possible_transports=None):
139
"""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.
141
This probes for a branch at url, and searches upwards from there.
143
Basically we keep looking up until we find the control directory or
144
run into the root. If there isn't one, raises NotBranchError.
145
If there is one and it is either an unrecognised format or an unsupported
146
format, UnknownFormatError or UnsupportedFormatError are raised.
147
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)
149
control, relpath = bzrdir.BzrDir.open_containing(url,
151
return control.open_branch(), relpath
153
def get_config(self):
154
return BranchConfig(self)
157
return self.get_config().get_nickname()
159
def _set_nick(self, nick):
160
self.get_config().set_user_option('nickname', nick, warn_masked=True)
162
nick = property(_get_nick, _set_nick)
165
raise NotImplementedError(self.is_locked)
212
167
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'
168
raise NotImplementedError(self.lock_write)
228
170
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'
171
raise NotImplementedError(self.lock_read)
242
173
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
174
raise NotImplementedError(self.unlock)
176
def peek_lock_mode(self):
177
"""Return lock mode for the Branch: 'r', 'w' or None"""
178
raise NotImplementedError(self.peek_lock_mode)
180
def get_physical_lock_status(self):
181
raise NotImplementedError(self.get_physical_lock_status)
184
def get_revision_id_to_revno_map(self):
185
"""Return the revision_id => dotted revno map.
187
This will be regenerated on demand, but will be cached.
189
:return: A dictionary mapping revision_id => dotted revno.
190
This dictionary should not be modified by the caller.
192
if self._revision_id_to_revno_cache is not None:
193
mapping = self._revision_id_to_revno_cache
252
self._lock_mode = self._lock_count = None
195
mapping = self._gen_revno_map()
196
self._cache_revision_id_to_revno(mapping)
197
# TODO: jam 20070417 Since this is being cached, should we be returning
199
# I would rather not, and instead just declare that users should not
200
# modify the return value.
203
def _gen_revno_map(self):
204
"""Create a new mapping from revision ids to dotted revnos.
206
Dotted revnos are generated based on the current tip in the revision
208
This is the worker function for get_revision_id_to_revno_map, which
209
just caches the return value.
211
:return: A dictionary mapping revision_id => dotted revno.
213
last_revision = self.last_revision()
214
revision_graph = self.repository.get_revision_graph(last_revision)
215
merge_sorted_revisions = tsort.merge_sort(
220
revision_id_to_revno = dict((rev_id, revno)
221
for seq_num, rev_id, depth, revno, end_of_merge
222
in merge_sorted_revisions)
223
return revision_id_to_revno
225
def leave_lock_in_place(self):
226
"""Tell this branch object not to release the physical lock when this
229
If lock_write doesn't return a token, then this method is not supported.
231
self.control_files.leave_in_place()
233
def dont_leave_lock_in_place(self):
234
"""Tell this branch object to release the physical lock when this
235
object is unlocked, even if it didn't originally acquire it.
237
If lock_write doesn't return a token, then this method is not supported.
239
self.control_files.dont_leave_in_place()
255
241
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
242
"""Return absolute filename for something in the branch
244
XXX: Robert Collins 20051017 what is this used for? why is it a branch
245
method and not a tree method.
247
raise NotImplementedError(self.abspath)
249
def bind(self, other):
250
"""Bind the local branch the other branch.
252
:param other: The branch to bind to
255
raise errors.UpgradeRequired(self.base)
258
def fetch(self, from_branch, last_revision=None, pb=None):
259
"""Copy revisions from from_branch into this branch.
261
:param from_branch: Where to copy from.
262
:param last_revision: What revision to stop at (None for at the end
264
:param pb: An optional progress bar to use.
266
Returns the copied revision count and the failed revisions in a tuple:
269
if self.base == from_branch.base:
272
nested_pb = ui.ui_factory.nested_progress_bar()
277
from_branch.lock_read()
279
if last_revision is None:
280
pb.update('get source history')
281
last_revision = from_branch.last_revision()
282
if last_revision is None:
283
last_revision = _mod_revision.NULL_REVISION
284
return self.repository.fetch(from_branch.repository,
285
revision_id=last_revision,
288
if nested_pb is not None:
292
def get_bound_location(self):
293
"""Return the URL of the branch we are bound to.
295
Older format branches cannot bind, please be sure to use a metadir
300
def get_old_bound_location(self):
301
"""Return the URL of the branch we used to be bound to
303
raise errors.UpgradeRequired(self.base)
305
def get_commit_builder(self, parents, config=None, timestamp=None,
306
timezone=None, committer=None, revprops=None,
308
"""Obtain a CommitBuilder for this branch.
310
:param parents: Revision ids of the parents of the new revision.
311
:param config: Optional configuration to use.
312
:param timestamp: Optional timestamp recorded for commit.
313
:param timezone: Optional timezone for timestamp.
314
:param committer: Optional committer to set for commit.
315
:param revprops: Optional dictionary of revision properties.
316
:param revision_id: Optional revision id.
320
config = self.get_config()
322
return self.repository.get_commit_builder(self, parents, config,
323
timestamp, timezone, committer, revprops, revision_id)
325
def get_master_branch(self, possible_transports=None):
326
"""Return the branch we are bound to.
328
:return: Either a Branch, or None
617
332
def get_revision_delta(self, revno):
618
333
"""Return the delta for one revision.
1125
546
Note that to_name is only the last component of the new name;
1126
547
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:
549
This returns a list of (from_path, to_path) pairs for each
552
raise NotImplementedError(self.move)
554
def get_parent(self):
555
"""Return the parent location of the branch.
557
This is the default location for push/pull/missing. The usual
558
pattern is that the user can override it by specifying a
561
raise NotImplementedError(self.get_parent)
563
def _set_config_location(self, name, url, config=None,
564
make_relative=False):
566
config = self.get_config()
570
url = urlutils.relative_url(self.base, url)
571
config.set_user_option(name, url, warn_masked=True)
573
def _get_config_location(self, name, config=None):
575
config = self.get_config()
576
location = config.get_user_option(name)
581
def get_submit_branch(self):
582
"""Return the submit location of the branch.
584
This is the default location for bundle. The usual
585
pattern is that the user can override it by specifying a
588
return self.get_config().get_user_option('submit_branch')
590
def set_submit_branch(self, location):
591
"""Return the submit location of the branch.
593
This is the default location for bundle. The usual
594
pattern is that the user can override it by specifying a
597
self.get_config().set_user_option('submit_branch', location,
600
def get_public_branch(self):
601
"""Return the public location of the branch.
603
This is is used by merge directives.
605
return self._get_config_location('public_branch')
607
def set_public_branch(self, location):
608
"""Return the submit location of the branch.
610
This is the default location for bundle. The usual
611
pattern is that the user can override it by specifying a
614
self._set_config_location('public_branch', location)
616
def get_push_location(self):
617
"""Return the None or the location to push this branch to."""
618
push_loc = self.get_config().get_user_option('push_location')
621
def set_push_location(self, location):
622
"""Set a new push location for this branch."""
623
raise NotImplementedError(self.set_push_location)
625
def set_parent(self, url):
626
raise NotImplementedError(self.set_parent)
630
"""Synchronise this branch with the master branch if any.
632
:return: None or the last_revision pivoted out during the update.
636
def check_revno(self, revno):
638
Check whether a revno corresponds to any revision.
639
Zero (the NULL revision) is considered valid.
642
self.check_real_revno(revno)
644
def check_real_revno(self, revno):
646
Check whether a revno corresponds to a real revision.
647
Zero (the NULL revision) is considered invalid
649
if revno < 1 or revno > self.revno():
650
raise InvalidRevisionNumber(revno)
653
def clone(self, to_bzrdir, revision_id=None):
654
"""Clone this branch into to_bzrdir preserving all semantic values.
656
revision_id: if not None, the revision history in the new branch will
657
be truncated to end with revision_id.
659
result = self._format.initialize(to_bzrdir)
660
self.copy_content_into(result, revision_id=revision_id)
664
def sprout(self, to_bzrdir, revision_id=None):
665
"""Create a new line of development from the branch, into to_bzrdir.
667
revision_id: if not None, the revision history in the new branch will
668
be truncated to end with revision_id.
670
result = self._format.initialize(to_bzrdir)
671
self.copy_content_into(result, revision_id=revision_id)
672
result.set_parent(self.bzrdir.root_transport.base)
675
def _synchronize_history(self, destination, revision_id):
676
"""Synchronize last revision and revision history between branches.
678
This version is most efficient when the destination is also a
679
BzrBranch5, but works for BzrBranch6 as long as the revision
680
history is the true lefthand parent history, and all of the revisions
681
are in the destination's repository. If not, set_revision_history
684
:param destination: The branch to copy the history into
685
:param revision_id: The revision-id to truncate history at. May
686
be None to copy complete history.
688
if revision_id == _mod_revision.NULL_REVISION:
690
new_history = self.revision_history()
691
if revision_id is not None and new_history != []:
693
new_history = new_history[:new_history.index(revision_id) + 1]
695
rev = self.repository.get_revision(revision_id)
696
new_history = rev.get_history(self.repository)[1:]
697
destination.set_revision_history(new_history)
700
def copy_content_into(self, destination, revision_id=None):
701
"""Copy the content of self into destination.
703
revision_id: if not None, the revision history in the new branch will
704
be truncated to end with revision_id.
706
self._synchronize_history(destination, revision_id)
708
parent = self.get_parent()
709
except errors.InaccessibleParent, e:
710
mutter('parent was not accessible to copy: %s', e)
713
destination.set_parent(parent)
714
self.tags.merge_to(destination.tags)
718
"""Check consistency of the branch.
720
In particular this checks that revisions given in the revision-history
721
do actually match up in the revision graph, and that they're all
722
present in the repository.
724
Callers will typically also want to check the repository.
726
:return: A BranchCheckResult.
728
mainline_parent_id = None
729
for revision_id in self.revision_history():
731
revision = self.repository.get_revision(revision_id)
732
except errors.NoSuchRevision, e:
733
raise errors.BzrCheckError("mainline revision {%s} not in repository"
735
# In general the first entry on the revision history has no parents.
736
# But it's not illegal for it to have parents listed; this can happen
737
# in imports from Arch when the parents weren't reachable.
738
if mainline_parent_id is not None:
739
if mainline_parent_id not in revision.parent_ids:
740
raise errors.BzrCheckError("previous revision {%s} not listed among "
742
% (mainline_parent_id, revision_id))
743
mainline_parent_id = revision_id
744
return BranchCheckResult(self)
746
def _get_checkout_format(self):
747
"""Return the most suitable metadir for a checkout of this branch.
748
Weaves are used if this branch's repository uses weaves.
750
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
751
from bzrlib.repofmt import weaverepo
752
format = bzrdir.BzrDirMetaFormat1()
753
format.repository_format = weaverepo.RepositoryFormat7()
755
format = self.repository.bzrdir.checkout_metadir()
756
format.set_branch_format(self._format)
759
def create_checkout(self, to_location, revision_id=None,
761
"""Create a checkout of a branch.
763
:param to_location: The url to produce the checkout at
764
:param revision_id: The revision to check out
765
:param lightweight: If True, produce a lightweight checkout, otherwise,
766
produce a bound branch (heavyweight checkout)
767
:return: The tree of the created checkout
769
t = transport.get_transport(to_location)
772
format = self._get_checkout_format()
773
checkout = format.initialize_on_transport(t)
774
from_branch = BranchReferenceFormat().initialize(checkout, self)
776
format = self._get_checkout_format()
777
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
778
to_location, force_new_tree=False, format=format)
779
checkout = checkout_branch.bzrdir
780
checkout_branch.bind(self)
781
# pull up to the specified revision_id to set the initial
782
# branch tip correctly, and seed it with history.
783
checkout_branch.pull(self, stop_revision=revision_id)
785
tree = checkout.create_workingtree(revision_id,
786
from_branch=from_branch)
787
basis_tree = tree.basis_tree()
788
basis_tree.lock_read()
790
for path, file_id in basis_tree.iter_references():
791
reference_parent = self.reference_parent(file_id, path)
792
reference_parent.create_checkout(tree.abspath(path),
793
basis_tree.get_reference_revision(file_id, path),
799
def reference_parent(self, file_id, path):
800
"""Return the parent branch for a tree-reference file_id
801
:param file_id: The file_id of the tree reference
802
:param path: The path of the file_id in the tree
803
:return: A branch associated with the file_id
805
# FIXME should provide multiple branches, based on config
806
return Branch.open(self.bzrdir.root_transport.clone(path).base)
808
def supports_tags(self):
809
return self._format.supports_tags()
812
class BranchFormat(object):
813
"""An encapsulation of the initialization and open routines for a format.
815
Formats provide three things:
816
* An initialization routine,
820
Formats are placed in an dict by their format string for reference
821
during branch opening. Its not required that these be instances, they
822
can be classes themselves with class methods - it simply depends on
823
whether state is needed for a given format or not.
825
Once a format is deprecated, just deprecate the initialize and open
826
methods on the format class. Do not deprecate the object, as the
827
object will be created every time regardless.
830
_default_format = None
831
"""The default format used for new branches."""
834
"""The known formats."""
836
def __eq__(self, other):
837
return self.__class__ is other.__class__
839
def __ne__(self, other):
840
return not (self == other)
843
def find_format(klass, a_bzrdir):
844
"""Return the format for the branch object in a_bzrdir."""
846
transport = a_bzrdir.get_branch_transport(None)
847
format_string = transport.get("format").read()
848
return klass._formats[format_string]
850
raise NotBranchError(path=transport.base)
852
raise errors.UnknownFormatError(format=format_string)
855
def get_default_format(klass):
856
"""Return the current default format."""
857
return klass._default_format
859
def get_reference(self, a_bzrdir):
860
"""Get 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 get the branch data from.
867
:return: None if the branch is not a reference branch.
872
def set_reference(self, a_bzrdir, to_branch):
873
"""Set the target reference of the branch in a_bzrdir.
875
format probing must have been completed before calling
876
this method - it is assumed that the format of the branch
877
in a_bzrdir is correct.
879
:param a_bzrdir: The bzrdir to set the branch reference for.
880
:param to_branch: branch that the checkout is to reference
882
raise NotImplementedError(self.set_reference)
884
def get_format_string(self):
885
"""Return the ASCII format string that identifies this format."""
886
raise NotImplementedError(self.get_format_string)
888
def get_format_description(self):
889
"""Return the short format description for this format."""
890
raise NotImplementedError(self.get_format_description)
892
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
894
"""Initialize a branch in a bzrdir, with specified files
896
:param a_bzrdir: The bzrdir to initialize the branch in
897
:param utf8_files: The files to create as a list of
898
(filename, content) tuples
899
:param set_format: If True, set the format with
900
self.get_format_string. (BzrBranch4 has its format set
902
:return: a branch in this format
904
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
905
branch_transport = a_bzrdir.get_branch_transport(self)
907
'metadir': ('lock', lockdir.LockDir),
908
'branch4': ('branch-lock', lockable_files.TransportLock),
910
lock_name, lock_class = lock_map[lock_type]
911
control_files = lockable_files.LockableFiles(branch_transport,
912
lock_name, lock_class)
913
control_files.create_lock()
914
control_files.lock_write()
916
control_files.put_utf8('format', self.get_format_string())
918
for file, content in utf8_files:
919
control_files.put_utf8(file, content)
921
control_files.unlock()
922
return self.open(a_bzrdir, _found=True)
924
def initialize(self, a_bzrdir):
925
"""Create a branch of this format in a_bzrdir."""
926
raise NotImplementedError(self.initialize)
928
def is_supported(self):
929
"""Is this format supported?
931
Supported formats can be initialized and opened.
932
Unsupported formats may not support initialization or committing or
933
some other features depending on the reason for not being supported.
937
def open(self, a_bzrdir, _found=False):
938
"""Return the branch object for a_bzrdir
940
_found is a private parameter, do not use it. It is used to indicate
941
if format probing has already be done.
943
raise NotImplementedError(self.open)
946
def register_format(klass, format):
947
klass._formats[format.get_format_string()] = format
950
def set_default_format(klass, format):
951
klass._default_format = format
954
def unregister_format(klass, format):
955
assert klass._formats[format.get_format_string()] is format
956
del klass._formats[format.get_format_string()]
959
return self.get_format_string().rstrip()
961
def supports_tags(self):
962
"""True if this format supports tags stored in the branch"""
963
return False # by default
965
# XXX: Probably doesn't really belong here -- mbp 20070212
966
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
968
branch_transport = a_bzrdir.get_branch_transport(self)
969
control_files = lockable_files.LockableFiles(branch_transport,
970
lock_filename, lock_class)
971
control_files.create_lock()
972
control_files.lock_write()
974
for filename, content in utf8_files:
975
control_files.put_utf8(filename, content)
977
control_files.unlock()
980
class BranchHooks(Hooks):
981
"""A dictionary mapping hook name to a list of callables for branch hooks.
983
e.g. ['set_rh'] Is the list of items to be called when the
984
set_revision_history function is invoked.
988
"""Create the default hooks.
990
These are all empty initially, because by default nothing should get
994
# Introduced in 0.15:
995
# invoked whenever the revision history has been set
996
# with set_revision_history. The api signature is
997
# (branch, revision_history), and the branch will
1000
# invoked after a push operation completes.
1001
# the api signature is
1003
# containing the members
1004
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1005
# where local is the local target branch or None, master is the target
1006
# master branch, and the rest should be self explanatory. The source
1007
# is read locked and the target branches write locked. Source will
1008
# be the local low-latency branch.
1009
self['post_push'] = []
1010
# invoked after a pull operation completes.
1011
# the api signature is
1013
# containing the members
1014
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1015
# where local is the local branch or None, master is the target
1016
# master branch, and the rest should be self explanatory. The source
1017
# is read locked and the target branches write locked. The local
1018
# branch is the low-latency branch.
1019
self['post_pull'] = []
1020
# invoked before a commit operation takes place.
1021
# the api signature is
1022
# (local, master, old_revno, old_revid, future_revno, future_revid,
1023
# tree_delta, future_tree).
1024
# old_revid is NULL_REVISION for the first commit to a branch
1025
# tree_delta is a TreeDelta object describing changes from the basis
1026
# revision, hooks MUST NOT modify this delta
1027
# future_tree is an in-memory tree obtained from
1028
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1029
self['pre_commit'] = []
1030
# invoked after a commit operation completes.
1031
# the api signature is
1032
# (local, master, old_revno, old_revid, new_revno, new_revid)
1033
# old_revid is NULL_REVISION for the first commit to a branch.
1034
self['post_commit'] = []
1035
# invoked after a uncommit operation completes.
1036
# the api signature is
1037
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1038
# local is the local branch or None, master is the target branch,
1039
# and an empty branch recieves new_revno of 0, new_revid of None.
1040
self['post_uncommit'] = []
1043
# install the default hooks into the Branch class.
1044
Branch.hooks = BranchHooks()
1047
class BzrBranchFormat4(BranchFormat):
1048
"""Bzr branch format 4.
1051
- a revision-history file.
1052
- a branch-lock lock file [ to be shared with the bzrdir ]
1055
def get_format_description(self):
1056
"""See BranchFormat.get_format_description()."""
1057
return "Branch format 4"
1059
def initialize(self, a_bzrdir):
1060
"""Create a branch of this format in a_bzrdir."""
1061
utf8_files = [('revision-history', ''),
1062
('branch-name', ''),
1064
return self._initialize_helper(a_bzrdir, utf8_files,
1065
lock_type='branch4', set_format=False)
1068
super(BzrBranchFormat4, self).__init__()
1069
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1071
def open(self, a_bzrdir, _found=False):
1072
"""Return the branch object for a_bzrdir
1074
_found is a private parameter, do not use it. It is used to indicate
1075
if format probing has already be done.
1078
# we are being called directly and must probe.
1079
raise NotImplementedError
1080
return BzrBranch(_format=self,
1081
_control_files=a_bzrdir._control_files,
1083
_repository=a_bzrdir.open_repository())
1086
return "Bazaar-NG branch format 4"
1089
class BzrBranchFormat5(BranchFormat):
1090
"""Bzr branch format 5.
1093
- a revision-history file.
1095
- a lock dir guarding the branch itself
1096
- all of this stored in a branch/ subdirectory
1097
- works with shared repositories.
1099
This format is new in bzr 0.8.
1102
def get_format_string(self):
1103
"""See BranchFormat.get_format_string()."""
1104
return "Bazaar-NG branch format 5\n"
1106
def get_format_description(self):
1107
"""See BranchFormat.get_format_description()."""
1108
return "Branch format 5"
1110
def initialize(self, a_bzrdir):
1111
"""Create a branch of this format in a_bzrdir."""
1112
utf8_files = [('revision-history', ''),
1113
('branch-name', ''),
1115
return self._initialize_helper(a_bzrdir, utf8_files)
1118
super(BzrBranchFormat5, self).__init__()
1119
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1121
def open(self, a_bzrdir, _found=False):
1122
"""Return the branch object for a_bzrdir
1124
_found is a private parameter, do not use it. It is used to indicate
1125
if format probing has already be done.
1128
format = BranchFormat.find_format(a_bzrdir)
1129
assert format.__class__ == self.__class__
1131
transport = a_bzrdir.get_branch_transport(None)
1132
control_files = lockable_files.LockableFiles(transport, 'lock',
1134
return BzrBranch5(_format=self,
1135
_control_files=control_files,
1137
_repository=a_bzrdir.find_repository())
1139
raise NotBranchError(path=transport.base)
1142
class BzrBranchFormat6(BzrBranchFormat5):
1143
"""Branch format with last-revision and tags.
1145
Unlike previous formats, this has no explicit revision history. Instead,
1146
this just stores the last-revision, and the left-hand history leading
1147
up to there is the history.
1149
This format was introduced in bzr 0.15
1150
and became the default in 0.91.
1153
def get_format_string(self):
1154
"""See BranchFormat.get_format_string()."""
1155
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1157
def get_format_description(self):
1158
"""See BranchFormat.get_format_description()."""
1159
return "Branch format 6"
1161
def initialize(self, a_bzrdir):
1162
"""Create a branch of this format in a_bzrdir."""
1163
utf8_files = [('last-revision', '0 null:\n'),
1164
('branch.conf', ''),
1167
return self._initialize_helper(a_bzrdir, utf8_files)
1169
def open(self, a_bzrdir, _found=False):
1170
"""Return the branch object for a_bzrdir
1172
_found is a private parameter, do not use it. It is used to indicate
1173
if format probing has already be done.
1176
format = BranchFormat.find_format(a_bzrdir)
1177
assert format.__class__ == self.__class__
1178
transport = a_bzrdir.get_branch_transport(None)
1179
control_files = lockable_files.LockableFiles(transport, 'lock',
1181
return BzrBranch6(_format=self,
1182
_control_files=control_files,
1184
_repository=a_bzrdir.find_repository())
1186
def supports_tags(self):
1190
class BranchReferenceFormat(BranchFormat):
1191
"""Bzr branch reference format.
1193
Branch references are used in implementing checkouts, they
1194
act as an alias to the real branch which is at some other url.
1201
def get_format_string(self):
1202
"""See BranchFormat.get_format_string()."""
1203
return "Bazaar-NG Branch Reference Format 1\n"
1205
def get_format_description(self):
1206
"""See BranchFormat.get_format_description()."""
1207
return "Checkout reference format 1"
1209
def get_reference(self, a_bzrdir):
1210
"""See BranchFormat.get_reference()."""
1211
transport = a_bzrdir.get_branch_transport(None)
1212
return transport.get('location').read()
1214
def set_reference(self, a_bzrdir, to_branch):
1215
"""See BranchFormat.set_reference()."""
1216
transport = a_bzrdir.get_branch_transport(None)
1217
location = transport.put_bytes('location', to_branch.base)
1219
def initialize(self, a_bzrdir, target_branch=None):
1220
"""Create a branch of this format in a_bzrdir."""
1221
if target_branch is None:
1222
# this format does not implement branch itself, thus the implicit
1223
# creation contract must see it as uninitializable
1224
raise errors.UninitializableFormat(self)
1225
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1226
branch_transport = a_bzrdir.get_branch_transport(self)
1227
branch_transport.put_bytes('location',
1228
target_branch.bzrdir.root_transport.base)
1229
branch_transport.put_bytes('format', self.get_format_string())
1231
a_bzrdir, _found=True,
1232
possible_transports=[target_branch.bzrdir.root_transport])
1235
super(BranchReferenceFormat, self).__init__()
1236
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1238
def _make_reference_clone_function(format, a_branch):
1239
"""Create a clone() routine for a branch dynamically."""
1240
def clone(to_bzrdir, revision_id=None):
1241
"""See Branch.clone()."""
1242
return format.initialize(to_bzrdir, a_branch)
1243
# cannot obey revision_id limits when cloning a reference ...
1244
# FIXME RBC 20060210 either nuke revision_id for clone, or
1245
# emit some sort of warning/error to the caller ?!
1248
def open(self, a_bzrdir, _found=False, location=None,
1249
possible_transports=None):
1250
"""Return the branch that the branch reference in a_bzrdir points at.
1252
_found is a private parameter, do not use it. It is used to indicate
1253
if format probing has already be done.
1256
format = BranchFormat.find_format(a_bzrdir)
1257
assert format.__class__ == self.__class__
1258
if location is None:
1259
location = self.get_reference(a_bzrdir)
1260
real_bzrdir = bzrdir.BzrDir.open(
1261
location, possible_transports=possible_transports)
1262
result = real_bzrdir.open_branch()
1263
# this changes the behaviour of result.clone to create a new reference
1264
# rather than a copy of the content of the branch.
1265
# I did not use a proxy object because that needs much more extensive
1266
# testing, and we are only changing one behaviour at the moment.
1267
# If we decide to alter more behaviours - i.e. the implicit nickname
1268
# then this should be refactored to introduce a tested proxy branch
1269
# and a subclass of that for use in overriding clone() and ....
1271
result.clone = self._make_reference_clone_function(result)
1275
# formats which have no format string are not discoverable
1276
# and not independently creatable, so are not registered.
1277
__format5 = BzrBranchFormat5()
1278
__format6 = BzrBranchFormat6()
1279
BranchFormat.register_format(__format5)
1280
BranchFormat.register_format(BranchReferenceFormat())
1281
BranchFormat.register_format(__format6)
1282
BranchFormat.set_default_format(__format6)
1283
_legacy_formats = [BzrBranchFormat4(),
1286
class BzrBranch(Branch):
1287
"""A branch stored in the actual filesystem.
1289
Note that it's "local" in the context of the filesystem; it doesn't
1290
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1291
it's writable, and can be accessed via the normal filesystem API.
1294
def __init__(self, _format=None,
1295
_control_files=None, a_bzrdir=None, _repository=None):
1296
"""Create new branch object at a particular location."""
1297
Branch.__init__(self)
1298
if a_bzrdir is None:
1299
raise ValueError('a_bzrdir must be supplied')
1301
self.bzrdir = a_bzrdir
1302
# self._transport used to point to the directory containing the
1303
# control directory, but was not used - now it's just the transport
1304
# for the branch control files. mbp 20070212
1305
self._base = self.bzrdir.transport.clone('..').base
1306
self._format = _format
1307
if _control_files is None:
1308
raise ValueError('BzrBranch _control_files is None')
1309
self.control_files = _control_files
1310
self._transport = _control_files._transport
1311
self.repository = _repository
1314
return '%s(%r)' % (self.__class__.__name__, self.base)
1318
def _get_base(self):
1319
"""Returns the directory containing the control directory."""
1322
base = property(_get_base, doc="The URL for the root of this branch.")
1324
def abspath(self, name):
1325
"""See Branch.abspath."""
1326
return self.control_files._transport.abspath(name)
1329
@deprecated_method(zero_sixteen)
1331
def get_root_id(self):
1332
"""See Branch.get_root_id."""
1333
tree = self.repository.revision_tree(self.last_revision())
1334
return tree.get_root_id()
1336
def is_locked(self):
1337
return self.control_files.is_locked()
1339
def lock_write(self, token=None):
1340
repo_token = self.repository.lock_write()
1342
token = self.control_files.lock_write(token=token)
1344
self.repository.unlock()
1348
def lock_read(self):
1349
self.repository.lock_read()
1351
self.control_files.lock_read()
1353
self.repository.unlock()
1357
# TODO: test for failed two phase locks. This is known broken.
1359
self.control_files.unlock()
1361
self.repository.unlock()
1362
if not self.control_files.is_locked():
1363
# we just released the lock
1364
self._clear_cached_state()
1366
def peek_lock_mode(self):
1367
if self.control_files._lock_count == 0:
1370
return self.control_files._lock_mode
1372
def get_physical_lock_status(self):
1373
return self.control_files.get_physical_lock_status()
1376
def print_file(self, file, revision_id):
1377
"""See Branch.print_file."""
1378
return self.repository.print_file(file, revision_id)
1380
def _write_revision_history(self, history):
1381
"""Factored out of set_revision_history.
1383
This performs the actual writing to disk.
1384
It is intended to be called by BzrBranch5.set_revision_history."""
1385
self.control_files.put_bytes(
1386
'revision-history', '\n'.join(history))
1389
def set_revision_history(self, rev_history):
1390
"""See Branch.set_revision_history."""
1391
if 'evil' in debug.debug_flags:
1392
mutter_callsite(3, "set_revision_history scales with history.")
1393
self._clear_cached_state()
1394
self._write_revision_history(rev_history)
1395
self._cache_revision_history(rev_history)
1396
for hook in Branch.hooks['set_rh']:
1397
hook(self, rev_history)
1400
def set_last_revision_info(self, revno, revision_id):
1401
"""Set the last revision of this branch.
1403
The caller is responsible for checking that the revno is correct
1404
for this revision id.
1406
It may be possible to set the branch last revision to an id not
1407
present in the repository. However, branches can also be
1408
configured to check constraints on history, in which case this may not
1411
history = self._lefthand_history(revision_id)
1412
assert len(history) == revno, '%d != %d' % (len(history), revno)
1413
self.set_revision_history(history)
1415
def _gen_revision_history(self):
1416
history = self.control_files.get('revision-history').read().split('\n')
1417
if history[-1:] == ['']:
1418
# There shouldn't be a trailing newline, but just in case.
1422
def _lefthand_history(self, revision_id, last_rev=None,
1424
if 'evil' in debug.debug_flags:
1425
mutter_callsite(4, "_lefthand_history scales with history.")
1426
# stop_revision must be a descendant of last_revision
1427
stop_graph = self.repository.get_revision_graph(revision_id)
1428
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1429
and last_rev not in stop_graph):
1430
# our previous tip is not merged into stop_revision
1431
raise errors.DivergedBranches(self, other_branch)
1432
# make a new revision history from the graph
1433
current_rev_id = revision_id
1435
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1436
new_history.append(current_rev_id)
1437
current_rev_id_parents = stop_graph[current_rev_id]
1439
current_rev_id = current_rev_id_parents[0]
1441
current_rev_id = None
1442
new_history.reverse()
1446
def generate_revision_history(self, revision_id, last_rev=None,
1448
"""Create a new revision history that will finish with revision_id.
1450
:param revision_id: the new tip to use.
1451
:param last_rev: The previous last_revision. If not None, then this
1452
must be a ancestory of revision_id, or DivergedBranches is raised.
1453
:param other_branch: The other branch that DivergedBranches should
1454
raise with respect to.
1456
self.set_revision_history(self._lefthand_history(revision_id,
1457
last_rev, other_branch))
1460
def update_revisions(self, other, stop_revision=None, overwrite=False):
1461
"""See Branch.update_revisions."""
1464
other_last_revno, other_last_revision = other.last_revision_info()
1465
if stop_revision is None:
1466
stop_revision = other_last_revision
1467
if _mod_revision.is_null(stop_revision):
1468
# if there are no commits, we're done.
1470
# whats the current last revision, before we fetch [and change it
1472
last_rev = _mod_revision.ensure_null(self.last_revision())
1473
# we fetch here so that we don't process data twice in the common
1474
# case of having something to pull, and so that the check for
1475
# already merged can operate on the just fetched graph, which will
1476
# be cached in memory.
1477
self.fetch(other, stop_revision)
1478
# Check to see if one is an ancestor of the other
1480
heads = self.repository.get_graph().heads([stop_revision,
1482
if heads == set([last_rev]):
1483
# The current revision is a decendent of the target,
1486
elif heads == set([stop_revision, last_rev]):
1487
# These branches have diverged
1488
raise errors.DivergedBranches(self, other)
1489
assert heads == set([stop_revision])
1490
if other_last_revision == stop_revision:
1491
self.set_last_revision_info(other_last_revno,
1492
other_last_revision)
1494
# TODO: jam 2007-11-29 Is there a way to determine the
1495
# revno without searching all of history??
1497
self.generate_revision_history(stop_revision)
1499
self.generate_revision_history(stop_revision,
1500
last_rev=last_rev, other_branch=other)
1504
def basis_tree(self):
1505
"""See Branch.basis_tree."""
1506
return self.repository.revision_tree(self.last_revision())
1509
def pull(self, source, overwrite=False, stop_revision=None,
1510
_hook_master=None, run_hooks=True, possible_transports=None):
1513
:param _hook_master: Private parameter - set the branch to
1514
be supplied as the master to push hooks.
1515
:param run_hooks: Private parameter - if false, this branch
1516
is being called because it's the master of the primary branch,
1517
so it should not run its hooks.
1519
result = PullResult()
1520
result.source_branch = source
1521
result.target_branch = self
1524
result.old_revno, result.old_revid = self.last_revision_info()
1525
self.update_revisions(source, stop_revision, overwrite=overwrite)
1526
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1527
result.new_revno, result.new_revid = self.last_revision_info()
1529
result.master_branch = _hook_master
1530
result.local_branch = self
1532
result.master_branch = self
1533
result.local_branch = None
1535
for hook in Branch.hooks['post_pull']:
1541
def _get_parent_location(self):
1542
_locs = ['parent', 'pull', 'x-pull']
1545
return self.control_files.get(l).read().strip('\n')
1551
def push(self, target, overwrite=False, stop_revision=None,
1552
_override_hook_source_branch=None):
1555
This is the basic concrete implementation of push()
1557
:param _override_hook_source_branch: If specified, run
1558
the hooks passing this Branch as the source, rather than self.
1559
This is for use of RemoteBranch, where push is delegated to the
1560
underlying vfs-based Branch.
1562
# TODO: Public option to disable running hooks - should be trivial but
1566
result = self._push_with_bound_branches(target, overwrite,
1568
_override_hook_source_branch=_override_hook_source_branch)
1573
def _push_with_bound_branches(self, target, overwrite,
1575
_override_hook_source_branch=None):
1576
"""Push from self into target, and into target's master if any.
1578
This is on the base BzrBranch class even though it doesn't support
1579
bound branches because the *target* might be bound.
1582
if _override_hook_source_branch:
1583
result.source_branch = _override_hook_source_branch
1584
for hook in Branch.hooks['post_push']:
1587
bound_location = target.get_bound_location()
1588
if bound_location and target.base != bound_location:
1589
# there is a master branch.
1591
# XXX: Why the second check? Is it even supported for a branch to
1592
# be bound to itself? -- mbp 20070507
1593
master_branch = target.get_master_branch()
1594
master_branch.lock_write()
1596
# push into the master from this branch.
1597
self._basic_push(master_branch, overwrite, stop_revision)
1598
# and push into the target branch from this. Note that we push from
1599
# this branch again, because its considered the highest bandwidth
1601
result = self._basic_push(target, overwrite, stop_revision)
1602
result.master_branch = master_branch
1603
result.local_branch = target
1607
master_branch.unlock()
1610
result = self._basic_push(target, overwrite, stop_revision)
1611
# TODO: Why set master_branch and local_branch if there's no
1612
# binding? Maybe cleaner to just leave them unset? -- mbp
1614
result.master_branch = target
1615
result.local_branch = None
1619
def _basic_push(self, target, overwrite, stop_revision):
1620
"""Basic implementation of push without bound branches or hooks.
1622
Must be called with self read locked and target write locked.
1624
result = PushResult()
1625
result.source_branch = self
1626
result.target_branch = target
1627
result.old_revno, result.old_revid = target.last_revision_info()
1629
target.update_revisions(self, stop_revision)
1630
except DivergedBranches:
1634
target.set_revision_history(self.revision_history())
1635
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1636
result.new_revno, result.new_revid = target.last_revision_info()
1639
def get_parent(self):
1640
"""See Branch.get_parent."""
1642
assert self.base[-1] == '/'
1643
parent = self._get_parent_location()
1646
# This is an old-format absolute path to a local branch
1647
# turn it into a url
1648
if parent.startswith('/'):
1649
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1651
return urlutils.join(self.base[:-1], parent)
1652
except errors.InvalidURLJoin, e:
1653
raise errors.InaccessibleParent(parent, self.base)
1655
def set_push_location(self, location):
1656
"""See Branch.set_push_location."""
1657
self.get_config().set_user_option(
1658
'push_location', location,
1659
store=_mod_config.STORE_LOCATION_NORECURSE)
1662
def set_parent(self, url):
1663
"""See Branch.set_parent."""
1664
# TODO: Maybe delete old location files?
1665
# URLs should never be unicode, even on the local fs,
1666
# FIXUP this and get_parent in a future branch format bump:
1667
# read and rewrite the file, and have the new format code read
1668
# using .get not .get_utf8. RBC 20060125
1670
if isinstance(url, unicode):
1672
url = url.encode('ascii')
1673
except UnicodeEncodeError:
1674
raise errors.InvalidURL(url,
1675
"Urls must be 7-bit ascii, "
1676
"use bzrlib.urlutils.escape")
1677
url = urlutils.relative_url(self.base, url)
1678
self._set_parent_location(url)
1680
def _set_parent_location(self, url):
1682
self.control_files._transport.delete('parent')
1684
assert isinstance(url, str)
1685
self.control_files.put_bytes('parent', url + '\n')
1688
class BzrBranch5(BzrBranch):
1689
"""A format 5 branch. This supports new features over plain branches.
1691
It has support for a master_branch which is the data for bound branches.
1699
super(BzrBranch5, self).__init__(_format=_format,
1700
_control_files=_control_files,
1702
_repository=_repository)
1705
def pull(self, source, overwrite=False, stop_revision=None,
1706
run_hooks=True, possible_transports=None):
1707
"""Pull from source into self, updating my master if any.
1709
:param run_hooks: Private parameter - if false, this branch
1710
is being called because it's the master of the primary branch,
1711
so it should not run its hooks.
1713
bound_location = self.get_bound_location()
1714
master_branch = None
1715
if bound_location and source.base != bound_location:
1716
# not pulling from master, so we need to update master.
1717
master_branch = self.get_master_branch(possible_transports)
1718
master_branch.lock_write()
1721
# pull from source into master.
1722
master_branch.pull(source, overwrite, stop_revision,
1724
return super(BzrBranch5, self).pull(source, overwrite,
1725
stop_revision, _hook_master=master_branch,
1726
run_hooks=run_hooks)
1729
master_branch.unlock()
1731
def get_bound_location(self):
1733
return self.control_files.get_utf8('bound').read()[:-1]
1734
except errors.NoSuchFile:
1738
def get_master_branch(self, possible_transports=None):
1739
"""Return the branch we are bound to.
1741
:return: Either a Branch, or None
1743
This could memoise the branch, but if thats done
1744
it must be revalidated on each new lock.
1745
So for now we just don't memoise it.
1746
# RBC 20060304 review this decision.
1748
bound_loc = self.get_bound_location()
1752
return Branch.open(bound_loc,
1753
possible_transports=possible_transports)
1754
except (errors.NotBranchError, errors.ConnectionError), e:
1755
raise errors.BoundBranchConnectionFailure(
1759
def set_bound_location(self, location):
1760
"""Set the target where this branch is bound to.
1762
:param location: URL to the target branch
1765
self.control_files.put_utf8('bound', location+'\n')
1768
self.control_files._transport.delete('bound')
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')
1774
def bind(self, other):
1775
"""Bind this branch to the branch other.
1777
This does not push or pull data between the branches, though it does
1778
check for divergence to raise an error when the branches are not
1779
either the same, or one a prefix of the other. That behaviour may not
1780
be useful, so that check may be removed in future.
1782
:param other: The branch to bind to
1785
# TODO: jam 20051230 Consider checking if the target is bound
1786
# It is debatable whether you should be able to bind to
1787
# a branch which is itself bound.
1788
# Committing is obviously forbidden,
1789
# but binding itself may not be.
1790
# Since we *have* to check at commit time, we don't
1791
# *need* to check here
1793
# we want to raise diverged if:
1794
# last_rev is not in the other_last_rev history, AND
1795
# other_last_rev is not in our history, and do it without pulling
1797
last_rev = _mod_revision.ensure_null(self.last_revision())
1798
if last_rev != _mod_revision.NULL_REVISION:
1801
other_last_rev = other.last_revision()
1802
if not _mod_revision.is_null(other_last_rev):
1803
# neither branch is new, we have to do some work to
1804
# ascertain diversion.
1805
remote_graph = other.repository.get_revision_graph(
1807
local_graph = self.repository.get_revision_graph(last_rev)
1808
if (last_rev not in remote_graph and
1809
other_last_rev not in local_graph):
1810
raise errors.DivergedBranches(self, other)
1813
self.set_bound_location(other.base)
1817
"""If bound, unbind"""
1818
return self.set_bound_location(None)
1821
def update(self, possible_transports=None):
1822
"""Synchronise this branch with the master branch if any.
1824
:return: None or the last_revision that was pivoted out during the
1827
master = self.get_master_branch(possible_transports)
1828
if master is not None:
1829
old_tip = _mod_revision.ensure_null(self.last_revision())
1830
self.pull(master, overwrite=True)
1831
if self.repository.get_graph().is_ancestor(old_tip,
1832
_mod_revision.ensure_null(self.last_revision())):
1838
class BzrBranchExperimental(BzrBranch5):
1839
"""Bzr experimental branch format
1842
- a revision-history file.
1844
- a lock dir guarding the branch itself
1845
- all of this stored in a branch/ subdirectory
1846
- works with shared repositories.
1847
- a tag dictionary in the branch
1849
This format is new in bzr 0.15, but shouldn't be used for real data,
1852
This class acts as it's own BranchFormat.
1855
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1858
def get_format_string(cls):
1859
"""See BranchFormat.get_format_string()."""
1860
return "Bazaar-NG branch format experimental\n"
1863
def get_format_description(cls):
1864
"""See BranchFormat.get_format_description()."""
1865
return "Experimental branch format"
1868
def get_reference(cls, a_bzrdir):
1869
"""Get the target reference of the branch in a_bzrdir.
1871
format probing must have been completed before calling
1872
this method - it is assumed that the format of the branch
1873
in a_bzrdir is correct.
1875
:param a_bzrdir: The bzrdir to get the branch data from.
1876
:return: None if the branch is not a reference branch.
1881
def set_reference(self, a_bzrdir, to_branch):
1882
"""Set the target reference of the branch in a_bzrdir.
1884
format probing must have been completed before calling
1885
this method - it is assumed that the format of the branch
1886
in a_bzrdir is correct.
1888
:param a_bzrdir: The bzrdir to set the branch reference for.
1889
:param to_branch: branch that the checkout is to reference
1891
raise NotImplementedError(self.set_reference)
1894
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1896
branch_transport = a_bzrdir.get_branch_transport(cls)
1897
control_files = lockable_files.LockableFiles(branch_transport,
1898
lock_filename, lock_class)
1899
control_files.create_lock()
1900
control_files.lock_write()
1902
for filename, content in utf8_files:
1903
control_files.put_utf8(filename, content)
1905
control_files.unlock()
1908
def initialize(cls, a_bzrdir):
1909
"""Create a branch of this format in a_bzrdir."""
1910
utf8_files = [('format', cls.get_format_string()),
1911
('revision-history', ''),
1912
('branch-name', ''),
1915
cls._initialize_control_files(a_bzrdir, utf8_files,
1916
'lock', lockdir.LockDir)
1917
return cls.open(a_bzrdir, _found=True)
1920
def open(cls, a_bzrdir, _found=False):
1921
"""Return the branch object for a_bzrdir
1923
_found is a private parameter, do not use it. It is used to indicate
1924
if format probing has already be done.
1927
format = BranchFormat.find_format(a_bzrdir)
1928
assert format.__class__ == cls
1929
transport = a_bzrdir.get_branch_transport(None)
1930
control_files = lockable_files.LockableFiles(transport, 'lock',
1932
return cls(_format=cls,
1933
_control_files=control_files,
1935
_repository=a_bzrdir.find_repository())
1938
def is_supported(cls):
1941
def _make_tags(self):
1942
return BasicTags(self)
1945
def supports_tags(cls):
1949
BranchFormat.register_format(BzrBranchExperimental)
1952
class BzrBranch6(BzrBranch5):
1955
def last_revision_info(self):
1956
revision_string = self.control_files.get('last-revision').read()
1957
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1958
revision_id = cache_utf8.get_cached_utf8(revision_id)
1960
return revno, revision_id
1962
def last_revision(self):
1963
"""Return last revision id, or None"""
1964
revision_id = self.last_revision_info()[1]
1967
def _write_last_revision_info(self, revno, revision_id):
1968
"""Simply write out the revision id, with no checks.
1970
Use set_last_revision_info to perform this safely.
1972
Does not update the revision_history cache.
1973
Intended to be called by set_last_revision_info and
1974
_write_revision_history.
1976
if revision_id is None:
1977
revision_id = 'null:'
1978
out_string = '%d %s\n' % (revno, revision_id)
1979
self.control_files.put_bytes('last-revision', out_string)
1982
def set_last_revision_info(self, revno, revision_id):
1983
if self._get_append_revisions_only():
1984
self._check_history_violation(revision_id)
1985
self._write_last_revision_info(revno, revision_id)
1986
self._clear_cached_state()
1988
def _check_history_violation(self, revision_id):
1989
last_revision = _mod_revision.ensure_null(self.last_revision())
1990
if _mod_revision.is_null(last_revision):
1992
if last_revision not in self._lefthand_history(revision_id):
1993
raise errors.AppendRevisionsOnlyViolation(self.base)
1995
def _gen_revision_history(self):
1996
"""Generate the revision history from last revision
1998
history = list(self.repository.iter_reverse_revision_history(
1999
self.last_revision()))
2003
def _write_revision_history(self, history):
2004
"""Factored out of set_revision_history.
2006
This performs the actual writing to disk, with format-specific checks.
2007
It is intended to be called by BzrBranch5.set_revision_history.
2009
if len(history) == 0:
2010
last_revision = 'null:'
2012
if history != self._lefthand_history(history[-1]):
2013
raise errors.NotLefthandHistory(history)
2014
last_revision = history[-1]
2015
if self._get_append_revisions_only():
2016
self._check_history_violation(last_revision)
2017
self._write_last_revision_info(len(history), last_revision)
2020
def _set_parent_location(self, url):
2021
"""Set the parent branch"""
2022
self._set_config_location('parent_location', url, make_relative=True)
2025
def _get_parent_location(self):
2026
"""Set the parent branch"""
2027
return self._get_config_location('parent_location')
2029
def set_push_location(self, location):
2030
"""See Branch.set_push_location."""
2031
self._set_config_location('push_location', location)
2033
def set_bound_location(self, location):
2034
"""See Branch.set_push_location."""
2036
config = self.get_config()
2037
if location is None:
2038
if config.get_user_option('bound') != 'True':
2041
config.set_user_option('bound', 'False', warn_masked=True)
2044
self._set_config_location('bound_location', location,
2046
config.set_user_option('bound', 'True', warn_masked=True)
2049
def _get_bound_location(self, bound):
2050
"""Return the bound location in the config file.
2052
Return None if the bound parameter does not match"""
2053
config = self.get_config()
2054
config_bound = (config.get_user_option('bound') == 'True')
2055
if config_bound != bound:
2057
return self._get_config_location('bound_location', config=config)
2059
def get_bound_location(self):
2060
"""See Branch.set_push_location."""
2061
return self._get_bound_location(True)
2063
def get_old_bound_location(self):
2064
"""See Branch.get_old_bound_location"""
2065
return self._get_bound_location(False)
2067
def set_append_revisions_only(self, enabled):
2072
self.get_config().set_user_option('append_revisions_only', value,
2075
def _get_append_revisions_only(self):
2076
value = self.get_config().get_user_option('append_revisions_only')
2077
return value == 'True'
2079
def _synchronize_history(self, destination, revision_id):
2080
"""Synchronize last revision and revision history between branches.
2082
This version is most efficient when the destination is also a
2083
BzrBranch6, but works for BzrBranch5, as long as the destination's
2084
repository contains all the lefthand ancestors of the intended
2085
last_revision. If not, set_last_revision_info will fail.
2087
:param destination: The branch to copy the history into
2088
:param revision_id: The revision-id to truncate history at. May
2089
be None to copy complete history.
2091
source_revno, source_revision_id = self.last_revision_info()
2092
if revision_id is None:
2093
revno, revision_id = source_revno, source_revision_id
2094
elif source_revision_id == revision_id:
2095
# we know the revno without needing to walk all of history
2096
revno = source_revno
2098
# To figure out the revno for a random revision, we need to build
2099
# the revision history, and count its length.
2100
# We don't care about the order, just how long it is.
2101
# Alternatively, we could start at the current location, and count
2102
# backwards. But there is no guarantee that we will find it since
2103
# it may be a merged revision.
2104
revno = len(list(self.repository.iter_reverse_revision_history(
2106
destination.set_last_revision_info(revno, revision_id)
2108
def _make_tags(self):
2109
return BasicTags(self)
2112
######################################################################
2113
# results of operations
2116
class _Result(object):
2118
def _show_tag_conficts(self, to_file):
2119
if not getattr(self, 'tag_conflicts', None):
2121
to_file.write('Conflicting tags:\n')
2122
for name, value1, value2 in self.tag_conflicts:
2123
to_file.write(' %s\n' % (name, ))
2126
class PullResult(_Result):
2127
"""Result of a Branch.pull operation.
2129
:ivar old_revno: Revision number before pull.
2130
:ivar new_revno: Revision number after pull.
2131
:ivar old_revid: Tip revision id before pull.
2132
:ivar new_revid: Tip revision id after pull.
2133
:ivar source_branch: Source (local) branch object.
2134
:ivar master_branch: Master branch of the target, or None.
2135
:ivar target_branch: Target/destination branch object.
2139
# DEPRECATED: pull used to return the change in revno
2140
return self.new_revno - self.old_revno
2142
def report(self, to_file):
2143
if self.old_revid == self.new_revid:
2144
to_file.write('No revisions to pull.\n')
2146
to_file.write('Now on revision %d.\n' % self.new_revno)
2147
self._show_tag_conficts(to_file)
2150
class PushResult(_Result):
2151
"""Result of a Branch.push operation.
2153
:ivar old_revno: Revision number before push.
2154
:ivar new_revno: Revision number after push.
2155
:ivar old_revid: Tip revision id before push.
2156
:ivar new_revid: Tip revision id after push.
2157
:ivar source_branch: Source branch object.
2158
:ivar master_branch: Master branch of the target, or None.
2159
:ivar target_branch: Target/destination branch object.
2163
# DEPRECATED: push used to return the change in revno
2164
return self.new_revno - self.old_revno
2166
def report(self, to_file):
2167
"""Write a human-readable description of the result."""
2168
if self.old_revid == self.new_revid:
2169
to_file.write('No new revisions to push.\n')
2171
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2172
self._show_tag_conficts(to_file)
2175
class BranchCheckResult(object):
2176
"""Results of checking branch consistency.
2181
def __init__(self, branch):
2182
self.branch = branch
2184
def report_results(self, verbose):
2185
"""Report the check results via trace.note.
2187
:param verbose: Requests more detailed display of what was checked,
2190
note('checked branch %s format %s',
2192
self.branch._format)
2195
class Converter5to6(object):
2196
"""Perform an in-place upgrade of format 5 to format 6"""
2198
def convert(self, branch):
2199
# Data for 5 and 6 can peacefully coexist.
2200
format = BzrBranchFormat6()
2201
new_branch = format.open(branch.bzrdir, _found=True)
2203
# Copy source data into target
2204
new_branch.set_last_revision_info(*branch.last_revision_info())
2205
new_branch.set_parent(branch.get_parent())
2206
new_branch.set_bound_location(branch.get_bound_location())
2207
new_branch.set_push_location(branch.get_push_location())
2209
# New branch has no tags by default
2210
new_branch.tags._set_tag_dict({})
2212
# Copying done; now update target format
2213
new_branch.control_files.put_utf8('format',
2214
format.get_format_string())
2216
# Clean up old files
2217
new_branch.control_files._transport.delete('revision-history')
2219
branch.set_parent(None)
2222
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
