74
133
"""Branch holding a history of revisions.
77
Base directory/url of the branch.
136
Base directory of the branch.
142
If _lock_mode is true, a positive count of the number of times the
146
Lock object from bzrlib.lock.
79
# this is really an instance variable - FIXME move it there
83
def __init__(self, *ignored, **ignored_too):
84
raise NotImplementedError('The Branch class is abstract')
87
"""Break a lock if one is present from another instance.
89
Uses the ui factory to ask for confirmation if the lock may be from
92
This will probe the repository for its lock as well.
94
self.control_files.break_lock()
95
self.repository.break_lock()
96
master = self.get_master_branch()
97
if master is not None:
101
@deprecated_method(zero_eight)
102
def open_downlevel(base):
103
"""Open a branch which may be of an old format."""
104
return Branch.open(base, _unsupported=True)
107
def open(base, _unsupported=False):
108
"""Open the branch rooted at base.
110
For instance, if the branch is at URL/.bzr/branch,
111
Branch.open(URL) -> a Branch instance.
113
control = bzrdir.BzrDir.open(base, _unsupported)
114
return control.open_branch(_unsupported)
117
def open_containing(url):
118
"""Open an existing branch which contains url.
120
This probes for a branch at url, and searches upwards from there.
122
Basically we keep looking up until we find the control directory or
123
run into the root. If there isn't one, raises NotBranchError.
124
If there is one and it is either an unrecognised format or an unsupported
125
format, UnknownFormatError or UnsupportedFormatError are raised.
126
If there is one, it is returned, along with the unused portion of url.
128
control, relpath = bzrdir.BzrDir.open_containing(url)
129
return control.open_branch(), relpath
132
@deprecated_function(zero_eight)
133
def initialize(base):
134
"""Create a new working tree and branch, rooted at 'base' (url)
136
NOTE: This will soon be deprecated in favour of creation
139
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
141
@deprecated_function(zero_eight)
142
def setup_caching(self, cache_root):
143
"""Subclasses that care about caching should override this, and set
144
up cached stores located under cache_root.
146
NOTE: This is unused.
150
def get_config(self):
151
return bzrlib.config.BranchConfig(self)
154
return self.get_config().get_nickname()
156
def _set_nick(self, nick):
157
self.get_config().set_user_option('nickname', nick)
159
nick = property(_get_nick, _set_nick)
162
raise NotImplementedError(self.is_locked)
153
def __init__(self, base, init=False, find_root=True):
154
"""Create new branch object at a particular location.
156
base -- Base directory for the branch.
158
init -- If True, create new control files in a previously
159
unversioned directory. If False, the branch must already
162
find_root -- If true and init is false, find the root of the
163
existing branch containing base.
165
In the test suite, creation of new trees is tested using the
166
`ScratchBranch` class.
168
from bzrlib.store import ImmutableStore
170
self.base = os.path.realpath(base)
173
self.base = find_branch_root(base)
175
self.base = os.path.realpath(base)
176
if not isdir(self.controlfilename('.')):
177
from errors import NotBranchError
178
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
179
['use "bzr init" to initialize a new working tree',
180
'current bzr can only operate from top-of-tree'])
183
self.text_store = ImmutableStore(self.controlfilename('text-store'))
184
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
185
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
189
return '%s(%r)' % (self.__class__.__name__, self.base)
196
if self._lock_mode or self._lock:
197
from warnings import warn
198
warn("branch %r was not explicitly unlocked" % self)
164
203
def lock_write(self):
165
raise NotImplementedError(self.lock_write)
205
if self._lock_mode != 'w':
206
from errors import LockError
207
raise LockError("can't upgrade to a write lock from %r" %
209
self._lock_count += 1
211
from bzrlib.lock import WriteLock
213
self._lock = WriteLock(self.controlfilename('branch-lock'))
214
self._lock_mode = 'w'
167
219
def lock_read(self):
168
raise NotImplementedError(self.lock_read)
221
assert self._lock_mode in ('r', 'w'), \
222
"invalid lock mode %r" % self._lock_mode
223
self._lock_count += 1
225
from bzrlib.lock import ReadLock
227
self._lock = ReadLock(self.controlfilename('branch-lock'))
228
self._lock_mode = 'r'
170
233
def unlock(self):
171
raise NotImplementedError(self.unlock)
173
def peek_lock_mode(self):
174
"""Return lock mode for the Branch: 'r', 'w' or None"""
175
raise NotImplementedError(self.peek_lock_mode)
177
def get_physical_lock_status(self):
178
raise NotImplementedError(self.get_physical_lock_status)
234
if not self._lock_mode:
235
from errors import LockError
236
raise LockError('branch %r is not locked' % (self))
238
if self._lock_count > 1:
239
self._lock_count -= 1
243
self._lock_mode = self._lock_count = None
180
246
def abspath(self, name):
181
"""Return absolute filename for something in the branch
183
XXX: Robert Collins 20051017 what is this used for? why is it a branch
184
method and not a tree method.
186
raise NotImplementedError(self.abspath)
188
def bind(self, other):
189
"""Bind the local branch the other branch.
191
:param other: The branch to bind to
194
raise errors.UpgradeRequired(self.base)
197
def fetch(self, from_branch, last_revision=None, pb=None):
198
"""Copy revisions from from_branch into this branch.
200
:param from_branch: Where to copy from.
201
:param last_revision: What revision to stop at (None for at the end
203
:param pb: An optional progress bar to use.
205
Returns the copied revision count and the failed revisions in a tuple:
208
if self.base == from_branch.base:
211
nested_pb = ui.ui_factory.nested_progress_bar()
216
from_branch.lock_read()
218
if last_revision is None:
219
pb.update('get source history')
220
from_history = from_branch.revision_history()
222
last_revision = from_history[-1]
224
# no history in the source branch
225
last_revision = revision.NULL_REVISION
226
return self.repository.fetch(from_branch.repository,
227
revision_id=last_revision,
230
if nested_pb is not None:
234
def get_bound_location(self):
235
"""Return the URL of the branch we are bound to.
237
Older format branches cannot bind, please be sure to use a metadir
242
def get_commit_builder(self, parents, config=None, timestamp=None,
243
timezone=None, committer=None, revprops=None,
245
"""Obtain a CommitBuilder for this branch.
247
:param parents: Revision ids of the parents of the new revision.
248
:param config: Optional configuration to use.
249
:param timestamp: Optional timestamp recorded for commit.
250
:param timezone: Optional timezone for timestamp.
251
:param committer: Optional committer to set for commit.
252
:param revprops: Optional dictionary of revision properties.
253
:param revision_id: Optional revision id.
257
config = self.get_config()
259
return self.repository.get_commit_builder(self, parents, config,
260
timestamp, timezone, committer, revprops, revision_id)
262
def get_master_branch(self):
263
"""Return the branch we are bound to.
265
:return: Either a Branch, or None
269
def get_revision_delta(self, revno):
270
"""Return the delta for one revision.
272
The delta is relative to its mainline predecessor, or the
273
empty tree for revision 1.
275
assert isinstance(revno, int)
247
"""Return absolute filename for something in the branch"""
248
return os.path.join(self.base, name)
251
def relpath(self, path):
252
"""Return path relative to this branch of something inside it.
254
Raises an error if path is not in this branch."""
255
return _relpath(self.base, path)
258
def controlfilename(self, file_or_path):
259
"""Return location relative to branch."""
260
if isinstance(file_or_path, basestring):
261
file_or_path = [file_or_path]
262
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
265
def controlfile(self, file_or_path, mode='r'):
266
"""Open a control file for this branch.
268
There are two classes of file in the control directory: text
269
and binary. binary files are untranslated byte streams. Text
270
control files are stored with Unix newlines and in UTF-8, even
271
if the platform or locale defaults are different.
273
Controlfiles should almost never be opened in write mode but
274
rather should be atomically copied and replaced using atomicfile.
277
fn = self.controlfilename(file_or_path)
279
if mode == 'rb' or mode == 'wb':
280
return file(fn, mode)
281
elif mode == 'r' or mode == 'w':
282
# open in binary mode anyhow so there's no newline translation;
283
# codecs uses line buffering by default; don't want that.
285
return codecs.open(fn, mode + 'b', 'utf-8',
288
raise BzrError("invalid controlfile mode %r" % mode)
292
def _make_control(self):
293
from bzrlib.inventory import Inventory
294
from bzrlib.xml import pack_xml
296
os.mkdir(self.controlfilename([]))
297
self.controlfile('README', 'w').write(
298
"This is a Bazaar-NG control directory.\n"
299
"Do not change any files in this directory.\n")
300
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
301
for d in ('text-store', 'inventory-store', 'revision-store'):
302
os.mkdir(self.controlfilename(d))
303
for f in ('revision-history', 'merged-patches',
304
'pending-merged-patches', 'branch-name',
307
self.controlfile(f, 'w').write('')
308
mutter('created control directory in ' + self.base)
310
pack_xml(Inventory(), self.controlfile('inventory','w'))
313
def _check_format(self):
314
"""Check this branch format is supported.
316
The current tool only supports the current unstable format.
318
In the future, we might need different in-memory Branch
319
classes to support downlevel branches. But not yet.
321
# This ignores newlines so that we can open branches created
322
# on Windows from Linux and so on. I think it might be better
323
# to always make all internal files in unix format.
324
fmt = self.controlfile('branch-format', 'r').read()
325
fmt.replace('\r\n', '')
326
if fmt != BZR_BRANCH_FORMAT:
327
raise BzrError('sorry, branch format %r not supported' % fmt,
328
['use a different bzr version',
329
'or remove the .bzr directory and "bzr init" again'])
333
def read_working_inventory(self):
334
"""Read the working inventory."""
335
from bzrlib.inventory import Inventory
336
from bzrlib.xml import unpack_xml
337
from time import time
341
# ElementTree does its own conversion from UTF-8, so open in
343
inv = unpack_xml(Inventory,
344
self.controlfile('inventory', 'rb'))
345
mutter("loaded inventory of %d items in %f"
346
% (len(inv), time() - before))
352
def _write_inventory(self, inv):
353
"""Update the working inventory.
355
That is to say, the inventory describing changes underway, that
356
will be committed to the next revision.
358
from bzrlib.atomicfile import AtomicFile
359
from bzrlib.xml import pack_xml
363
f = AtomicFile(self.controlfilename('inventory'), 'wb')
372
mutter('wrote working inventory')
375
inventory = property(read_working_inventory, _write_inventory, None,
376
"""Inventory for the working copy.""")
379
def add(self, files, verbose=False, ids=None):
380
"""Make files versioned.
382
Note that the command line normally calls smart_add instead.
384
This puts the files in the Added state, so that they will be
385
recorded by the next commit.
388
List of paths to add, relative to the base of the tree.
391
If set, use these instead of automatically generated ids.
392
Must be the same length as the list of files, but may
393
contain None for ids that are to be autogenerated.
395
TODO: Perhaps have an option to add the ids even if the files do
398
TODO: Perhaps return the ids of the files? But then again it
399
is easy to retrieve them if they're needed.
401
TODO: Adding a directory should optionally recurse down and
402
add all non-ignored children. Perhaps do that in a
405
from bzrlib.textui import show_status
406
# TODO: Re-adding a file that is removed in the working copy
407
# should probably put it back with the previous ID.
408
if isinstance(files, basestring):
409
assert(ids is None or isinstance(ids, basestring))
415
ids = [None] * len(files)
417
assert(len(ids) == len(files))
421
inv = self.read_working_inventory()
422
for f,file_id in zip(files, ids):
423
if is_control_file(f):
424
raise BzrError("cannot add control file %s" % quotefn(f))
429
raise BzrError("cannot add top-level %r" % f)
431
fullpath = os.path.normpath(self.abspath(f))
434
kind = file_kind(fullpath)
436
# maybe something better?
437
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
439
if kind != 'file' and kind != 'directory':
440
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
443
file_id = gen_file_id(f)
444
inv.add_path(f, kind=kind, file_id=file_id)
447
print 'added', quotefn(f)
449
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
451
self._write_inventory(inv)
456
def print_file(self, file, revno):
457
"""Print `file` to stdout."""
460
tree = self.revision_tree(self.lookup_revision(revno))
461
# use inventory as it was in that revision
462
file_id = tree.inventory.path2id(file)
464
raise BzrError("%r is not present in revision %d" % (file, revno))
465
tree.print_file(file_id)
470
def remove(self, files, verbose=False):
471
"""Mark nominated files for removal from the inventory.
473
This does not remove their text. This does not run on
475
TODO: Refuse to remove modified files unless --force is given?
477
TODO: Do something useful with directories.
479
TODO: Should this remove the text or not? Tough call; not
480
removing may be useful and the user can just use use rm, and
481
is the opposite of add. Removing it is consistent with most
482
other tools. Maybe an option.
484
from bzrlib.textui import show_status
485
## TODO: Normalize names
486
## TODO: Remove nested loops; better scalability
487
if isinstance(files, basestring):
493
tree = self.working_tree()
496
# do this before any modifications
500
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
501
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
503
# having remove it, it must be either ignored or unknown
504
if tree.is_ignored(f):
508
show_status(new_status, inv[fid].kind, quotefn(f))
511
self._write_inventory(inv)
516
# FIXME: this doesn't need to be a branch method
517
def set_inventory(self, new_inventory_list):
518
from bzrlib.inventory import Inventory, InventoryEntry
520
for path, file_id, parent, kind in new_inventory_list:
521
name = os.path.basename(path)
524
inv.add(InventoryEntry(file_id, name, kind, parent))
525
self._write_inventory(inv)
529
"""Return all unknown files.
531
These are files in the working directory that are not versioned or
532
control files or ignored.
534
>>> b = ScratchBranch(files=['foo', 'foo~'])
535
>>> list(b.unknowns())
538
>>> list(b.unknowns())
541
>>> list(b.unknowns())
544
return self.working_tree().unknowns()
547
def append_revision(self, revision_id):
548
from bzrlib.atomicfile import AtomicFile
550
mutter("add {%s} to revision-history" % revision_id)
551
rev_history = self.revision_history() + [revision_id]
553
f = AtomicFile(self.controlfilename('revision-history'))
555
for rev_id in rev_history:
562
def get_revision(self, revision_id):
563
"""Return the Revision object for a named revision"""
564
from bzrlib.revision import Revision
565
from bzrlib.xml import unpack_xml
569
if not revision_id or not isinstance(revision_id, basestring):
570
raise ValueError('invalid revision-id: %r' % revision_id)
571
r = unpack_xml(Revision, self.revision_store[revision_id])
575
assert r.revision_id == revision_id
579
def get_revision_sha1(self, revision_id):
580
"""Hash the stored value of a revision, and return it."""
581
# In the future, revision entries will be signed. At that
582
# point, it is probably best *not* to include the signature
583
# in the revision hash. Because that lets you re-sign
584
# the revision, (add signatures/remove signatures) and still
585
# have all hash pointers stay consistent.
586
# But for now, just hash the contents.
587
return sha_file(self.revision_store[revision_id])
590
def get_inventory(self, inventory_id):
591
"""Get Inventory object by hash.
593
TODO: Perhaps for this and similar methods, take a revision
594
parameter which can be either an integer revno or a
596
from bzrlib.inventory import Inventory
597
from bzrlib.xml import unpack_xml
599
return unpack_xml(Inventory, self.inventory_store[inventory_id])
602
def get_inventory_sha1(self, inventory_id):
603
"""Return the sha1 hash of the inventory entry
605
return sha_file(self.inventory_store[inventory_id])
608
def get_revision_inventory(self, revision_id):
609
"""Return inventory of a past revision."""
610
if revision_id == None:
611
from bzrlib.inventory import Inventory
614
return self.get_inventory(self.get_revision(revision_id).inventory_id)
617
def revision_history(self):
618
"""Return sequence of revision hashes on to this branch.
620
>>> ScratchBranch().revision_history()
625
return [l.rstrip('\r\n') for l in
626
self.controlfile('revision-history', 'r').readlines()]
631
def common_ancestor(self, other, self_revno=None, other_revno=None):
634
>>> sb = ScratchBranch(files=['foo', 'foo~'])
635
>>> sb.common_ancestor(sb) == (None, None)
637
>>> commit.commit(sb, "Committing first revision", verbose=False)
638
>>> sb.common_ancestor(sb)[0]
640
>>> clone = sb.clone()
641
>>> commit.commit(sb, "Committing second revision", verbose=False)
642
>>> sb.common_ancestor(sb)[0]
644
>>> sb.common_ancestor(clone)[0]
646
>>> commit.commit(clone, "Committing divergent second revision",
648
>>> sb.common_ancestor(clone)[0]
650
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
652
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
654
>>> clone2 = sb.clone()
655
>>> sb.common_ancestor(clone2)[0]
657
>>> sb.common_ancestor(clone2, self_revno=1)[0]
659
>>> sb.common_ancestor(clone2, other_revno=1)[0]
662
my_history = self.revision_history()
663
other_history = other.revision_history()
664
if self_revno is None:
665
self_revno = len(my_history)
666
if other_revno is None:
667
other_revno = len(other_history)
668
indices = range(min((self_revno, other_revno)))
671
if my_history[r] == other_history[r]:
672
return r+1, my_history[r]
675
def enum_history(self, direction):
676
"""Return (revno, revision_id) for history of branch.
679
'forward' is from earliest to latest
680
'reverse' is from latest to earliest
276
682
rh = self.revision_history()
277
if not (1 <= revno <= len(rh)):
278
raise InvalidRevisionNumber(revno)
279
return self.repository.get_revision_delta(rh[revno-1])
281
def get_root_id(self):
282
"""Return the id of this branches root"""
283
raise NotImplementedError(self.get_root_id)
285
def print_file(self, file, revision_id):
286
"""Print `file` to stdout."""
287
raise NotImplementedError(self.print_file)
289
def append_revision(self, *revision_ids):
290
raise NotImplementedError(self.append_revision)
292
def set_revision_history(self, rev_history):
293
raise NotImplementedError(self.set_revision_history)
295
def revision_history(self):
296
"""Return sequence of revision hashes on to this branch."""
297
raise NotImplementedError(self.revision_history)
683
if direction == 'forward':
688
elif direction == 'reverse':
694
raise ValueError('invalid history direction', direction)
300
698
"""Return current revision number for this branch.
393
943
Note that to_name is only the last component of the new name;
394
944
this doesn't change the directory.
396
This returns a list of (from_path, to_path) pairs for each
399
raise NotImplementedError(self.move)
401
def get_parent(self):
402
"""Return the parent location of the branch.
404
This is the default location for push/pull/missing. The usual
405
pattern is that the user can override it by specifying a
408
raise NotImplementedError(self.get_parent)
410
def get_submit_branch(self):
411
"""Return the submit location of the branch.
413
This is the default location for bundle. The usual
414
pattern is that the user can override it by specifying a
417
return self.get_config().get_user_option('submit_branch')
419
def set_submit_branch(self, location):
420
"""Return the submit location of the branch.
422
This is the default location for bundle. The usual
423
pattern is that the user can override it by specifying a
426
self.get_config().set_user_option('submit_branch', location)
428
def get_push_location(self):
429
"""Return the None or the location to push this branch to."""
430
raise NotImplementedError(self.get_push_location)
432
def set_push_location(self, location):
433
"""Set a new push location for this branch."""
434
raise NotImplementedError(self.set_push_location)
436
def set_parent(self, url):
437
raise NotImplementedError(self.set_parent)
441
"""Synchronise this branch with the master branch if any.
443
:return: None or the last_revision pivoted out during the update.
447
def check_revno(self, revno):
449
Check whether a revno corresponds to any revision.
450
Zero (the NULL revision) is considered valid.
453
self.check_real_revno(revno)
455
def check_real_revno(self, revno):
457
Check whether a revno corresponds to a real revision.
458
Zero (the NULL revision) is considered invalid
460
if revno < 1 or revno > self.revno():
461
raise InvalidRevisionNumber(revno)
464
def clone(self, *args, **kwargs):
465
"""Clone this branch into to_bzrdir preserving all semantic values.
467
revision_id: if not None, the revision history in the new branch will
468
be truncated to end with revision_id.
470
# for API compatibility, until 0.8 releases we provide the old api:
471
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
472
# after 0.8 releases, the *args and **kwargs should be changed:
473
# def clone(self, to_bzrdir, revision_id=None):
474
if (kwargs.get('to_location', None) or
475
kwargs.get('revision', None) or
476
kwargs.get('basis_branch', None) or
477
(len(args) and isinstance(args[0], basestring))):
478
# backwards compatibility api:
479
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
480
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
483
basis_branch = args[2]
485
basis_branch = kwargs.get('basis_branch', None)
487
basis = basis_branch.bzrdir
492
revision_id = args[1]
494
revision_id = kwargs.get('revision', None)
499
# no default to raise if not provided.
500
url = kwargs.get('to_location')
501
return self.bzrdir.clone(url,
502
revision_id=revision_id,
503
basis=basis).open_branch()
505
# generate args by hand
507
revision_id = args[1]
509
revision_id = kwargs.get('revision_id', None)
513
# no default to raise if not provided.
514
to_bzrdir = kwargs.get('to_bzrdir')
515
result = self._format.initialize(to_bzrdir)
516
self.copy_content_into(result, revision_id=revision_id)
520
def sprout(self, to_bzrdir, revision_id=None):
521
"""Create a new line of development from the branch, into to_bzrdir.
523
revision_id: if not None, the revision history in the new branch will
524
be truncated to end with revision_id.
526
result = self._format.initialize(to_bzrdir)
527
self.copy_content_into(result, revision_id=revision_id)
528
result.set_parent(self.bzrdir.root_transport.base)
532
def copy_content_into(self, destination, revision_id=None):
533
"""Copy the content of self into destination.
535
revision_id: if not None, the revision history in the new branch will
536
be truncated to end with revision_id.
538
new_history = self.revision_history()
539
if revision_id is not None:
541
new_history = new_history[:new_history.index(revision_id) + 1]
543
rev = self.repository.get_revision(revision_id)
544
new_history = rev.get_history(self.repository)[1:]
545
destination.set_revision_history(new_history)
547
parent = self.get_parent()
548
except errors.InaccessibleParent, e:
549
mutter('parent was not accessible to copy: %s', e)
552
destination.set_parent(parent)
556
"""Check consistency of the branch.
558
In particular this checks that revisions given in the revision-history
559
do actually match up in the revision graph, and that they're all
560
present in the repository.
562
Callers will typically also want to check the repository.
564
:return: A BranchCheckResult.
566
mainline_parent_id = None
567
for revision_id in self.revision_history():
569
revision = self.repository.get_revision(revision_id)
570
except errors.NoSuchRevision, e:
571
raise errors.BzrCheckError("mainline revision {%s} not in repository"
573
# In general the first entry on the revision history has no parents.
574
# But it's not illegal for it to have parents listed; this can happen
575
# in imports from Arch when the parents weren't reachable.
576
if mainline_parent_id is not None:
577
if mainline_parent_id not in revision.parent_ids:
578
raise errors.BzrCheckError("previous revision {%s} not listed among "
580
% (mainline_parent_id, revision_id))
581
mainline_parent_id = revision_id
582
return BranchCheckResult(self)
584
def _get_checkout_format(self):
585
"""Return the most suitable metadir for a checkout of this branch.
586
Weaves are used if this branch's repostory uses weaves.
588
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
589
from bzrlib import repository
590
format = bzrdir.BzrDirMetaFormat1()
591
format.repository_format = repository.RepositoryFormat7()
593
format = self.repository.bzrdir.cloning_metadir()
596
def create_checkout(self, to_location, revision_id=None,
598
"""Create a checkout of a branch.
600
:param to_location: The url to produce the checkout at
601
:param revision_id: The revision to check out
602
:param lightweight: If True, produce a lightweight checkout, otherwise,
603
produce a bound branch (heavyweight checkout)
604
:return: The tree of the created checkout
606
t = transport.get_transport(to_location)
609
except errors.FileExists:
612
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
613
BranchReferenceFormat().initialize(checkout, self)
615
format = self._get_checkout_format()
616
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
617
to_location, force_new_tree=False, format=format)
618
checkout = checkout_branch.bzrdir
619
checkout_branch.bind(self)
620
# pull up to the specified revision_id to set the initial
621
# branch tip correctly, and seed it with history.
622
checkout_branch.pull(self, stop_revision=revision_id)
623
return checkout.create_workingtree(revision_id)
626
class BranchFormat(object):
627
"""An encapsulation of the initialization and open routines for a format.
629
Formats provide three things:
630
* An initialization routine,
634
Formats are placed in an dict by their format string for reference
635
during branch opening. Its not required that these be instances, they
636
can be classes themselves with class methods - it simply depends on
637
whether state is needed for a given format or not.
639
Once a format is deprecated, just deprecate the initialize and open
640
methods on the format class. Do not deprecate the object, as the
641
object will be created every time regardless.
644
_default_format = None
645
"""The default format used for new branches."""
648
"""The known formats."""
651
def find_format(klass, a_bzrdir):
652
"""Return the format for the branch object in a_bzrdir."""
654
transport = a_bzrdir.get_branch_transport(None)
655
format_string = transport.get("format").read()
656
return klass._formats[format_string]
658
raise NotBranchError(path=transport.base)
660
raise errors.UnknownFormatError(format=format_string)
663
def get_default_format(klass):
664
"""Return the current default format."""
665
return klass._default_format
667
def get_format_string(self):
668
"""Return the ASCII format string that identifies this format."""
669
raise NotImplementedError(self.get_format_string)
671
def get_format_description(self):
672
"""Return the short format description for this format."""
673
raise NotImplementedError(self.get_format_string)
675
def initialize(self, a_bzrdir):
676
"""Create a branch of this format in a_bzrdir."""
677
raise NotImplementedError(self.initialize)
679
def is_supported(self):
680
"""Is this format supported?
682
Supported formats can be initialized and opened.
683
Unsupported formats may not support initialization or committing or
684
some other features depending on the reason for not being supported.
688
def open(self, a_bzrdir, _found=False):
689
"""Return the branch object for a_bzrdir
691
_found is a private parameter, do not use it. It is used to indicate
692
if format probing has already be done.
694
raise NotImplementedError(self.open)
697
def register_format(klass, format):
698
klass._formats[format.get_format_string()] = format
701
def set_default_format(klass, format):
702
klass._default_format = format
705
def unregister_format(klass, format):
706
assert klass._formats[format.get_format_string()] is format
707
del klass._formats[format.get_format_string()]
710
return self.get_format_string().rstrip()
713
class BzrBranchFormat4(BranchFormat):
714
"""Bzr branch format 4.
717
- a revision-history file.
718
- a branch-lock lock file [ to be shared with the bzrdir ]
721
def get_format_description(self):
722
"""See BranchFormat.get_format_description()."""
723
return "Branch format 4"
725
def initialize(self, a_bzrdir):
726
"""Create a branch of this format in a_bzrdir."""
727
mutter('creating branch in %s', a_bzrdir.transport.base)
728
branch_transport = a_bzrdir.get_branch_transport(self)
729
utf8_files = [('revision-history', ''),
732
control_files = LockableFiles(branch_transport, 'branch-lock',
734
control_files.create_lock()
735
control_files.lock_write()
737
for file, content in utf8_files:
738
control_files.put_utf8(file, content)
740
control_files.unlock()
741
return self.open(a_bzrdir, _found=True)
744
super(BzrBranchFormat4, self).__init__()
745
self._matchingbzrdir = bzrdir.BzrDirFormat6()
747
def open(self, a_bzrdir, _found=False):
748
"""Return the branch object for a_bzrdir
750
_found is a private parameter, do not use it. It is used to indicate
751
if format probing has already be done.
754
# we are being called directly and must probe.
755
raise NotImplementedError
756
return BzrBranch(_format=self,
757
_control_files=a_bzrdir._control_files,
759
_repository=a_bzrdir.open_repository())
762
return "Bazaar-NG branch format 4"
765
class BzrBranchFormat5(BranchFormat):
766
"""Bzr branch format 5.
769
- a revision-history file.
771
- a lock dir guarding the branch itself
772
- all of this stored in a branch/ subdirectory
773
- works with shared repositories.
775
This format is new in bzr 0.8.
778
def get_format_string(self):
779
"""See BranchFormat.get_format_string()."""
780
return "Bazaar-NG branch format 5\n"
782
def get_format_description(self):
783
"""See BranchFormat.get_format_description()."""
784
return "Branch format 5"
786
def initialize(self, a_bzrdir):
787
"""Create a branch of this format in a_bzrdir."""
788
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
789
branch_transport = a_bzrdir.get_branch_transport(self)
790
utf8_files = [('revision-history', ''),
793
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
794
control_files.create_lock()
795
control_files.lock_write()
796
control_files.put_utf8('format', self.get_format_string())
798
for file, content in utf8_files:
799
control_files.put_utf8(file, content)
801
control_files.unlock()
802
return self.open(a_bzrdir, _found=True, )
805
super(BzrBranchFormat5, self).__init__()
806
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
808
def open(self, a_bzrdir, _found=False):
809
"""Return the branch object for a_bzrdir
811
_found is a private parameter, do not use it. It is used to indicate
812
if format probing has already be done.
815
format = BranchFormat.find_format(a_bzrdir)
816
assert format.__class__ == self.__class__
817
transport = a_bzrdir.get_branch_transport(None)
818
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
819
return BzrBranch5(_format=self,
820
_control_files=control_files,
822
_repository=a_bzrdir.find_repository())
825
return "Bazaar-NG Metadir branch format 5"
828
class BranchReferenceFormat(BranchFormat):
829
"""Bzr branch reference format.
831
Branch references are used in implementing checkouts, they
832
act as an alias to the real branch which is at some other url.
839
def get_format_string(self):
840
"""See BranchFormat.get_format_string()."""
841
return "Bazaar-NG Branch Reference Format 1\n"
843
def get_format_description(self):
844
"""See BranchFormat.get_format_description()."""
845
return "Checkout reference format 1"
847
def initialize(self, a_bzrdir, target_branch=None):
848
"""Create a branch of this format in a_bzrdir."""
849
if target_branch is None:
850
# this format does not implement branch itself, thus the implicit
851
# creation contract must see it as uninitializable
852
raise errors.UninitializableFormat(self)
853
mutter('creating branch reference in %s', a_bzrdir.transport.base)
854
branch_transport = a_bzrdir.get_branch_transport(self)
855
branch_transport.put_bytes('location',
856
target_branch.bzrdir.root_transport.base)
857
branch_transport.put_bytes('format', self.get_format_string())
858
return self.open(a_bzrdir, _found=True)
861
super(BranchReferenceFormat, self).__init__()
862
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
864
def _make_reference_clone_function(format, a_branch):
865
"""Create a clone() routine for a branch dynamically."""
866
def clone(to_bzrdir, revision_id=None):
867
"""See Branch.clone()."""
868
return format.initialize(to_bzrdir, a_branch)
869
# cannot obey revision_id limits when cloning a reference ...
870
# FIXME RBC 20060210 either nuke revision_id for clone, or
871
# emit some sort of warning/error to the caller ?!
874
def open(self, a_bzrdir, _found=False):
875
"""Return the branch that the branch reference in a_bzrdir points at.
877
_found is a private parameter, do not use it. It is used to indicate
878
if format probing has already be done.
881
format = BranchFormat.find_format(a_bzrdir)
882
assert format.__class__ == self.__class__
883
transport = a_bzrdir.get_branch_transport(None)
884
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
885
result = real_bzrdir.open_branch()
886
# this changes the behaviour of result.clone to create a new reference
887
# rather than a copy of the content of the branch.
888
# I did not use a proxy object because that needs much more extensive
889
# testing, and we are only changing one behaviour at the moment.
890
# If we decide to alter more behaviours - i.e. the implicit nickname
891
# then this should be refactored to introduce a tested proxy branch
892
# and a subclass of that for use in overriding clone() and ....
894
result.clone = self._make_reference_clone_function(result)
898
# formats which have no format string are not discoverable
899
# and not independently creatable, so are not registered.
900
__default_format = BzrBranchFormat5()
901
BranchFormat.register_format(__default_format)
902
BranchFormat.register_format(BranchReferenceFormat())
903
BranchFormat.set_default_format(__default_format)
904
_legacy_formats = [BzrBranchFormat4(),
907
class BzrBranch(Branch):
908
"""A branch stored in the actual filesystem.
910
Note that it's "local" in the context of the filesystem; it doesn't
911
really matter if it's on an nfs/smb/afs/coda/... share, as long as
912
it's writable, and can be accessed via the normal filesystem API.
948
## TODO: Option to move IDs only
949
assert not isinstance(from_paths, basestring)
950
tree = self.working_tree()
952
to_abs = self.abspath(to_name)
953
if not isdir(to_abs):
954
raise BzrError("destination %r is not a directory" % to_abs)
955
if not tree.has_filename(to_name):
956
raise BzrError("destination %r not in working directory" % to_abs)
957
to_dir_id = inv.path2id(to_name)
958
if to_dir_id == None and to_name != '':
959
raise BzrError("destination %r is not a versioned directory" % to_name)
960
to_dir_ie = inv[to_dir_id]
961
if to_dir_ie.kind not in ('directory', 'root_directory'):
962
raise BzrError("destination %r is not a directory" % to_abs)
964
to_idpath = inv.get_idpath(to_dir_id)
967
if not tree.has_filename(f):
968
raise BzrError("%r does not exist in working tree" % f)
969
f_id = inv.path2id(f)
971
raise BzrError("%r is not versioned" % f)
972
name_tail = splitpath(f)[-1]
973
dest_path = appendpath(to_name, name_tail)
974
if tree.has_filename(dest_path):
975
raise BzrError("destination %r already exists" % dest_path)
976
if f_id in to_idpath:
977
raise BzrError("can't move %r to a subdirectory of itself" % f)
979
# OK, so there's a race here, it's possible that someone will
980
# create a file in this interval and then the rename might be
981
# left half-done. But we should have caught most problems.
984
name_tail = splitpath(f)[-1]
985
dest_path = appendpath(to_name, name_tail)
986
print "%s => %s" % (f, dest_path)
987
inv.rename(inv.path2id(f), to_dir_id, name_tail)
989
os.rename(self.abspath(f), self.abspath(dest_path))
991
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
992
["rename rolled back"])
994
self._write_inventory(inv)
999
def revert(self, filenames, old_tree=None, backups=True):
1000
"""Restore selected files to the versions from a previous tree.
1003
If true (default) backups are made of files before
1006
from bzrlib.errors import NotVersionedError, BzrError
1007
from bzrlib.atomicfile import AtomicFile
1008
from bzrlib.osutils import backup_file
1010
inv = self.read_working_inventory()
1011
if old_tree is None:
1012
old_tree = self.basis_tree()
1013
old_inv = old_tree.inventory
1016
for fn in filenames:
1017
file_id = inv.path2id(fn)
1019
raise NotVersionedError("not a versioned file", fn)
1020
if not old_inv.has_id(file_id):
1021
raise BzrError("file not present in old tree", fn, file_id)
1022
nids.append((fn, file_id))
1024
# TODO: Rename back if it was previously at a different location
1026
# TODO: If given a directory, restore the entire contents from
1027
# the previous version.
1029
# TODO: Make a backup to a temporary file.
1031
# TODO: If the file previously didn't exist, delete it?
1032
for fn, file_id in nids:
1035
f = AtomicFile(fn, 'wb')
1037
f.write(old_tree.get_file(file_id).read())
1043
def pending_merges(self):
1044
"""Return a list of pending merges.
1046
These are revisions that have been merged into the working
1047
directory but not yet committed.
1049
cfn = self.controlfilename('pending-merges')
1050
if not os.path.exists(cfn):
1053
for l in self.controlfile('pending-merges', 'r').readlines():
1054
p.append(l.rstrip('\n'))
1058
def add_pending_merge(self, revision_id):
1059
from bzrlib.revision import validate_revision_id
1061
validate_revision_id(revision_id)
1063
p = self.pending_merges()
1064
if revision_id in p:
1066
p.append(revision_id)
1067
self.set_pending_merges(p)
1070
def set_pending_merges(self, rev_list):
1071
from bzrlib.atomicfile import AtomicFile
1074
f = AtomicFile(self.controlfilename('pending-merges'))
1086
class ScratchBranch(Branch):
1087
"""Special test class: a branch that cleans up after itself.
1089
>>> b = ScratchBranch()
1097
def __init__(self, files=[], dirs=[], base=None):
1098
"""Make a test branch.
1100
This creates a temporary directory and runs init-tree in it.
1102
If any files are listed, they are created in the working copy.
1104
from tempfile import mkdtemp
1109
Branch.__init__(self, base, init=init)
1111
os.mkdir(self.abspath(d))
1114
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1119
>>> orig = ScratchBranch(files=["file1", "file2"])
1120
>>> clone = orig.clone()
1121
>>> os.path.samefile(orig.base, clone.base)
1123
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1126
from shutil import copytree
1127
from tempfile import mkdtemp
1130
copytree(self.base, base, symlinks=True)
1131
return ScratchBranch(base=base)
1137
"""Destroy the test branch, removing the scratch directory."""
1138
from shutil import rmtree
1141
mutter("delete ScratchBranch %s" % self.base)
1144
# Work around for shutil.rmtree failing on Windows when
1145
# readonly files are encountered
1146
mutter("hit exception in destroying ScratchBranch: %s" % e)
1147
for root, dirs, files in os.walk(self.base, topdown=False):
1149
os.chmod(os.path.join(root, name), 0700)
915
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
916
relax_version_check=DEPRECATED_PARAMETER, _format=None,
917
_control_files=None, a_bzrdir=None, _repository=None):
918
"""Create new branch object at a particular location.
920
transport -- A Transport object, defining how to access files.
922
init -- If True, create new control files in a previously
923
unversioned directory. If False, the branch must already
926
relax_version_check -- If true, the usual check for the branch
927
version is not applied. This is intended only for
928
upgrade/recovery type use; it's not guaranteed that
929
all operations will work on old format branches.
932
self.bzrdir = bzrdir.BzrDir.open(transport.base)
934
self.bzrdir = a_bzrdir
935
self._transport = self.bzrdir.transport.clone('..')
936
self._base = self._transport.base
937
self._format = _format
938
if _control_files is None:
939
raise ValueError('BzrBranch _control_files is None')
940
self.control_files = _control_files
941
if deprecated_passed(init):
942
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
943
"deprecated as of bzr 0.8. Please use Branch.create().",
947
# this is slower than before deprecation, oh well never mind.
949
self._initialize(transport.base)
950
self._check_format(_format)
951
if deprecated_passed(relax_version_check):
952
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
953
"relax_version_check parameter is deprecated as of bzr 0.8. "
954
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
958
if (not relax_version_check
959
and not self._format.is_supported()):
960
raise errors.UnsupportedFormatError(format=fmt)
961
if deprecated_passed(transport):
962
warn("BzrBranch.__init__(transport=XXX...): The transport "
963
"parameter is deprecated as of bzr 0.8. "
964
"Please use Branch.open, or bzrdir.open_branch().",
967
self.repository = _repository
970
return '%s(%r)' % (self.__class__.__name__, self.base)
977
base = property(_get_base, doc="The URL for the root of this branch.")
979
def _finish_transaction(self):
980
"""Exit the current transaction."""
981
return self.control_files._finish_transaction()
983
def get_transaction(self):
984
"""Return the current active transaction.
986
If no transaction is active, this returns a passthrough object
987
for which all data is immediately flushed and no caching happens.
989
# this is an explicit function so that we can do tricky stuff
990
# when the storage in rev_storage is elsewhere.
991
# we probably need to hook the two 'lock a location' and
992
# 'have a transaction' together more delicately, so that
993
# we can have two locks (branch and storage) and one transaction
994
# ... and finishing the transaction unlocks both, but unlocking
995
# does not. - RBC 20051121
996
return self.control_files.get_transaction()
998
def _set_transaction(self, transaction):
999
"""Set a new active transaction."""
1000
return self.control_files._set_transaction(transaction)
1002
def abspath(self, name):
1003
"""See Branch.abspath."""
1004
return self.control_files._transport.abspath(name)
1006
def _check_format(self, format):
1007
"""Identify the branch format if needed.
1009
The format is stored as a reference to the format object in
1010
self._format for code that needs to check it later.
1012
The format parameter is either None or the branch format class
1013
used to open this branch.
1015
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1018
format = BranchFormat.find_format(self.bzrdir)
1019
self._format = format
1020
mutter("got branch format %s", self._format)
1023
def get_root_id(self):
1024
"""See Branch.get_root_id."""
1025
tree = self.repository.revision_tree(self.last_revision())
1026
return tree.inventory.root.file_id
1028
def is_locked(self):
1029
return self.control_files.is_locked()
1031
def lock_write(self):
1032
self.repository.lock_write()
1034
self.control_files.lock_write()
1036
self.repository.unlock()
1039
def lock_read(self):
1040
self.repository.lock_read()
1042
self.control_files.lock_read()
1044
self.repository.unlock()
1048
# TODO: test for failed two phase locks. This is known broken.
1050
self.control_files.unlock()
1052
self.repository.unlock()
1054
def peek_lock_mode(self):
1055
if self.control_files._lock_count == 0:
1058
return self.control_files._lock_mode
1060
def get_physical_lock_status(self):
1061
return self.control_files.get_physical_lock_status()
1064
def print_file(self, file, revision_id):
1065
"""See Branch.print_file."""
1066
return self.repository.print_file(file, revision_id)
1069
def append_revision(self, *revision_ids):
1070
"""See Branch.append_revision."""
1071
for revision_id in revision_ids:
1072
mutter("add {%s} to revision-history" % revision_id)
1073
rev_history = self.revision_history()
1074
rev_history.extend(revision_ids)
1075
self.set_revision_history(rev_history)
1078
def set_revision_history(self, rev_history):
1079
"""See Branch.set_revision_history."""
1080
self.control_files.put_utf8(
1081
'revision-history', '\n'.join(rev_history))
1082
transaction = self.get_transaction()
1083
history = transaction.map.find_revision_history()
1084
if history is not None:
1085
# update the revision history in the identity map.
1086
history[:] = list(rev_history)
1087
# this call is disabled because revision_history is
1088
# not really an object yet, and the transaction is for objects.
1089
# transaction.register_dirty(history)
1091
transaction.map.add_revision_history(rev_history)
1092
# this call is disabled because revision_history is
1093
# not really an object yet, and the transaction is for objects.
1094
# transaction.register_clean(history)
1097
def revision_history(self):
1098
"""See Branch.revision_history."""
1099
transaction = self.get_transaction()
1100
history = transaction.map.find_revision_history()
1101
if history is not None:
1102
# mutter("cache hit for revision-history in %s", self)
1103
return list(history)
1104
decode_utf8 = cache_utf8.decode
1105
history = [decode_utf8(l.rstrip('\r\n')) for l in
1106
self.control_files.get('revision-history').readlines()]
1107
transaction.map.add_revision_history(history)
1108
# this call is disabled because revision_history is
1109
# not really an object yet, and the transaction is for objects.
1110
# transaction.register_clean(history, precious=True)
1111
return list(history)
1114
def generate_revision_history(self, revision_id, last_rev=None,
1116
"""Create a new revision history that will finish with revision_id.
1118
:param revision_id: the new tip to use.
1119
:param last_rev: The previous last_revision. If not None, then this
1120
must be a ancestory of revision_id, or DivergedBranches is raised.
1121
:param other_branch: The other branch that DivergedBranches should
1122
raise with respect to.
1124
# stop_revision must be a descendant of last_revision
1125
stop_graph = self.repository.get_revision_graph(revision_id)
1126
if last_rev is not None and last_rev not in stop_graph:
1127
# our previous tip is not merged into stop_revision
1128
raise errors.DivergedBranches(self, other_branch)
1129
# make a new revision history from the graph
1130
current_rev_id = revision_id
1132
while current_rev_id not in (None, revision.NULL_REVISION):
1133
new_history.append(current_rev_id)
1134
current_rev_id_parents = stop_graph[current_rev_id]
1136
current_rev_id = current_rev_id_parents[0]
1138
current_rev_id = None
1139
new_history.reverse()
1140
self.set_revision_history(new_history)
1143
def update_revisions(self, other, stop_revision=None):
1144
"""See Branch.update_revisions."""
1147
if stop_revision is None:
1148
stop_revision = other.last_revision()
1149
if stop_revision is None:
1150
# if there are no commits, we're done.
1152
# whats the current last revision, before we fetch [and change it
1154
last_rev = self.last_revision()
1155
# we fetch here regardless of whether we need to so that we pickup
1157
self.fetch(other, stop_revision)
1158
my_ancestry = self.repository.get_ancestry(last_rev)
1159
if stop_revision in my_ancestry:
1160
# last_revision is a descendant of stop_revision
1162
self.generate_revision_history(stop_revision, last_rev=last_rev,
1167
def basis_tree(self):
1168
"""See Branch.basis_tree."""
1169
return self.repository.revision_tree(self.last_revision())
1171
@deprecated_method(zero_eight)
1172
def working_tree(self):
1173
"""Create a Working tree object for this branch."""
1175
from bzrlib.transport.local import LocalTransport
1176
if (self.base.find('://') != -1 or
1177
not isinstance(self._transport, LocalTransport)):
1178
raise NoWorkingTree(self.base)
1179
return self.bzrdir.open_workingtree()
1182
def pull(self, source, overwrite=False, stop_revision=None):
1183
"""See Branch.pull."""
1186
old_count = len(self.revision_history())
1188
self.update_revisions(source, stop_revision)
1189
except DivergedBranches:
1193
self.set_revision_history(source.revision_history())
1194
new_count = len(self.revision_history())
1195
return new_count - old_count
1199
def get_parent(self):
1200
"""See Branch.get_parent."""
1202
_locs = ['parent', 'pull', 'x-pull']
1203
assert self.base[-1] == '/'
1206
parent = self.control_files.get(l).read().strip('\n')
1209
# This is an old-format absolute path to a local branch
1210
# turn it into a url
1211
if parent.startswith('/'):
1212
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1214
return urlutils.join(self.base[:-1], parent)
1215
except errors.InvalidURLJoin, e:
1216
raise errors.InaccessibleParent(parent, self.base)
1219
def get_push_location(self):
1220
"""See Branch.get_push_location."""
1221
push_loc = self.get_config().get_user_option('push_location')
1224
def set_push_location(self, location):
1225
"""See Branch.set_push_location."""
1226
self.get_config().set_user_option('push_location', location,
1230
def set_parent(self, url):
1231
"""See Branch.set_parent."""
1232
# TODO: Maybe delete old location files?
1233
# URLs should never be unicode, even on the local fs,
1234
# FIXUP this and get_parent in a future branch format bump:
1235
# read and rewrite the file, and have the new format code read
1236
# using .get not .get_utf8. RBC 20060125
1238
self.control_files._transport.delete('parent')
1240
if isinstance(url, unicode):
1242
url = url.encode('ascii')
1243
except UnicodeEncodeError:
1244
raise bzrlib.errors.InvalidURL(url,
1245
"Urls must be 7-bit ascii, "
1246
"use bzrlib.urlutils.escape")
1248
url = urlutils.relative_url(self.base, url)
1249
self.control_files.put('parent', StringIO(url + '\n'))
1251
@deprecated_function(zero_nine)
1252
def tree_config(self):
1253
"""DEPRECATED; call get_config instead.
1254
TreeConfig has become part of BranchConfig."""
1255
return TreeConfig(self)
1258
class BzrBranch5(BzrBranch):
1259
"""A format 5 branch. This supports new features over plan branches.
1261
It has support for a master_branch which is the data for bound branches.
1269
super(BzrBranch5, self).__init__(_format=_format,
1270
_control_files=_control_files,
1272
_repository=_repository)
1275
def pull(self, source, overwrite=False, stop_revision=None):
1276
"""Updates branch.pull to be bound branch aware."""
1277
bound_location = self.get_bound_location()
1278
if source.base != bound_location:
1279
# not pulling from master, so we need to update master.
1280
master_branch = self.get_master_branch()
1282
master_branch.pull(source)
1283
source = master_branch
1284
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1286
def get_bound_location(self):
1288
return self.control_files.get_utf8('bound').read()[:-1]
1289
except errors.NoSuchFile:
1293
def get_master_branch(self):
1294
"""Return the branch we are bound to.
1296
:return: Either a Branch, or None
1298
This could memoise the branch, but if thats done
1299
it must be revalidated on each new lock.
1300
So for now we just don't memoise it.
1301
# RBC 20060304 review this decision.
1303
bound_loc = self.get_bound_location()
1307
return Branch.open(bound_loc)
1308
except (errors.NotBranchError, errors.ConnectionError), e:
1309
raise errors.BoundBranchConnectionFailure(
1313
def set_bound_location(self, location):
1314
"""Set the target where this branch is bound to.
1316
:param location: URL to the target branch
1319
self.control_files.put_utf8('bound', location+'\n')
1322
self.control_files._transport.delete('bound')
1155
######################################################################
1159
def is_control_file(filename):
1160
## FIXME: better check
1161
filename = os.path.normpath(filename)
1162
while filename != '':
1163
head, tail = os.path.split(filename)
1164
## mutter('check %r for control file' % ((head, tail), ))
1165
if tail == bzrlib.BZRDIR:
1328
def bind(self, other):
1329
"""Bind this branch to the branch other.
1331
This does not push or pull data between the branches, though it does
1332
check for divergence to raise an error when the branches are not
1333
either the same, or one a prefix of the other. That behaviour may not
1334
be useful, so that check may be removed in future.
1336
:param other: The branch to bind to
1339
# TODO: jam 20051230 Consider checking if the target is bound
1340
# It is debatable whether you should be able to bind to
1341
# a branch which is itself bound.
1342
# Committing is obviously forbidden,
1343
# but binding itself may not be.
1344
# Since we *have* to check at commit time, we don't
1345
# *need* to check here
1347
# we want to raise diverged if:
1348
# last_rev is not in the other_last_rev history, AND
1349
# other_last_rev is not in our history, and do it without pulling
1351
last_rev = self.last_revision()
1352
if last_rev is not None:
1355
other_last_rev = other.last_revision()
1356
if other_last_rev is not None:
1357
# neither branch is new, we have to do some work to
1358
# ascertain diversion.
1359
remote_graph = other.repository.get_revision_graph(
1361
local_graph = self.repository.get_revision_graph(last_rev)
1362
if (last_rev not in remote_graph and
1363
other_last_rev not in local_graph):
1364
raise errors.DivergedBranches(self, other)
1367
self.set_bound_location(other.base)
1371
"""If bound, unbind"""
1372
return self.set_bound_location(None)
1376
"""Synchronise this branch with the master branch if any.
1378
:return: None or the last_revision that was pivoted out during the
1381
master = self.get_master_branch()
1382
if master is not None:
1383
old_tip = self.last_revision()
1384
self.pull(master, overwrite=True)
1385
if old_tip in self.repository.get_ancestry(self.last_revision()):
1391
class BranchTestProviderAdapter(object):
1392
"""A tool to generate a suite testing multiple branch formats at once.
1394
This is done by copying the test once for each transport and injecting
1395
the transport_server, transport_readonly_server, and branch_format
1396
classes into each copy. Each copy is also given a new id() to make it
1400
def __init__(self, transport_server, transport_readonly_server, formats):
1401
self._transport_server = transport_server
1402
self._transport_readonly_server = transport_readonly_server
1403
self._formats = formats
1405
def adapt(self, test):
1406
result = TestSuite()
1407
for branch_format, bzrdir_format in self._formats:
1408
new_test = deepcopy(test)
1409
new_test.transport_server = self._transport_server
1410
new_test.transport_readonly_server = self._transport_readonly_server
1411
new_test.bzrdir_format = bzrdir_format
1412
new_test.branch_format = branch_format
1413
def make_new_test_id():
1414
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1415
return lambda: new_id
1416
new_test.id = make_new_test_id()
1417
result.addTest(new_test)
1421
class BranchCheckResult(object):
1422
"""Results of checking branch consistency.
1427
def __init__(self, branch):
1428
self.branch = branch
1430
def report_results(self, verbose):
1431
"""Report the check results via trace.note.
1433
:param verbose: Requests more detailed display of what was checked,
1436
note('checked branch %s format %s',
1438
self.branch._format)
1441
######################################################################
1445
@deprecated_function(zero_eight)
1446
def is_control_file(*args, **kwargs):
1447
"""See bzrlib.workingtree.is_control_file."""
1448
return bzrlib.workingtree.is_control_file(*args, **kwargs)
1167
if filename == head:
1174
def gen_file_id(name):
1175
"""Return new file id.
1177
This should probably generate proper UUIDs, but for the moment we
1178
cope with just randomness because running uuidgen every time is
1181
from binascii import hexlify
1182
from time import time
1184
# get last component
1185
idx = name.rfind('/')
1187
name = name[idx+1 : ]
1188
idx = name.rfind('\\')
1190
name = name[idx+1 : ]
1192
# make it not a hidden file
1193
name = name.lstrip('.')
1195
# remove any wierd characters; we don't escape them but rather
1196
# just pull them out
1197
name = re.sub(r'[^\w.]', '', name)
1199
s = hexlify(rand_bytes(8))
1200
return '-'.join((name, compact_date(time()), s))
added
removed
bzrlib/branch.py
