84
80
"""Branch holding a history of revisions.
87
Base directory of the branch.
83
Base directory/url of the branch.
85
hooks: An instance of BranchHooks.
87
# this is really an instance variable - FIXME move it there
91
def __init__(self, *ignored, **ignored_too):
92
raise NotImplementedError('The Branch class is abstract')
95
"""Break a lock if one is present from another instance.
97
Uses the ui factory to ask for confirmation if the lock may be from
100
This will probe the repository for its lock as well.
102
self.control_files.break_lock()
103
self.repository.break_lock()
104
master = self.get_master_branch()
105
if master is not None:
109
@deprecated_method(zero_eight)
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format."""
112
return Branch.open(base, _unsupported=True)
115
def open(base, _unsupported=False):
116
"""Open the branch rooted at base.
118
For instance, if the branch is at URL/.bzr/branch,
119
Branch.open(URL) -> a Branch instance.
121
control = bzrdir.BzrDir.open(base, _unsupported)
122
return control.open_branch(_unsupported)
125
def open_containing(url):
126
"""Open an existing branch which contains url.
128
This probes for a branch at url, and searches upwards from there.
130
Basically we keep looking up until we find the control directory or
131
run into the root. If there isn't one, raises NotBranchError.
132
If there is one and it is either an unrecognised format or an unsupported
133
format, UnknownFormatError or UnsupportedFormatError are raised.
134
If there is one, it is returned, along with the unused portion of url.
136
control, relpath = bzrdir.BzrDir.open_containing(url)
137
return control.open_branch(), relpath
140
@deprecated_function(zero_eight)
141
def initialize(base):
142
"""Create a new working tree and branch, rooted at 'base' (url)
144
NOTE: This will soon be deprecated in favour of creation
147
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
149
@deprecated_function(zero_eight)
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
154
NOTE: This is unused.
158
def get_config(self):
159
return BranchConfig(self)
162
return self.get_config().get_nickname()
164
def _set_nick(self, nick):
165
self.get_config().set_user_option('nickname', nick)
167
nick = property(_get_nick, _set_nick)
170
raise NotImplementedError(self.is_locked)
172
def lock_write(self):
173
raise NotImplementedError(self.lock_write)
176
raise NotImplementedError(self.lock_read)
179
raise NotImplementedError(self.unlock)
181
def peek_lock_mode(self):
182
"""Return lock mode for the Branch: 'r', 'w' or None"""
183
raise NotImplementedError(self.peek_lock_mode)
185
def get_physical_lock_status(self):
186
raise NotImplementedError(self.get_physical_lock_status)
188
def abspath(self, name):
189
"""Return absolute filename for something in the branch
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
194
raise NotImplementedError(self.abspath)
196
def bind(self, other):
197
"""Bind the local branch the other branch.
199
:param other: The branch to bind to
202
raise errors.UpgradeRequired(self.base)
205
def fetch(self, from_branch, last_revision=None, pb=None):
206
"""Copy revisions from from_branch into this branch.
208
:param from_branch: Where to copy from.
209
:param last_revision: What revision to stop at (None for at the end
211
:param pb: An optional progress bar to use.
213
Returns the copied revision count and the failed revisions in a tuple:
216
if self.base == from_branch.base:
219
nested_pb = ui.ui_factory.nested_progress_bar()
224
from_branch.lock_read()
226
if last_revision is None:
227
pb.update('get source history')
228
last_revision = from_branch.last_revision()
229
if last_revision is None:
230
last_revision = _mod_revision.NULL_REVISION
231
return self.repository.fetch(from_branch.repository,
232
revision_id=last_revision,
235
if nested_pb is not None:
239
def get_bound_location(self):
240
"""Return the URL of the branch we are bound to.
242
Older format branches cannot bind, please be sure to use a metadir
92
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
93
"""Create new branch object at a particular location.
95
base -- Base directory for the branch.
97
init -- If True, create new control files in a previously
98
unversioned directory. If False, the branch must already
101
find_root -- If true and init is false, find the root of the
102
existing branch containing base.
104
In the test suite, creation of new trees is tested using the
105
`ScratchBranch` class.
108
self.base = os.path.realpath(base)
111
self.base = find_branch_root(base)
113
self.base = os.path.realpath(base)
114
if not isdir(self.controlfilename('.')):
115
bailout("not a bzr branch: %s" % quotefn(base),
116
['use "bzr init" to initialize a new working tree',
117
'current bzr can only operate from top-of-tree'])
121
self.text_store = ImmutableStore(self.controlfilename('text-store'))
122
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
123
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
127
return '%s(%r)' % (self.__class__.__name__, self.base)
134
def lock(self, mode='w'):
135
"""Lock the on-disk branch, excluding other processes."""
141
om = os.O_WRONLY | os.O_CREAT
146
raise BzrError("invalid locking mode %r" % mode)
149
lockfile = os.open(self.controlfilename('branch-lock'), om)
151
if e.errno == errno.ENOENT:
152
# might not exist on branches from <0.0.4
153
self.controlfile('branch-lock', 'w').close()
154
lockfile = os.open(self.controlfilename('branch-lock'), om)
158
fcntl.lockf(lockfile, lm)
160
fcntl.lockf(lockfile, fcntl.LOCK_UN)
162
self._lockmode = None
164
self._lockmode = mode
166
warning("please write a locking method for platform %r" % sys.platform)
168
self._lockmode = None
170
self._lockmode = mode
173
def _need_readlock(self):
174
if self._lockmode not in ['r', 'w']:
175
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
177
def _need_writelock(self):
178
if self._lockmode not in ['w']:
179
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
182
def abspath(self, name):
183
"""Return absolute filename for something in the branch"""
184
return os.path.join(self.base, name)
187
def relpath(self, path):
188
"""Return path relative to this branch of something inside it.
190
Raises an error if path is not in this branch."""
191
rp = os.path.realpath(path)
193
if not rp.startswith(self.base):
194
bailout("path %r is not within branch %r" % (rp, self.base))
195
rp = rp[len(self.base):]
196
rp = rp.lstrip(os.sep)
200
def controlfilename(self, file_or_path):
201
"""Return location relative to branch."""
202
if isinstance(file_or_path, types.StringTypes):
203
file_or_path = [file_or_path]
204
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
207
def controlfile(self, file_or_path, mode='r'):
208
"""Open a control file for this branch.
210
There are two classes of file in the control directory: text
211
and binary. binary files are untranslated byte streams. Text
212
control files are stored with Unix newlines and in UTF-8, even
213
if the platform or locale defaults are different.
215
Controlfiles should almost never be opened in write mode but
216
rather should be atomically copied and replaced using atomicfile.
219
fn = self.controlfilename(file_or_path)
221
if mode == 'rb' or mode == 'wb':
222
return file(fn, mode)
223
elif mode == 'r' or mode == 'w':
224
# open in binary mode anyhow so there's no newline translation;
225
# codecs uses line buffering by default; don't want that.
227
return codecs.open(fn, mode + 'b', 'utf-8',
230
raise BzrError("invalid controlfile mode %r" % mode)
234
def _make_control(self):
235
os.mkdir(self.controlfilename([]))
236
self.controlfile('README', 'w').write(
237
"This is a Bazaar-NG control directory.\n"
238
"Do not change any files in this directory.")
239
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
240
for d in ('text-store', 'inventory-store', 'revision-store'):
241
os.mkdir(self.controlfilename(d))
242
for f in ('revision-history', 'merged-patches',
243
'pending-merged-patches', 'branch-name',
245
self.controlfile(f, 'w').write('')
246
mutter('created control directory in ' + self.base)
247
Inventory().write_xml(self.controlfile('inventory','w'))
250
def _check_format(self):
251
"""Check this branch format is supported.
253
The current tool only supports the current unstable format.
255
In the future, we might need different in-memory Branch
256
classes to support downlevel branches. But not yet.
258
# This ignores newlines so that we can open branches created
259
# on Windows from Linux and so on. I think it might be better
260
# to always make all internal files in unix format.
261
fmt = self.controlfile('branch-format', 'r').read()
262
fmt.replace('\r\n', '')
263
if fmt != BZR_BRANCH_FORMAT:
264
bailout('sorry, branch format %r not supported' % fmt,
265
['use a different bzr version',
266
'or remove the .bzr directory and "bzr init" again'])
269
def read_working_inventory(self):
270
"""Read the working inventory."""
271
self._need_readlock()
273
# ElementTree does its own conversion from UTF-8, so open in
275
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
276
mutter("loaded inventory of %d items in %f"
277
% (len(inv), time.time() - before))
281
def _write_inventory(self, inv):
282
"""Update the working inventory.
284
That is to say, the inventory describing changes underway, that
285
will be committed to the next revision.
287
self._need_writelock()
288
## TODO: factor out to atomicfile? is rename safe on windows?
289
## TODO: Maybe some kind of clean/dirty marker on inventory?
290
tmpfname = self.controlfilename('inventory.tmp')
291
tmpf = file(tmpfname, 'wb')
294
inv_fname = self.controlfilename('inventory')
295
if sys.platform == 'win32':
297
os.rename(tmpfname, inv_fname)
298
mutter('wrote working inventory')
301
inventory = property(read_working_inventory, _write_inventory, None,
302
"""Inventory for the working copy.""")
305
def add(self, files, verbose=False, ids=None):
306
"""Make files versioned.
308
Note that the command line normally calls smart_add instead.
310
This puts the files in the Added state, so that they will be
311
recorded by the next commit.
313
TODO: Perhaps have an option to add the ids even if the files do
316
TODO: Perhaps return the ids of the files? But then again it
317
is easy to retrieve them if they're needed.
319
TODO: Option to specify file id.
321
TODO: Adding a directory should optionally recurse down and
322
add all non-ignored children. Perhaps do that in a
325
self._need_writelock()
327
# TODO: Re-adding a file that is removed in the working copy
328
# should probably put it back with the previous ID.
329
if isinstance(files, types.StringTypes):
330
assert(ids is None or isinstance(ids, types.StringTypes))
336
ids = [None] * len(files)
338
assert(len(ids) == len(files))
340
inv = self.read_working_inventory()
341
for f,file_id in zip(files, ids):
342
if is_control_file(f):
343
bailout("cannot add control file %s" % quotefn(f))
348
bailout("cannot add top-level %r" % f)
350
fullpath = os.path.normpath(self.abspath(f))
353
kind = file_kind(fullpath)
355
# maybe something better?
356
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
358
if kind != 'file' and kind != 'directory':
359
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
362
file_id = gen_file_id(f)
363
inv.add_path(f, kind=kind, file_id=file_id)
366
show_status('A', kind, quotefn(f))
368
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
370
self._write_inventory(inv)
373
def print_file(self, file, revno):
247
def get_old_bound_location(self):
248
"""Return the URL of the branch we used to be bound to
250
raise errors.UpgradeRequired(self.base)
252
def get_commit_builder(self, parents, config=None, timestamp=None,
253
timezone=None, committer=None, revprops=None,
255
"""Obtain a CommitBuilder for this branch.
257
:param parents: Revision ids of the parents of the new revision.
258
:param config: Optional configuration to use.
259
:param timestamp: Optional timestamp recorded for commit.
260
:param timezone: Optional timezone for timestamp.
261
:param committer: Optional committer to set for commit.
262
:param revprops: Optional dictionary of revision properties.
263
:param revision_id: Optional revision id.
267
config = self.get_config()
269
return self.repository.get_commit_builder(self, parents, config,
270
timestamp, timezone, committer, revprops, revision_id)
272
def get_master_branch(self):
273
"""Return the branch we are bound to.
275
:return: Either a Branch, or None
279
def get_revision_delta(self, revno):
280
"""Return the delta for one revision.
282
The delta is relative to its mainline predecessor, or the
283
empty tree for revision 1.
285
assert isinstance(revno, int)
286
rh = self.revision_history()
287
if not (1 <= revno <= len(rh)):
288
raise InvalidRevisionNumber(revno)
289
return self.repository.get_revision_delta(rh[revno-1])
291
def get_root_id(self):
292
"""Return the id of this branches root"""
293
raise NotImplementedError(self.get_root_id)
295
def print_file(self, file, revision_id):
374
296
"""Print `file` to stdout."""
375
self._need_readlock()
376
tree = self.revision_tree(self.lookup_revision(revno))
377
# use inventory as it was in that revision
378
file_id = tree.inventory.path2id(file)
380
bailout("%r is not present in revision %d" % (file, revno))
381
tree.print_file(file_id)
384
def remove(self, files, verbose=False):
385
"""Mark nominated files for removal from the inventory.
387
This does not remove their text. This does not run on
389
TODO: Refuse to remove modified files unless --force is given?
391
TODO: Do something useful with directories.
393
TODO: Should this remove the text or not? Tough call; not
394
removing may be useful and the user can just use use rm, and
395
is the opposite of add. Removing it is consistent with most
396
other tools. Maybe an option.
398
## TODO: Normalize names
399
## TODO: Remove nested loops; better scalability
400
self._need_writelock()
402
if isinstance(files, types.StringTypes):
405
tree = self.working_tree()
408
# do this before any modifications
412
bailout("cannot remove unversioned file %s" % quotefn(f))
413
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
415
# having remove it, it must be either ignored or unknown
416
if tree.is_ignored(f):
420
show_status(new_status, inv[fid].kind, quotefn(f))
423
self._write_inventory(inv)
425
def set_inventory(self, new_inventory_list):
427
for path, file_id, parent, kind in new_inventory_list:
428
name = os.path.basename(path)
431
inv.add(InventoryEntry(file_id, name, kind, parent))
432
self._write_inventory(inv)
436
"""Return all unknown files.
438
These are files in the working directory that are not versioned or
439
control files or ignored.
441
>>> b = ScratchBranch(files=['foo', 'foo~'])
442
>>> list(b.unknowns())
445
>>> list(b.unknowns())
448
>>> list(b.unknowns())
451
return self.working_tree().unknowns()
454
def append_revision(self, revision_id):
455
mutter("add {%s} to revision-history" % revision_id)
456
rev_history = self.revision_history()
458
tmprhname = self.controlfilename('revision-history.tmp')
459
rhname = self.controlfilename('revision-history')
461
f = file(tmprhname, 'wt')
462
rev_history.append(revision_id)
463
f.write('\n'.join(rev_history))
467
if sys.platform == 'win32':
469
os.rename(tmprhname, rhname)
473
def get_revision(self, revision_id):
474
"""Return the Revision object for a named revision"""
475
self._need_readlock()
476
r = Revision.read_xml(self.revision_store[revision_id])
477
assert r.revision_id == revision_id
481
def get_inventory(self, inventory_id):
482
"""Get Inventory object by hash.
484
TODO: Perhaps for this and similar methods, take a revision
485
parameter which can be either an integer revno or a
487
self._need_readlock()
488
i = Inventory.read_xml(self.inventory_store[inventory_id])
492
def get_revision_inventory(self, revision_id):
493
"""Return inventory of a past revision."""
494
self._need_readlock()
495
if revision_id == None:
498
return self.get_inventory(self.get_revision(revision_id).inventory_id)
297
raise NotImplementedError(self.print_file)
299
def append_revision(self, *revision_ids):
300
raise NotImplementedError(self.append_revision)
302
def set_revision_history(self, rev_history):
303
raise NotImplementedError(self.set_revision_history)
501
305
def revision_history(self):
502
"""Return sequence of revision hashes on to this branch.
504
>>> ScratchBranch().revision_history()
507
self._need_readlock()
508
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
511
def enum_history(self, direction):
512
"""Return (revno, revision_id) for history of branch.
515
'forward' is from earliest to latest
516
'reverse' is from latest to earliest
518
rh = self.revision_history()
519
if direction == 'forward':
524
elif direction == 'reverse':
530
raise ValueError('invalid history direction', direction)
306
"""Return sequence of revision hashes on to this branch."""
307
raise NotImplementedError(self.revision_history)
534
310
"""Return current revision number for this branch.
661
431
Note that to_name is only the last component of the new name;
662
432
this doesn't change the directory.
664
self._need_writelock()
665
## TODO: Option to move IDs only
666
assert not isinstance(from_paths, basestring)
667
tree = self.working_tree()
669
to_abs = self.abspath(to_name)
670
if not isdir(to_abs):
671
bailout("destination %r is not a directory" % to_abs)
672
if not tree.has_filename(to_name):
673
bailout("destination %r not in working directory" % to_abs)
674
to_dir_id = inv.path2id(to_name)
675
if to_dir_id == None and to_name != '':
676
bailout("destination %r is not a versioned directory" % to_name)
677
to_dir_ie = inv[to_dir_id]
678
if to_dir_ie.kind not in ('directory', 'root_directory'):
679
bailout("destination %r is not a directory" % to_abs)
681
to_idpath = inv.get_idpath(to_dir_id)
684
if not tree.has_filename(f):
685
bailout("%r does not exist in working tree" % f)
686
f_id = inv.path2id(f)
688
bailout("%r is not versioned" % f)
689
name_tail = splitpath(f)[-1]
690
dest_path = appendpath(to_name, name_tail)
691
if tree.has_filename(dest_path):
692
bailout("destination %r already exists" % dest_path)
693
if f_id in to_idpath:
694
bailout("can't move %r to a subdirectory of itself" % f)
696
# OK, so there's a race here, it's possible that someone will
697
# create a file in this interval and then the rename might be
698
# left half-done. But we should have caught most problems.
701
name_tail = splitpath(f)[-1]
702
dest_path = appendpath(to_name, name_tail)
703
print "%s => %s" % (f, dest_path)
704
inv.rename(inv.path2id(f), to_dir_id, name_tail)
706
os.rename(self.abspath(f), self.abspath(dest_path))
708
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
709
["rename rolled back"])
711
self._write_inventory(inv)
716
class ScratchBranch(Branch):
717
"""Special test class: a branch that cleans up after itself.
719
>>> b = ScratchBranch()
727
def __init__(self, files=[], dirs=[]):
728
"""Make a test branch.
730
This creates a temporary directory and runs init-tree in it.
732
If any files are listed, they are created in the working copy.
734
Branch.__init__(self, tempfile.mkdtemp(), init=True)
736
os.mkdir(self.abspath(d))
434
This returns a list of (from_path, to_path) pairs for each
437
raise NotImplementedError(self.move)
439
def get_parent(self):
440
"""Return the parent location of the branch.
442
This is the default location for push/pull/missing. The usual
443
pattern is that the user can override it by specifying a
446
raise NotImplementedError(self.get_parent)
448
def get_submit_branch(self):
449
"""Return the submit location of the branch.
451
This is the default location for bundle. The usual
452
pattern is that the user can override it by specifying a
455
return self.get_config().get_user_option('submit_branch')
457
def set_submit_branch(self, location):
458
"""Return the submit location of the branch.
460
This is the default location for bundle. The usual
461
pattern is that the user can override it by specifying a
464
self.get_config().set_user_option('submit_branch', location)
466
def get_push_location(self):
467
"""Return the None or the location to push this branch to."""
468
raise NotImplementedError(self.get_push_location)
470
def set_push_location(self, location):
471
"""Set a new push location for this branch."""
472
raise NotImplementedError(self.set_push_location)
474
def set_parent(self, url):
475
raise NotImplementedError(self.set_parent)
479
"""Synchronise this branch with the master branch if any.
481
:return: None or the last_revision pivoted out during the update.
485
def check_revno(self, revno):
487
Check whether a revno corresponds to any revision.
488
Zero (the NULL revision) is considered valid.
491
self.check_real_revno(revno)
739
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
746
"""Destroy the test branch, removing the scratch directory."""
748
mutter("delete ScratchBranch %s" % self.base)
749
shutil.rmtree(self.base)
751
# Work around for shutil.rmtree failing on Windows when
752
# readonly files are encountered
753
mutter("hit exception in destroying ScratchBranch: %s" % e)
754
for root, dirs, files in os.walk(self.base, topdown=False):
756
os.chmod(os.path.join(root, name), 0700)
757
shutil.rmtree(self.base)
493
def check_real_revno(self, revno):
495
Check whether a revno corresponds to a real revision.
496
Zero (the NULL revision) is considered invalid
498
if revno < 1 or revno > self.revno():
499
raise InvalidRevisionNumber(revno)
502
def clone(self, *args, **kwargs):
503
"""Clone this branch into to_bzrdir preserving all semantic values.
505
revision_id: if not None, the revision history in the new branch will
506
be truncated to end with revision_id.
508
# for API compatibility, until 0.8 releases we provide the old api:
509
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
510
# after 0.8 releases, the *args and **kwargs should be changed:
511
# def clone(self, to_bzrdir, revision_id=None):
512
if (kwargs.get('to_location', None) or
513
kwargs.get('revision', None) or
514
kwargs.get('basis_branch', None) or
515
(len(args) and isinstance(args[0], basestring))):
516
# backwards compatibility api:
517
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
518
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
521
basis_branch = args[2]
523
basis_branch = kwargs.get('basis_branch', None)
525
basis = basis_branch.bzrdir
530
revision_id = args[1]
532
revision_id = kwargs.get('revision', None)
537
# no default to raise if not provided.
538
url = kwargs.get('to_location')
539
return self.bzrdir.clone(url,
540
revision_id=revision_id,
541
basis=basis).open_branch()
543
# generate args by hand
545
revision_id = args[1]
547
revision_id = kwargs.get('revision_id', None)
551
# no default to raise if not provided.
552
to_bzrdir = kwargs.get('to_bzrdir')
553
result = self._format.initialize(to_bzrdir)
554
self.copy_content_into(result, revision_id=revision_id)
558
def sprout(self, to_bzrdir, revision_id=None):
559
"""Create a new line of development from the branch, into to_bzrdir.
561
revision_id: if not None, the revision history in the new branch will
562
be truncated to end with revision_id.
564
result = self._format.initialize(to_bzrdir)
565
self.copy_content_into(result, revision_id=revision_id)
566
result.set_parent(self.bzrdir.root_transport.base)
569
def _synchronize_history(self, destination, revision_id):
570
"""Synchronize last revision and revision history between branches.
572
This version is most efficient when the destination is also a
573
BzrBranch5, but works for BzrBranch6 as long as the revision
574
history is the true lefthand parent history, and all of the revisions
575
are in the destination's repository. If not, set_revision_history
578
:param destination: The branch to copy the history into
579
:param revision_id: The revision-id to truncate history at. May
580
be None to copy complete history.
582
new_history = self.revision_history()
583
if revision_id is not None:
584
revision_id = osutils.safe_revision_id(revision_id)
586
new_history = new_history[:new_history.index(revision_id) + 1]
588
rev = self.repository.get_revision(revision_id)
589
new_history = rev.get_history(self.repository)[1:]
590
destination.set_revision_history(new_history)
593
def copy_content_into(self, destination, revision_id=None):
594
"""Copy the content of self into destination.
596
revision_id: if not None, the revision history in the new branch will
597
be truncated to end with revision_id.
599
self._synchronize_history(destination, revision_id)
601
parent = self.get_parent()
602
except errors.InaccessibleParent, e:
603
mutter('parent was not accessible to copy: %s', e)
606
destination.set_parent(parent)
610
"""Check consistency of the branch.
612
In particular this checks that revisions given in the revision-history
613
do actually match up in the revision graph, and that they're all
614
present in the repository.
616
Callers will typically also want to check the repository.
618
:return: A BranchCheckResult.
620
mainline_parent_id = None
621
for revision_id in self.revision_history():
623
revision = self.repository.get_revision(revision_id)
624
except errors.NoSuchRevision, e:
625
raise errors.BzrCheckError("mainline revision {%s} not in repository"
627
# In general the first entry on the revision history has no parents.
628
# But it's not illegal for it to have parents listed; this can happen
629
# in imports from Arch when the parents weren't reachable.
630
if mainline_parent_id is not None:
631
if mainline_parent_id not in revision.parent_ids:
632
raise errors.BzrCheckError("previous revision {%s} not listed among "
634
% (mainline_parent_id, revision_id))
635
mainline_parent_id = revision_id
636
return BranchCheckResult(self)
638
def _get_checkout_format(self):
639
"""Return the most suitable metadir for a checkout of this branch.
640
Weaves are used if this branch's repostory uses weaves.
642
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
643
from bzrlib.repofmt import weaverepo
644
format = bzrdir.BzrDirMetaFormat1()
645
format.repository_format = weaverepo.RepositoryFormat7()
647
format = self.repository.bzrdir.cloning_metadir()
648
format.branch_format = self._format
651
def create_checkout(self, to_location, revision_id=None,
653
"""Create a checkout of a branch.
655
:param to_location: The url to produce the checkout at
656
:param revision_id: The revision to check out
657
:param lightweight: If True, produce a lightweight checkout, otherwise,
658
produce a bound branch (heavyweight checkout)
659
:return: The tree of the created checkout
661
t = transport.get_transport(to_location)
664
except errors.FileExists:
667
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
668
BranchReferenceFormat().initialize(checkout, self)
670
format = self._get_checkout_format()
671
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
672
to_location, force_new_tree=False, format=format)
673
checkout = checkout_branch.bzrdir
674
checkout_branch.bind(self)
675
# pull up to the specified revision_id to set the initial
676
# branch tip correctly, and seed it with history.
677
checkout_branch.pull(self, stop_revision=revision_id)
678
return checkout.create_workingtree(revision_id)
681
class BranchFormat(object):
682
"""An encapsulation of the initialization and open routines for a format.
684
Formats provide three things:
685
* An initialization routine,
689
Formats are placed in an dict by their format string for reference
690
during branch opening. Its not required that these be instances, they
691
can be classes themselves with class methods - it simply depends on
692
whether state is needed for a given format or not.
694
Once a format is deprecated, just deprecate the initialize and open
695
methods on the format class. Do not deprecate the object, as the
696
object will be created every time regardless.
699
_default_format = None
700
"""The default format used for new branches."""
703
"""The known formats."""
706
def find_format(klass, a_bzrdir):
707
"""Return the format for the branch object in a_bzrdir."""
709
transport = a_bzrdir.get_branch_transport(None)
710
format_string = transport.get("format").read()
711
return klass._formats[format_string]
713
raise NotBranchError(path=transport.base)
715
raise errors.UnknownFormatError(format=format_string)
718
def get_default_format(klass):
719
"""Return the current default format."""
720
return klass._default_format
722
def get_format_string(self):
723
"""Return the ASCII format string that identifies this format."""
724
raise NotImplementedError(self.get_format_string)
726
def get_format_description(self):
727
"""Return the short format description for this format."""
728
raise NotImplementedError(self.get_format_description)
730
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
732
"""Initialize a branch in a bzrdir, with specified files
734
:param a_bzrdir: The bzrdir to initialize the branch in
735
:param utf8_files: The files to create as a list of
736
(filename, content) tuples
737
:param set_format: If True, set the format with
738
self.get_format_string. (BzrBranch4 has its format set
740
:return: a branch in this format
742
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
743
branch_transport = a_bzrdir.get_branch_transport(self)
745
'metadir': ('lock', lockdir.LockDir),
746
'branch4': ('branch-lock', lockable_files.TransportLock),
748
lock_name, lock_class = lock_map[lock_type]
749
control_files = lockable_files.LockableFiles(branch_transport,
750
lock_name, lock_class)
751
control_files.create_lock()
752
control_files.lock_write()
754
control_files.put_utf8('format', self.get_format_string())
756
for file, content in utf8_files:
757
control_files.put_utf8(file, content)
759
control_files.unlock()
760
return self.open(a_bzrdir, _found=True)
762
def initialize(self, a_bzrdir):
763
"""Create a branch of this format in a_bzrdir."""
764
raise NotImplementedError(self.initialize)
766
def is_supported(self):
767
"""Is this format supported?
769
Supported formats can be initialized and opened.
770
Unsupported formats may not support initialization or committing or
771
some other features depending on the reason for not being supported.
775
def open(self, a_bzrdir, _found=False):
776
"""Return the branch object for a_bzrdir
778
_found is a private parameter, do not use it. It is used to indicate
779
if format probing has already be done.
781
raise NotImplementedError(self.open)
784
def register_format(klass, format):
785
klass._formats[format.get_format_string()] = format
788
def set_default_format(klass, format):
789
klass._default_format = format
792
def unregister_format(klass, format):
793
assert klass._formats[format.get_format_string()] is format
794
del klass._formats[format.get_format_string()]
797
return self.get_format_string().rstrip()
800
class BranchHooks(dict):
801
"""A dictionary mapping hook name to a list of callables for branch hooks.
803
e.g. ['set_rh'] Is the list of items to be called when the
804
set_revision_history function is invoked.
808
"""Create the default hooks.
810
These are all empty initially, because by default nothing should get
814
# Introduced in 0.15:
815
# invoked whenever the revision history has been set
816
# with set_revision_history. The api signature is
817
# (branch, revision_history), and the branch will
820
# invoked after a push operation completes.
821
# the api signature is
822
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
823
# where local is the local branch or None, master is the target
824
# master branch, and the rest should be self explanatory. The source
825
# is read locked and the target branches write locked. Source will
826
# be the local low-latency branch.
827
self['post_push'] = []
828
# invoked after a pull operation completes.
829
# the api signature is
830
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
831
# where local is the local branch or None, master is the target
832
# master branch, and the rest should be self explanatory. The source
833
# is read locked and the target branches write locked. The local
834
# branch is the low-latency branch.
835
self['post_pull'] = []
836
# invoked after a commit operation completes.
837
# the api signature is
838
# (local, master, old_revno, old_revid, new_revno, new_revid)
839
# old_revid is NULL_REVISION for the first commit to a branch.
840
self['post_commit'] = []
841
# invoked after a uncommit operation completes.
842
# the api signature is
843
# (local, master, old_revno, old_revid, new_revno, new_revid) where
844
# local is the local branch or None, master is the target branch,
845
# and an empty branch recieves new_revno of 0, new_revid of None.
846
self['post_uncommit'] = []
848
def install_hook(self, hook_name, a_callable):
849
"""Install a_callable in to the hook hook_name.
851
:param hook_name: A hook name. See the __init__ method of BranchHooks
852
for the complete list of hooks.
853
:param a_callable: The callable to be invoked when the hook triggers.
854
The exact signature will depend on the hook - see the __init__
855
method of BranchHooks for details on each hook.
858
self[hook_name].append(a_callable)
860
raise errors.UnknownHook('branch', hook_name)
863
# install the default hooks into the Branch class.
864
Branch.hooks = BranchHooks()
867
class BzrBranchFormat4(BranchFormat):
868
"""Bzr branch format 4.
871
- a revision-history file.
872
- a branch-lock lock file [ to be shared with the bzrdir ]
875
def get_format_description(self):
876
"""See BranchFormat.get_format_description()."""
877
return "Branch format 4"
879
def initialize(self, a_bzrdir):
880
"""Create a branch of this format in a_bzrdir."""
881
utf8_files = [('revision-history', ''),
884
return self._initialize_helper(a_bzrdir, utf8_files,
885
lock_type='branch4', set_format=False)
888
super(BzrBranchFormat4, self).__init__()
889
self._matchingbzrdir = bzrdir.BzrDirFormat6()
891
def open(self, a_bzrdir, _found=False):
892
"""Return the branch object for a_bzrdir
894
_found is a private parameter, do not use it. It is used to indicate
895
if format probing has already be done.
898
# we are being called directly and must probe.
899
raise NotImplementedError
900
return BzrBranch(_format=self,
901
_control_files=a_bzrdir._control_files,
903
_repository=a_bzrdir.open_repository())
906
return "Bazaar-NG branch format 4"
909
class BzrBranchFormat5(BranchFormat):
910
"""Bzr branch format 5.
913
- a revision-history file.
915
- a lock dir guarding the branch itself
916
- all of this stored in a branch/ subdirectory
917
- works with shared repositories.
919
This format is new in bzr 0.8.
922
def get_format_string(self):
923
"""See BranchFormat.get_format_string()."""
924
return "Bazaar-NG branch format 5\n"
926
def get_format_description(self):
927
"""See BranchFormat.get_format_description()."""
928
return "Branch format 5"
930
def initialize(self, a_bzrdir):
931
"""Create a branch of this format in a_bzrdir."""
932
utf8_files = [('revision-history', ''),
935
return self._initialize_helper(a_bzrdir, utf8_files)
938
super(BzrBranchFormat5, self).__init__()
939
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
941
def open(self, a_bzrdir, _found=False):
942
"""Return the branch object for a_bzrdir
944
_found is a private parameter, do not use it. It is used to indicate
945
if format probing has already be done.
948
format = BranchFormat.find_format(a_bzrdir)
949
assert format.__class__ == self.__class__
950
transport = a_bzrdir.get_branch_transport(None)
951
control_files = lockable_files.LockableFiles(transport, 'lock',
953
return BzrBranch5(_format=self,
954
_control_files=control_files,
956
_repository=a_bzrdir.find_repository())
959
return "Bazaar-NG Metadir branch format 5"
962
class BzrBranchFormat6(BzrBranchFormat5):
963
"""Branch format with last-revision
965
Unlike previous formats, this has no explicit revision history. Instead,
966
this just stores the last-revision, and the left-hand history leading
967
up to there is the history.
969
This format was introduced in bzr 0.15
972
def get_format_string(self):
973
"""See BranchFormat.get_format_string()."""
974
return "Bazaar-NG branch format 6\n"
976
def get_format_description(self):
977
"""See BranchFormat.get_format_description()."""
978
return "Branch format 6"
980
def initialize(self, a_bzrdir):
981
"""Create a branch of this format in a_bzrdir."""
982
utf8_files = [('last-revision', '0 null:\n'),
986
return self._initialize_helper(a_bzrdir, utf8_files)
988
def open(self, a_bzrdir, _found=False):
989
"""Return the branch object for a_bzrdir
991
_found is a private parameter, do not use it. It is used to indicate
992
if format probing has already be done.
995
format = BranchFormat.find_format(a_bzrdir)
996
assert format.__class__ == self.__class__
997
transport = a_bzrdir.get_branch_transport(None)
998
control_files = lockable_files.LockableFiles(transport, 'lock',
1000
return BzrBranch6(_format=self,
1001
_control_files=control_files,
1003
_repository=a_bzrdir.find_repository())
1006
class BranchReferenceFormat(BranchFormat):
1007
"""Bzr branch reference format.
1009
Branch references are used in implementing checkouts, they
1010
act as an alias to the real branch which is at some other url.
1017
def get_format_string(self):
1018
"""See BranchFormat.get_format_string()."""
1019
return "Bazaar-NG Branch Reference Format 1\n"
1021
def get_format_description(self):
1022
"""See BranchFormat.get_format_description()."""
1023
return "Checkout reference format 1"
1025
def initialize(self, a_bzrdir, target_branch=None):
1026
"""Create a branch of this format in a_bzrdir."""
1027
if target_branch is None:
1028
# this format does not implement branch itself, thus the implicit
1029
# creation contract must see it as uninitializable
1030
raise errors.UninitializableFormat(self)
1031
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1032
branch_transport = a_bzrdir.get_branch_transport(self)
1033
branch_transport.put_bytes('location',
1034
target_branch.bzrdir.root_transport.base)
1035
branch_transport.put_bytes('format', self.get_format_string())
1036
return self.open(a_bzrdir, _found=True)
1039
super(BranchReferenceFormat, self).__init__()
1040
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1042
def _make_reference_clone_function(format, a_branch):
1043
"""Create a clone() routine for a branch dynamically."""
1044
def clone(to_bzrdir, revision_id=None):
1045
"""See Branch.clone()."""
1046
return format.initialize(to_bzrdir, a_branch)
1047
# cannot obey revision_id limits when cloning a reference ...
1048
# FIXME RBC 20060210 either nuke revision_id for clone, or
1049
# emit some sort of warning/error to the caller ?!
1052
def open(self, a_bzrdir, _found=False):
1053
"""Return the branch that the branch reference in a_bzrdir points at.
1055
_found is a private parameter, do not use it. It is used to indicate
1056
if format probing has already be done.
1059
format = BranchFormat.find_format(a_bzrdir)
1060
assert format.__class__ == self.__class__
1061
transport = a_bzrdir.get_branch_transport(None)
1062
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1063
result = real_bzrdir.open_branch()
1064
# this changes the behaviour of result.clone to create a new reference
1065
# rather than a copy of the content of the branch.
1066
# I did not use a proxy object because that needs much more extensive
1067
# testing, and we are only changing one behaviour at the moment.
1068
# If we decide to alter more behaviours - i.e. the implicit nickname
1069
# then this should be refactored to introduce a tested proxy branch
1070
# and a subclass of that for use in overriding clone() and ....
1072
result.clone = self._make_reference_clone_function(result)
1076
# formats which have no format string are not discoverable
1077
# and not independently creatable, so are not registered.
1078
__default_format = BzrBranchFormat5()
1079
BranchFormat.register_format(__default_format)
1080
BranchFormat.register_format(BranchReferenceFormat())
1081
BranchFormat.register_format(BzrBranchFormat6())
1082
BranchFormat.set_default_format(__default_format)
1083
_legacy_formats = [BzrBranchFormat4(),
1086
class BzrBranch(Branch):
1087
"""A branch stored in the actual filesystem.
1089
Note that it's "local" in the context of the filesystem; it doesn't
1090
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1091
it's writable, and can be accessed via the normal filesystem API.
1094
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1095
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1096
_control_files=None, a_bzrdir=None, _repository=None):
1097
"""Create new branch object at a particular location.
1099
transport -- A Transport object, defining how to access files.
1101
init -- If True, create new control files in a previously
1102
unversioned directory. If False, the branch must already
1105
relax_version_check -- If true, the usual check for the branch
1106
version is not applied. This is intended only for
1107
upgrade/recovery type use; it's not guaranteed that
1108
all operations will work on old format branches.
1110
if a_bzrdir is None:
1111
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1113
self.bzrdir = a_bzrdir
1114
self._transport = self.bzrdir.transport.clone('..')
1115
self._base = self._transport.base
1116
self._format = _format
1117
if _control_files is None:
1118
raise ValueError('BzrBranch _control_files is None')
1119
self.control_files = _control_files
1120
if deprecated_passed(init):
1121
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1122
"deprecated as of bzr 0.8. Please use Branch.create().",
1126
# this is slower than before deprecation, oh well never mind.
1127
# -> its deprecated.
1128
self._initialize(transport.base)
1129
self._check_format(_format)
1130
if deprecated_passed(relax_version_check):
1131
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1132
"relax_version_check parameter is deprecated as of bzr 0.8. "
1133
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1137
if (not relax_version_check
1138
and not self._format.is_supported()):
1139
raise errors.UnsupportedFormatError(format=fmt)
1140
if deprecated_passed(transport):
1141
warn("BzrBranch.__init__(transport=XXX...): The transport "
1142
"parameter is deprecated as of bzr 0.8. "
1143
"Please use Branch.open, or bzrdir.open_branch().",
1146
self.repository = _repository
1149
return '%s(%r)' % (self.__class__.__name__, self.base)
1153
def _get_base(self):
1156
base = property(_get_base, doc="The URL for the root of this branch.")
1158
def _finish_transaction(self):
1159
"""Exit the current transaction."""
1160
return self.control_files._finish_transaction()
1162
def get_transaction(self):
1163
"""Return the current active transaction.
1165
If no transaction is active, this returns a passthrough object
1166
for which all data is immediately flushed and no caching happens.
1168
# this is an explicit function so that we can do tricky stuff
1169
# when the storage in rev_storage is elsewhere.
1170
# we probably need to hook the two 'lock a location' and
1171
# 'have a transaction' together more delicately, so that
1172
# we can have two locks (branch and storage) and one transaction
1173
# ... and finishing the transaction unlocks both, but unlocking
1174
# does not. - RBC 20051121
1175
return self.control_files.get_transaction()
1177
def _set_transaction(self, transaction):
1178
"""Set a new active transaction."""
1179
return self.control_files._set_transaction(transaction)
1181
def abspath(self, name):
1182
"""See Branch.abspath."""
1183
return self.control_files._transport.abspath(name)
1185
def _check_format(self, format):
1186
"""Identify the branch format if needed.
1188
The format is stored as a reference to the format object in
1189
self._format for code that needs to check it later.
1191
The format parameter is either None or the branch format class
1192
used to open this branch.
1194
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1197
format = BranchFormat.find_format(self.bzrdir)
1198
self._format = format
1199
mutter("got branch format %s", self._format)
1202
def get_root_id(self):
1203
"""See Branch.get_root_id."""
1204
tree = self.repository.revision_tree(self.last_revision())
1205
return tree.inventory.root.file_id
1207
def is_locked(self):
1208
return self.control_files.is_locked()
1210
def lock_write(self):
1211
self.repository.lock_write()
1213
self.control_files.lock_write()
1215
self.repository.unlock()
1218
def lock_read(self):
1219
self.repository.lock_read()
1221
self.control_files.lock_read()
1223
self.repository.unlock()
1227
# TODO: test for failed two phase locks. This is known broken.
1229
self.control_files.unlock()
1231
self.repository.unlock()
1233
def peek_lock_mode(self):
1234
if self.control_files._lock_count == 0:
1237
return self.control_files._lock_mode
1239
def get_physical_lock_status(self):
1240
return self.control_files.get_physical_lock_status()
1243
def print_file(self, file, revision_id):
1244
"""See Branch.print_file."""
1245
return self.repository.print_file(file, revision_id)
1248
def append_revision(self, *revision_ids):
1249
"""See Branch.append_revision."""
1250
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1251
for revision_id in revision_ids:
1252
_mod_revision.check_not_reserved_id(revision_id)
1253
mutter("add {%s} to revision-history" % revision_id)
1254
rev_history = self.revision_history()
1255
rev_history.extend(revision_ids)
1256
self.set_revision_history(rev_history)
1258
def _write_revision_history(self, history):
1259
"""Factored out of set_revision_history.
1261
This performs the actual writing to disk.
1262
It is intended to be called by BzrBranch5.set_revision_history."""
1263
self.control_files.put_bytes(
1264
'revision-history', '\n'.join(history))
1267
def set_revision_history(self, rev_history):
1268
"""See Branch.set_revision_history."""
1269
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1270
self._write_revision_history(rev_history)
1271
transaction = self.get_transaction()
1272
history = transaction.map.find_revision_history()
1273
if history is not None:
1274
# update the revision history in the identity map.
1275
history[:] = list(rev_history)
1276
# this call is disabled because revision_history is
1277
# not really an object yet, and the transaction is for objects.
1278
# transaction.register_dirty(history)
1280
transaction.map.add_revision_history(rev_history)
1281
# this call is disabled because revision_history is
1282
# not really an object yet, and the transaction is for objects.
1283
# transaction.register_clean(history)
1284
for hook in Branch.hooks['set_rh']:
1285
hook(self, rev_history)
1288
def set_last_revision_info(self, revno, revision_id):
1289
revision_id = osutils.safe_revision_id(revision_id)
1290
history = self._lefthand_history(revision_id)
1291
assert len(history) == revno, '%d != %d' % (len(history), revno)
1292
self.set_revision_history(history)
1294
def _gen_revision_history(self):
1295
get_cached_utf8 = cache_utf8.get_cached_utf8
1296
history = [get_cached_utf8(l.rstrip('\r\n')) for l in
1297
self.control_files.get('revision-history').readlines()]
1301
def revision_history(self):
1302
"""See Branch.revision_history."""
1303
transaction = self.get_transaction()
1304
history = transaction.map.find_revision_history()
1305
if history is not None:
1306
# mutter("cache hit for revision-history in %s", self)
1307
return list(history)
1308
history = self._gen_revision_history()
1309
transaction.map.add_revision_history(history)
1310
# this call is disabled because revision_history is
1311
# not really an object yet, and the transaction is for objects.
1312
# transaction.register_clean(history, precious=True)
1313
return list(history)
1315
def _lefthand_history(self, revision_id, last_rev=None,
1317
# stop_revision must be a descendant of last_revision
1318
stop_graph = self.repository.get_revision_graph(revision_id)
1319
if last_rev is not None and last_rev not in stop_graph:
1320
# our previous tip is not merged into stop_revision
1321
raise errors.DivergedBranches(self, other_branch)
1322
# make a new revision history from the graph
1323
current_rev_id = revision_id
1325
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1326
new_history.append(current_rev_id)
1327
current_rev_id_parents = stop_graph[current_rev_id]
1329
current_rev_id = current_rev_id_parents[0]
1331
current_rev_id = None
1332
new_history.reverse()
1336
def generate_revision_history(self, revision_id, last_rev=None,
1338
"""Create a new revision history that will finish with revision_id.
1340
:param revision_id: the new tip to use.
1341
:param last_rev: The previous last_revision. If not None, then this
1342
must be a ancestory of revision_id, or DivergedBranches is raised.
1343
:param other_branch: The other branch that DivergedBranches should
1344
raise with respect to.
1346
revision_id = osutils.safe_revision_id(revision_id)
1347
self.set_revision_history(self._lefthand_history(revision_id,
1348
last_rev, other_branch))
1351
def update_revisions(self, other, stop_revision=None):
1352
"""See Branch.update_revisions."""
1355
if stop_revision is None:
1356
stop_revision = other.last_revision()
1357
if stop_revision is None:
1358
# if there are no commits, we're done.
1361
stop_revision = osutils.safe_revision_id(stop_revision)
1362
# whats the current last revision, before we fetch [and change it
1364
last_rev = self.last_revision()
1365
# we fetch here regardless of whether we need to so that we pickup
1367
self.fetch(other, stop_revision)
1368
my_ancestry = self.repository.get_ancestry(last_rev)
1369
if stop_revision in my_ancestry:
1370
# last_revision is a descendant of stop_revision
1372
self.generate_revision_history(stop_revision, last_rev=last_rev,
1377
def basis_tree(self):
1378
"""See Branch.basis_tree."""
1379
return self.repository.revision_tree(self.last_revision())
1381
@deprecated_method(zero_eight)
1382
def working_tree(self):
1383
"""Create a Working tree object for this branch."""
1385
from bzrlib.transport.local import LocalTransport
1386
if (self.base.find('://') != -1 or
1387
not isinstance(self._transport, LocalTransport)):
1388
raise NoWorkingTree(self.base)
1389
return self.bzrdir.open_workingtree()
1392
def pull(self, source, overwrite=False, stop_revision=None,
1393
_hook_master=None, _run_hooks=True):
1396
:param _hook_master: Private parameter - set the branch to
1397
be supplied as the master to push hooks.
1398
:param _run_hooks: Private parameter - allow disabling of
1399
hooks, used when pushing to a master branch.
1403
old_count, old_tip = self.last_revision_info()
1405
self.update_revisions(source, stop_revision)
1406
except DivergedBranches:
1410
self.set_revision_history(source.revision_history())
1411
new_count, new_tip = self.last_revision_info()
1418
for hook in Branch.hooks['post_pull']:
1419
hook(source, _hook_local, _hook_master, old_count, old_tip,
1421
return new_count - old_count
1425
def _get_parent_location(self):
1426
_locs = ['parent', 'pull', 'x-pull']
1429
return self.control_files.get(l).read().strip('\n')
1435
def push(self, target, overwrite=False, stop_revision=None,
1436
_hook_master=None, _run_hooks=True):
1439
:param _hook_master: Private parameter - set the branch to
1440
be supplied as the master to push hooks.
1441
:param _run_hooks: Private parameter - allow disabling of
1442
hooks, used when pushing to a master branch.
1446
old_count, old_tip = target.last_revision_info()
1448
target.update_revisions(self, stop_revision)
1449
except DivergedBranches:
1453
target.set_revision_history(self.revision_history())
1454
new_count, new_tip = target.last_revision_info()
1457
_hook_local = target
1459
_hook_master = target
1461
for hook in Branch.hooks['post_push']:
1462
hook(self, _hook_local, _hook_master, old_count, old_tip,
1464
return new_count - old_count
1468
def get_parent(self):
1469
"""See Branch.get_parent."""
1471
assert self.base[-1] == '/'
1472
parent = self._get_parent_location()
1475
# This is an old-format absolute path to a local branch
1476
# turn it into a url
1477
if parent.startswith('/'):
1478
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1480
return urlutils.join(self.base[:-1], parent)
1481
except errors.InvalidURLJoin, e:
1482
raise errors.InaccessibleParent(parent, self.base)
1484
def get_push_location(self):
1485
"""See Branch.get_push_location."""
1486
push_loc = self.get_config().get_user_option('push_location')
1489
def set_push_location(self, location):
1490
"""See Branch.set_push_location."""
1491
self.get_config().set_user_option(
1492
'push_location', location,
1493
store=_mod_config.STORE_LOCATION_NORECURSE)
1496
def set_parent(self, url):
1497
"""See Branch.set_parent."""
1498
# TODO: Maybe delete old location files?
1499
# URLs should never be unicode, even on the local fs,
1500
# FIXUP this and get_parent in a future branch format bump:
1501
# read and rewrite the file, and have the new format code read
1502
# using .get not .get_utf8. RBC 20060125
1504
if isinstance(url, unicode):
1506
url = url.encode('ascii')
1507
except UnicodeEncodeError:
1508
raise bzrlib.errors.InvalidURL(url,
1509
"Urls must be 7-bit ascii, "
1510
"use bzrlib.urlutils.escape")
1511
url = urlutils.relative_url(self.base, url)
1512
self._set_parent_location(url)
1514
def _set_parent_location(self, url):
1516
self.control_files._transport.delete('parent')
1518
assert isinstance(url, str)
1519
self.control_files.put_bytes('parent', url + '\n')
1521
@deprecated_function(zero_nine)
1522
def tree_config(self):
1523
"""DEPRECATED; call get_config instead.
1524
TreeConfig has become part of BranchConfig."""
1525
return TreeConfig(self)
1528
class BzrBranch5(BzrBranch):
1529
"""A format 5 branch. This supports new features over plan branches.
1531
It has support for a master_branch which is the data for bound branches.
1539
super(BzrBranch5, self).__init__(_format=_format,
1540
_control_files=_control_files,
1542
_repository=_repository)
1545
def pull(self, source, overwrite=False, stop_revision=None,
1547
"""Extends branch.pull to be bound branch aware.
1549
:param _run_hooks: Private parameter used to force hook running
1550
off during bound branch double-pushing.
1552
bound_location = self.get_bound_location()
1553
master_branch = None
1554
if bound_location and source.base != bound_location:
1555
# not pulling from master, so we need to update master.
1556
master_branch = self.get_master_branch()
1557
master_branch.lock_write()
1560
# pull from source into master.
1561
master_branch.pull(source, overwrite, stop_revision,
1563
return super(BzrBranch5, self).pull(source, overwrite,
1564
stop_revision, _hook_master=master_branch,
1565
_run_hooks=_run_hooks)
1568
master_branch.unlock()
1571
def push(self, target, overwrite=False, stop_revision=None):
1572
"""Updates branch.push to be bound branch aware."""
1573
bound_location = target.get_bound_location()
1574
master_branch = None
1575
if bound_location and target.base != bound_location:
1576
# not pushing to master, so we need to update master.
1577
master_branch = target.get_master_branch()
1578
master_branch.lock_write()
1581
# push into the master from this branch.
1582
super(BzrBranch5, self).push(master_branch, overwrite,
1583
stop_revision, _run_hooks=False)
1584
# and push into the target branch from this. Note that we push from
1585
# this branch again, because its considered the highest bandwidth
1587
return super(BzrBranch5, self).push(target, overwrite,
1588
stop_revision, _hook_master=master_branch)
1591
master_branch.unlock()
1593
def get_bound_location(self):
1595
return self.control_files.get_utf8('bound').read()[:-1]
1596
except errors.NoSuchFile:
1600
def get_master_branch(self):
1601
"""Return the branch we are bound to.
1603
:return: Either a Branch, or None
1605
This could memoise the branch, but if thats done
1606
it must be revalidated on each new lock.
1607
So for now we just don't memoise it.
1608
# RBC 20060304 review this decision.
1610
bound_loc = self.get_bound_location()
1614
return Branch.open(bound_loc)
1615
except (errors.NotBranchError, errors.ConnectionError), e:
1616
raise errors.BoundBranchConnectionFailure(
1620
def set_bound_location(self, location):
1621
"""Set the target where this branch is bound to.
1623
:param location: URL to the target branch
1626
self.control_files.put_utf8('bound', location+'\n')
1629
self.control_files._transport.delete('bound')
1635
def bind(self, other):
1636
"""Bind this branch to the branch other.
1638
This does not push or pull data between the branches, though it does
1639
check for divergence to raise an error when the branches are not
1640
either the same, or one a prefix of the other. That behaviour may not
1641
be useful, so that check may be removed in future.
1643
:param other: The branch to bind to
1646
# TODO: jam 20051230 Consider checking if the target is bound
1647
# It is debatable whether you should be able to bind to
1648
# a branch which is itself bound.
1649
# Committing is obviously forbidden,
1650
# but binding itself may not be.
1651
# Since we *have* to check at commit time, we don't
1652
# *need* to check here
1654
# we want to raise diverged if:
1655
# last_rev is not in the other_last_rev history, AND
1656
# other_last_rev is not in our history, and do it without pulling
1658
last_rev = self.last_revision()
1659
if last_rev is not None:
1662
other_last_rev = other.last_revision()
1663
if other_last_rev is not None:
1664
# neither branch is new, we have to do some work to
1665
# ascertain diversion.
1666
remote_graph = other.repository.get_revision_graph(
1668
local_graph = self.repository.get_revision_graph(last_rev)
1669
if (last_rev not in remote_graph and
1670
other_last_rev not in local_graph):
1671
raise errors.DivergedBranches(self, other)
1674
self.set_bound_location(other.base)
1678
"""If bound, unbind"""
1679
return self.set_bound_location(None)
1683
"""Synchronise this branch with the master branch if any.
1685
:return: None or the last_revision that was pivoted out during the
1688
master = self.get_master_branch()
1689
if master is not None:
1690
old_tip = self.last_revision()
1691
self.pull(master, overwrite=True)
1692
if old_tip in self.repository.get_ancestry(self.last_revision()):
1698
class BzrBranch6(BzrBranch5):
1701
def last_revision_info(self):
1702
revision_string = self.control_files.get('last-revision').read()
1703
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1704
revision_id = cache_utf8.get_cached_utf8(revision_id)
1706
return revno, revision_id
1708
def last_revision(self):
1709
"""Return last revision id, or None"""
1710
revision_id = self.last_revision_info()[1]
1711
if revision_id == _mod_revision.NULL_REVISION:
1715
def _write_last_revision_info(self, revno, revision_id):
1716
"""Simply write out the revision id, with no checks.
1718
Use set_last_revision_info to perform this safely.
1720
Does not update the revision_history cache.
1721
Intended to be called by set_last_revision_info and
1722
_write_revision_history.
1724
if revision_id is None:
1725
revision_id = 'null:'
1726
out_string = '%d %s\n' % (revno, revision_id)
1727
self.control_files.put_bytes('last-revision', out_string)
1730
def set_last_revision_info(self, revno, revision_id):
1731
revision_id = osutils.safe_revision_id(revision_id)
1732
if self._get_append_revisions_only():
1733
self._check_history_violation(revision_id)
1734
self._write_last_revision_info(revno, revision_id)
1735
transaction = self.get_transaction()
1736
cached_history = transaction.map.find_revision_history()
1737
if cached_history is not None:
1738
transaction.map.remove_object(cached_history)
1740
def _check_history_violation(self, revision_id):
1741
last_revision = self.last_revision()
1742
if last_revision is None:
1744
if last_revision not in self._lefthand_history(revision_id):
1745
raise errors.AppendRevisionsOnlyViolation(self.base)
1747
def _gen_revision_history(self):
1748
"""Generate the revision history from last revision
1750
history = list(self.repository.iter_reverse_revision_history(
1751
self.last_revision()))
1755
def _write_revision_history(self, history):
1756
"""Factored out of set_revision_history.
1758
This performs the actual writing to disk, with format-specific checks.
1759
It is intended to be called by BzrBranch5.set_revision_history.
1761
if len(history) == 0:
1762
last_revision = 'null:'
1764
if history != self._lefthand_history(history[-1]):
1765
raise errors.NotLefthandHistory(history)
1766
last_revision = history[-1]
1767
if self._get_append_revisions_only():
1768
self._check_history_violation(last_revision)
1769
self._write_last_revision_info(len(history), last_revision)
1772
def append_revision(self, *revision_ids):
1773
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1774
if len(revision_ids) == 0:
1776
prev_revno, prev_revision = self.last_revision_info()
1777
for revision in self.repository.get_revisions(revision_ids):
1778
if prev_revision == _mod_revision.NULL_REVISION:
1779
if revision.parent_ids != []:
1780
raise errors.NotLeftParentDescendant(self, prev_revision,
1781
revision.revision_id)
1783
if revision.parent_ids[0] != prev_revision:
1784
raise errors.NotLeftParentDescendant(self, prev_revision,
1785
revision.revision_id)
1786
prev_revision = revision.revision_id
1787
self.set_last_revision_info(prev_revno + len(revision_ids),
1790
def _set_config_location(self, name, url, config=None,
1791
make_relative=False):
1793
config = self.get_config()
1797
url = urlutils.relative_url(self.base, url)
1798
config.set_user_option(name, url)
1801
def _get_config_location(self, name, config=None):
1803
config = self.get_config()
1804
location = config.get_user_option(name)
1810
def _set_parent_location(self, url):
1811
"""Set the parent branch"""
1812
self._set_config_location('parent_location', url, make_relative=True)
1815
def _get_parent_location(self):
1816
"""Set the parent branch"""
1817
return self._get_config_location('parent_location')
1819
def set_push_location(self, location):
1820
"""See Branch.set_push_location."""
1821
self._set_config_location('push_location', location)
1823
def set_bound_location(self, location):
1824
"""See Branch.set_push_location."""
1826
config = self.get_config()
1827
if location is None:
1828
if config.get_user_option('bound') != 'True':
1831
config.set_user_option('bound', 'False')
1834
self._set_config_location('bound_location', location,
1836
config.set_user_option('bound', 'True')
1839
def _get_bound_location(self, bound):
1840
"""Return the bound location in the config file.
1842
Return None if the bound parameter does not match"""
1843
config = self.get_config()
1844
config_bound = (config.get_user_option('bound') == 'True')
1845
if config_bound != bound:
1847
return self._get_config_location('bound_location', config=config)
1849
def get_bound_location(self):
1850
"""See Branch.set_push_location."""
1851
return self._get_bound_location(True)
1853
def get_old_bound_location(self):
1854
"""See Branch.get_old_bound_location"""
1855
return self._get_bound_location(False)
1857
def set_append_revisions_only(self, enabled):
1862
self.get_config().set_user_option('append_revisions_only', value)
1864
def _get_append_revisions_only(self):
1865
value = self.get_config().get_user_option('append_revisions_only')
1866
return value == 'True'
1868
def _synchronize_history(self, destination, revision_id):
1869
"""Synchronize last revision and revision history between branches.
1871
This version is most efficient when the destination is also a
1872
BzrBranch6, but works for BzrBranch5, as long as the destination's
1873
repository contains all the lefthand ancestors of the intended
1874
last_revision. If not, set_last_revision_info will fail.
1876
:param destination: The branch to copy the history into
1877
:param revision_id: The revision-id to truncate history at. May
1878
be None to copy complete history.
1880
if revision_id is None:
1881
revno, revision_id = self.last_revision_info()
1883
revno = self.revision_id_to_revno(revision_id)
1884
destination.set_last_revision_info(revno, revision_id)
1887
class BranchTestProviderAdapter(object):
1888
"""A tool to generate a suite testing multiple branch formats at once.
1890
This is done by copying the test once for each transport and injecting
1891
the transport_server, transport_readonly_server, and branch_format
1892
classes into each copy. Each copy is also given a new id() to make it
1896
def __init__(self, transport_server, transport_readonly_server, formats):
1897
self._transport_server = transport_server
1898
self._transport_readonly_server = transport_readonly_server
1899
self._formats = formats
1901
def adapt(self, test):
1902
result = TestSuite()
1903
for branch_format, bzrdir_format in self._formats:
1904
new_test = deepcopy(test)
1905
new_test.transport_server = self._transport_server
1906
new_test.transport_readonly_server = self._transport_readonly_server
1907
new_test.bzrdir_format = bzrdir_format
1908
new_test.branch_format = branch_format
1909
def make_new_test_id():
1910
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1911
return lambda: new_id
1912
new_test.id = make_new_test_id()
1913
result.addTest(new_test)
1917
class BranchCheckResult(object):
1918
"""Results of checking branch consistency.
1923
def __init__(self, branch):
1924
self.branch = branch
1926
def report_results(self, verbose):
1927
"""Report the check results via trace.note.
1929
:param verbose: Requests more detailed display of what was checked,
1932
note('checked branch %s format %s',
1934
self.branch._format)
762
1937
######################################################################
766
def is_control_file(filename):
767
## FIXME: better check
768
filename = os.path.normpath(filename)
769
while filename != '':
770
head, tail = os.path.split(filename)
771
## mutter('check %r for control file' % ((head, tail), ))
772
if tail == bzrlib.BZRDIR:
781
def gen_file_id(name):
782
"""Return new file id.
784
This should probably generate proper UUIDs, but for the moment we
785
cope with just randomness because running uuidgen every time is
790
idx = name.rfind('/')
792
name = name[idx+1 : ]
793
idx = name.rfind('\\')
795
name = name[idx+1 : ]
797
# make it not a hidden file
798
name = name.lstrip('.')
800
# remove any wierd characters; we don't escape them but rather
802
name = re.sub(r'[^\w.]', '', name)
804
s = hexlify(rand_bytes(8))
805
return '-'.join((name, compact_date(time.time()), s))
1941
@deprecated_function(zero_eight)
1942
def is_control_file(*args, **kwargs):
1943
"""See bzrlib.workingtree.is_control_file."""
1944
from bzrlib import workingtree
1945
return workingtree.is_control_file(*args, **kwargs)
1948
class Converter5to6(object):
1949
"""Perform an in-place upgrade of format 5 to format 6"""
1951
def convert(self, branch):
1952
# Data for 5 and 6 can peacefully coexist.
1953
format = BzrBranchFormat6()
1954
new_branch = format.open(branch.bzrdir, _found=True)
1956
# Copy source data into target
1957
new_branch.set_last_revision_info(*branch.last_revision_info())
1958
new_branch.set_parent(branch.get_parent())
1959
new_branch.set_bound_location(branch.get_bound_location())
1960
new_branch.set_push_location(branch.get_push_location())
1962
# Copying done; now update target format
1963
new_branch.control_files.put_utf8('format',
1964
format.get_format_string())
1966
# Clean up old files
1967
new_branch.control_files._transport.delete('revision-history')
1969
branch.set_parent(None)
1972
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
