1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
import traceback, socket, fnmatch, difflib, time
22
from binascii import hexlify
18
from copy import deepcopy
19
from cStringIO import StringIO
20
from unittest import TestSuite
21
from warnings import warn
25
from inventory import Inventory
26
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree
28
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset, appendpath
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout, BzrError
35
from textui import show_status
37
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
38
## TODO: Maybe include checks for common corruption of newlines, etc?
42
def find_branch(f, **args):
43
if f and (f.startswith('http://') or f.startswith('https://')):
45
return remotebranch.RemoteBranch(f, **args)
47
return Branch(f, **args)
50
def find_branch_root(f=None):
51
"""Find the branch root enclosing f, or pwd.
53
f may be a filename or a URL.
55
It is not necessary that f exists.
57
Basically we keep looking up until we find the control directory or
61
elif hasattr(os.path, 'realpath'):
62
f = os.path.realpath(f)
64
f = os.path.abspath(f)
65
if not os.path.exists(f):
66
raise BzrError('%r does not exist' % f)
72
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
74
head, tail = os.path.split(f)
76
# reached the root, whatever that may be
77
raise BzrError('%r is not in a branch' % orig_f)
36
from bzrlib.config import TreeConfig
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
40
HistoryMissing, InvalidRevisionId,
41
InvalidRevisionNumber, LockError, NoSuchFile,
42
NoSuchRevision, NoWorkingTree, NotVersionedError,
43
NotBranchError, UninitializableFormat,
44
UnlistableStore, UnlistableBranch,
46
from bzrlib.lockable_files import LockableFiles, TransportLock
47
from bzrlib.symbol_versioning import (deprecated_function,
51
zero_eight, zero_nine,
53
from bzrlib.trace import mutter, note
56
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
57
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
58
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
61
# TODO: Maybe include checks for common corruption of newlines, etc?
63
# TODO: Some operations like log might retrieve the same revisions
64
# repeatedly to calculate deltas. We could perhaps have a weakref
65
# cache in memory to make this faster. In general anything can be
66
# cached in memory between lock and unlock operations. .. nb thats
67
# what the transaction identity map provides
82
70
######################################################################
86
74
"""Branch holding a history of revisions.
89
Base directory of the branch.
77
Base directory/url of the branch.
93
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
94
"""Create new branch object at a particular location.
96
base -- Base directory for the branch.
98
init -- If True, create new control files in a previously
99
unversioned directory. If False, the branch must already
102
find_root -- If true and init is false, find the root of the
103
existing branch containing base.
105
In the test suite, creation of new trees is tested using the
106
`ScratchBranch` class.
109
self.base = os.path.realpath(base)
112
self.base = find_branch_root(base)
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
def setup_caching(self, cache_root):
142
"""Subclasses that care about caching should override this, and set
143
up cached stores located under cache_root.
145
# seems to be unused, 2006-01-13 mbp
146
warn('%s is deprecated' % self.setup_caching)
147
self.cache_root = cache_root
149
def get_config(self):
150
return bzrlib.config.BranchConfig(self)
153
return self.get_config().get_nickname()
155
def _set_nick(self, nick):
156
self.get_config().set_user_option('nickname', nick)
158
nick = property(_get_nick, _set_nick)
161
raise NotImplementedError('is_locked is abstract')
163
def lock_write(self):
164
raise NotImplementedError('lock_write is abstract')
167
raise NotImplementedError('lock_read is abstract')
170
raise NotImplementedError('unlock is abstract')
172
def peek_lock_mode(self):
173
"""Return lock mode for the Branch: 'r', 'w' or None"""
174
raise NotImplementedError(self.peek_lock_mode)
176
def get_physical_lock_status(self):
177
raise NotImplementedError('get_physical_lock_status is abstract')
179
def abspath(self, name):
180
"""Return absolute filename for something in the branch
182
XXX: Robert Collins 20051017 what is this used for? why is it a branch
183
method and not a tree method.
185
raise NotImplementedError('abspath is abstract')
187
def bind(self, other):
188
"""Bind the local branch the other branch.
190
:param other: The branch to bind to
193
raise errors.UpgradeRequired(self.base)
196
def fetch(self, from_branch, last_revision=None, pb=None):
197
"""Copy revisions from from_branch into this branch.
199
:param from_branch: Where to copy from.
200
:param last_revision: What revision to stop at (None for at the end
202
:param pb: An optional progress bar to use.
204
Returns the copied revision count and the failed revisions in a tuple:
207
if self.base == from_branch.base:
210
nested_pb = ui.ui_factory.nested_progress_bar()
114
self.base = os.path.realpath(base)
115
if not isdir(self.controlfilename('.')):
116
bailout("not a bzr branch: %s" % quotefn(base),
117
['use "bzr init" to initialize a new working tree',
118
'current bzr can only operate from top-of-tree'])
122
self.text_store = ImmutableStore(self.controlfilename('text-store'))
123
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
124
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
128
return '%s(%r)' % (self.__class__.__name__, self.base)
135
def lock(self, mode='w'):
136
"""Lock the on-disk branch, excluding other processes."""
215
from_branch.lock_read()
142
om = os.O_WRONLY | os.O_CREAT
147
raise BzrError("invalid locking mode %r" % mode)
150
lockfile = os.open(self.controlfilename('branch-lock'), om)
152
if e.errno == errno.ENOENT:
153
# might not exist on branches from <0.0.4
154
self.controlfile('branch-lock', 'w').close()
155
lockfile = os.open(self.controlfilename('branch-lock'), om)
217
if last_revision is None:
218
pb.update('get source history')
219
from_history = from_branch.revision_history()
221
last_revision = from_history[-1]
159
fcntl.lockf(lockfile, lm)
161
fcntl.lockf(lockfile, fcntl.LOCK_UN)
163
self._lockmode = None
165
self._lockmode = mode
167
warning("please write a locking method for platform %r" % sys.platform)
169
self._lockmode = None
171
self._lockmode = mode
174
def _need_readlock(self):
175
if self._lockmode not in ['r', 'w']:
176
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
178
def _need_writelock(self):
179
if self._lockmode not in ['w']:
180
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
183
def abspath(self, name):
184
"""Return absolute filename for something in the branch"""
185
return os.path.join(self.base, name)
188
def relpath(self, path):
189
"""Return path relative to this branch of something inside it.
191
Raises an error if path is not in this branch."""
192
rp = os.path.realpath(path)
194
if not rp.startswith(self.base):
195
bailout("path %r is not within branch %r" % (rp, self.base))
196
rp = rp[len(self.base):]
197
rp = rp.lstrip(os.sep)
201
def controlfilename(self, file_or_path):
202
"""Return location relative to branch."""
203
if isinstance(file_or_path, types.StringTypes):
204
file_or_path = [file_or_path]
205
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
208
def controlfile(self, file_or_path, mode='r'):
209
"""Open a control file for this branch.
211
There are two classes of file in the control directory: text
212
and binary. binary files are untranslated byte streams. Text
213
control files are stored with Unix newlines and in UTF-8, even
214
if the platform or locale defaults are different.
216
Controlfiles should almost never be opened in write mode but
217
rather should be atomically copied and replaced using atomicfile.
220
fn = self.controlfilename(file_or_path)
222
if mode == 'rb' or mode == 'wb':
223
return file(fn, mode)
224
elif mode == 'r' or mode == 'w':
225
# open in binary mode anyhow so there's no newline translation;
226
# codecs uses line buffering by default; don't want that.
228
return codecs.open(fn, mode + 'b', 'utf-8',
231
raise BzrError("invalid controlfile mode %r" % mode)
235
def _make_control(self):
236
os.mkdir(self.controlfilename([]))
237
self.controlfile('README', 'w').write(
238
"This is a Bazaar-NG control directory.\n"
239
"Do not change any files in this directory.")
240
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
241
for d in ('text-store', 'inventory-store', 'revision-store'):
242
os.mkdir(self.controlfilename(d))
243
for f in ('revision-history', 'merged-patches',
244
'pending-merged-patches', 'branch-name',
246
self.controlfile(f, 'w').write('')
247
mutter('created control directory in ' + self.base)
248
Inventory().write_xml(self.controlfile('inventory','w'))
251
def _check_format(self):
252
"""Check this branch format is supported.
254
The current tool only supports the current unstable format.
256
In the future, we might need different in-memory Branch
257
classes to support downlevel branches. But not yet.
259
# This ignores newlines so that we can open branches created
260
# on Windows from Linux and so on. I think it might be better
261
# to always make all internal files in unix format.
262
fmt = self.controlfile('branch-format', 'r').read()
263
fmt.replace('\r\n', '')
264
if fmt != BZR_BRANCH_FORMAT:
265
bailout('sorry, branch format %r not supported' % fmt,
266
['use a different bzr version',
267
'or remove the .bzr directory and "bzr init" again'])
270
def read_working_inventory(self):
271
"""Read the working inventory."""
272
self._need_readlock()
274
# ElementTree does its own conversion from UTF-8, so open in
276
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
277
mutter("loaded inventory of %d items in %f"
278
% (len(inv), time.time() - before))
282
def _write_inventory(self, inv):
283
"""Update the working inventory.
285
That is to say, the inventory describing changes underway, that
286
will be committed to the next revision.
288
self._need_writelock()
289
## TODO: factor out to atomicfile? is rename safe on windows?
290
## TODO: Maybe some kind of clean/dirty marker on inventory?
291
tmpfname = self.controlfilename('inventory.tmp')
292
tmpf = file(tmpfname, 'wb')
295
inv_fname = self.controlfilename('inventory')
296
if sys.platform == 'win32':
298
os.rename(tmpfname, inv_fname)
299
mutter('wrote working inventory')
302
inventory = property(read_working_inventory, _write_inventory, None,
303
"""Inventory for the working copy.""")
306
def add(self, files, verbose=False):
307
"""Make files versioned.
309
Note that the command line normally calls smart_add instead.
311
This puts the files in the Added state, so that they will be
312
recorded by the next commit.
314
TODO: Perhaps have an option to add the ids even if the files do
317
TODO: Perhaps return the ids of the files? But then again it
318
is easy to retrieve them if they're needed.
320
TODO: Option to specify file id.
322
TODO: Adding a directory should optionally recurse down and
323
add all non-ignored children. Perhaps do that in a
326
self._need_writelock()
328
# TODO: Re-adding a file that is removed in the working copy
329
# should probably put it back with the previous ID.
330
if isinstance(files, types.StringTypes):
333
inv = self.read_working_inventory()
335
if is_control_file(f):
336
bailout("cannot add control file %s" % quotefn(f))
341
bailout("cannot add top-level %r" % f)
343
fullpath = os.path.normpath(self.abspath(f))
346
kind = file_kind(fullpath)
348
# maybe something better?
349
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
351
if kind != 'file' and kind != 'directory':
352
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
354
file_id = gen_file_id(f)
355
inv.add_path(f, kind=kind, file_id=file_id)
358
show_status('A', kind, quotefn(f))
360
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
362
self._write_inventory(inv)
365
def print_file(self, file, revno):
223
# no history in the source branch
224
last_revision = revision.NULL_REVISION
225
return self.repository.fetch(from_branch.repository,
226
revision_id=last_revision,
229
if nested_pb is not None:
233
def get_bound_location(self):
234
"""Return the URL of the branch we are bound to.
236
Older format branches cannot bind, please be sure to use a metadir
241
def get_commit_builder(self, parents, config=None, timestamp=None,
242
timezone=None, committer=None, revprops=None,
244
"""Obtain a CommitBuilder for this branch.
246
:param parents: Revision ids of the parents of the new revision.
247
:param config: Optional configuration to use.
248
:param timestamp: Optional timestamp recorded for commit.
249
:param timezone: Optional timezone for timestamp.
250
:param committer: Optional committer to set for commit.
251
:param revprops: Optional dictionary of revision properties.
252
:param revision_id: Optional revision id.
256
config = self.get_config()
258
return self.repository.get_commit_builder(self, parents, config,
259
timestamp, timezone, committer, revprops, revision_id)
261
def get_master_branch(self):
262
"""Return the branch we are bound to.
264
:return: Either a Branch, or None
268
def get_revision_delta(self, revno):
269
"""Return the delta for one revision.
271
The delta is relative to its mainline predecessor, or the
272
empty tree for revision 1.
274
assert isinstance(revno, int)
275
rh = self.revision_history()
276
if not (1 <= revno <= len(rh)):
277
raise InvalidRevisionNumber(revno)
278
return self.repository.get_revision_delta(rh[revno-1])
280
def get_root_id(self):
281
"""Return the id of this branches root"""
282
raise NotImplementedError('get_root_id is abstract')
284
def print_file(self, file, revision_id):
366
285
"""Print `file` to stdout."""
367
self._need_readlock()
368
tree = self.revision_tree(self.lookup_revision(revno))
369
# use inventory as it was in that revision
370
file_id = tree.inventory.path2id(file)
372
bailout("%r is not present in revision %d" % (file, revno))
373
tree.print_file(file_id)
376
def remove(self, files, verbose=False):
377
"""Mark nominated files for removal from the inventory.
379
This does not remove their text. This does not run on
381
TODO: Refuse to remove modified files unless --force is given?
383
TODO: Do something useful with directories.
385
TODO: Should this remove the text or not? Tough call; not
386
removing may be useful and the user can just use use rm, and
387
is the opposite of add. Removing it is consistent with most
388
other tools. Maybe an option.
390
## TODO: Normalize names
391
## TODO: Remove nested loops; better scalability
392
self._need_writelock()
394
if isinstance(files, types.StringTypes):
397
tree = self.working_tree()
400
# do this before any modifications
404
bailout("cannot remove unversioned file %s" % quotefn(f))
405
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
407
# having remove it, it must be either ignored or unknown
408
if tree.is_ignored(f):
412
show_status(new_status, inv[fid].kind, quotefn(f))
415
self._write_inventory(inv)
419
"""Return all unknown files.
421
These are files in the working directory that are not versioned or
422
control files or ignored.
424
>>> b = ScratchBranch(files=['foo', 'foo~'])
425
>>> list(b.unknowns())
428
>>> list(b.unknowns())
431
>>> list(b.unknowns())
434
return self.working_tree().unknowns()
437
def append_revision(self, revision_id):
438
mutter("add {%s} to revision-history" % revision_id)
439
rev_history = self.revision_history()
441
tmprhname = self.controlfilename('revision-history.tmp')
442
rhname = self.controlfilename('revision-history')
444
f = file(tmprhname, 'wt')
445
rev_history.append(revision_id)
446
f.write('\n'.join(rev_history))
450
if sys.platform == 'win32':
452
os.rename(tmprhname, rhname)
456
def get_revision(self, revision_id):
457
"""Return the Revision object for a named revision"""
458
self._need_readlock()
459
r = Revision.read_xml(self.revision_store[revision_id])
460
assert r.revision_id == revision_id
464
def get_inventory(self, inventory_id):
465
"""Get Inventory object by hash.
467
TODO: Perhaps for this and similar methods, take a revision
468
parameter which can be either an integer revno or a
470
self._need_readlock()
471
i = Inventory.read_xml(self.inventory_store[inventory_id])
475
def get_revision_inventory(self, revision_id):
476
"""Return inventory of a past revision."""
477
self._need_readlock()
478
if revision_id == None:
481
return self.get_inventory(self.get_revision(revision_id).inventory_id)
286
raise NotImplementedError('print_file is abstract')
288
def append_revision(self, *revision_ids):
289
raise NotImplementedError('append_revision is abstract')
291
def set_revision_history(self, rev_history):
292
raise NotImplementedError('set_revision_history is abstract')
484
294
def revision_history(self):
485
"""Return sequence of revision hashes on to this branch.
487
>>> ScratchBranch().revision_history()
490
self._need_readlock()
491
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
494
def enum_history(self, direction):
495
"""Return (revno, revision_id) for history of branch.
498
'forward' is from earliest to latest
499
'reverse' is from latest to earliest
501
rh = self.revision_history()
502
if direction == 'forward':
507
elif direction == 'reverse':
513
raise BzrError('invalid history direction %r' % direction)
295
"""Return sequence of revision hashes on to this branch."""
296
raise NotImplementedError('revision_history is abstract')
517
299
"""Return current revision number for this branch.
642
392
Note that to_name is only the last component of the new name;
643
393
this doesn't change the directory.
645
self._need_writelock()
646
## TODO: Option to move IDs only
647
assert not isinstance(from_paths, basestring)
648
tree = self.working_tree()
650
to_abs = self.abspath(to_name)
651
if not isdir(to_abs):
652
bailout("destination %r is not a directory" % to_abs)
653
if not tree.has_filename(to_name):
654
bailout("destination %r not in working directory" % to_abs)
655
to_dir_id = inv.path2id(to_name)
656
if to_dir_id == None and to_name != '':
657
bailout("destination %r is not a versioned directory" % to_name)
658
to_dir_ie = inv[to_dir_id]
659
if to_dir_ie.kind not in ('directory', 'root_directory'):
660
bailout("destination %r is not a directory" % to_abs)
662
to_idpath = Set(inv.get_idpath(to_dir_id))
665
if not tree.has_filename(f):
666
bailout("%r does not exist in working tree" % f)
667
f_id = inv.path2id(f)
669
bailout("%r is not versioned" % f)
670
name_tail = splitpath(f)[-1]
671
dest_path = appendpath(to_name, name_tail)
672
if tree.has_filename(dest_path):
673
bailout("destination %r already exists" % dest_path)
674
if f_id in to_idpath:
675
bailout("can't move %r to a subdirectory of itself" % f)
677
# OK, so there's a race here, it's possible that someone will
678
# create a file in this interval and then the rename might be
679
# left half-done. But we should have caught most problems.
682
name_tail = splitpath(f)[-1]
683
dest_path = appendpath(to_name, name_tail)
684
print "%s => %s" % (f, dest_path)
685
inv.rename(inv.path2id(f), to_dir_id, name_tail)
687
os.rename(self.abspath(f), self.abspath(dest_path))
689
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
690
["rename rolled back"])
692
self._write_inventory(inv)
697
class ScratchBranch(Branch):
698
"""Special test class: a branch that cleans up after itself.
700
>>> b = ScratchBranch()
708
def __init__(self, files=[], dirs=[]):
709
"""Make a test branch.
711
This creates a temporary directory and runs init-tree in it.
713
If any files are listed, they are created in the working copy.
715
Branch.__init__(self, tempfile.mkdtemp(), init=True)
717
os.mkdir(self.abspath(d))
395
This returns a list of (from_path, to_path) pairs for each
398
raise NotImplementedError('move is abstract')
400
def get_parent(self):
401
"""Return the parent location of the branch.
403
This is the default location for push/pull/missing. The usual
404
pattern is that the user can override it by specifying a
407
raise NotImplementedError('get_parent is abstract')
409
def get_submit_branch(self):
410
"""Return the submit location of the branch.
412
This is the default location for bundle. The usual
413
pattern is that the user can override it by specifying a
416
return self.get_config().get_user_option('submit_branch')
418
def set_submit_branch(self, location):
419
"""Return the submit location of the branch.
421
This is the default location for bundle. The usual
422
pattern is that the user can override it by specifying a
425
self.get_config().set_user_option('submit_branch', location)
427
def get_push_location(self):
428
"""Return the None or the location to push this branch to."""
429
raise NotImplementedError('get_push_location is abstract')
431
def set_push_location(self, location):
432
"""Set a new push location for this branch."""
433
raise NotImplementedError('set_push_location is abstract')
435
def set_parent(self, url):
436
raise NotImplementedError('set_parent is abstract')
440
"""Synchronise this branch with the master branch if any.
442
:return: None or the last_revision pivoted out during the update.
446
def check_revno(self, revno):
448
Check whether a revno corresponds to any revision.
449
Zero (the NULL revision) is considered valid.
452
self.check_real_revno(revno)
720
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
454
def check_real_revno(self, revno):
456
Check whether a revno corresponds to a real revision.
457
Zero (the NULL revision) is considered invalid
459
if revno < 1 or revno > self.revno():
460
raise InvalidRevisionNumber(revno)
463
def clone(self, *args, **kwargs):
464
"""Clone this branch into to_bzrdir preserving all semantic values.
466
revision_id: if not None, the revision history in the new branch will
467
be truncated to end with revision_id.
469
# for API compatibility, until 0.8 releases we provide the old api:
470
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
471
# after 0.8 releases, the *args and **kwargs should be changed:
472
# def clone(self, to_bzrdir, revision_id=None):
473
if (kwargs.get('to_location', None) or
474
kwargs.get('revision', None) or
475
kwargs.get('basis_branch', None) or
476
(len(args) and isinstance(args[0], basestring))):
477
# backwards compatibility api:
478
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
479
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
482
basis_branch = args[2]
484
basis_branch = kwargs.get('basis_branch', None)
486
basis = basis_branch.bzrdir
491
revision_id = args[1]
493
revision_id = kwargs.get('revision', None)
498
# no default to raise if not provided.
499
url = kwargs.get('to_location')
500
return self.bzrdir.clone(url,
501
revision_id=revision_id,
502
basis=basis).open_branch()
504
# generate args by hand
506
revision_id = args[1]
508
revision_id = kwargs.get('revision_id', None)
512
# no default to raise if not provided.
513
to_bzrdir = kwargs.get('to_bzrdir')
514
result = self._format.initialize(to_bzrdir)
515
self.copy_content_into(result, revision_id=revision_id)
519
def sprout(self, to_bzrdir, revision_id=None):
520
"""Create a new line of development from the branch, into to_bzrdir.
522
revision_id: if not None, the revision history in the new branch will
523
be truncated to end with revision_id.
525
result = self._format.initialize(to_bzrdir)
526
self.copy_content_into(result, revision_id=revision_id)
527
result.set_parent(self.bzrdir.root_transport.base)
531
def copy_content_into(self, destination, revision_id=None):
532
"""Copy the content of self into destination.
534
revision_id: if not None, the revision history in the new branch will
535
be truncated to end with revision_id.
537
new_history = self.revision_history()
538
if revision_id is not None:
540
new_history = new_history[:new_history.index(revision_id) + 1]
542
rev = self.repository.get_revision(revision_id)
543
new_history = rev.get_history(self.repository)[1:]
544
destination.set_revision_history(new_history)
546
parent = self.get_parent()
547
except errors.InaccessibleParent, e:
548
mutter('parent was not accessible to copy: %s', e)
551
destination.set_parent(parent)
555
"""Check consistency of the branch.
557
In particular this checks that revisions given in the revision-history
558
do actually match up in the revision graph, and that they're all
559
present in the repository.
561
Callers will typically also want to check the repository.
563
:return: A BranchCheckResult.
565
mainline_parent_id = None
566
for revision_id in self.revision_history():
568
revision = self.repository.get_revision(revision_id)
569
except errors.NoSuchRevision, e:
570
raise errors.BzrCheckError("mainline revision {%s} not in repository"
572
# In general the first entry on the revision history has no parents.
573
# But it's not illegal for it to have parents listed; this can happen
574
# in imports from Arch when the parents weren't reachable.
575
if mainline_parent_id is not None:
576
if mainline_parent_id not in revision.parent_ids:
577
raise errors.BzrCheckError("previous revision {%s} not listed among "
579
% (mainline_parent_id, revision_id))
580
mainline_parent_id = revision_id
581
return BranchCheckResult(self)
583
def create_checkout(self, to_location, revision_id=None,
585
"""Create a checkout of a branch.
587
:param to_location: The url to produce the checkout at
588
:param revision_id: The revision to check out
589
:param lightweight: If True, produce a lightweight checkout, otherwise,
590
produce a bound branch (heavyweight checkout)
591
:return: The tree of the created checkout
594
t = transport.get_transport(to_location)
597
except errors.FileExists:
599
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
600
BranchReferenceFormat().initialize(checkout, self)
602
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
603
to_location, force_new_tree=False)
604
checkout = checkout_branch.bzrdir
605
checkout_branch.bind(self)
606
if revision_id is not None:
607
rh = checkout_branch.revision_history()
608
new_rh = rh[:rh.index(revision_id) + 1]
609
checkout_branch.set_revision_history(new_rh)
610
return checkout.create_workingtree(revision_id)
613
class BranchFormat(object):
614
"""An encapsulation of the initialization and open routines for a format.
616
Formats provide three things:
617
* An initialization routine,
621
Formats are placed in an dict by their format string for reference
622
during branch opening. Its not required that these be instances, they
623
can be classes themselves with class methods - it simply depends on
624
whether state is needed for a given format or not.
626
Once a format is deprecated, just deprecate the initialize and open
627
methods on the format class. Do not deprecate the object, as the
628
object will be created every time regardless.
631
_default_format = None
632
"""The default format used for new branches."""
635
"""The known formats."""
638
def find_format(klass, a_bzrdir):
639
"""Return the format for the branch object in a_bzrdir."""
641
transport = a_bzrdir.get_branch_transport(None)
642
format_string = transport.get("format").read()
643
return klass._formats[format_string]
645
raise NotBranchError(path=transport.base)
647
raise errors.UnknownFormatError(format=format_string)
650
def get_default_format(klass):
651
"""Return the current default format."""
652
return klass._default_format
654
def get_format_string(self):
655
"""Return the ASCII format string that identifies this format."""
656
raise NotImplementedError(self.get_format_string)
658
def get_format_description(self):
659
"""Return the short format description for this format."""
660
raise NotImplementedError(self.get_format_string)
662
def initialize(self, a_bzrdir):
663
"""Create a branch of this format in a_bzrdir."""
664
raise NotImplementedError(self.initialize)
666
def is_supported(self):
667
"""Is this format supported?
669
Supported formats can be initialized and opened.
670
Unsupported formats may not support initialization or committing or
671
some other features depending on the reason for not being supported.
675
def open(self, a_bzrdir, _found=False):
676
"""Return the branch object for a_bzrdir
678
_found is a private parameter, do not use it. It is used to indicate
679
if format probing has already be done.
681
raise NotImplementedError(self.open)
684
def register_format(klass, format):
685
klass._formats[format.get_format_string()] = format
688
def set_default_format(klass, format):
689
klass._default_format = format
692
def unregister_format(klass, format):
693
assert klass._formats[format.get_format_string()] is format
694
del klass._formats[format.get_format_string()]
697
return self.get_format_string().rstrip()
700
class BzrBranchFormat4(BranchFormat):
701
"""Bzr branch format 4.
704
- a revision-history file.
705
- a branch-lock lock file [ to be shared with the bzrdir ]
708
def get_format_description(self):
709
"""See BranchFormat.get_format_description()."""
710
return "Branch format 4"
712
def initialize(self, a_bzrdir):
713
"""Create a branch of this format in a_bzrdir."""
714
mutter('creating branch in %s', a_bzrdir.transport.base)
715
branch_transport = a_bzrdir.get_branch_transport(self)
716
utf8_files = [('revision-history', ''),
719
control_files = LockableFiles(branch_transport, 'branch-lock',
721
control_files.create_lock()
722
control_files.lock_write()
724
for file, content in utf8_files:
725
control_files.put_utf8(file, content)
727
control_files.unlock()
728
return self.open(a_bzrdir, _found=True)
731
super(BzrBranchFormat4, self).__init__()
732
self._matchingbzrdir = bzrdir.BzrDirFormat6()
734
def open(self, a_bzrdir, _found=False):
735
"""Return the branch object for a_bzrdir
737
_found is a private parameter, do not use it. It is used to indicate
738
if format probing has already be done.
741
# we are being called directly and must probe.
742
raise NotImplementedError
743
return BzrBranch(_format=self,
744
_control_files=a_bzrdir._control_files,
746
_repository=a_bzrdir.open_repository())
749
return "Bazaar-NG branch format 4"
752
class BzrBranchFormat5(BranchFormat):
753
"""Bzr branch format 5.
756
- a revision-history file.
758
- a lock dir guarding the branch itself
759
- all of this stored in a branch/ subdirectory
760
- works with shared repositories.
762
This format is new in bzr 0.8.
765
def get_format_string(self):
766
"""See BranchFormat.get_format_string()."""
767
return "Bazaar-NG branch format 5\n"
769
def get_format_description(self):
770
"""See BranchFormat.get_format_description()."""
771
return "Branch format 5"
773
def initialize(self, a_bzrdir):
774
"""Create a branch of this format in a_bzrdir."""
775
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
776
branch_transport = a_bzrdir.get_branch_transport(self)
777
utf8_files = [('revision-history', ''),
780
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
781
control_files.create_lock()
782
control_files.lock_write()
783
control_files.put_utf8('format', self.get_format_string())
785
for file, content in utf8_files:
786
control_files.put_utf8(file, content)
788
control_files.unlock()
789
return self.open(a_bzrdir, _found=True, )
792
super(BzrBranchFormat5, self).__init__()
793
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
795
def open(self, a_bzrdir, _found=False):
796
"""Return the branch object for a_bzrdir
798
_found is a private parameter, do not use it. It is used to indicate
799
if format probing has already be done.
802
format = BranchFormat.find_format(a_bzrdir)
803
assert format.__class__ == self.__class__
804
transport = a_bzrdir.get_branch_transport(None)
805
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
806
return BzrBranch5(_format=self,
807
_control_files=control_files,
809
_repository=a_bzrdir.find_repository())
812
return "Bazaar-NG Metadir branch format 5"
815
class BranchReferenceFormat(BranchFormat):
816
"""Bzr branch reference format.
818
Branch references are used in implementing checkouts, they
819
act as an alias to the real branch which is at some other url.
826
def get_format_string(self):
827
"""See BranchFormat.get_format_string()."""
828
return "Bazaar-NG Branch Reference Format 1\n"
830
def get_format_description(self):
831
"""See BranchFormat.get_format_description()."""
832
return "Checkout reference format 1"
834
def initialize(self, a_bzrdir, target_branch=None):
835
"""Create a branch of this format in a_bzrdir."""
836
if target_branch is None:
837
# this format does not implement branch itself, thus the implicit
838
# creation contract must see it as uninitializable
839
raise errors.UninitializableFormat(self)
840
mutter('creating branch reference in %s', a_bzrdir.transport.base)
841
branch_transport = a_bzrdir.get_branch_transport(self)
842
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
843
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
844
branch_transport.put('format', StringIO(self.get_format_string()))
845
return self.open(a_bzrdir, _found=True)
848
super(BranchReferenceFormat, self).__init__()
849
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
851
def _make_reference_clone_function(format, a_branch):
852
"""Create a clone() routine for a branch dynamically."""
853
def clone(to_bzrdir, revision_id=None):
854
"""See Branch.clone()."""
855
return format.initialize(to_bzrdir, a_branch)
856
# cannot obey revision_id limits when cloning a reference ...
857
# FIXME RBC 20060210 either nuke revision_id for clone, or
858
# emit some sort of warning/error to the caller ?!
861
def open(self, a_bzrdir, _found=False):
862
"""Return the branch that the branch reference in a_bzrdir points at.
864
_found is a private parameter, do not use it. It is used to indicate
865
if format probing has already be done.
868
format = BranchFormat.find_format(a_bzrdir)
869
assert format.__class__ == self.__class__
870
transport = a_bzrdir.get_branch_transport(None)
871
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
872
result = real_bzrdir.open_branch()
873
# this changes the behaviour of result.clone to create a new reference
874
# rather than a copy of the content of the branch.
875
# I did not use a proxy object because that needs much more extensive
876
# testing, and we are only changing one behaviour at the moment.
877
# If we decide to alter more behaviours - i.e. the implicit nickname
878
# then this should be refactored to introduce a tested proxy branch
879
# and a subclass of that for use in overriding clone() and ....
881
result.clone = self._make_reference_clone_function(result)
885
# formats which have no format string are not discoverable
886
# and not independently creatable, so are not registered.
887
__default_format = BzrBranchFormat5()
888
BranchFormat.register_format(__default_format)
889
BranchFormat.register_format(BranchReferenceFormat())
890
BranchFormat.set_default_format(__default_format)
891
_legacy_formats = [BzrBranchFormat4(),
894
class BzrBranch(Branch):
895
"""A branch stored in the actual filesystem.
897
Note that it's "local" in the context of the filesystem; it doesn't
898
really matter if it's on an nfs/smb/afs/coda/... share, as long as
899
it's writable, and can be accessed via the normal filesystem API.
902
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
903
relax_version_check=DEPRECATED_PARAMETER, _format=None,
904
_control_files=None, a_bzrdir=None, _repository=None):
905
"""Create new branch object at a particular location.
907
transport -- A Transport object, defining how to access files.
909
init -- If True, create new control files in a previously
910
unversioned directory. If False, the branch must already
913
relax_version_check -- If true, the usual check for the branch
914
version is not applied. This is intended only for
915
upgrade/recovery type use; it's not guaranteed that
916
all operations will work on old format branches.
919
self.bzrdir = bzrdir.BzrDir.open(transport.base)
921
self.bzrdir = a_bzrdir
922
self._transport = self.bzrdir.transport.clone('..')
923
self._base = self._transport.base
924
self._format = _format
925
if _control_files is None:
926
raise ValueError('BzrBranch _control_files is None')
927
self.control_files = _control_files
928
if deprecated_passed(init):
929
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
930
"deprecated as of bzr 0.8. Please use Branch.create().",
934
# this is slower than before deprecation, oh well never mind.
936
self._initialize(transport.base)
937
self._check_format(_format)
938
if deprecated_passed(relax_version_check):
939
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
940
"relax_version_check parameter is deprecated as of bzr 0.8. "
941
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
945
if (not relax_version_check
946
and not self._format.is_supported()):
947
raise errors.UnsupportedFormatError(format=fmt)
948
if deprecated_passed(transport):
949
warn("BzrBranch.__init__(transport=XXX...): The transport "
950
"parameter is deprecated as of bzr 0.8. "
951
"Please use Branch.open, or bzrdir.open_branch().",
954
self.repository = _repository
957
return '%s(%r)' % (self.__class__.__name__, self.base)
723
961
def __del__(self):
727
"""Destroy the test branch, removing the scratch directory."""
729
mutter("delete ScratchBranch %s" % self.base)
730
shutil.rmtree(self.base)
732
# Work around for shutil.rmtree failing on Windows when
733
# readonly files are encountered
734
mutter("hit exception in destroying ScratchBranch: %s" % e)
735
for root, dirs, files in os.walk(self.base, topdown=False):
737
os.chmod(os.path.join(root, name), 0700)
738
shutil.rmtree(self.base)
962
# TODO: It might be best to do this somewhere else,
963
# but it is nice for a Branch object to automatically
964
# cache it's information.
965
# Alternatively, we could have the Transport objects cache requests
966
# See the earlier discussion about how major objects (like Branch)
967
# should never expect their __del__ function to run.
968
# XXX: cache_root seems to be unused, 2006-01-13 mbp
969
if hasattr(self, 'cache_root') and self.cache_root is not None:
971
osutils.rmtree(self.cache_root)
974
self.cache_root = None
979
base = property(_get_base, doc="The URL for the root of this branch.")
981
def _finish_transaction(self):
982
"""Exit the current transaction."""
983
return self.control_files._finish_transaction()
985
def get_transaction(self):
986
"""Return the current active transaction.
988
If no transaction is active, this returns a passthrough object
989
for which all data is immediately flushed and no caching happens.
991
# this is an explicit function so that we can do tricky stuff
992
# when the storage in rev_storage is elsewhere.
993
# we probably need to hook the two 'lock a location' and
994
# 'have a transaction' together more delicately, so that
995
# we can have two locks (branch and storage) and one transaction
996
# ... and finishing the transaction unlocks both, but unlocking
997
# does not. - RBC 20051121
998
return self.control_files.get_transaction()
1000
def _set_transaction(self, transaction):
1001
"""Set a new active transaction."""
1002
return self.control_files._set_transaction(transaction)
1004
def abspath(self, name):
1005
"""See Branch.abspath."""
1006
return self.control_files._transport.abspath(name)
1008
def _check_format(self, format):
1009
"""Identify the branch format if needed.
1011
The format is stored as a reference to the format object in
1012
self._format for code that needs to check it later.
1014
The format parameter is either None or the branch format class
1015
used to open this branch.
1017
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1020
format = BranchFormat.find_format(self.bzrdir)
1021
self._format = format
1022
mutter("got branch format %s", self._format)
1025
def get_root_id(self):
1026
"""See Branch.get_root_id."""
1027
tree = self.repository.revision_tree(self.last_revision())
1028
return tree.inventory.root.file_id
1030
def is_locked(self):
1031
return self.control_files.is_locked()
1033
def lock_write(self):
1034
self.repository.lock_write()
1036
self.control_files.lock_write()
1038
self.repository.unlock()
1041
def lock_read(self):
1042
self.repository.lock_read()
1044
self.control_files.lock_read()
1046
self.repository.unlock()
1050
# TODO: test for failed two phase locks. This is known broken.
1052
self.control_files.unlock()
1054
self.repository.unlock()
1056
def peek_lock_mode(self):
1057
if self.control_files._lock_count == 0:
1060
return self.control_files._lock_mode
1062
def get_physical_lock_status(self):
1063
return self.control_files.get_physical_lock_status()
1066
def print_file(self, file, revision_id):
1067
"""See Branch.print_file."""
1068
return self.repository.print_file(file, revision_id)
1071
def append_revision(self, *revision_ids):
1072
"""See Branch.append_revision."""
1073
for revision_id in revision_ids:
1074
mutter("add {%s} to revision-history" % revision_id)
1075
rev_history = self.revision_history()
1076
rev_history.extend(revision_ids)
1077
self.set_revision_history(rev_history)
1080
def set_revision_history(self, rev_history):
1081
"""See Branch.set_revision_history."""
1082
self.control_files.put_utf8(
1083
'revision-history', '\n'.join(rev_history))
1084
transaction = self.get_transaction()
1085
history = transaction.map.find_revision_history()
1086
if history is not None:
1087
# update the revision history in the identity map.
1088
history[:] = list(rev_history)
1089
# this call is disabled because revision_history is
1090
# not really an object yet, and the transaction is for objects.
1091
# transaction.register_dirty(history)
1093
transaction.map.add_revision_history(rev_history)
1094
# this call is disabled because revision_history is
1095
# not really an object yet, and the transaction is for objects.
1096
# transaction.register_clean(history)
1099
def revision_history(self):
1100
"""See Branch.revision_history."""
1101
transaction = self.get_transaction()
1102
history = transaction.map.find_revision_history()
1103
if history is not None:
1104
# mutter("cache hit for revision-history in %s", self)
1105
return list(history)
1106
decode_utf8 = cache_utf8.decode
1107
history = [decode_utf8(l.rstrip('\r\n')) for l in
1108
self.control_files.get('revision-history').readlines()]
1109
transaction.map.add_revision_history(history)
1110
# this call is disabled because revision_history is
1111
# not really an object yet, and the transaction is for objects.
1112
# transaction.register_clean(history, precious=True)
1113
return list(history)
1116
def generate_revision_history(self, revision_id, last_rev=None,
1118
"""Create a new revision history that will finish with revision_id.
1120
:param revision_id: the new tip to use.
1121
:param last_rev: The previous last_revision. If not None, then this
1122
must be a ancestory of revision_id, or DivergedBranches is raised.
1123
:param other_branch: The other branch that DivergedBranches should
1124
raise with respect to.
1126
# stop_revision must be a descendant of last_revision
1127
stop_graph = self.repository.get_revision_graph(revision_id)
1128
if last_rev is not None and last_rev not in stop_graph:
1129
# our previous tip is not merged into stop_revision
1130
raise errors.DivergedBranches(self, other_branch)
1131
# make a new revision history from the graph
1132
current_rev_id = revision_id
1134
while current_rev_id not in (None, revision.NULL_REVISION):
1135
new_history.append(current_rev_id)
1136
current_rev_id_parents = stop_graph[current_rev_id]
1138
current_rev_id = current_rev_id_parents[0]
1140
current_rev_id = None
1141
new_history.reverse()
1142
self.set_revision_history(new_history)
1145
def update_revisions(self, other, stop_revision=None):
1146
"""See Branch.update_revisions."""
1149
if stop_revision is None:
1150
stop_revision = other.last_revision()
1151
if stop_revision is None:
1152
# if there are no commits, we're done.
1154
# whats the current last revision, before we fetch [and change it
1156
last_rev = self.last_revision()
1157
# we fetch here regardless of whether we need to so that we pickup
1159
self.fetch(other, stop_revision)
1160
my_ancestry = self.repository.get_ancestry(last_rev)
1161
if stop_revision in my_ancestry:
1162
# last_revision is a descendant of stop_revision
1164
self.generate_revision_history(stop_revision, last_rev=last_rev,
1169
def basis_tree(self):
1170
"""See Branch.basis_tree."""
1171
return self.repository.revision_tree(self.last_revision())
1173
@deprecated_method(zero_eight)
1174
def working_tree(self):
1175
"""Create a Working tree object for this branch."""
1177
from bzrlib.transport.local import LocalTransport
1178
if (self.base.find('://') != -1 or
1179
not isinstance(self._transport, LocalTransport)):
1180
raise NoWorkingTree(self.base)
1181
return self.bzrdir.open_workingtree()
1184
def pull(self, source, overwrite=False, stop_revision=None):
1185
"""See Branch.pull."""
1188
old_count = len(self.revision_history())
1190
self.update_revisions(source,stop_revision)
1191
except DivergedBranches:
1195
self.set_revision_history(source.revision_history())
1196
new_count = len(self.revision_history())
1197
return new_count - old_count
1201
def get_parent(self):
1202
"""See Branch.get_parent."""
1204
_locs = ['parent', 'pull', 'x-pull']
1205
assert self.base[-1] == '/'
1208
parent = self.control_files.get(l).read().strip('\n')
1211
# This is an old-format absolute path to a local branch
1212
# turn it into a url
1213
if parent.startswith('/'):
1214
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1216
return urlutils.join(self.base[:-1], parent)
1217
except errors.InvalidURLJoin, e:
1218
raise errors.InaccessibleParent(parent, self.base)
1221
def get_push_location(self):
1222
"""See Branch.get_push_location."""
1223
push_loc = self.get_config().get_user_option('push_location')
1226
def set_push_location(self, location):
1227
"""See Branch.set_push_location."""
1228
self.get_config().set_user_option('push_location', location,
1232
def set_parent(self, url):
1233
"""See Branch.set_parent."""
1234
# TODO: Maybe delete old location files?
1235
# URLs should never be unicode, even on the local fs,
1236
# FIXUP this and get_parent in a future branch format bump:
1237
# read and rewrite the file, and have the new format code read
1238
# using .get not .get_utf8. RBC 20060125
1240
self.control_files._transport.delete('parent')
1242
if isinstance(url, unicode):
1244
url = url.encode('ascii')
1245
except UnicodeEncodeError:
1246
raise bzrlib.errors.InvalidURL(url,
1247
"Urls must be 7-bit ascii, "
1248
"use bzrlib.urlutils.escape")
1250
url = urlutils.relative_url(self.base, url)
1251
self.control_files.put('parent', url + '\n')
1253
@deprecated_function(zero_nine)
1254
def tree_config(self):
1255
"""DEPRECATED; call get_config instead.
1256
TreeConfig has become part of BranchConfig."""
1257
return TreeConfig(self)
1260
class BzrBranch5(BzrBranch):
1261
"""A format 5 branch. This supports new features over plan branches.
1263
It has support for a master_branch which is the data for bound branches.
1271
super(BzrBranch5, self).__init__(_format=_format,
1272
_control_files=_control_files,
1274
_repository=_repository)
1277
def pull(self, source, overwrite=False, stop_revision=None):
1278
"""Updates branch.pull to be bound branch aware."""
1279
bound_location = self.get_bound_location()
1280
if source.base != bound_location:
1281
# not pulling from master, so we need to update master.
1282
master_branch = self.get_master_branch()
1284
master_branch.pull(source)
1285
source = master_branch
1286
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1288
def get_bound_location(self):
1290
return self.control_files.get_utf8('bound').read()[:-1]
1291
except errors.NoSuchFile:
1295
def get_master_branch(self):
1296
"""Return the branch we are bound to.
1298
:return: Either a Branch, or None
1300
This could memoise the branch, but if thats done
1301
it must be revalidated on each new lock.
1302
So for now we just don't memoise it.
1303
# RBC 20060304 review this decision.
1305
bound_loc = self.get_bound_location()
1309
return Branch.open(bound_loc)
1310
except (errors.NotBranchError, errors.ConnectionError), e:
1311
raise errors.BoundBranchConnectionFailure(
1315
def set_bound_location(self, location):
1316
"""Set the target where this branch is bound to.
1318
:param location: URL to the target branch
1321
self.control_files.put_utf8('bound', location+'\n')
1324
self.control_files._transport.delete('bound')
1330
def bind(self, other):
1331
"""Bind the local branch the other branch.
1333
:param other: The branch to bind to
1336
# TODO: jam 20051230 Consider checking if the target is bound
1337
# It is debatable whether you should be able to bind to
1338
# a branch which is itself bound.
1339
# Committing is obviously forbidden,
1340
# but binding itself may not be.
1341
# Since we *have* to check at commit time, we don't
1342
# *need* to check here
1345
# we are now equal to or a suffix of other.
1347
# Since we have 'pulled' from the remote location,
1348
# now we should try to pull in the opposite direction
1349
# in case the local tree has more revisions than the
1351
# There may be a different check you could do here
1352
# rather than actually trying to install revisions remotely.
1353
# TODO: capture an exception which indicates the remote branch
1355
# If it is up-to-date, this probably should not be a failure
1357
# lock other for write so the revision-history syncing cannot race
1361
# if this does not error, other now has the same last rev we do
1362
# it can only error if the pull from other was concurrent with
1363
# a commit to other from someone else.
1365
# until we ditch revision-history, we need to sync them up:
1366
self.set_revision_history(other.revision_history())
1367
# now other and self are up to date with each other and have the
1368
# same revision-history.
1372
self.set_bound_location(other.base)
1376
"""If bound, unbind"""
1377
return self.set_bound_location(None)
1381
"""Synchronise this branch with the master branch if any.
1383
:return: None or the last_revision that was pivoted out during the
1386
master = self.get_master_branch()
1387
if master is not None:
1388
old_tip = self.last_revision()
1389
self.pull(master, overwrite=True)
1390
if old_tip in self.repository.get_ancestry(self.last_revision()):
1396
class BranchTestProviderAdapter(object):
1397
"""A tool to generate a suite testing multiple branch formats at once.
1399
This is done by copying the test once for each transport and injecting
1400
the transport_server, transport_readonly_server, and branch_format
1401
classes into each copy. Each copy is also given a new id() to make it
1405
def __init__(self, transport_server, transport_readonly_server, formats):
1406
self._transport_server = transport_server
1407
self._transport_readonly_server = transport_readonly_server
1408
self._formats = formats
1410
def adapt(self, test):
1411
result = TestSuite()
1412
for branch_format, bzrdir_format in self._formats:
1413
new_test = deepcopy(test)
1414
new_test.transport_server = self._transport_server
1415
new_test.transport_readonly_server = self._transport_readonly_server
1416
new_test.bzrdir_format = bzrdir_format
1417
new_test.branch_format = branch_format
1418
def make_new_test_id():
1419
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1420
return lambda: new_id
1421
new_test.id = make_new_test_id()
1422
result.addTest(new_test)
1426
class BranchCheckResult(object):
1427
"""Results of checking branch consistency.
1432
def __init__(self, branch):
1433
self.branch = branch
1435
def report_results(self, verbose):
1436
"""Report the check results via trace.note.
1438
:param verbose: Requests more detailed display of what was checked,
1441
note('checked branch %s format %s',
1443
self.branch._format)
743
1446
######################################################################
747
def is_control_file(filename):
748
## FIXME: better check
749
filename = os.path.normpath(filename)
750
while filename != '':
751
head, tail = os.path.split(filename)
752
## mutter('check %r for control file' % ((head, tail), ))
753
if tail == bzrlib.BZRDIR:
762
def gen_file_id(name):
763
"""Return new file id.
765
This should probably generate proper UUIDs, but for the moment we
766
cope with just randomness because running uuidgen every time is
768
idx = name.rfind('/')
770
name = name[idx+1 : ]
771
idx = name.rfind('\\')
773
name = name[idx+1 : ]
775
name = name.lstrip('.')
777
s = hexlify(rand_bytes(8))
778
return '-'.join((name, compact_date(time.time()), s))
1450
@deprecated_function(zero_eight)
1451
def is_control_file(*args, **kwargs):
1452
"""See bzrlib.workingtree.is_control_file."""
1453
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
