126
86
"""Branch holding a history of revisions.
129
Base directory of the branch.
135
If _lock_mode is true, a positive count of the number of times the
139
Lock object from bzrlib.lock.
89
Base directory/url of the branch.
91
hooks: An instance of BranchHooks.
93
# this is really an instance variable - FIXME move it there
146
def __init__(self, base, init=False, find_root=True):
147
"""Create new branch object at a particular location.
149
base -- Base directory for the branch.
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.
151
init -- If True, create new control files in a previously
152
unversioned directory. If False, the branch must already
155
find_root -- If true and init is false, find the root of the
156
existing branch containing base.
158
In the test suite, creation of new trees is tested using the
159
`ScratchBranch` class.
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.
162
self.base = os.path.realpath(base)
165
self.base = find_branch_root(base)
167
self.base = os.path.realpath(base)
168
if not isdir(self.controlfilename('.')):
169
from errors import NotBranchError
170
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
171
['use "bzr init" to initialize a new working tree',
172
'current bzr can only operate from top-of-tree'])
175
self.text_store = ImmutableStore(self.controlfilename('text-store'))
176
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
177
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
181
return '%s(%r)' % (self.__class__.__name__, self.base)
188
if self._lock_mode or self._lock:
189
from warnings import warn
190
warn("branch %r was not explicitly unlocked" % self)
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)
195
167
def lock_write(self):
197
if self._lock_mode != 'w':
198
from errors import LockError
199
raise LockError("can't upgrade to a write lock from %r" %
201
self._lock_count += 1
203
from bzrlib.lock import WriteLock
205
self._lock = WriteLock(self.controlfilename('branch-lock'))
206
self._lock_mode = 'w'
168
raise NotImplementedError(self.lock_write)
211
170
def lock_read(self):
213
assert self._lock_mode in ('r', 'w'), \
214
"invalid lock mode %r" % self._lock_mode
215
self._lock_count += 1
217
from bzrlib.lock import ReadLock
219
self._lock = ReadLock(self.controlfilename('branch-lock'))
220
self._lock_mode = 'r'
171
raise NotImplementedError(self.lock_read)
225
173
def unlock(self):
226
if not self._lock_mode:
227
from errors import LockError
228
raise LockError('branch %r is not locked' % (self))
230
if self._lock_count > 1:
231
self._lock_count -= 1
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
235
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()
238
241
def abspath(self, name):
239
"""Return absolute filename for something in the branch"""
240
return os.path.join(self.base, name)
243
def relpath(self, path):
244
"""Return path relative to this branch of something inside it.
246
Raises an error if path is not in this branch."""
247
return _relpath(self.base, path)
250
def controlfilename(self, file_or_path):
251
"""Return location relative to branch."""
252
if isinstance(file_or_path, types.StringTypes):
253
file_or_path = [file_or_path]
254
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
257
def controlfile(self, file_or_path, mode='r'):
258
"""Open a control file for this branch.
260
There are two classes of file in the control directory: text
261
and binary. binary files are untranslated byte streams. Text
262
control files are stored with Unix newlines and in UTF-8, even
263
if the platform or locale defaults are different.
265
Controlfiles should almost never be opened in write mode but
266
rather should be atomically copied and replaced using atomicfile.
269
fn = self.controlfilename(file_or_path)
271
if mode == 'rb' or mode == 'wb':
272
return file(fn, mode)
273
elif mode == 'r' or mode == 'w':
274
# open in binary mode anyhow so there's no newline translation;
275
# codecs uses line buffering by default; don't want that.
277
return codecs.open(fn, mode + 'b', 'utf-8',
280
raise BzrError("invalid controlfile mode %r" % mode)
284
def _make_control(self):
285
os.mkdir(self.controlfilename([]))
286
self.controlfile('README', 'w').write(
287
"This is a Bazaar-NG control directory.\n"
288
"Do not change any files in this directory.\n")
289
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
290
for d in ('text-store', 'inventory-store', 'revision-store'):
291
os.mkdir(self.controlfilename(d))
292
for f in ('revision-history', 'merged-patches',
293
'pending-merged-patches', 'branch-name',
295
self.controlfile(f, 'w').write('')
296
mutter('created control directory in ' + self.base)
297
Inventory().write_xml(self.controlfile('inventory','w'))
300
def _check_format(self):
301
"""Check this branch format is supported.
303
The current tool only supports the current unstable format.
305
In the future, we might need different in-memory Branch
306
classes to support downlevel branches. But not yet.
308
# This ignores newlines so that we can open branches created
309
# on Windows from Linux and so on. I think it might be better
310
# to always make all internal files in unix format.
311
fmt = self.controlfile('branch-format', 'r').read()
312
fmt.replace('\r\n', '')
313
if fmt != BZR_BRANCH_FORMAT:
314
raise BzrError('sorry, branch format %r not supported' % fmt,
315
['use a different bzr version',
316
'or remove the .bzr directory and "bzr init" again'])
320
def read_working_inventory(self):
321
"""Read the working inventory."""
323
# ElementTree does its own conversion from UTF-8, so open in
327
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
328
mutter("loaded inventory of %d items in %f"
329
% (len(inv), time.time() - before))
335
def _write_inventory(self, inv):
336
"""Update the working inventory.
338
That is to say, the inventory describing changes underway, that
339
will be committed to the next revision.
341
## TODO: factor out to atomicfile? is rename safe on windows?
342
## TODO: Maybe some kind of clean/dirty marker on inventory?
343
tmpfname = self.controlfilename('inventory.tmp')
344
tmpf = file(tmpfname, 'wb')
347
inv_fname = self.controlfilename('inventory')
348
if sys.platform == 'win32':
350
os.rename(tmpfname, inv_fname)
351
mutter('wrote working inventory')
354
inventory = property(read_working_inventory, _write_inventory, None,
355
"""Inventory for the working copy.""")
358
def add(self, files, verbose=False, ids=None):
359
"""Make files versioned.
361
Note that the command line normally calls smart_add instead.
363
This puts the files in the Added state, so that they will be
364
recorded by the next commit.
367
List of paths to add, relative to the base of the tree.
370
If set, use these instead of automatically generated ids.
371
Must be the same length as the list of files, but may
372
contain None for ids that are to be autogenerated.
374
TODO: Perhaps have an option to add the ids even if the files do
377
TODO: Perhaps return the ids of the files? But then again it
378
is easy to retrieve them if they're needed.
380
TODO: Adding a directory should optionally recurse down and
381
add all non-ignored children. Perhaps do that in a
384
# TODO: Re-adding a file that is removed in the working copy
385
# should probably put it back with the previous ID.
386
if isinstance(files, types.StringTypes):
387
assert(ids is None or isinstance(ids, types.StringTypes))
393
ids = [None] * len(files)
395
assert(len(ids) == len(files))
399
inv = self.read_working_inventory()
400
for f,file_id in zip(files, ids):
401
if is_control_file(f):
402
raise BzrError("cannot add control file %s" % quotefn(f))
407
raise BzrError("cannot add top-level %r" % f)
409
fullpath = os.path.normpath(self.abspath(f))
412
kind = file_kind(fullpath)
414
# maybe something better?
415
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
417
if kind != 'file' and kind != 'directory':
418
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
421
file_id = gen_file_id(f)
422
inv.add_path(f, kind=kind, file_id=file_id)
425
show_status('A', kind, quotefn(f))
427
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
429
self._write_inventory(inv)
434
def print_file(self, file, revno):
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
332
def get_revision_delta(self, revno):
333
"""Return the delta for one revision.
335
The delta is relative to its mainline predecessor, or the
336
empty tree for revision 1.
338
assert isinstance(revno, int)
339
rh = self.revision_history()
340
if not (1 <= revno <= len(rh)):
341
raise InvalidRevisionNumber(revno)
342
return self.repository.get_revision_delta(rh[revno-1])
344
@deprecated_method(zero_sixteen)
345
def get_root_id(self):
346
"""Return the id of this branches root
348
Deprecated: branches don't have root ids-- trees do.
349
Use basis_tree().get_root_id() instead.
351
raise NotImplementedError(self.get_root_id)
353
def print_file(self, file, revision_id):
435
354
"""Print `file` to stdout."""
438
tree = self.revision_tree(self.lookup_revision(revno))
439
# use inventory as it was in that revision
440
file_id = tree.inventory.path2id(file)
442
raise BzrError("%r is not present in revision %d" % (file, revno))
443
tree.print_file(file_id)
448
def remove(self, files, verbose=False):
449
"""Mark nominated files for removal from the inventory.
451
This does not remove their text. This does not run on
453
TODO: Refuse to remove modified files unless --force is given?
455
TODO: Do something useful with directories.
457
TODO: Should this remove the text or not? Tough call; not
458
removing may be useful and the user can just use use rm, and
459
is the opposite of add. Removing it is consistent with most
460
other tools. Maybe an option.
462
## TODO: Normalize names
463
## TODO: Remove nested loops; better scalability
464
if isinstance(files, types.StringTypes):
470
tree = self.working_tree()
473
# do this before any modifications
477
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
478
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
480
# having remove it, it must be either ignored or unknown
481
if tree.is_ignored(f):
485
show_status(new_status, inv[fid].kind, quotefn(f))
488
self._write_inventory(inv)
493
# FIXME: this doesn't need to be a branch method
494
def set_inventory(self, new_inventory_list):
496
for path, file_id, parent, kind in new_inventory_list:
497
name = os.path.basename(path)
500
inv.add(InventoryEntry(file_id, name, kind, parent))
501
self._write_inventory(inv)
505
"""Return all unknown files.
507
These are files in the working directory that are not versioned or
508
control files or ignored.
510
>>> b = ScratchBranch(files=['foo', 'foo~'])
511
>>> list(b.unknowns())
514
>>> list(b.unknowns())
517
>>> list(b.unknowns())
520
return self.working_tree().unknowns()
523
def append_revision(self, revision_id):
524
mutter("add {%s} to revision-history" % revision_id)
525
rev_history = self.revision_history()
527
tmprhname = self.controlfilename('revision-history.tmp')
528
rhname = self.controlfilename('revision-history')
530
f = file(tmprhname, 'wt')
531
rev_history.append(revision_id)
532
f.write('\n'.join(rev_history))
536
if sys.platform == 'win32':
538
os.rename(tmprhname, rhname)
542
def get_revision(self, revision_id):
543
"""Return the Revision object for a named revision"""
544
if not revision_id or not isinstance(revision_id, basestring):
545
raise ValueError('invalid revision-id: %r' % revision_id)
546
r = Revision.read_xml(self.revision_store[revision_id])
547
assert r.revision_id == revision_id
550
def get_revision_sha1(self, revision_id):
551
"""Hash the stored value of a revision, and return it."""
552
# In the future, revision entries will be signed. At that
553
# point, it is probably best *not* to include the signature
554
# in the revision hash. Because that lets you re-sign
555
# the revision, (add signatures/remove signatures) and still
556
# have all hash pointers stay consistent.
557
# But for now, just hash the contents.
558
return sha_file(self.revision_store[revision_id])
561
def get_inventory(self, inventory_id):
562
"""Get Inventory object by hash.
564
TODO: Perhaps for this and similar methods, take a revision
565
parameter which can be either an integer revno or a
567
i = Inventory.read_xml(self.inventory_store[inventory_id])
570
def get_inventory_sha1(self, inventory_id):
571
"""Return the sha1 hash of the inventory entry
573
return sha_file(self.inventory_store[inventory_id])
576
def get_revision_inventory(self, revision_id):
577
"""Return inventory of a past revision."""
578
if revision_id == None:
581
return self.get_inventory(self.get_revision(revision_id).inventory_id)
355
raise NotImplementedError(self.print_file)
357
def set_revision_history(self, rev_history):
358
raise NotImplementedError(self.set_revision_history)
360
def _cache_revision_history(self, rev_history):
361
"""Set the cached revision history to rev_history.
363
The revision_history method will use this cache to avoid regenerating
364
the revision history.
366
This API is semi-public; it only for use by subclasses, all other code
367
should consider it to be private.
369
self._revision_history_cache = rev_history
371
def _cache_revision_id_to_revno(self, revision_id_to_revno):
372
"""Set the cached revision_id => revno map to revision_id_to_revno.
374
This API is semi-public; it only for use by subclasses, all other code
375
should consider it to be private.
377
self._revision_id_to_revno_cache = revision_id_to_revno
379
def _clear_cached_state(self):
380
"""Clear any cached data on this branch, e.g. cached revision history.
382
This means the next call to revision_history will need to call
383
_gen_revision_history.
385
This API is semi-public; it only for use by subclasses, all other code
386
should consider it to be private.
388
self._revision_history_cache = None
389
self._revision_id_to_revno_cache = None
391
def _gen_revision_history(self):
392
"""Return sequence of revision hashes on to this branch.
394
Unlike revision_history, this method always regenerates or rereads the
395
revision history, i.e. it does not cache the result, so repeated calls
398
Concrete subclasses should override this instead of revision_history so
399
that subclasses do not need to deal with caching logic.
401
This API is semi-public; it only for use by subclasses, all other code
402
should consider it to be private.
404
raise NotImplementedError(self._gen_revision_history)
584
407
def revision_history(self):
585
"""Return sequence of revision hashes on to this branch.
587
>>> ScratchBranch().revision_history()
592
return [l.rstrip('\r\n') for l in
593
self.controlfile('revision-history', 'r').readlines()]
598
def common_ancestor(self, other, self_revno=None, other_revno=None):
601
>>> sb = ScratchBranch(files=['foo', 'foo~'])
602
>>> sb.common_ancestor(sb) == (None, None)
604
>>> commit.commit(sb, "Committing first revision", verbose=False)
605
>>> sb.common_ancestor(sb)[0]
607
>>> clone = sb.clone()
608
>>> commit.commit(sb, "Committing second revision", verbose=False)
609
>>> sb.common_ancestor(sb)[0]
611
>>> sb.common_ancestor(clone)[0]
613
>>> commit.commit(clone, "Committing divergent second revision",
615
>>> sb.common_ancestor(clone)[0]
617
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
619
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
621
>>> clone2 = sb.clone()
622
>>> sb.common_ancestor(clone2)[0]
624
>>> sb.common_ancestor(clone2, self_revno=1)[0]
626
>>> sb.common_ancestor(clone2, other_revno=1)[0]
629
my_history = self.revision_history()
630
other_history = other.revision_history()
631
if self_revno is None:
632
self_revno = len(my_history)
633
if other_revno is None:
634
other_revno = len(other_history)
635
indices = range(min((self_revno, other_revno)))
638
if my_history[r] == other_history[r]:
639
return r+1, my_history[r]
642
def enum_history(self, direction):
643
"""Return (revno, revision_id) for history of branch.
646
'forward' is from earliest to latest
647
'reverse' is from latest to earliest
649
rh = self.revision_history()
650
if direction == 'forward':
655
elif direction == 'reverse':
408
"""Return sequence of revision ids on this branch.
410
This method will cache the revision history for as long as it is safe to
413
if 'evil' in debug.debug_flags:
414
mutter_callsite(3, "revision_history scales with history.")
415
if self._revision_history_cache is not None:
416
history = self._revision_history_cache
661
raise ValueError('invalid history direction', direction)
418
history = self._gen_revision_history()
419
self._cache_revision_history(history)
665
423
"""Return current revision number for this branch.
897
546
Note that to_name is only the last component of the new name;
898
547
this doesn't change the directory.
902
## TODO: Option to move IDs only
903
assert not isinstance(from_paths, basestring)
904
tree = self.working_tree()
906
to_abs = self.abspath(to_name)
907
if not isdir(to_abs):
908
raise BzrError("destination %r is not a directory" % to_abs)
909
if not tree.has_filename(to_name):
910
raise BzrError("destination %r not in working directory" % to_abs)
911
to_dir_id = inv.path2id(to_name)
912
if to_dir_id == None and to_name != '':
913
raise BzrError("destination %r is not a versioned directory" % to_name)
914
to_dir_ie = inv[to_dir_id]
915
if to_dir_ie.kind not in ('directory', 'root_directory'):
916
raise BzrError("destination %r is not a directory" % to_abs)
918
to_idpath = inv.get_idpath(to_dir_id)
921
if not tree.has_filename(f):
922
raise BzrError("%r does not exist in working tree" % f)
923
f_id = inv.path2id(f)
925
raise BzrError("%r is not versioned" % f)
926
name_tail = splitpath(f)[-1]
927
dest_path = appendpath(to_name, name_tail)
928
if tree.has_filename(dest_path):
929
raise BzrError("destination %r already exists" % dest_path)
930
if f_id in to_idpath:
931
raise BzrError("can't move %r to a subdirectory of itself" % f)
933
# OK, so there's a race here, it's possible that someone will
934
# create a file in this interval and then the rename might be
935
# left half-done. But we should have caught most problems.
938
name_tail = splitpath(f)[-1]
939
dest_path = appendpath(to_name, name_tail)
940
print "%s => %s" % (f, dest_path)
941
inv.rename(inv.path2id(f), to_dir_id, name_tail)
943
os.rename(self.abspath(f), self.abspath(dest_path))
945
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
946
["rename rolled back"])
948
self._write_inventory(inv)
954
class ScratchBranch(Branch):
955
"""Special test class: a branch that cleans up after itself.
957
>>> b = ScratchBranch()
965
def __init__(self, files=[], dirs=[], base=None):
966
"""Make a test branch.
968
This creates a temporary directory and runs init-tree in it.
970
If any files are listed, they are created in the working copy.
974
base = tempfile.mkdtemp()
976
Branch.__init__(self, base, init=init)
978
os.mkdir(self.abspath(d))
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)
981
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
986
>>> orig = ScratchBranch(files=["file1", "file2"])
987
>>> clone = orig.clone()
988
>>> os.path.samefile(orig.base, clone.base)
990
>>> os.path.isfile(os.path.join(clone.base, "file1"))
993
base = tempfile.mkdtemp()
995
shutil.copytree(self.base, base, symlinks=True)
996
return ScratchBranch(base=base)
1002
"""Destroy the test branch, removing the scratch directory."""
1005
mutter("delete ScratchBranch %s" % self.base)
1006
shutil.rmtree(self.base)
1008
# Work around for shutil.rmtree failing on Windows when
1009
# readonly files are encountered
1010
mutter("hit exception in destroying ScratchBranch: %s" % e)
1011
for root, dirs, files in os.walk(self.base, topdown=False):
1013
os.chmod(os.path.join(root, name), 0700)
1014
shutil.rmtree(self.base)
1019
######################################################################
1023
def is_control_file(filename):
1024
## FIXME: better check
1025
filename = os.path.normpath(filename)
1026
while filename != '':
1027
head, tail = os.path.split(filename)
1028
## mutter('check %r for control file' % ((head, tail), ))
1029
if tail == bzrlib.BZRDIR:
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.
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())
1126
raise 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 initialize(self, a_bzrdir, target_branch=None):
1202
"""Create a branch of this format in a_bzrdir."""
1203
if target_branch is None:
1204
# this format does not implement branch itself, thus the implicit
1205
# creation contract must see it as uninitializable
1206
raise errors.UninitializableFormat(self)
1207
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1208
branch_transport = a_bzrdir.get_branch_transport(self)
1209
branch_transport.put_bytes('location',
1210
target_branch.bzrdir.root_transport.base)
1211
branch_transport.put_bytes('format', self.get_format_string())
1213
a_bzrdir, _found=True,
1214
possible_transports=[target_branch.bzrdir.root_transport])
1217
super(BranchReferenceFormat, self).__init__()
1218
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1220
def _make_reference_clone_function(format, a_branch):
1221
"""Create a clone() routine for a branch dynamically."""
1222
def clone(to_bzrdir, revision_id=None):
1223
"""See Branch.clone()."""
1224
return format.initialize(to_bzrdir, a_branch)
1225
# cannot obey revision_id limits when cloning a reference ...
1226
# FIXME RBC 20060210 either nuke revision_id for clone, or
1227
# emit some sort of warning/error to the caller ?!
1230
def open(self, a_bzrdir, _found=False, location=None,
1231
possible_transports=None):
1232
"""Return the branch that the branch reference in a_bzrdir points at.
1234
_found is a private parameter, do not use it. It is used to indicate
1235
if format probing has already be done.
1238
format = BranchFormat.find_format(a_bzrdir)
1239
assert format.__class__ == self.__class__
1240
if location is None:
1241
location = self.get_reference(a_bzrdir)
1242
real_bzrdir = bzrdir.BzrDir.open(
1243
location, possible_transports=possible_transports)
1244
result = real_bzrdir.open_branch()
1245
# this changes the behaviour of result.clone to create a new reference
1246
# rather than a copy of the content of the branch.
1247
# I did not use a proxy object because that needs much more extensive
1248
# testing, and we are only changing one behaviour at the moment.
1249
# If we decide to alter more behaviours - i.e. the implicit nickname
1250
# then this should be refactored to introduce a tested proxy branch
1251
# and a subclass of that for use in overriding clone() and ....
1253
result.clone = self._make_reference_clone_function(result)
1257
# formats which have no format string are not discoverable
1258
# and not independently creatable, so are not registered.
1259
__format5 = BzrBranchFormat5()
1260
__format6 = BzrBranchFormat6()
1261
BranchFormat.register_format(__format5)
1262
BranchFormat.register_format(BranchReferenceFormat())
1263
BranchFormat.register_format(__format6)
1264
BranchFormat.set_default_format(__format6)
1265
_legacy_formats = [BzrBranchFormat4(),
1268
class BzrBranch(Branch):
1269
"""A branch stored in the actual filesystem.
1271
Note that it's "local" in the context of the filesystem; it doesn't
1272
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1273
it's writable, and can be accessed via the normal filesystem API.
1276
def __init__(self, _format=None,
1277
_control_files=None, a_bzrdir=None, _repository=None):
1278
"""Create new branch object at a particular location."""
1279
Branch.__init__(self)
1280
if a_bzrdir is None:
1281
raise ValueError('a_bzrdir must be supplied')
1283
self.bzrdir = a_bzrdir
1284
# self._transport used to point to the directory containing the
1285
# control directory, but was not used - now it's just the transport
1286
# for the branch control files. mbp 20070212
1287
self._base = self.bzrdir.transport.clone('..').base
1288
self._format = _format
1289
if _control_files is None:
1290
raise ValueError('BzrBranch _control_files is None')
1291
self.control_files = _control_files
1292
self._transport = _control_files._transport
1293
self.repository = _repository
1296
return '%s(%r)' % (self.__class__.__name__, self.base)
1300
def _get_base(self):
1301
"""Returns the directory containing the control directory."""
1304
base = property(_get_base, doc="The URL for the root of this branch.")
1306
def abspath(self, name):
1307
"""See Branch.abspath."""
1308
return self.control_files._transport.abspath(name)
1311
@deprecated_method(zero_sixteen)
1313
def get_root_id(self):
1314
"""See Branch.get_root_id."""
1315
tree = self.repository.revision_tree(self.last_revision())
1316
return tree.get_root_id()
1318
def is_locked(self):
1319
return self.control_files.is_locked()
1321
def lock_write(self, token=None):
1322
repo_token = self.repository.lock_write()
1324
token = self.control_files.lock_write(token=token)
1326
self.repository.unlock()
1330
def lock_read(self):
1331
self.repository.lock_read()
1333
self.control_files.lock_read()
1335
self.repository.unlock()
1339
# TODO: test for failed two phase locks. This is known broken.
1341
self.control_files.unlock()
1343
self.repository.unlock()
1344
if not self.control_files.is_locked():
1345
# we just released the lock
1346
self._clear_cached_state()
1348
def peek_lock_mode(self):
1349
if self.control_files._lock_count == 0:
1352
return self.control_files._lock_mode
1354
def get_physical_lock_status(self):
1355
return self.control_files.get_physical_lock_status()
1358
def print_file(self, file, revision_id):
1359
"""See Branch.print_file."""
1360
return self.repository.print_file(file, revision_id)
1362
def _write_revision_history(self, history):
1363
"""Factored out of set_revision_history.
1365
This performs the actual writing to disk.
1366
It is intended to be called by BzrBranch5.set_revision_history."""
1367
self.control_files.put_bytes(
1368
'revision-history', '\n'.join(history))
1371
def set_revision_history(self, rev_history):
1372
"""See Branch.set_revision_history."""
1373
if 'evil' in debug.debug_flags:
1374
mutter_callsite(3, "set_revision_history scales with history.")
1375
self._clear_cached_state()
1376
self._write_revision_history(rev_history)
1377
self._cache_revision_history(rev_history)
1378
for hook in Branch.hooks['set_rh']:
1379
hook(self, rev_history)
1382
def set_last_revision_info(self, revno, revision_id):
1383
"""Set the last revision of this branch.
1385
The caller is responsible for checking that the revno is correct
1386
for this revision id.
1388
It may be possible to set the branch last revision to an id not
1389
present in the repository. However, branches can also be
1390
configured to check constraints on history, in which case this may not
1393
history = self._lefthand_history(revision_id)
1394
assert len(history) == revno, '%d != %d' % (len(history), revno)
1395
self.set_revision_history(history)
1397
def _gen_revision_history(self):
1398
history = self.control_files.get('revision-history').read().split('\n')
1399
if history[-1:] == ['']:
1400
# There shouldn't be a trailing newline, but just in case.
1404
def _lefthand_history(self, revision_id, last_rev=None,
1406
if 'evil' in debug.debug_flags:
1407
mutter_callsite(4, "_lefthand_history scales with history.")
1408
# stop_revision must be a descendant of last_revision
1409
stop_graph = self.repository.get_revision_graph(revision_id)
1410
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1411
and last_rev not in stop_graph):
1412
# our previous tip is not merged into stop_revision
1413
raise errors.DivergedBranches(self, other_branch)
1414
# make a new revision history from the graph
1415
current_rev_id = revision_id
1417
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1418
new_history.append(current_rev_id)
1419
current_rev_id_parents = stop_graph[current_rev_id]
1421
current_rev_id = current_rev_id_parents[0]
1423
current_rev_id = None
1424
new_history.reverse()
1428
def generate_revision_history(self, revision_id, last_rev=None,
1430
"""Create a new revision history that will finish with revision_id.
1432
:param revision_id: the new tip to use.
1433
:param last_rev: The previous last_revision. If not None, then this
1434
must be a ancestory of revision_id, or DivergedBranches is raised.
1435
:param other_branch: The other branch that DivergedBranches should
1436
raise with respect to.
1438
self.set_revision_history(self._lefthand_history(revision_id,
1439
last_rev, other_branch))
1442
def update_revisions(self, other, stop_revision=None):
1443
"""See Branch.update_revisions."""
1446
if stop_revision is None:
1447
stop_revision = other.last_revision()
1448
if stop_revision is None:
1449
# if there are no commits, we're done.
1451
# whats the current last revision, before we fetch [and change it
1453
last_rev = _mod_revision.ensure_null(self.last_revision())
1454
# we fetch here so that we don't process data twice in the common
1455
# case of having something to pull, and so that the check for
1456
# already merged can operate on the just fetched graph, which will
1457
# be cached in memory.
1458
self.fetch(other, stop_revision)
1459
if self.repository.get_graph().is_ancestor(stop_revision,
1462
self.generate_revision_history(stop_revision, last_rev=last_rev,
1467
def basis_tree(self):
1468
"""See Branch.basis_tree."""
1469
return self.repository.revision_tree(self.last_revision())
1472
def pull(self, source, overwrite=False, stop_revision=None,
1473
_hook_master=None, run_hooks=True, possible_transports=None):
1476
:param _hook_master: Private parameter - set the branch to
1477
be supplied as the master to push hooks.
1478
:param run_hooks: Private parameter - if false, this branch
1479
is being called because it's the master of the primary branch,
1480
so it should not run its hooks.
1482
result = PullResult()
1483
result.source_branch = source
1484
result.target_branch = self
1487
result.old_revno, result.old_revid = self.last_revision_info()
1489
self.update_revisions(source, stop_revision)
1490
except DivergedBranches:
1494
if stop_revision is None:
1495
stop_revision = source.last_revision()
1496
self.generate_revision_history(stop_revision)
1497
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1498
result.new_revno, result.new_revid = self.last_revision_info()
1500
result.master_branch = _hook_master
1501
result.local_branch = self
1503
result.master_branch = self
1504
result.local_branch = None
1506
for hook in Branch.hooks['post_pull']:
1512
def _get_parent_location(self):
1513
_locs = ['parent', 'pull', 'x-pull']
1516
return self.control_files.get(l).read().strip('\n')
1522
def push(self, target, overwrite=False, stop_revision=None,
1523
_override_hook_source_branch=None):
1526
This is the basic concrete implementation of push()
1528
:param _override_hook_source_branch: If specified, run
1529
the hooks passing this Branch as the source, rather than self.
1530
This is for use of RemoteBranch, where push is delegated to the
1531
underlying vfs-based Branch.
1533
# TODO: Public option to disable running hooks - should be trivial but
1537
result = self._push_with_bound_branches(target, overwrite,
1539
_override_hook_source_branch=_override_hook_source_branch)
1544
def _push_with_bound_branches(self, target, overwrite,
1546
_override_hook_source_branch=None):
1547
"""Push from self into target, and into target's master if any.
1549
This is on the base BzrBranch class even though it doesn't support
1550
bound branches because the *target* might be bound.
1553
if _override_hook_source_branch:
1554
result.source_branch = _override_hook_source_branch
1555
for hook in Branch.hooks['post_push']:
1558
bound_location = target.get_bound_location()
1559
if bound_location and target.base != bound_location:
1560
# there is a master branch.
1562
# XXX: Why the second check? Is it even supported for a branch to
1563
# be bound to itself? -- mbp 20070507
1564
master_branch = target.get_master_branch()
1565
master_branch.lock_write()
1567
# push into the master from this branch.
1568
self._basic_push(master_branch, overwrite, stop_revision)
1569
# and push into the target branch from this. Note that we push from
1570
# this branch again, because its considered the highest bandwidth
1572
result = self._basic_push(target, overwrite, stop_revision)
1573
result.master_branch = master_branch
1574
result.local_branch = target
1578
master_branch.unlock()
1581
result = self._basic_push(target, overwrite, stop_revision)
1582
# TODO: Why set master_branch and local_branch if there's no
1583
# binding? Maybe cleaner to just leave them unset? -- mbp
1585
result.master_branch = target
1586
result.local_branch = None
1590
def _basic_push(self, target, overwrite, stop_revision):
1591
"""Basic implementation of push without bound branches or hooks.
1593
Must be called with self read locked and target write locked.
1595
result = PushResult()
1596
result.source_branch = self
1597
result.target_branch = target
1598
result.old_revno, result.old_revid = target.last_revision_info()
1600
target.update_revisions(self, stop_revision)
1601
except DivergedBranches:
1605
target.set_revision_history(self.revision_history())
1606
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1607
result.new_revno, result.new_revid = target.last_revision_info()
1610
def get_parent(self):
1611
"""See Branch.get_parent."""
1613
assert self.base[-1] == '/'
1614
parent = self._get_parent_location()
1617
# This is an old-format absolute path to a local branch
1618
# turn it into a url
1619
if parent.startswith('/'):
1620
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1622
return urlutils.join(self.base[:-1], parent)
1623
except errors.InvalidURLJoin, e:
1624
raise errors.InaccessibleParent(parent, self.base)
1626
def set_push_location(self, location):
1627
"""See Branch.set_push_location."""
1628
self.get_config().set_user_option(
1629
'push_location', location,
1630
store=_mod_config.STORE_LOCATION_NORECURSE)
1633
def set_parent(self, url):
1634
"""See Branch.set_parent."""
1635
# TODO: Maybe delete old location files?
1636
# URLs should never be unicode, even on the local fs,
1637
# FIXUP this and get_parent in a future branch format bump:
1638
# read and rewrite the file, and have the new format code read
1639
# using .get not .get_utf8. RBC 20060125
1641
if isinstance(url, unicode):
1643
url = url.encode('ascii')
1644
except UnicodeEncodeError:
1645
raise errors.InvalidURL(url,
1646
"Urls must be 7-bit ascii, "
1647
"use bzrlib.urlutils.escape")
1648
url = urlutils.relative_url(self.base, url)
1649
self._set_parent_location(url)
1651
def _set_parent_location(self, url):
1653
self.control_files._transport.delete('parent')
1655
assert isinstance(url, str)
1656
self.control_files.put_bytes('parent', url + '\n')
1659
class BzrBranch5(BzrBranch):
1660
"""A format 5 branch. This supports new features over plain branches.
1662
It has support for a master_branch which is the data for bound branches.
1670
super(BzrBranch5, self).__init__(_format=_format,
1671
_control_files=_control_files,
1673
_repository=_repository)
1676
def pull(self, source, overwrite=False, stop_revision=None,
1677
run_hooks=True, possible_transports=None):
1678
"""Pull from source into self, updating my master if any.
1680
:param run_hooks: Private parameter - if false, this branch
1681
is being called because it's the master of the primary branch,
1682
so it should not run its hooks.
1684
bound_location = self.get_bound_location()
1685
master_branch = None
1686
if bound_location and source.base != bound_location:
1687
# not pulling from master, so we need to update master.
1688
master_branch = self.get_master_branch(possible_transports)
1689
master_branch.lock_write()
1692
# pull from source into master.
1693
master_branch.pull(source, overwrite, stop_revision,
1695
return super(BzrBranch5, self).pull(source, overwrite,
1696
stop_revision, _hook_master=master_branch,
1697
run_hooks=run_hooks)
1700
master_branch.unlock()
1702
def get_bound_location(self):
1704
return self.control_files.get_utf8('bound').read()[:-1]
1705
except errors.NoSuchFile:
1709
def get_master_branch(self, possible_transports=None):
1710
"""Return the branch we are bound to.
1712
:return: Either a Branch, or None
1714
This could memoise the branch, but if thats done
1715
it must be revalidated on each new lock.
1716
So for now we just don't memoise it.
1717
# RBC 20060304 review this decision.
1719
bound_loc = self.get_bound_location()
1723
return Branch.open(bound_loc,
1724
possible_transports=possible_transports)
1725
except (errors.NotBranchError, errors.ConnectionError), e:
1726
raise errors.BoundBranchConnectionFailure(
1730
def set_bound_location(self, location):
1731
"""Set the target where this branch is bound to.
1733
:param location: URL to the target branch
1736
self.control_files.put_utf8('bound', location+'\n')
1739
self.control_files._transport.delete('bound')
1031
if filename == head:
1038
def gen_file_id(name):
1039
"""Return new file id.
1041
This should probably generate proper UUIDs, but for the moment we
1042
cope with just randomness because running uuidgen every time is
1046
# get last component
1047
idx = name.rfind('/')
1049
name = name[idx+1 : ]
1050
idx = name.rfind('\\')
1052
name = name[idx+1 : ]
1054
# make it not a hidden file
1055
name = name.lstrip('.')
1057
# remove any wierd characters; we don't escape them but rather
1058
# just pull them out
1059
name = re.sub(r'[^\w.]', '', name)
1061
s = hexlify(rand_bytes(8))
1062
return '-'.join((name, compact_date(time.time()), s))
1745
def bind(self, other):
1746
"""Bind this branch to the branch other.
1748
This does not push or pull data between the branches, though it does
1749
check for divergence to raise an error when the branches are not
1750
either the same, or one a prefix of the other. That behaviour may not
1751
be useful, so that check may be removed in future.
1753
:param other: The branch to bind to
1756
# TODO: jam 20051230 Consider checking if the target is bound
1757
# It is debatable whether you should be able to bind to
1758
# a branch which is itself bound.
1759
# Committing is obviously forbidden,
1760
# but binding itself may not be.
1761
# Since we *have* to check at commit time, we don't
1762
# *need* to check here
1764
# we want to raise diverged if:
1765
# last_rev is not in the other_last_rev history, AND
1766
# other_last_rev is not in our history, and do it without pulling
1768
last_rev = _mod_revision.ensure_null(self.last_revision())
1769
if last_rev != _mod_revision.NULL_REVISION:
1772
other_last_rev = other.last_revision()
1773
if not _mod_revision.is_null(other_last_rev):
1774
# neither branch is new, we have to do some work to
1775
# ascertain diversion.
1776
remote_graph = other.repository.get_revision_graph(
1778
local_graph = self.repository.get_revision_graph(last_rev)
1779
if (last_rev not in remote_graph and
1780
other_last_rev not in local_graph):
1781
raise errors.DivergedBranches(self, other)
1784
self.set_bound_location(other.base)
1788
"""If bound, unbind"""
1789
return self.set_bound_location(None)
1792
def update(self, possible_transports=None):
1793
"""Synchronise this branch with the master branch if any.
1795
:return: None or the last_revision that was pivoted out during the
1798
master = self.get_master_branch(possible_transports)
1799
if master is not None:
1800
old_tip = _mod_revision.ensure_null(self.last_revision())
1801
self.pull(master, overwrite=True)
1802
if self.repository.get_graph().is_ancestor(old_tip,
1803
_mod_revision.ensure_null(self.last_revision())):
1809
class BzrBranchExperimental(BzrBranch5):
1810
"""Bzr experimental branch format
1813
- a revision-history file.
1815
- a lock dir guarding the branch itself
1816
- all of this stored in a branch/ subdirectory
1817
- works with shared repositories.
1818
- a tag dictionary in the branch
1820
This format is new in bzr 0.15, but shouldn't be used for real data,
1823
This class acts as it's own BranchFormat.
1826
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1829
def get_format_string(cls):
1830
"""See BranchFormat.get_format_string()."""
1831
return "Bazaar-NG branch format experimental\n"
1834
def get_format_description(cls):
1835
"""See BranchFormat.get_format_description()."""
1836
return "Experimental branch format"
1839
def get_reference(cls, a_bzrdir):
1840
"""Get the target reference of the branch in a_bzrdir.
1842
format probing must have been completed before calling
1843
this method - it is assumed that the format of the branch
1844
in a_bzrdir is correct.
1846
:param a_bzrdir: The bzrdir to get the branch data from.
1847
:return: None if the branch is not a reference branch.
1852
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1854
branch_transport = a_bzrdir.get_branch_transport(cls)
1855
control_files = lockable_files.LockableFiles(branch_transport,
1856
lock_filename, lock_class)
1857
control_files.create_lock()
1858
control_files.lock_write()
1860
for filename, content in utf8_files:
1861
control_files.put_utf8(filename, content)
1863
control_files.unlock()
1866
def initialize(cls, a_bzrdir):
1867
"""Create a branch of this format in a_bzrdir."""
1868
utf8_files = [('format', cls.get_format_string()),
1869
('revision-history', ''),
1870
('branch-name', ''),
1873
cls._initialize_control_files(a_bzrdir, utf8_files,
1874
'lock', lockdir.LockDir)
1875
return cls.open(a_bzrdir, _found=True)
1878
def open(cls, a_bzrdir, _found=False):
1879
"""Return the branch object for a_bzrdir
1881
_found is a private parameter, do not use it. It is used to indicate
1882
if format probing has already be done.
1885
format = BranchFormat.find_format(a_bzrdir)
1886
assert format.__class__ == cls
1887
transport = a_bzrdir.get_branch_transport(None)
1888
control_files = lockable_files.LockableFiles(transport, 'lock',
1890
return cls(_format=cls,
1891
_control_files=control_files,
1893
_repository=a_bzrdir.find_repository())
1896
def is_supported(cls):
1899
def _make_tags(self):
1900
return BasicTags(self)
1903
def supports_tags(cls):
1907
BranchFormat.register_format(BzrBranchExperimental)
1910
class BzrBranch6(BzrBranch5):
1913
def last_revision_info(self):
1914
revision_string = self.control_files.get('last-revision').read()
1915
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1916
revision_id = cache_utf8.get_cached_utf8(revision_id)
1918
return revno, revision_id
1920
def last_revision(self):
1921
"""Return last revision id, or None"""
1922
revision_id = self.last_revision_info()[1]
1925
def _write_last_revision_info(self, revno, revision_id):
1926
"""Simply write out the revision id, with no checks.
1928
Use set_last_revision_info to perform this safely.
1930
Does not update the revision_history cache.
1931
Intended to be called by set_last_revision_info and
1932
_write_revision_history.
1934
if revision_id is None:
1935
revision_id = 'null:'
1936
out_string = '%d %s\n' % (revno, revision_id)
1937
self.control_files.put_bytes('last-revision', out_string)
1940
def set_last_revision_info(self, revno, revision_id):
1941
if self._get_append_revisions_only():
1942
self._check_history_violation(revision_id)
1943
self._write_last_revision_info(revno, revision_id)
1944
self._clear_cached_state()
1946
def _check_history_violation(self, revision_id):
1947
last_revision = _mod_revision.ensure_null(self.last_revision())
1948
if _mod_revision.is_null(last_revision):
1950
if last_revision not in self._lefthand_history(revision_id):
1951
raise errors.AppendRevisionsOnlyViolation(self.base)
1953
def _gen_revision_history(self):
1954
"""Generate the revision history from last revision
1956
history = list(self.repository.iter_reverse_revision_history(
1957
self.last_revision()))
1961
def _write_revision_history(self, history):
1962
"""Factored out of set_revision_history.
1964
This performs the actual writing to disk, with format-specific checks.
1965
It is intended to be called by BzrBranch5.set_revision_history.
1967
if len(history) == 0:
1968
last_revision = 'null:'
1970
if history != self._lefthand_history(history[-1]):
1971
raise errors.NotLefthandHistory(history)
1972
last_revision = history[-1]
1973
if self._get_append_revisions_only():
1974
self._check_history_violation(last_revision)
1975
self._write_last_revision_info(len(history), last_revision)
1978
def _set_parent_location(self, url):
1979
"""Set the parent branch"""
1980
self._set_config_location('parent_location', url, make_relative=True)
1983
def _get_parent_location(self):
1984
"""Set the parent branch"""
1985
return self._get_config_location('parent_location')
1987
def set_push_location(self, location):
1988
"""See Branch.set_push_location."""
1989
self._set_config_location('push_location', location)
1991
def set_bound_location(self, location):
1992
"""See Branch.set_push_location."""
1994
config = self.get_config()
1995
if location is None:
1996
if config.get_user_option('bound') != 'True':
1999
config.set_user_option('bound', 'False', warn_masked=True)
2002
self._set_config_location('bound_location', location,
2004
config.set_user_option('bound', 'True', warn_masked=True)
2007
def _get_bound_location(self, bound):
2008
"""Return the bound location in the config file.
2010
Return None if the bound parameter does not match"""
2011
config = self.get_config()
2012
config_bound = (config.get_user_option('bound') == 'True')
2013
if config_bound != bound:
2015
return self._get_config_location('bound_location', config=config)
2017
def get_bound_location(self):
2018
"""See Branch.set_push_location."""
2019
return self._get_bound_location(True)
2021
def get_old_bound_location(self):
2022
"""See Branch.get_old_bound_location"""
2023
return self._get_bound_location(False)
2025
def set_append_revisions_only(self, enabled):
2030
self.get_config().set_user_option('append_revisions_only', value,
2033
def _get_append_revisions_only(self):
2034
value = self.get_config().get_user_option('append_revisions_only')
2035
return value == 'True'
2037
def _synchronize_history(self, destination, revision_id):
2038
"""Synchronize last revision and revision history between branches.
2040
This version is most efficient when the destination is also a
2041
BzrBranch6, but works for BzrBranch5, as long as the destination's
2042
repository contains all the lefthand ancestors of the intended
2043
last_revision. If not, set_last_revision_info will fail.
2045
:param destination: The branch to copy the history into
2046
:param revision_id: The revision-id to truncate history at. May
2047
be None to copy complete history.
2049
source_revno, source_revision_id = self.last_revision_info()
2050
if revision_id is None:
2051
revno, revision_id = source_revno, source_revision_id
2052
elif source_revision_id == revision_id:
2053
# we know the revno without needing to walk all of history
2054
revno = source_revno
2056
# To figure out the revno for a random revision, we need to build
2057
# the revision history, and count its length.
2058
# We don't care about the order, just how long it is.
2059
# Alternatively, we could start at the current location, and count
2060
# backwards. But there is no guarantee that we will find it since
2061
# it may be a merged revision.
2062
revno = len(list(self.repository.iter_reverse_revision_history(
2064
destination.set_last_revision_info(revno, revision_id)
2066
def _make_tags(self):
2067
return BasicTags(self)
2070
######################################################################
2071
# results of operations
2074
class _Result(object):
2076
def _show_tag_conficts(self, to_file):
2077
if not getattr(self, 'tag_conflicts', None):
2079
to_file.write('Conflicting tags:\n')
2080
for name, value1, value2 in self.tag_conflicts:
2081
to_file.write(' %s\n' % (name, ))
2084
class PullResult(_Result):
2085
"""Result of a Branch.pull operation.
2087
:ivar old_revno: Revision number before pull.
2088
:ivar new_revno: Revision number after pull.
2089
:ivar old_revid: Tip revision id before pull.
2090
:ivar new_revid: Tip revision id after pull.
2091
:ivar source_branch: Source (local) branch object.
2092
:ivar master_branch: Master branch of the target, or None.
2093
:ivar target_branch: Target/destination branch object.
2097
# DEPRECATED: pull used to return the change in revno
2098
return self.new_revno - self.old_revno
2100
def report(self, to_file):
2101
if self.old_revid == self.new_revid:
2102
to_file.write('No revisions to pull.\n')
2104
to_file.write('Now on revision %d.\n' % self.new_revno)
2105
self._show_tag_conficts(to_file)
2108
class PushResult(_Result):
2109
"""Result of a Branch.push operation.
2111
:ivar old_revno: Revision number before push.
2112
:ivar new_revno: Revision number after push.
2113
:ivar old_revid: Tip revision id before push.
2114
:ivar new_revid: Tip revision id after push.
2115
:ivar source_branch: Source branch object.
2116
:ivar master_branch: Master branch of the target, or None.
2117
:ivar target_branch: Target/destination branch object.
2121
# DEPRECATED: push used to return the change in revno
2122
return self.new_revno - self.old_revno
2124
def report(self, to_file):
2125
"""Write a human-readable description of the result."""
2126
if self.old_revid == self.new_revid:
2127
to_file.write('No new revisions to push.\n')
2129
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2130
self._show_tag_conficts(to_file)
2133
class BranchCheckResult(object):
2134
"""Results of checking branch consistency.
2139
def __init__(self, branch):
2140
self.branch = branch
2142
def report_results(self, verbose):
2143
"""Report the check results via trace.note.
2145
:param verbose: Requests more detailed display of what was checked,
2148
note('checked branch %s format %s',
2150
self.branch._format)
2153
class Converter5to6(object):
2154
"""Perform an in-place upgrade of format 5 to format 6"""
2156
def convert(self, branch):
2157
# Data for 5 and 6 can peacefully coexist.
2158
format = BzrBranchFormat6()
2159
new_branch = format.open(branch.bzrdir, _found=True)
2161
# Copy source data into target
2162
new_branch.set_last_revision_info(*branch.last_revision_info())
2163
new_branch.set_parent(branch.get_parent())
2164
new_branch.set_bound_location(branch.get_bound_location())
2165
new_branch.set_push_location(branch.get_push_location())
2167
# New branch has no tags by default
2168
new_branch.tags._set_tag_dict({})
2170
# Copying done; now update target format
2171
new_branch.control_files.put_utf8('format',
2172
format.get_format_string())
2174
# Clean up old files
2175
new_branch.control_files._transport.delete('revision-history')
2177
branch.set_parent(None)
2180
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
