« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 2318.1.1
- compare with another revision
- download diff
- download tarball
- view history from revision 2318.1.1
- Committer: Alexander Belchenko
- Date: 2007-03-06 08:05:08 UTC
- mto: This revision was merged to the branch mainline in revision 2319.
- Revision ID: bialix@ukr.net-20070306080508-43s3c6gz2nqikt8m
update comment about stderr (trivial)
- files added:
- BRANCH.TODO
- bzrlib/benchmarks
- bzrlib/benchmarks/tree_creator
- bzrlib/bundle
- bzrlib/bundle/old
- bzrlib/bundle/serializer
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins
- bzrlib/plugins/launchpad
- bzrlib/repofmt
- bzrlib/store
- bzrlib/store/revision
- bzrlib/store/versioned
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/intertree_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/test_patches_data
- bzrlib/tests/tree_implementations
- bzrlib/tests/workingtree_implementations
- bzrlib/transport
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/version_info_formats
- contrib/emacs
- tools
- tools/doc_generate
- tools/win32
- files removed:
- bzrlib/cache.py
- notes
- urlgrabber
- files renamed:
- bzrlib/store.py => bzrlib/store/__init__.py
- elementtree/ => bzrlib/util/elementtree/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- contrib/bash/bzr => contrib/bash/bzr.simple
- bzrlib/newinventory.py => contrib/newinventory.py
- files modified:
- .bzrignore
- bzr *
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
#
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.
7
7
#
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.
12
12
#
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
16
16
17
17
18
from sets import Set
18
from cStringIO import StringIO
19
19
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
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
23
25
24
26
import bzrlib
25
from inventory import Inventory
26
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
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
36
from diff import diff_trees
37
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
## TODO: Maybe include checks for common corruption of newlines, etc?
40
41
42
43
def find_branch_root(f=None):
44
"""Find the branch root enclosing f, or pwd.
45
46
It is not necessary that f exists.
47
48
Basically we keep looking up until we find the control directory or
49
run into the root."""
50
if f == None:
51
f = os.getcwd()
52
elif hasattr(os.path, 'realpath'):
53
f = os.path.realpath(f)
54
else:
55
f = os.path.abspath(f)
56
57
orig_f = f
58
59
while True:
60
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
61
return f
62
head, tail = os.path.split(f)
63
if head == f:
64
# reached the root, whatever that may be
65
raise BzrError('%r is not in a branch' % orig_f)
66
f = head
67
27
from bzrlib import (
28
bzrdir,
29
cache_utf8,
30
config as _mod_config,
31
errors,
32
lockdir,
33
lockable_files,
34
osutils,
35
revision as _mod_revision,
36
transport,
37
tree,
38
ui,
39
urlutils,
40
)
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.tag import (
44
BasicTags,
45
DisabledTags,
46
)
47
""")
48
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
56
)
57
from bzrlib.symbol_versioning import (deprecated_function,
58
deprecated_method,
59
DEPRECATED_PARAMETER,
60
deprecated_passed,
61
zero_eight, zero_nine,
62
)
63
from bzrlib.trace import mutter, note
64
65
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
69
70
71
# TODO: Maybe include checks for common corruption of newlines, etc?
72
73
# TODO: Some operations like log might retrieve the same revisions
74
# repeatedly to calculate deltas. We could perhaps have a weakref
75
# cache in memory to make this faster. In general anything can be
76
# cached in memory between lock and unlock operations. .. nb thats
77
# what the transaction identity map provides
68
78
69
79
70
80
######################################################################
71
81
# branch objects
72
82
73
class Branch:
83
class Branch(object):
74
84
"""Branch holding a history of revisions.
75
85
76
86
base
77
Base directory of the branch.
87
Base directory/url of the branch.
88
89
hooks: An instance of BranchHooks.
78
90
"""
79
_lockmode = None
91
# this is really an instance variable - FIXME move it there
92
# - RBC 20060112
93
base = None
94
95
# override this to set the strategy for storing tags
96
def _make_tags(self):
97
return DisabledTags(self)
98
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
101
102
def break_lock(self):
103
"""Break a lock if one is present from another instance.
104
105
Uses the ui factory to ask for confirmation if the lock may be from
106
an active process.
107
108
This will probe the repository for its lock as well.
109
"""
110
self.control_files.break_lock()
111
self.repository.break_lock()
112
master = self.get_master_branch()
113
if master is not None:
114
master.break_lock()
115
116
@staticmethod
117
@deprecated_method(zero_eight)
118
def open_downlevel(base):
119
"""Open a branch which may be of an old format."""
120
return Branch.open(base, _unsupported=True)
121
122
@staticmethod
123
def open(base, _unsupported=False):
124
"""Open the branch rooted at base.
125
126
For instance, if the branch is at URL/.bzr/branch,
127
Branch.open(URL) -> a Branch instance.
128
"""
129
control = bzrdir.BzrDir.open(base, _unsupported)
130
return control.open_branch(_unsupported)
131
132
@staticmethod
133
def open_containing(url):
134
"""Open an existing branch which contains url.
135
136
This probes for a branch at url, and searches upwards from there.
137
138
Basically we keep looking up until we find the control directory or
139
run into the root. If there isn't one, raises NotBranchError.
140
If there is one and it is either an unrecognised format or an unsupported
141
format, UnknownFormatError or UnsupportedFormatError are raised.
142
If there is one, it is returned, along with the unused portion of url.
143
"""
144
control, relpath = bzrdir.BzrDir.open_containing(url)
145
return control.open_branch(), relpath
146
147
@staticmethod
148
@deprecated_function(zero_eight)
149
def initialize(base):
150
"""Create a new working tree and branch, rooted at 'base' (url)
151
152
NOTE: This will soon be deprecated in favour of creation
153
through a BzrDir.
154
"""
155
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
156
157
@deprecated_function(zero_eight)
158
def setup_caching(self, cache_root):
159
"""Subclasses that care about caching should override this, and set
160
up cached stores located under cache_root.
161
162
NOTE: This is unused.
163
"""
164
pass
165
166
def get_config(self):
167
return BranchConfig(self)
168
169
def _get_nick(self):
170
return self.get_config().get_nickname()
171
172
def _set_nick(self, nick):
173
self.get_config().set_user_option('nickname', nick)
174
175
nick = property(_get_nick, _set_nick)
176
177
def is_locked(self):
178
raise NotImplementedError(self.is_locked)
179
180
def lock_write(self):
181
raise NotImplementedError(self.lock_write)
182
183
def lock_read(self):
184
raise NotImplementedError(self.lock_read)
185
186
def unlock(self):
187
raise NotImplementedError(self.unlock)
188
189
def peek_lock_mode(self):
190
"""Return lock mode for the Branch: 'r', 'w' or None"""
191
raise NotImplementedError(self.peek_lock_mode)
192
193
def get_physical_lock_status(self):
194
raise NotImplementedError(self.get_physical_lock_status)
195
196
def abspath(self, name):
197
"""Return absolute filename for something in the branch
198
199
XXX: Robert Collins 20051017 what is this used for? why is it a branch
200
method and not a tree method.
201
"""
202
raise NotImplementedError(self.abspath)
203
204
def bind(self, other):
205
"""Bind the local branch the other branch.
206
207
:param other: The branch to bind to
208
:type other: Branch
209
"""
210
raise errors.UpgradeRequired(self.base)
211
212
@needs_write_lock
213
def fetch(self, from_branch, last_revision=None, pb=None):
214
"""Copy revisions from from_branch into this branch.
215
216
:param from_branch: Where to copy from.
217
:param last_revision: What revision to stop at (None for at the end
218
of the branch.
219
:param pb: An optional progress bar to use.
220
221
Returns the copied revision count and the failed revisions in a tuple:
222
(copied, failures).
223
"""
224
if self.base == from_branch.base:
225
return (0, [])
226
if pb is None:
227
nested_pb = ui.ui_factory.nested_progress_bar()
228
pb = nested_pb
229
else:
230
nested_pb = None
231
232
from_branch.lock_read()
233
try:
234
if last_revision is None:
235
pb.update('get source history')
236
last_revision = from_branch.last_revision()
237
if last_revision is None:
238
last_revision = _mod_revision.NULL_REVISION
239
return self.repository.fetch(from_branch.repository,
240
revision_id=last_revision,
241
pb=nested_pb)
242
finally:
243
if nested_pb is not None:
244
nested_pb.finished()
245
from_branch.unlock()
246
247
def get_bound_location(self):
248
"""Return the URL of the branch we are bound to.
249
250
Older format branches cannot bind, please be sure to use a metadir
251
branch.
252
"""
253
return None
80
254
81
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
82
"""Create new branch object at a particular location.
83
84
base -- Base directory for the branch.
85
86
init -- If True, create new control files in a previously
87
unversioned directory. If False, the branch must already
88
be versioned.
89
90
find_root -- If true and init is false, find the root of the
91
existing branch containing base.
92
93
In the test suite, creation of new trees is tested using the
94
`ScratchBranch` class.
95
"""
96
if init:
97
self.base = os.path.realpath(base)
98
self._make_control()
99
elif find_root:
100
self.base = find_branch_root(base)
101
else:
102
self.base = os.path.realpath(base)
103
if not isdir(self.controlfilename('.')):
104
bailout("not a bzr branch: %s" % quotefn(base),
105
['use "bzr init" to initialize a new working tree',
106
'current bzr can only operate from top-of-tree'])
107
self._check_format()
108
self.lock(lock_mode)
109
110
self.text_store = ImmutableStore(self.controlfilename('text-store'))
111
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
112
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
113
114
115
def __str__(self):
116
return '%s(%r)' % (self.__class__.__name__, self.base)
117
118
119
__repr__ = __str__
120
121
122
123
def lock(self, mode='w'):
124
"""Lock the on-disk branch, excluding other processes."""
125
try:
126
import fcntl, errno
127
128
if mode == 'w':
129
lm = fcntl.LOCK_EX
130
om = os.O_WRONLY | os.O_CREAT
131
elif mode == 'r':
132
lm = fcntl.LOCK_SH
133
om = os.O_RDONLY
134
else:
135
raise BzrError("invalid locking mode %r" % mode)
136
137
try:
138
lockfile = os.open(self.controlfilename('branch-lock'), om)
139
except OSError, e:
140
if e.errno == errno.ENOENT:
141
# might not exist on branches from <0.0.4
142
self.controlfile('branch-lock', 'w').close()
143
lockfile = os.open(self.controlfilename('branch-lock'), om)
144
else:
145
raise e
146
147
fcntl.lockf(lockfile, lm)
148
def unlock():
149
fcntl.lockf(lockfile, fcntl.LOCK_UN)
150
os.close(lockfile)
151
self._lockmode = None
152
self.unlock = unlock
153
self._lockmode = mode
154
except ImportError:
155
warning("please write a locking method for platform %r" % sys.platform)
156
def unlock():
157
self._lockmode = None
158
self.unlock = unlock
159
self._lockmode = mode
160
161
162
def _need_readlock(self):
163
if self._lockmode not in ['r', 'w']:
164
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
165
166
def _need_writelock(self):
167
if self._lockmode not in ['w']:
168
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
169
170
171
def abspath(self, name):
172
"""Return absolute filename for something in the branch"""
173
return os.path.join(self.base, name)
174
175
176
def relpath(self, path):
177
"""Return path relative to this branch of something inside it.
178
179
Raises an error if path is not in this branch."""
180
rp = os.path.realpath(path)
181
# FIXME: windows
182
if not rp.startswith(self.base):
183
bailout("path %r is not within branch %r" % (rp, self.base))
184
rp = rp[len(self.base):]
185
rp = rp.lstrip(os.sep)
186
return rp
187
188
189
def controlfilename(self, file_or_path):
190
"""Return location relative to branch."""
191
if isinstance(file_or_path, types.StringTypes):
192
file_or_path = [file_or_path]
193
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
194
195
196
def controlfile(self, file_or_path, mode='r'):
197
"""Open a control file for this branch.
198
199
There are two classes of file in the control directory: text
200
and binary. binary files are untranslated byte streams. Text
201
control files are stored with Unix newlines and in UTF-8, even
202
if the platform or locale defaults are different.
203
"""
204
205
fn = self.controlfilename(file_or_path)
206
207
if mode == 'rb' or mode == 'wb':
208
return file(fn, mode)
209
elif mode == 'r' or mode == 'w':
210
# open in binary mode anyhow so there's no newline translation;
211
# codecs uses line buffering by default; don't want that.
212
import codecs
213
return codecs.open(fn, mode + 'b', 'utf-8',
214
buffering=60000)
215
else:
216
raise BzrError("invalid controlfile mode %r" % mode)
217
218
219
220
def _make_control(self):
221
os.mkdir(self.controlfilename([]))
222
self.controlfile('README', 'w').write(
223
"This is a Bazaar-NG control directory.\n"
224
"Do not change any files in this directory.")
225
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
226
for d in ('text-store', 'inventory-store', 'revision-store'):
227
os.mkdir(self.controlfilename(d))
228
for f in ('revision-history', 'merged-patches',
229
'pending-merged-patches', 'branch-name',
230
'branch-lock'):
231
self.controlfile(f, 'w').write('')
232
mutter('created control directory in ' + self.base)
233
Inventory().write_xml(self.controlfile('inventory','w'))
234
235
236
def _check_format(self):
237
"""Check this branch format is supported.
238
239
The current tool only supports the current unstable format.
240
241
In the future, we might need different in-memory Branch
242
classes to support downlevel branches. But not yet.
243
"""
244
# This ignores newlines so that we can open branches created
245
# on Windows from Linux and so on. I think it might be better
246
# to always make all internal files in unix format.
247
fmt = self.controlfile('branch-format', 'r').read()
248
fmt.replace('\r\n', '')
249
if fmt != BZR_BRANCH_FORMAT:
250
bailout('sorry, branch format %r not supported' % fmt,
251
['use a different bzr version',
252
'or remove the .bzr directory and "bzr init" again'])
253
254
255
def read_working_inventory(self):
256
"""Read the working inventory."""
257
self._need_readlock()
258
before = time.time()
259
# ElementTree does its own conversion from UTF-8, so open in
260
# binary.
261
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
262
mutter("loaded inventory of %d items in %f"
263
% (len(inv), time.time() - before))
264
return inv
265
266
267
def _write_inventory(self, inv):
268
"""Update the working inventory.
269
270
That is to say, the inventory describing changes underway, that
271
will be committed to the next revision.
272
"""
273
self._need_writelock()
274
## TODO: factor out to atomicfile? is rename safe on windows?
275
## TODO: Maybe some kind of clean/dirty marker on inventory?
276
tmpfname = self.controlfilename('inventory.tmp')
277
tmpf = file(tmpfname, 'wb')
278
inv.write_xml(tmpf)
279
tmpf.close()
280
inv_fname = self.controlfilename('inventory')
281
if sys.platform == 'win32':
282
os.remove(inv_fname)
283
os.rename(tmpfname, inv_fname)
284
mutter('wrote working inventory')
285
286
287
inventory = property(read_working_inventory, _write_inventory, None,
288
"""Inventory for the working copy.""")
289
290
291
def add(self, files, verbose=False):
292
"""Make files versioned.
293
294
Note that the command line normally calls smart_add instead.
295
296
This puts the files in the Added state, so that they will be
297
recorded by the next commit.
298
299
TODO: Perhaps have an option to add the ids even if the files do
300
not (yet) exist.
301
302
TODO: Perhaps return the ids of the files? But then again it
303
is easy to retrieve them if they're needed.
304
305
TODO: Option to specify file id.
306
307
TODO: Adding a directory should optionally recurse down and
308
add all non-ignored children. Perhaps do that in a
309
higher-level method.
310
311
>>> b = ScratchBranch(files=['foo'])
312
>>> 'foo' in b.unknowns()
313
True
314
>>> b.show_status()
315
? foo
316
>>> b.add('foo')
317
>>> 'foo' in b.unknowns()
318
False
319
>>> bool(b.inventory.path2id('foo'))
320
True
321
>>> b.show_status()
322
A foo
323
324
>>> b.add('foo')
325
Traceback (most recent call last):
326
...
327
BzrError: ('foo is already versioned', [])
328
329
>>> b.add(['nothere'])
330
Traceback (most recent call last):
331
BzrError: ('cannot add: not a regular file or directory: nothere', [])
332
"""
333
self._need_writelock()
334
335
# TODO: Re-adding a file that is removed in the working copy
336
# should probably put it back with the previous ID.
337
if isinstance(files, types.StringTypes):
338
files = [files]
339
340
inv = self.read_working_inventory()
341
for f in files:
342
if is_control_file(f):
343
bailout("cannot add control file %s" % quotefn(f))
344
345
fp = splitpath(f)
346
347
if len(fp) == 0:
348
bailout("cannot add top-level %r" % f)
349
350
fullpath = os.path.normpath(self.abspath(f))
351
352
try:
353
kind = file_kind(fullpath)
354
except OSError:
355
# maybe something better?
356
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
357
358
if kind != 'file' and kind != 'directory':
359
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
360
361
file_id = gen_file_id(f)
362
inv.add_path(f, kind=kind, file_id=file_id)
363
364
if verbose:
365
show_status('A', kind, quotefn(f))
366
367
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
368
369
self._write_inventory(inv)
370
371
372
def print_file(self, file, revno):
255
def get_old_bound_location(self):
256
"""Return the URL of the branch we used to be bound to
257
"""
258
raise errors.UpgradeRequired(self.base)
259
260
def get_commit_builder(self, parents, config=None, timestamp=None,
261
timezone=None, committer=None, revprops=None,
262
revision_id=None):
263
"""Obtain a CommitBuilder for this branch.
264
265
:param parents: Revision ids of the parents of the new revision.
266
:param config: Optional configuration to use.
267
:param timestamp: Optional timestamp recorded for commit.
268
:param timezone: Optional timezone for timestamp.
269
:param committer: Optional committer to set for commit.
270
:param revprops: Optional dictionary of revision properties.
271
:param revision_id: Optional revision id.
272
"""
273
274
if config is None:
275
config = self.get_config()
276
277
return self.repository.get_commit_builder(self, parents, config,
278
timestamp, timezone, committer, revprops, revision_id)
279
280
def get_master_branch(self):
281
"""Return the branch we are bound to.
282
283
:return: Either a Branch, or None
284
"""
285
return None
286
287
def get_revision_delta(self, revno):
288
"""Return the delta for one revision.
289
290
The delta is relative to its mainline predecessor, or the
291
empty tree for revision 1.
292
"""
293
assert isinstance(revno, int)
294
rh = self.revision_history()
295
if not (1 <= revno <= len(rh)):
296
raise InvalidRevisionNumber(revno)
297
return self.repository.get_revision_delta(rh[revno-1])
298
299
def get_root_id(self):
300
"""Return the id of this branches root"""
301
raise NotImplementedError(self.get_root_id)
302
303
def print_file(self, file, revision_id):
373
304
"""Print `file` to stdout."""
374
self._need_readlock()
375
tree = self.revision_tree(self.lookup_revision(revno))
376
# use inventory as it was in that revision
377
file_id = tree.inventory.path2id(file)
378
if not file_id:
379
bailout("%r is not present in revision %d" % (file, revno))
380
tree.print_file(file_id)
381
382
383
def remove(self, files, verbose=False):
384
"""Mark nominated files for removal from the inventory.
385
386
This does not remove their text. This does not run on
387
388
TODO: Refuse to remove modified files unless --force is given?
389
390
>>> b = ScratchBranch(files=['foo'])
391
>>> b.add('foo')
392
>>> b.inventory.has_filename('foo')
393
True
394
>>> b.remove('foo')
395
>>> b.working_tree().has_filename('foo')
396
True
397
>>> b.inventory.has_filename('foo')
398
False
399
400
>>> b = ScratchBranch(files=['foo'])
401
>>> b.add('foo')
402
>>> b.commit('one')
403
>>> b.remove('foo')
404
>>> b.commit('two')
405
>>> b.inventory.has_filename('foo')
406
False
407
>>> b.basis_tree().has_filename('foo')
408
False
409
>>> b.working_tree().has_filename('foo')
410
True
411
412
TODO: Do something useful with directories.
413
414
TODO: Should this remove the text or not? Tough call; not
415
removing may be useful and the user can just use use rm, and
416
is the opposite of add. Removing it is consistent with most
417
other tools. Maybe an option.
418
"""
419
## TODO: Normalize names
420
## TODO: Remove nested loops; better scalability
421
self._need_writelock()
422
423
if isinstance(files, types.StringTypes):
424
files = [files]
425
426
tree = self.working_tree()
427
inv = tree.inventory
428
429
# do this before any modifications
430
for f in files:
431
fid = inv.path2id(f)
432
if not fid:
433
bailout("cannot remove unversioned file %s" % quotefn(f))
434
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
435
if verbose:
436
# having remove it, it must be either ignored or unknown
437
if tree.is_ignored(f):
438
new_status = 'I'
439
else:
440
new_status = '?'
441
show_status(new_status, inv[fid].kind, quotefn(f))
442
del inv[fid]
443
444
self._write_inventory(inv)
445
446
447
def unknowns(self):
448
"""Return all unknown files.
449
450
These are files in the working directory that are not versioned or
451
control files or ignored.
452
453
>>> b = ScratchBranch(files=['foo', 'foo~'])
454
>>> list(b.unknowns())
455
['foo']
456
>>> b.add('foo')
457
>>> list(b.unknowns())
458
[]
459
>>> b.remove('foo')
460
>>> list(b.unknowns())
461
['foo']
462
"""
463
return self.working_tree().unknowns()
464
465
466
def commit(self, message, timestamp=None, timezone=None,
467
committer=None,
468
verbose=False):
469
"""Commit working copy as a new revision.
470
471
The basic approach is to add all the file texts into the
472
store, then the inventory, then make a new revision pointing
473
to that inventory and store that.
474
475
This is not quite safe if the working copy changes during the
476
commit; for the moment that is simply not allowed. A better
477
approach is to make a temporary copy of the files before
478
computing their hashes, and then add those hashes in turn to
479
the inventory. This should mean at least that there are no
480
broken hash pointers. There is no way we can get a snapshot
481
of the whole directory at an instant. This would also have to
482
be robust against files disappearing, moving, etc. So the
483
whole thing is a bit hard.
484
485
timestamp -- if not None, seconds-since-epoch for a
486
postdated/predated commit.
487
"""
488
self._need_writelock()
489
490
## TODO: Show branch names
491
492
# TODO: Don't commit if there are no changes, unless forced?
493
494
# First walk over the working inventory; and both update that
495
# and also build a new revision inventory. The revision
496
# inventory needs to hold the text-id, sha1 and size of the
497
# actual file versions committed in the revision. (These are
498
# not present in the working inventory.) We also need to
499
# detect missing/deleted files, and remove them from the
500
# working inventory.
501
502
work_inv = self.read_working_inventory()
503
inv = Inventory()
504
basis = self.basis_tree()
505
basis_inv = basis.inventory
506
missing_ids = []
507
for path, entry in work_inv.iter_entries():
508
## TODO: Cope with files that have gone missing.
509
510
## TODO: Check that the file kind has not changed from the previous
511
## revision of this file (if any).
512
513
entry = entry.copy()
514
515
p = self.abspath(path)
516
file_id = entry.file_id
517
mutter('commit prep file %s, id %r ' % (p, file_id))
518
519
if not os.path.exists(p):
520
mutter(" file is missing, removing from inventory")
521
if verbose:
522
show_status('D', entry.kind, quotefn(path))
523
missing_ids.append(file_id)
524
continue
525
526
# TODO: Handle files that have been deleted
527
528
# TODO: Maybe a special case for empty files? Seems a
529
# waste to store them many times.
530
531
inv.add(entry)
532
533
if basis_inv.has_id(file_id):
534
old_kind = basis_inv[file_id].kind
535
if old_kind != entry.kind:
536
bailout("entry %r changed kind from %r to %r"
537
% (file_id, old_kind, entry.kind))
538
539
if entry.kind == 'directory':
540
if not isdir(p):
541
bailout("%s is entered as directory but not a directory" % quotefn(p))
542
elif entry.kind == 'file':
543
if not isfile(p):
544
bailout("%s is entered as file but is not a file" % quotefn(p))
545
546
content = file(p, 'rb').read()
547
548
entry.text_sha1 = sha_string(content)
549
entry.text_size = len(content)
550
551
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
552
if (old_ie
553
and (old_ie.text_size == entry.text_size)
554
and (old_ie.text_sha1 == entry.text_sha1)):
555
## assert content == basis.get_file(file_id).read()
556
entry.text_id = basis_inv[file_id].text_id
557
mutter(' unchanged from previous text_id {%s}' %
558
entry.text_id)
559
560
else:
561
entry.text_id = gen_file_id(entry.name)
562
self.text_store.add(content, entry.text_id)
563
mutter(' stored with text_id {%s}' % entry.text_id)
564
if verbose:
565
if not old_ie:
566
state = 'A'
567
elif (old_ie.name == entry.name
568
and old_ie.parent_id == entry.parent_id):
569
state = 'M'
570
else:
571
state = 'R'
572
573
show_status(state, entry.kind, quotefn(path))
574
575
for file_id in missing_ids:
576
# have to do this later so we don't mess up the iterator.
577
# since parents may be removed before their children we
578
# have to test.
579
580
# FIXME: There's probably a better way to do this; perhaps
581
# the workingtree should know how to filter itself.
582
if work_inv.has_id(file_id):
583
del work_inv[file_id]
584
585
586
inv_id = rev_id = _gen_revision_id(time.time())
587
588
inv_tmp = tempfile.TemporaryFile()
589
inv.write_xml(inv_tmp)
590
inv_tmp.seek(0)
591
self.inventory_store.add(inv_tmp, inv_id)
592
mutter('new inventory_id is {%s}' % inv_id)
593
594
self._write_inventory(work_inv)
595
596
if timestamp == None:
597
timestamp = time.time()
598
599
if committer == None:
600
committer = username()
601
602
if timezone == None:
603
timezone = local_time_offset()
604
605
mutter("building commit log message")
606
rev = Revision(timestamp=timestamp,
607
timezone=timezone,
608
committer=committer,
609
precursor = self.last_patch(),
610
message = message,
611
inventory_id=inv_id,
612
revision_id=rev_id)
613
614
rev_tmp = tempfile.TemporaryFile()
615
rev.write_xml(rev_tmp)
616
rev_tmp.seek(0)
617
self.revision_store.add(rev_tmp, rev_id)
618
mutter("new revision_id is {%s}" % rev_id)
619
620
## XXX: Everything up to here can simply be orphaned if we abort
621
## the commit; it will leave junk files behind but that doesn't
622
## matter.
623
624
## TODO: Read back the just-generated changeset, and make sure it
625
## applies and recreates the right state.
626
627
## TODO: Also calculate and store the inventory SHA1
628
mutter("committing patch r%d" % (self.revno() + 1))
629
630
631
self.append_revision(rev_id)
632
633
if verbose:
634
note("commited r%d" % self.revno())
635
636
637
def append_revision(self, revision_id):
638
mutter("add {%s} to revision-history" % revision_id)
639
rev_history = self.revision_history()
640
641
tmprhname = self.controlfilename('revision-history.tmp')
642
rhname = self.controlfilename('revision-history')
643
644
f = file(tmprhname, 'wt')
645
rev_history.append(revision_id)
646
f.write('\n'.join(rev_history))
647
f.write('\n')
648
f.close()
649
650
if sys.platform == 'win32':
651
os.remove(rhname)
652
os.rename(tmprhname, rhname)
653
654
655
656
def get_revision(self, revision_id):
657
"""Return the Revision object for a named revision"""
658
self._need_readlock()
659
r = Revision.read_xml(self.revision_store[revision_id])
660
assert r.revision_id == revision_id
661
return r
662
663
664
def get_inventory(self, inventory_id):
665
"""Get Inventory object by hash.
666
667
TODO: Perhaps for this and similar methods, take a revision
668
parameter which can be either an integer revno or a
669
string hash."""
670
self._need_readlock()
671
i = Inventory.read_xml(self.inventory_store[inventory_id])
672
return i
673
674
675
def get_revision_inventory(self, revision_id):
676
"""Return inventory of a past revision."""
677
self._need_readlock()
678
if revision_id == None:
679
return Inventory()
680
else:
681
return self.get_inventory(self.get_revision(revision_id).inventory_id)
682
305
raise NotImplementedError(self.print_file)
306
307
def append_revision(self, *revision_ids):
308
raise NotImplementedError(self.append_revision)
309
310
def set_revision_history(self, rev_history):
311
raise NotImplementedError(self.set_revision_history)
683
312
684
313
def revision_history(self):
685
"""Return sequence of revision hashes on to this branch.
686
687
>>> ScratchBranch().revision_history()
688
[]
689
"""
690
self._need_readlock()
691
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
692
693
694
def enum_history(self, direction):
695
"""Return (revno, revision_id) for history of branch.
696
697
direction
698
'forward' is from earliest to latest
699
'reverse' is from latest to earliest
700
"""
701
rh = self.revision_history()
702
if direction == 'forward':
703
i = 1
704
for rid in rh:
705
yield i, rid
706
i += 1
707
elif direction == 'reverse':
708
i = len(rh)
709
while i > 0:
710
yield i, rh[i-1]
711
i -= 1
712
else:
713
raise BzrError('invalid history direction %r' % direction)
714
314
"""Return sequence of revision hashes on to this branch."""
315
raise NotImplementedError(self.revision_history)
715
316
716
317
def revno(self):
717
318
"""Return current revision number for this branch.
718
319
719
320
That is equivalent to the number of revisions committed to
720
321
this branch.
721
722
>>> b = ScratchBranch()
723
>>> b.revno()
724
0
725
>>> b.commit('no foo')
726
>>> b.revno()
727
1
728
322
"""
729
323
return len(self.revision_history())
730
324
731
732
def last_patch(self):
733
"""Return last patch hash, or None if no history.
734
735
>>> ScratchBranch().last_patch() == None
736
True
737
"""
325
def unbind(self):
326
"""Older format branches cannot bind or unbind."""
327
raise errors.UpgradeRequired(self.base)
328
329
def set_append_revisions_only(self, enabled):
330
"""Older format branches are never restricted to append-only"""
331
raise errors.UpgradeRequired(self.base)
332
333
def last_revision(self):
334
"""Return last revision id, or None"""
738
335
ph = self.revision_history()
739
336
if ph:
740
337
return ph[-1]
741
338
else:
742
339
return None
340
341
def last_revision_info(self):
342
"""Return information about the last revision.
343
344
:return: A tuple (revno, last_revision_id).
345
"""
346
rh = self.revision_history()
347
revno = len(rh)
348
if revno:
349
return (revno, rh[-1])
350
else:
351
return (0, _mod_revision.NULL_REVISION)
352
353
def missing_revisions(self, other, stop_revision=None):
354
"""Return a list of new revisions that would perfectly fit.
743
355
744
745
def lookup_revision(self, revno):
746
"""Return revision hash for revision number."""
356
If self and other have not diverged, return a list of the revisions
357
present in other, but missing from self.
358
"""
359
self_history = self.revision_history()
360
self_len = len(self_history)
361
other_history = other.revision_history()
362
other_len = len(other_history)
363
common_index = min(self_len, other_len) -1
364
if common_index >= 0 and \
365
self_history[common_index] != other_history[common_index]:
366
raise DivergedBranches(self, other)
367
368
if stop_revision is None:
369
stop_revision = other_len
370
else:
371
assert isinstance(stop_revision, int)
372
if stop_revision > other_len:
373
raise errors.NoSuchRevision(self, stop_revision)
374
return other_history[self_len:stop_revision]
375
376
def update_revisions(self, other, stop_revision=None):
377
"""Pull in new perfect-fit revisions.
378
379
:param other: Another Branch to pull from
380
:param stop_revision: Updated until the given revision
381
:return: None
382
"""
383
raise NotImplementedError(self.update_revisions)
384
385
def revision_id_to_revno(self, revision_id):
386
"""Given a revision id, return its revno"""
387
if revision_id is None:
388
return 0
389
revision_id = osutils.safe_revision_id(revision_id)
390
history = self.revision_history()
391
try:
392
return history.index(revision_id) + 1
393
except ValueError:
394
raise bzrlib.errors.NoSuchRevision(self, revision_id)
395
396
def get_rev_id(self, revno, history=None):
397
"""Find the revision id of the specified revno."""
747
398
if revno == 0:
748
399
return None
749
750
try:
751
# list is 0-based; revisions are 1-based
752
return self.revision_history()[revno-1]
753
except IndexError:
754
raise BzrError("no such revision %s" % revno)
755
756
757
def revision_tree(self, revision_id):
758
"""Return Tree for a revision on this branch.
759
760
`revision_id` may be None for the null revision, in which case
761
an `EmptyTree` is returned."""
762
self._need_readlock()
763
if revision_id == None:
764
return EmptyTree()
765
else:
766
inv = self.get_revision_inventory(revision_id)
767
return RevisionTree(self.text_store, inv)
768
769
770
def working_tree(self):
771
"""Return a `Tree` for the working copy."""
772
return WorkingTree(self.base, self.read_working_inventory())
773
400
if history is None:
401
history = self.revision_history()
402
if revno <= 0 or revno > len(history):
403
raise bzrlib.errors.NoSuchRevision(self, revno)
404
return history[revno - 1]
405
406
def pull(self, source, overwrite=False, stop_revision=None):
407
"""Mirror source into this branch.
408
409
This branch is considered to be 'local', having low latency.
410
411
:returns: PullResult instance
412
"""
413
raise NotImplementedError(self.pull)
414
415
def push(self, target, overwrite=False, stop_revision=None):
416
"""Mirror this branch into target.
417
418
This branch is considered to be 'local', having low latency.
419
"""
420
raise NotImplementedError(self.push)
774
421
775
422
def basis_tree(self):
776
"""Return `Tree` object for last revision.
777
778
If there are no revisions yet, return an `EmptyTree`.
779
780
>>> b = ScratchBranch(files=['foo'])
781
>>> b.basis_tree().has_filename('foo')
782
False
783
>>> b.working_tree().has_filename('foo')
784
True
785
>>> b.add('foo')
786
>>> b.commit('add foo')
787
>>> b.basis_tree().has_filename('foo')
788
True
789
"""
790
r = self.last_patch()
791
if r == None:
792
return EmptyTree()
793
else:
794
return RevisionTree(self.text_store, self.get_revision_inventory(r))
795
796
423
"""Return `Tree` object for last revision."""
424
return self.repository.revision_tree(self.last_revision())
797
425
798
426
def rename_one(self, from_rel, to_rel):
799
427
"""Rename one file.
800
428
801
429
This can change the directory or the filename or both.
802
430
"""
803
self._need_writelock()
804
tree = self.working_tree()
805
inv = tree.inventory
806
if not tree.has_filename(from_rel):
807
bailout("can't rename: old working file %r does not exist" % from_rel)
808
if tree.has_filename(to_rel):
809
bailout("can't rename: new working file %r already exists" % to_rel)
810
811
file_id = inv.path2id(from_rel)
812
if file_id == None:
813
bailout("can't rename: old name %r is not versioned" % from_rel)
814
815
if inv.path2id(to_rel):
816
bailout("can't rename: new name %r is already versioned" % to_rel)
817
818
to_dir, to_tail = os.path.split(to_rel)
819
to_dir_id = inv.path2id(to_dir)
820
if to_dir_id == None and to_dir != '':
821
bailout("can't determine destination directory id for %r" % to_dir)
822
823
mutter("rename_one:")
824
mutter(" file_id {%s}" % file_id)
825
mutter(" from_rel %r" % from_rel)
826
mutter(" to_rel %r" % to_rel)
827
mutter(" to_dir %r" % to_dir)
828
mutter(" to_dir_id {%s}" % to_dir_id)
829
830
inv.rename(file_id, to_dir_id, to_tail)
831
832
print "%s => %s" % (from_rel, to_rel)
833
834
from_abs = self.abspath(from_rel)
835
to_abs = self.abspath(to_rel)
836
try:
837
os.rename(from_abs, to_abs)
838
except OSError, e:
839
bailout("failed to rename %r to %r: %s"
840
% (from_abs, to_abs, e[1]),
841
["rename rolled back"])
842
843
self._write_inventory(inv)
844
845
431
raise NotImplementedError(self.rename_one)
846
432
847
433
def move(self, from_paths, to_name):
848
434
"""Rename files.
854
440
855
441
Note that to_name is only the last component of the new name;
856
442
this doesn't change the directory.
857
"""
858
self._need_writelock()
859
## TODO: Option to move IDs only
860
assert not isinstance(from_paths, basestring)
861
tree = self.working_tree()
862
inv = tree.inventory
863
to_abs = self.abspath(to_name)
864
if not isdir(to_abs):
865
bailout("destination %r is not a directory" % to_abs)
866
if not tree.has_filename(to_name):
867
bailout("destination %r not in working directory" % to_abs)
868
to_dir_id = inv.path2id(to_name)
869
if to_dir_id == None and to_name != '':
870
bailout("destination %r is not a versioned directory" % to_name)
871
to_dir_ie = inv[to_dir_id]
872
if to_dir_ie.kind not in ('directory', 'root_directory'):
873
bailout("destination %r is not a directory" % to_abs)
874
875
to_idpath = Set(inv.get_idpath(to_dir_id))
876
877
for f in from_paths:
878
if not tree.has_filename(f):
879
bailout("%r does not exist in working tree" % f)
880
f_id = inv.path2id(f)
881
if f_id == None:
882
bailout("%r is not versioned" % f)
883
name_tail = splitpath(f)[-1]
884
dest_path = appendpath(to_name, name_tail)
885
if tree.has_filename(dest_path):
886
bailout("destination %r already exists" % dest_path)
887
if f_id in to_idpath:
888
bailout("can't move %r to a subdirectory of itself" % f)
889
890
# OK, so there's a race here, it's possible that someone will
891
# create a file in this interval and then the rename might be
892
# left half-done. But we should have caught most problems.
893
894
for f in from_paths:
895
name_tail = splitpath(f)[-1]
896
dest_path = appendpath(to_name, name_tail)
897
print "%s => %s" % (f, dest_path)
898
inv.rename(inv.path2id(f), to_dir_id, name_tail)
899
try:
900
os.rename(self.abspath(f), self.abspath(dest_path))
901
except OSError, e:
902
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
903
["rename rolled back"])
904
905
self._write_inventory(inv)
906
907
908
909
def show_status(self, show_all=False):
910
"""Display single-line status for non-ignored working files.
911
912
The list is show sorted in order by file name.
913
914
>>> b = ScratchBranch(files=['foo', 'foo~'])
915
>>> b.show_status()
916
? foo
917
>>> b.add('foo')
918
>>> b.show_status()
919
A foo
920
>>> b.commit("add foo")
921
>>> b.show_status()
922
>>> os.unlink(b.abspath('foo'))
923
>>> b.show_status()
924
D foo
925
926
TODO: Get state for single files.
927
"""
928
self._need_readlock()
929
930
# We have to build everything into a list first so that it can
931
# sorted by name, incorporating all the different sources.
932
933
# FIXME: Rather than getting things in random order and then sorting,
934
# just step through in order.
935
936
# Interesting case: the old ID for a file has been removed,
937
# but a new file has been created under that name.
938
939
old = self.basis_tree()
940
new = self.working_tree()
941
942
for fs, fid, oldname, newname, kind in diff_trees(old, new):
943
if fs == 'R':
944
show_status(fs, kind,
945
oldname + ' => ' + newname)
946
elif fs == 'A' or fs == 'M':
947
show_status(fs, kind, newname)
948
elif fs == 'D':
949
show_status(fs, kind, oldname)
950
elif fs == '.':
951
if show_all:
952
show_status(fs, kind, newname)
953
elif fs == 'I':
954
if show_all:
955
show_status(fs, kind, newname)
956
elif fs == '?':
957
show_status(fs, kind, newname)
958
else:
959
bailout("weird file state %r" % ((fs, fid),))
960
961
962
963
class ScratchBranch(Branch):
964
"""Special test class: a branch that cleans up after itself.
965
966
>>> b = ScratchBranch()
967
>>> isdir(b.base)
968
True
969
>>> bd = b.base
970
>>> b.destroy()
971
>>> isdir(bd)
972
False
973
"""
974
def __init__(self, files=[], dirs=[]):
975
"""Make a test branch.
976
977
This creates a temporary directory and runs init-tree in it.
978
979
If any files are listed, they are created in the working copy.
980
"""
981
Branch.__init__(self, tempfile.mkdtemp(), init=True)
982
for d in dirs:
983
os.mkdir(self.abspath(d))
443
444
This returns a list of (from_path, to_path) pairs for each
445
entry that is moved.
446
"""
447
raise NotImplementedError(self.move)
448
449
def get_parent(self):
450
"""Return the parent location of the branch.
451
452
This is the default location for push/pull/missing. The usual
453
pattern is that the user can override it by specifying a
454
location.
455
"""
456
raise NotImplementedError(self.get_parent)
457
458
def get_submit_branch(self):
459
"""Return the submit location of the branch.
460
461
This is the default location for bundle. The usual
462
pattern is that the user can override it by specifying a
463
location.
464
"""
465
return self.get_config().get_user_option('submit_branch')
466
467
def set_submit_branch(self, location):
468
"""Return the submit location of the branch.
469
470
This is the default location for bundle. The usual
471
pattern is that the user can override it by specifying a
472
location.
473
"""
474
self.get_config().set_user_option('submit_branch', location)
475
476
def get_push_location(self):
477
"""Return the None or the location to push this branch to."""
478
raise NotImplementedError(self.get_push_location)
479
480
def set_push_location(self, location):
481
"""Set a new push location for this branch."""
482
raise NotImplementedError(self.set_push_location)
483
484
def set_parent(self, url):
485
raise NotImplementedError(self.set_parent)
486
487
@needs_write_lock
488
def update(self):
489
"""Synchronise this branch with the master branch if any.
490
491
:return: None or the last_revision pivoted out during the update.
492
"""
493
return None
494
495
def check_revno(self, revno):
496
"""\
497
Check whether a revno corresponds to any revision.
498
Zero (the NULL revision) is considered valid.
499
"""
500
if revno != 0:
501
self.check_real_revno(revno)
984
502
985
for f in files:
986
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
987
988
989
def __del__(self):
990
self.destroy()
991
992
def destroy(self):
993
"""Destroy the test branch, removing the scratch directory."""
994
try:
995
mutter("delete ScratchBranch %s" % self.base)
996
shutil.rmtree(self.base)
997
except OSError, e:
998
# Work around for shutil.rmtree failing on Windows when
999
# readonly files are encountered
1000
mutter("hit exception in destroying ScratchBranch: %s" % e)
1001
for root, dirs, files in os.walk(self.base, topdown=False):
1002
for name in files:
1003
os.chmod(os.path.join(root, name), 0700)
1004
shutil.rmtree(self.base)
1005
self.base = None
1006
1007
1008
1009
######################################################################
1010
# predicates
1011
1012
1013
def is_control_file(filename):
1014
## FIXME: better check
1015
filename = os.path.normpath(filename)
1016
while filename != '':
1017
head, tail = os.path.split(filename)
1018
## mutter('check %r for control file' % ((head, tail), ))
1019
if tail == bzrlib.BZRDIR:
503
def check_real_revno(self, revno):
504
"""\
505
Check whether a revno corresponds to a real revision.
506
Zero (the NULL revision) is considered invalid
507
"""
508
if revno < 1 or revno > self.revno():
509
raise InvalidRevisionNumber(revno)
510
511
@needs_read_lock
512
def clone(self, *args, **kwargs):
513
"""Clone this branch into to_bzrdir preserving all semantic values.
514
515
revision_id: if not None, the revision history in the new branch will
516
be truncated to end with revision_id.
517
"""
518
# for API compatibility, until 0.8 releases we provide the old api:
519
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
520
# after 0.8 releases, the *args and **kwargs should be changed:
521
# def clone(self, to_bzrdir, revision_id=None):
522
if (kwargs.get('to_location', None) or
523
kwargs.get('revision', None) or
524
kwargs.get('basis_branch', None) or
525
(len(args) and isinstance(args[0], basestring))):
526
# backwards compatibility api:
527
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
528
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
529
# get basis_branch
530
if len(args) > 2:
531
basis_branch = args[2]
532
else:
533
basis_branch = kwargs.get('basis_branch', None)
534
if basis_branch:
535
basis = basis_branch.bzrdir
536
else:
537
basis = None
538
# get revision
539
if len(args) > 1:
540
revision_id = args[1]
541
else:
542
revision_id = kwargs.get('revision', None)
543
# get location
544
if len(args):
545
url = args[0]
546
else:
547
# no default to raise if not provided.
548
url = kwargs.get('to_location')
549
return self.bzrdir.clone(url,
550
revision_id=revision_id,
551
basis=basis).open_branch()
552
# new cleaner api.
553
# generate args by hand
554
if len(args) > 1:
555
revision_id = args[1]
556
else:
557
revision_id = kwargs.get('revision_id', None)
558
if len(args):
559
to_bzrdir = args[0]
560
else:
561
# no default to raise if not provided.
562
to_bzrdir = kwargs.get('to_bzrdir')
563
result = self._format.initialize(to_bzrdir)
564
self.copy_content_into(result, revision_id=revision_id)
565
return result
566
567
@needs_read_lock
568
def sprout(self, to_bzrdir, revision_id=None):
569
"""Create a new line of development from the branch, into to_bzrdir.
570
571
revision_id: if not None, the revision history in the new branch will
572
be truncated to end with revision_id.
573
"""
574
result = self._format.initialize(to_bzrdir)
575
self.copy_content_into(result, revision_id=revision_id)
576
result.set_parent(self.bzrdir.root_transport.base)
577
return result
578
579
def _synchronize_history(self, destination, revision_id):
580
"""Synchronize last revision and revision history between branches.
581
582
This version is most efficient when the destination is also a
583
BzrBranch5, but works for BzrBranch6 as long as the revision
584
history is the true lefthand parent history, and all of the revisions
585
are in the destination's repository. If not, set_revision_history
586
will fail.
587
588
:param destination: The branch to copy the history into
589
:param revision_id: The revision-id to truncate history at. May
590
be None to copy complete history.
591
"""
592
new_history = self.revision_history()
593
if revision_id is not None:
594
revision_id = osutils.safe_revision_id(revision_id)
595
try:
596
new_history = new_history[:new_history.index(revision_id) + 1]
597
except ValueError:
598
rev = self.repository.get_revision(revision_id)
599
new_history = rev.get_history(self.repository)[1:]
600
destination.set_revision_history(new_history)
601
602
@needs_read_lock
603
def copy_content_into(self, destination, revision_id=None):
604
"""Copy the content of self into destination.
605
606
revision_id: if not None, the revision history in the new branch will
607
be truncated to end with revision_id.
608
"""
609
self._synchronize_history(destination, revision_id)
610
try:
611
parent = self.get_parent()
612
except errors.InaccessibleParent, e:
613
mutter('parent was not accessible to copy: %s', e)
614
else:
615
if parent:
616
destination.set_parent(parent)
617
618
@needs_read_lock
619
def check(self):
620
"""Check consistency of the branch.
621
622
In particular this checks that revisions given in the revision-history
623
do actually match up in the revision graph, and that they're all
624
present in the repository.
625
626
Callers will typically also want to check the repository.
627
628
:return: A BranchCheckResult.
629
"""
630
mainline_parent_id = None
631
for revision_id in self.revision_history():
632
try:
633
revision = self.repository.get_revision(revision_id)
634
except errors.NoSuchRevision, e:
635
raise errors.BzrCheckError("mainline revision {%s} not in repository"
636
% revision_id)
637
# In general the first entry on the revision history has no parents.
638
# But it's not illegal for it to have parents listed; this can happen
639
# in imports from Arch when the parents weren't reachable.
640
if mainline_parent_id is not None:
641
if mainline_parent_id not in revision.parent_ids:
642
raise errors.BzrCheckError("previous revision {%s} not listed among "
643
"parents of {%s}"
644
% (mainline_parent_id, revision_id))
645
mainline_parent_id = revision_id
646
return BranchCheckResult(self)
647
648
def _get_checkout_format(self):
649
"""Return the most suitable metadir for a checkout of this branch.
650
Weaves are used if this branch's repostory uses weaves.
651
"""
652
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
653
from bzrlib.repofmt import weaverepo
654
format = bzrdir.BzrDirMetaFormat1()
655
format.repository_format = weaverepo.RepositoryFormat7()
656
else:
657
format = self.repository.bzrdir.cloning_metadir()
658
format.branch_format = self._format
659
return format
660
661
def create_checkout(self, to_location, revision_id=None,
662
lightweight=False):
663
"""Create a checkout of a branch.
664
665
:param to_location: The url to produce the checkout at
666
:param revision_id: The revision to check out
667
:param lightweight: If True, produce a lightweight checkout, otherwise,
668
produce a bound branch (heavyweight checkout)
669
:return: The tree of the created checkout
670
"""
671
t = transport.get_transport(to_location)
672
try:
673
t.mkdir('.')
674
except errors.FileExists:
675
pass
676
if lightweight:
677
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
678
BranchReferenceFormat().initialize(checkout, self)
679
else:
680
format = self._get_checkout_format()
681
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
682
to_location, force_new_tree=False, format=format)
683
checkout = checkout_branch.bzrdir
684
checkout_branch.bind(self)
685
# pull up to the specified revision_id to set the initial
686
# branch tip correctly, and seed it with history.
687
checkout_branch.pull(self, stop_revision=revision_id)
688
return checkout.create_workingtree(revision_id)
689
690
def supports_tags(self):
691
return self._format.supports_tags()
692
693
694
class BranchFormat(object):
695
"""An encapsulation of the initialization and open routines for a format.
696
697
Formats provide three things:
698
* An initialization routine,
699
* a format string,
700
* an open routine.
701
702
Formats are placed in an dict by their format string for reference
703
during branch opening. Its not required that these be instances, they
704
can be classes themselves with class methods - it simply depends on
705
whether state is needed for a given format or not.
706
707
Once a format is deprecated, just deprecate the initialize and open
708
methods on the format class. Do not deprecate the object, as the
709
object will be created every time regardless.
710
"""
711
712
_default_format = None
713
"""The default format used for new branches."""
714
715
_formats = {}
716
"""The known formats."""
717
718
@classmethod
719
def find_format(klass, a_bzrdir):
720
"""Return the format for the branch object in a_bzrdir."""
721
try:
722
transport = a_bzrdir.get_branch_transport(None)
723
format_string = transport.get("format").read()
724
return klass._formats[format_string]
725
except NoSuchFile:
726
raise NotBranchError(path=transport.base)
727
except KeyError:
728
raise errors.UnknownFormatError(format=format_string)
729
730
@classmethod
731
def get_default_format(klass):
732
"""Return the current default format."""
733
return klass._default_format
734
735
def get_format_string(self):
736
"""Return the ASCII format string that identifies this format."""
737
raise NotImplementedError(self.get_format_string)
738
739
def get_format_description(self):
740
"""Return the short format description for this format."""
741
raise NotImplementedError(self.get_format_description)
742
743
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
744
set_format=True):
745
"""Initialize a branch in a bzrdir, with specified files
746
747
:param a_bzrdir: The bzrdir to initialize the branch in
748
:param utf8_files: The files to create as a list of
749
(filename, content) tuples
750
:param set_format: If True, set the format with
751
self.get_format_string. (BzrBranch4 has its format set
752
elsewhere)
753
:return: a branch in this format
754
"""
755
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
756
branch_transport = a_bzrdir.get_branch_transport(self)
757
lock_map = {
758
'metadir': ('lock', lockdir.LockDir),
759
'branch4': ('branch-lock', lockable_files.TransportLock),
760
}
761
lock_name, lock_class = lock_map[lock_type]
762
control_files = lockable_files.LockableFiles(branch_transport,
763
lock_name, lock_class)
764
control_files.create_lock()
765
control_files.lock_write()
766
if set_format:
767
control_files.put_utf8('format', self.get_format_string())
768
try:
769
for file, content in utf8_files:
770
control_files.put_utf8(file, content)
771
finally:
772
control_files.unlock()
773
return self.open(a_bzrdir, _found=True)
774
775
def initialize(self, a_bzrdir):
776
"""Create a branch of this format in a_bzrdir."""
777
raise NotImplementedError(self.initialize)
778
779
def is_supported(self):
780
"""Is this format supported?
781
782
Supported formats can be initialized and opened.
783
Unsupported formats may not support initialization or committing or
784
some other features depending on the reason for not being supported.
785
"""
786
return True
787
788
def open(self, a_bzrdir, _found=False):
789
"""Return the branch object for a_bzrdir
790
791
_found is a private parameter, do not use it. It is used to indicate
792
if format probing has already be done.
793
"""
794
raise NotImplementedError(self.open)
795
796
@classmethod
797
def register_format(klass, format):
798
klass._formats[format.get_format_string()] = format
799
800
@classmethod
801
def set_default_format(klass, format):
802
klass._default_format = format
803
804
@classmethod
805
def unregister_format(klass, format):
806
assert klass._formats[format.get_format_string()] is format
807
del klass._formats[format.get_format_string()]
808
809
def __str__(self):
810
return self.get_format_string().rstrip()
811
812
def supports_tags(self):
813
"""True if this format supports tags stored in the branch"""
814
return False # by default
815
816
# XXX: Probably doesn't really belong here -- mbp 20070212
817
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
818
lock_class):
819
branch_transport = a_bzrdir.get_branch_transport(self)
820
control_files = lockable_files.LockableFiles(branch_transport,
821
lock_filename, lock_class)
822
control_files.create_lock()
823
control_files.lock_write()
824
try:
825
for filename, content in utf8_files:
826
control_files.put_utf8(filename, content)
827
finally:
828
control_files.unlock()
829
830
831
class BranchHooks(dict):
832
"""A dictionary mapping hook name to a list of callables for branch hooks.
833
834
e.g. ['set_rh'] Is the list of items to be called when the
835
set_revision_history function is invoked.
836
"""
837
838
def __init__(self):
839
"""Create the default hooks.
840
841
These are all empty initially, because by default nothing should get
842
notified.
843
"""
844
dict.__init__(self)
845
# Introduced in 0.15:
846
# invoked whenever the revision history has been set
847
# with set_revision_history. The api signature is
848
# (branch, revision_history), and the branch will
849
# be write-locked.
850
self['set_rh'] = []
851
# invoked after a push operation completes.
852
# the api signature is
853
# (push_result)
854
# containing the members
855
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
856
# where local is the local branch or None, master is the target
857
# master branch, and the rest should be self explanatory. The source
858
# is read locked and the target branches write locked. Source will
859
# be the local low-latency branch.
860
self['post_push'] = []
861
# invoked after a pull operation completes.
862
# the api signature is
863
# (pull_result)
864
# containing the members
865
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
866
# where local is the local branch or None, master is the target
867
# master branch, and the rest should be self explanatory. The source
868
# is read locked and the target branches write locked. The local
869
# branch is the low-latency branch.
870
self['post_pull'] = []
871
# invoked after a commit operation completes.
872
# the api signature is
873
# (local, master, old_revno, old_revid, new_revno, new_revid)
874
# old_revid is NULL_REVISION for the first commit to a branch.
875
self['post_commit'] = []
876
# invoked after a uncommit operation completes.
877
# the api signature is
878
# (local, master, old_revno, old_revid, new_revno, new_revid) where
879
# local is the local branch or None, master is the target branch,
880
# and an empty branch recieves new_revno of 0, new_revid of None.
881
self['post_uncommit'] = []
882
883
def install_hook(self, hook_name, a_callable):
884
"""Install a_callable in to the hook hook_name.
885
886
:param hook_name: A hook name. See the __init__ method of BranchHooks
887
for the complete list of hooks.
888
:param a_callable: The callable to be invoked when the hook triggers.
889
The exact signature will depend on the hook - see the __init__
890
method of BranchHooks for details on each hook.
891
"""
892
try:
893
self[hook_name].append(a_callable)
894
except KeyError:
895
raise errors.UnknownHook('branch', hook_name)
896
897
898
# install the default hooks into the Branch class.
899
Branch.hooks = BranchHooks()
900
901
902
class BzrBranchFormat4(BranchFormat):
903
"""Bzr branch format 4.
904
905
This format has:
906
- a revision-history file.
907
- a branch-lock lock file [ to be shared with the bzrdir ]
908
"""
909
910
def get_format_description(self):
911
"""See BranchFormat.get_format_description()."""
912
return "Branch format 4"
913
914
def initialize(self, a_bzrdir):
915
"""Create a branch of this format in a_bzrdir."""
916
utf8_files = [('revision-history', ''),
917
('branch-name', ''),
918
]
919
return self._initialize_helper(a_bzrdir, utf8_files,
920
lock_type='branch4', set_format=False)
921
922
def __init__(self):
923
super(BzrBranchFormat4, self).__init__()
924
self._matchingbzrdir = bzrdir.BzrDirFormat6()
925
926
def open(self, a_bzrdir, _found=False):
927
"""Return the branch object for a_bzrdir
928
929
_found is a private parameter, do not use it. It is used to indicate
930
if format probing has already be done.
931
"""
932
if not _found:
933
# we are being called directly and must probe.
934
raise NotImplementedError
935
return BzrBranch(_format=self,
936
_control_files=a_bzrdir._control_files,
937
a_bzrdir=a_bzrdir,
938
_repository=a_bzrdir.open_repository())
939
940
def __str__(self):
941
return "Bazaar-NG branch format 4"
942
943
944
class BzrBranchFormat5(BranchFormat):
945
"""Bzr branch format 5.
946
947
This format has:
948
- a revision-history file.
949
- a format string
950
- a lock dir guarding the branch itself
951
- all of this stored in a branch/ subdirectory
952
- works with shared repositories.
953
954
This format is new in bzr 0.8.
955
"""
956
957
def get_format_string(self):
958
"""See BranchFormat.get_format_string()."""
959
return "Bazaar-NG branch format 5\n"
960
961
def get_format_description(self):
962
"""See BranchFormat.get_format_description()."""
963
return "Branch format 5"
964
965
def initialize(self, a_bzrdir):
966
"""Create a branch of this format in a_bzrdir."""
967
utf8_files = [('revision-history', ''),
968
('branch-name', ''),
969
]
970
return self._initialize_helper(a_bzrdir, utf8_files)
971
972
def __init__(self):
973
super(BzrBranchFormat5, self).__init__()
974
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
975
976
def open(self, a_bzrdir, _found=False):
977
"""Return the branch object for a_bzrdir
978
979
_found is a private parameter, do not use it. It is used to indicate
980
if format probing has already be done.
981
"""
982
if not _found:
983
format = BranchFormat.find_format(a_bzrdir)
984
assert format.__class__ == self.__class__
985
transport = a_bzrdir.get_branch_transport(None)
986
control_files = lockable_files.LockableFiles(transport, 'lock',
987
lockdir.LockDir)
988
return BzrBranch5(_format=self,
989
_control_files=control_files,
990
a_bzrdir=a_bzrdir,
991
_repository=a_bzrdir.find_repository())
992
993
994
class BzrBranchFormat6(BzrBranchFormat5):
995
"""Branch format with last-revision
996
997
Unlike previous formats, this has no explicit revision history. Instead,
998
this just stores the last-revision, and the left-hand history leading
999
up to there is the history.
1000
1001
This format was introduced in bzr 0.15
1002
"""
1003
1004
def get_format_string(self):
1005
"""See BranchFormat.get_format_string()."""
1006
return "Bazaar-NG branch format 6\n"
1007
1008
def get_format_description(self):
1009
"""See BranchFormat.get_format_description()."""
1010
return "Branch format 6"
1011
1012
def initialize(self, a_bzrdir):
1013
"""Create a branch of this format in a_bzrdir."""
1014
utf8_files = [('last-revision', '0 null:\n'),
1015
('branch-name', ''),
1016
('branch.conf', ''),
1017
('tags', ''),
1018
]
1019
return self._initialize_helper(a_bzrdir, utf8_files)
1020
1021
def open(self, a_bzrdir, _found=False):
1022
"""Return the branch object for a_bzrdir
1023
1024
_found is a private parameter, do not use it. It is used to indicate
1025
if format probing has already be done.
1026
"""
1027
if not _found:
1028
format = BranchFormat.find_format(a_bzrdir)
1029
assert format.__class__ == self.__class__
1030
transport = a_bzrdir.get_branch_transport(None)
1031
control_files = lockable_files.LockableFiles(transport, 'lock',
1032
lockdir.LockDir)
1033
return BzrBranch6(_format=self,
1034
_control_files=control_files,
1035
a_bzrdir=a_bzrdir,
1036
_repository=a_bzrdir.find_repository())
1037
1038
def supports_tags(self):
1039
return True
1040
1041
1042
class BranchReferenceFormat(BranchFormat):
1043
"""Bzr branch reference format.
1044
1045
Branch references are used in implementing checkouts, they
1046
act as an alias to the real branch which is at some other url.
1047
1048
This format has:
1049
- A location file
1050
- a format string
1051
"""
1052
1053
def get_format_string(self):
1054
"""See BranchFormat.get_format_string()."""
1055
return "Bazaar-NG Branch Reference Format 1\n"
1056
1057
def get_format_description(self):
1058
"""See BranchFormat.get_format_description()."""
1059
return "Checkout reference format 1"
1060
1061
def initialize(self, a_bzrdir, target_branch=None):
1062
"""Create a branch of this format in a_bzrdir."""
1063
if target_branch is None:
1064
# this format does not implement branch itself, thus the implicit
1065
# creation contract must see it as uninitializable
1066
raise errors.UninitializableFormat(self)
1067
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1068
branch_transport = a_bzrdir.get_branch_transport(self)
1069
branch_transport.put_bytes('location',
1070
target_branch.bzrdir.root_transport.base)
1071
branch_transport.put_bytes('format', self.get_format_string())
1072
return self.open(a_bzrdir, _found=True)
1073
1074
def __init__(self):
1075
super(BranchReferenceFormat, self).__init__()
1076
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1077
1078
def _make_reference_clone_function(format, a_branch):
1079
"""Create a clone() routine for a branch dynamically."""
1080
def clone(to_bzrdir, revision_id=None):
1081
"""See Branch.clone()."""
1082
return format.initialize(to_bzrdir, a_branch)
1083
# cannot obey revision_id limits when cloning a reference ...
1084
# FIXME RBC 20060210 either nuke revision_id for clone, or
1085
# emit some sort of warning/error to the caller ?!
1086
return clone
1087
1088
def open(self, a_bzrdir, _found=False):
1089
"""Return the branch that the branch reference in a_bzrdir points at.
1090
1091
_found is a private parameter, do not use it. It is used to indicate
1092
if format probing has already be done.
1093
"""
1094
if not _found:
1095
format = BranchFormat.find_format(a_bzrdir)
1096
assert format.__class__ == self.__class__
1097
transport = a_bzrdir.get_branch_transport(None)
1098
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1099
result = real_bzrdir.open_branch()
1100
# this changes the behaviour of result.clone to create a new reference
1101
# rather than a copy of the content of the branch.
1102
# I did not use a proxy object because that needs much more extensive
1103
# testing, and we are only changing one behaviour at the moment.
1104
# If we decide to alter more behaviours - i.e. the implicit nickname
1105
# then this should be refactored to introduce a tested proxy branch
1106
# and a subclass of that for use in overriding clone() and ....
1107
# - RBC 20060210
1108
result.clone = self._make_reference_clone_function(result)
1109
return result
1110
1111
1112
# formats which have no format string are not discoverable
1113
# and not independently creatable, so are not registered.
1114
__default_format = BzrBranchFormat5()
1115
BranchFormat.register_format(__default_format)
1116
BranchFormat.register_format(BranchReferenceFormat())
1117
BranchFormat.register_format(BzrBranchFormat6())
1118
BranchFormat.set_default_format(__default_format)
1119
_legacy_formats = [BzrBranchFormat4(),
1120
]
1121
1122
class BzrBranch(Branch):
1123
"""A branch stored in the actual filesystem.
1124
1125
Note that it's "local" in the context of the filesystem; it doesn't
1126
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1127
it's writable, and can be accessed via the normal filesystem API.
1128
"""
1129
1130
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1131
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1132
_control_files=None, a_bzrdir=None, _repository=None):
1133
"""Create new branch object at a particular location.
1134
1135
transport -- A Transport object, defining how to access files.
1136
1137
init -- If True, create new control files in a previously
1138
unversioned directory. If False, the branch must already
1139
be versioned.
1140
1141
relax_version_check -- If true, the usual check for the branch
1142
version is not applied. This is intended only for
1143
upgrade/recovery type use; it's not guaranteed that
1144
all operations will work on old format branches.
1145
"""
1146
Branch.__init__(self)
1147
if a_bzrdir is None:
1148
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1149
else:
1150
self.bzrdir = a_bzrdir
1151
# self._transport used to point to the directory containing the
1152
# control directory, but was not used - now it's just the transport
1153
# for the branch control files. mbp 20070212
1154
self._base = self.bzrdir.transport.clone('..').base
1155
self._format = _format
1156
if _control_files is None:
1157
raise ValueError('BzrBranch _control_files is None')
1158
self.control_files = _control_files
1159
self._transport = _control_files._transport
1160
if deprecated_passed(init):
1161
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1162
"deprecated as of bzr 0.8. Please use Branch.create().",
1163
DeprecationWarning,
1164
stacklevel=2)
1165
if init:
1166
# this is slower than before deprecation, oh well never mind.
1167
# -> its deprecated.
1168
self._initialize(transport.base)
1169
self._check_format(_format)
1170
if deprecated_passed(relax_version_check):
1171
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1172
"relax_version_check parameter is deprecated as of bzr 0.8. "
1173
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1174
"open() method.",
1175
DeprecationWarning,
1176
stacklevel=2)
1177
if (not relax_version_check
1178
and not self._format.is_supported()):
1179
raise errors.UnsupportedFormatError(format=fmt)
1180
if deprecated_passed(transport):
1181
warn("BzrBranch.__init__(transport=XXX...): The transport "
1182
"parameter is deprecated as of bzr 0.8. "
1183
"Please use Branch.open, or bzrdir.open_branch().",
1184
DeprecationWarning,
1185
stacklevel=2)
1186
self.repository = _repository
1187
1188
def __str__(self):
1189
return '%s(%r)' % (self.__class__.__name__, self.base)
1190
1191
__repr__ = __str__
1192
1193
def _get_base(self):
1194
"""Returns the directory containing the control directory."""
1195
return self._base
1196
1197
base = property(_get_base, doc="The URL for the root of this branch.")
1198
1199
def _finish_transaction(self):
1200
"""Exit the current transaction."""
1201
return self.control_files._finish_transaction()
1202
1203
def get_transaction(self):
1204
"""Return the current active transaction.
1205
1206
If no transaction is active, this returns a passthrough object
1207
for which all data is immediately flushed and no caching happens.
1208
"""
1209
# this is an explicit function so that we can do tricky stuff
1210
# when the storage in rev_storage is elsewhere.
1211
# we probably need to hook the two 'lock a location' and
1212
# 'have a transaction' together more delicately, so that
1213
# we can have two locks (branch and storage) and one transaction
1214
# ... and finishing the transaction unlocks both, but unlocking
1215
# does not. - RBC 20051121
1216
return self.control_files.get_transaction()
1217
1218
def _set_transaction(self, transaction):
1219
"""Set a new active transaction."""
1220
return self.control_files._set_transaction(transaction)
1221
1222
def abspath(self, name):
1223
"""See Branch.abspath."""
1224
return self.control_files._transport.abspath(name)
1225
1226
def _check_format(self, format):
1227
"""Identify the branch format if needed.
1228
1229
The format is stored as a reference to the format object in
1230
self._format for code that needs to check it later.
1231
1232
The format parameter is either None or the branch format class
1233
used to open this branch.
1234
1235
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1236
"""
1237
if format is None:
1238
format = BranchFormat.find_format(self.bzrdir)
1239
self._format = format
1240
mutter("got branch format %s", self._format)
1241
1242
@needs_read_lock
1243
def get_root_id(self):
1244
"""See Branch.get_root_id."""
1245
tree = self.repository.revision_tree(self.last_revision())
1246
return tree.inventory.root.file_id
1247
1248
def is_locked(self):
1249
return self.control_files.is_locked()
1250
1251
def lock_write(self):
1252
self.repository.lock_write()
1253
try:
1254
self.control_files.lock_write()
1255
except:
1256
self.repository.unlock()
1257
raise
1258
1259
def lock_read(self):
1260
self.repository.lock_read()
1261
try:
1262
self.control_files.lock_read()
1263
except:
1264
self.repository.unlock()
1265
raise
1266
1267
def unlock(self):
1268
# TODO: test for failed two phase locks. This is known broken.
1269
try:
1270
self.control_files.unlock()
1271
finally:
1272
self.repository.unlock()
1273
1274
def peek_lock_mode(self):
1275
if self.control_files._lock_count == 0:
1276
return None
1277
else:
1278
return self.control_files._lock_mode
1279
1280
def get_physical_lock_status(self):
1281
return self.control_files.get_physical_lock_status()
1282
1283
@needs_read_lock
1284
def print_file(self, file, revision_id):
1285
"""See Branch.print_file."""
1286
return self.repository.print_file(file, revision_id)
1287
1288
@needs_write_lock
1289
def append_revision(self, *revision_ids):
1290
"""See Branch.append_revision."""
1291
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1292
for revision_id in revision_ids:
1293
_mod_revision.check_not_reserved_id(revision_id)
1294
mutter("add {%s} to revision-history" % revision_id)
1295
rev_history = self.revision_history()
1296
rev_history.extend(revision_ids)
1297
self.set_revision_history(rev_history)
1298
1299
def _write_revision_history(self, history):
1300
"""Factored out of set_revision_history.
1301
1302
This performs the actual writing to disk.
1303
It is intended to be called by BzrBranch5.set_revision_history."""
1304
self.control_files.put_bytes(
1305
'revision-history', '\n'.join(history))
1306
1307
@needs_write_lock
1308
def set_revision_history(self, rev_history):
1309
"""See Branch.set_revision_history."""
1310
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1311
self._write_revision_history(rev_history)
1312
transaction = self.get_transaction()
1313
history = transaction.map.find_revision_history()
1314
if history is not None:
1315
# update the revision history in the identity map.
1316
history[:] = list(rev_history)
1317
# this call is disabled because revision_history is
1318
# not really an object yet, and the transaction is for objects.
1319
# transaction.register_dirty(history)
1320
else:
1321
transaction.map.add_revision_history(rev_history)
1322
# this call is disabled because revision_history is
1323
# not really an object yet, and the transaction is for objects.
1324
# transaction.register_clean(history)
1325
for hook in Branch.hooks['set_rh']:
1326
hook(self, rev_history)
1327
1328
@needs_write_lock
1329
def set_last_revision_info(self, revno, revision_id):
1330
revision_id = osutils.safe_revision_id(revision_id)
1331
history = self._lefthand_history(revision_id)
1332
assert len(history) == revno, '%d != %d' % (len(history), revno)
1333
self.set_revision_history(history)
1334
1335
def _gen_revision_history(self):
1336
get_cached_utf8 = cache_utf8.get_cached_utf8
1337
history = [get_cached_utf8(l.rstrip('\r\n')) for l in
1338
self.control_files.get('revision-history').readlines()]
1339
return history
1340
1341
@needs_read_lock
1342
def revision_history(self):
1343
"""See Branch.revision_history."""
1344
transaction = self.get_transaction()
1345
history = transaction.map.find_revision_history()
1346
if history is not None:
1347
# mutter("cache hit for revision-history in %s", self)
1348
return list(history)
1349
history = self._gen_revision_history()
1350
transaction.map.add_revision_history(history)
1351
# this call is disabled because revision_history is
1352
# not really an object yet, and the transaction is for objects.
1353
# transaction.register_clean(history, precious=True)
1354
return list(history)
1355
1356
def _lefthand_history(self, revision_id, last_rev=None,
1357
other_branch=None):
1358
# stop_revision must be a descendant of last_revision
1359
stop_graph = self.repository.get_revision_graph(revision_id)
1360
if last_rev is not None and last_rev not in stop_graph:
1361
# our previous tip is not merged into stop_revision
1362
raise errors.DivergedBranches(self, other_branch)
1363
# make a new revision history from the graph
1364
current_rev_id = revision_id
1365
new_history = []
1366
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1367
new_history.append(current_rev_id)
1368
current_rev_id_parents = stop_graph[current_rev_id]
1369
try:
1370
current_rev_id = current_rev_id_parents[0]
1371
except IndexError:
1372
current_rev_id = None
1373
new_history.reverse()
1374
return new_history
1375
1376
@needs_write_lock
1377
def generate_revision_history(self, revision_id, last_rev=None,
1378
other_branch=None):
1379
"""Create a new revision history that will finish with revision_id.
1380
1381
:param revision_id: the new tip to use.
1382
:param last_rev: The previous last_revision. If not None, then this
1383
must be a ancestory of revision_id, or DivergedBranches is raised.
1384
:param other_branch: The other branch that DivergedBranches should
1385
raise with respect to.
1386
"""
1387
revision_id = osutils.safe_revision_id(revision_id)
1388
self.set_revision_history(self._lefthand_history(revision_id,
1389
last_rev, other_branch))
1390
1391
@needs_write_lock
1392
def update_revisions(self, other, stop_revision=None):
1393
"""See Branch.update_revisions."""
1394
other.lock_read()
1395
try:
1396
if stop_revision is None:
1397
stop_revision = other.last_revision()
1398
if stop_revision is None:
1399
# if there are no commits, we're done.
1400
return
1401
else:
1402
stop_revision = osutils.safe_revision_id(stop_revision)
1403
# whats the current last revision, before we fetch [and change it
1404
# possibly]
1405
last_rev = self.last_revision()
1406
# we fetch here regardless of whether we need to so that we pickup
1407
# filled in ghosts.
1408
self.fetch(other, stop_revision)
1409
my_ancestry = self.repository.get_ancestry(last_rev)
1410
if stop_revision in my_ancestry:
1411
# last_revision is a descendant of stop_revision
1412
return
1413
self.generate_revision_history(stop_revision, last_rev=last_rev,
1414
other_branch=other)
1415
finally:
1416
other.unlock()
1417
1418
def basis_tree(self):
1419
"""See Branch.basis_tree."""
1420
return self.repository.revision_tree(self.last_revision())
1421
1422
@deprecated_method(zero_eight)
1423
def working_tree(self):
1424
"""Create a Working tree object for this branch."""
1425
1426
from bzrlib.transport.local import LocalTransport
1427
if (self.base.find('://') != -1 or
1428
not isinstance(self._transport, LocalTransport)):
1429
raise NoWorkingTree(self.base)
1430
return self.bzrdir.open_workingtree()
1431
1432
@needs_write_lock
1433
def pull(self, source, overwrite=False, stop_revision=None,
1434
_hook_master=None, _run_hooks=True):
1435
"""See Branch.pull.
1436
1437
:param _hook_master: Private parameter - set the branch to
1438
be supplied as the master to push hooks.
1439
:param _run_hooks: Private parameter - allow disabling of
1440
hooks, used when pushing to a master branch.
1441
"""
1442
result = PullResult()
1443
result.source_branch = source
1444
result.target_branch = self
1445
source.lock_read()
1446
try:
1447
result.old_revno, result.old_revid = self.last_revision_info()
1448
try:
1449
self.update_revisions(source, stop_revision)
1450
except DivergedBranches:
1451
if not overwrite:
1452
raise
1453
if overwrite:
1454
if stop_revision is None:
1455
stop_revision = source.last_revision()
1456
self.generate_revision_history(stop_revision)
1457
result.tag_conflicts = source.tags.merge_to(self.tags)
1458
result.new_revno, result.new_revid = self.last_revision_info()
1459
if _hook_master:
1460
result.master_branch = _hook_master
1461
result.local_branch = self
1462
else:
1463
result.master_branch = self
1464
result.local_branch = None
1465
if _run_hooks:
1466
for hook in Branch.hooks['post_pull']:
1467
hook(result)
1468
finally:
1469
source.unlock()
1470
return result
1471
1472
def _get_parent_location(self):
1473
_locs = ['parent', 'pull', 'x-pull']
1474
for l in _locs:
1475
try:
1476
return self.control_files.get(l).read().strip('\n')
1477
except NoSuchFile:
1478
pass
1479
return None
1480
1481
@needs_read_lock
1482
def push(self, target, overwrite=False, stop_revision=None,
1483
_hook_master=None, _run_hooks=True):
1484
"""See Branch.push.
1485
1486
:param _hook_master: Private parameter - set the branch to
1487
be supplied as the master to push hooks.
1488
:param _run_hooks: Private parameter - allow disabling of
1489
hooks, used when pushing to a master branch.
1490
"""
1491
result = PushResult()
1492
result.source_branch = self
1493
result.target_branch = target
1494
target.lock_write()
1495
try:
1496
result.old_revno, result.old_revid = target.last_revision_info()
1497
try:
1498
target.update_revisions(self, stop_revision)
1499
except DivergedBranches:
1500
if not overwrite:
1501
raise
1502
if overwrite:
1503
target.set_revision_history(self.revision_history())
1504
result.tag_conflicts = self.tags.merge_to(target.tags)
1505
result.new_revno, result.new_revid = target.last_revision_info()
1506
if _hook_master:
1507
result.master_branch = _hook_master
1508
result.local_branch = target
1509
else:
1510
result.master_branch = target
1511
result.local_branch = None
1512
if _run_hooks:
1513
for hook in Branch.hooks['post_push']:
1514
hook(result)
1515
finally:
1516
target.unlock()
1517
return result
1518
1519
def get_parent(self):
1520
"""See Branch.get_parent."""
1521
1522
assert self.base[-1] == '/'
1523
parent = self._get_parent_location()
1524
if parent is None:
1525
return parent
1526
# This is an old-format absolute path to a local branch
1527
# turn it into a url
1528
if parent.startswith('/'):
1529
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1530
try:
1531
return urlutils.join(self.base[:-1], parent)
1532
except errors.InvalidURLJoin, e:
1533
raise errors.InaccessibleParent(parent, self.base)
1534
1535
def get_push_location(self):
1536
"""See Branch.get_push_location."""
1537
push_loc = self.get_config().get_user_option('push_location')
1538
return push_loc
1539
1540
def set_push_location(self, location):
1541
"""See Branch.set_push_location."""
1542
self.get_config().set_user_option(
1543
'push_location', location,
1544
store=_mod_config.STORE_LOCATION_NORECURSE)
1545
1546
@needs_write_lock
1547
def set_parent(self, url):
1548
"""See Branch.set_parent."""
1549
# TODO: Maybe delete old location files?
1550
# URLs should never be unicode, even on the local fs,
1551
# FIXUP this and get_parent in a future branch format bump:
1552
# read and rewrite the file, and have the new format code read
1553
# using .get not .get_utf8. RBC 20060125
1554
if url is not None:
1555
if isinstance(url, unicode):
1556
try:
1557
url = url.encode('ascii')
1558
except UnicodeEncodeError:
1559
raise bzrlib.errors.InvalidURL(url,
1560
"Urls must be 7-bit ascii, "
1561
"use bzrlib.urlutils.escape")
1562
url = urlutils.relative_url(self.base, url)
1563
self._set_parent_location(url)
1564
1565
def _set_parent_location(self, url):
1566
if url is None:
1567
self.control_files._transport.delete('parent')
1568
else:
1569
assert isinstance(url, str)
1570
self.control_files.put_bytes('parent', url + '\n')
1571
1572
@deprecated_function(zero_nine)
1573
def tree_config(self):
1574
"""DEPRECATED; call get_config instead.
1575
TreeConfig has become part of BranchConfig."""
1576
return TreeConfig(self)
1577
1578
1579
class BzrBranch5(BzrBranch):
1580
"""A format 5 branch. This supports new features over plan branches.
1581
1582
It has support for a master_branch which is the data for bound branches.
1583
"""
1584
1585
def __init__(self,
1586
_format,
1587
_control_files,
1588
a_bzrdir,
1589
_repository):
1590
super(BzrBranch5, self).__init__(_format=_format,
1591
_control_files=_control_files,
1592
a_bzrdir=a_bzrdir,
1593
_repository=_repository)
1594
1595
@needs_write_lock
1596
def pull(self, source, overwrite=False, stop_revision=None,
1597
_run_hooks=True):
1598
"""Extends branch.pull to be bound branch aware.
1599
1600
:param _run_hooks: Private parameter used to force hook running
1601
off during bound branch double-pushing.
1602
"""
1603
bound_location = self.get_bound_location()
1604
master_branch = None
1605
if bound_location and source.base != bound_location:
1606
# not pulling from master, so we need to update master.
1607
master_branch = self.get_master_branch()
1608
master_branch.lock_write()
1609
try:
1610
if master_branch:
1611
# pull from source into master.
1612
master_branch.pull(source, overwrite, stop_revision,
1613
_run_hooks=False)
1614
return super(BzrBranch5, self).pull(source, overwrite,
1615
stop_revision, _hook_master=master_branch,
1616
_run_hooks=_run_hooks)
1617
finally:
1618
if master_branch:
1619
master_branch.unlock()
1620
1621
@needs_read_lock
1622
def push(self, target, overwrite=False, stop_revision=None):
1623
"""Updates branch.push to be bound branch aware."""
1624
bound_location = target.get_bound_location()
1625
master_branch = None
1626
if bound_location and target.base != bound_location:
1627
# not pushing to master, so we need to update master.
1628
master_branch = target.get_master_branch()
1629
master_branch.lock_write()
1630
try:
1631
if master_branch:
1632
# push into the master from this branch.
1633
super(BzrBranch5, self).push(master_branch, overwrite,
1634
stop_revision, _run_hooks=False)
1635
# and push into the target branch from this. Note that we push from
1636
# this branch again, because its considered the highest bandwidth
1637
# repository.
1638
return super(BzrBranch5, self).push(target, overwrite,
1639
stop_revision, _hook_master=master_branch)
1640
finally:
1641
if master_branch:
1642
master_branch.unlock()
1643
1644
def get_bound_location(self):
1645
try:
1646
return self.control_files.get_utf8('bound').read()[:-1]
1647
except errors.NoSuchFile:
1648
return None
1649
1650
@needs_read_lock
1651
def get_master_branch(self):
1652
"""Return the branch we are bound to.
1653
1654
:return: Either a Branch, or None
1655
1656
This could memoise the branch, but if thats done
1657
it must be revalidated on each new lock.
1658
So for now we just don't memoise it.
1659
# RBC 20060304 review this decision.
1660
"""
1661
bound_loc = self.get_bound_location()
1662
if not bound_loc:
1663
return None
1664
try:
1665
return Branch.open(bound_loc)
1666
except (errors.NotBranchError, errors.ConnectionError), e:
1667
raise errors.BoundBranchConnectionFailure(
1668
self, bound_loc, e)
1669
1670
@needs_write_lock
1671
def set_bound_location(self, location):
1672
"""Set the target where this branch is bound to.
1673
1674
:param location: URL to the target branch
1675
"""
1676
if location:
1677
self.control_files.put_utf8('bound', location+'\n')
1678
else:
1679
try:
1680
self.control_files._transport.delete('bound')
1681
except NoSuchFile:
1682
return False
1020
1683
return True
1021
if filename == head:
1022
break
1023
filename = head
1024
return False
1025
1026
1027
1028
def _gen_revision_id(when):
1029
"""Return new revision-id."""
1030
s = '%s-%s-' % (user_email(), compact_date(when))
1031
s += hexlify(rand_bytes(8))
1032
return s
1033
1034
1035
def gen_file_id(name):
1036
"""Return new file id.
1037
1038
This should probably generate proper UUIDs, but for the moment we
1039
cope with just randomness because running uuidgen every time is
1040
slow."""
1041
idx = name.rfind('/')
1042
if idx != -1:
1043
name = name[idx+1 : ]
1044
idx = name.rfind('\\')
1045
if idx != -1:
1046
name = name[idx+1 : ]
1047
1048
name = name.lstrip('.')
1049
1050
s = hexlify(rand_bytes(8))
1051
return '-'.join((name, compact_date(time.time()), s))
1684
1685
@needs_write_lock
1686
def bind(self, other):
1687
"""Bind this branch to the branch other.
1688
1689
This does not push or pull data between the branches, though it does
1690
check for divergence to raise an error when the branches are not
1691
either the same, or one a prefix of the other. That behaviour may not
1692
be useful, so that check may be removed in future.
1693
1694
:param other: The branch to bind to
1695
:type other: Branch
1696
"""
1697
# TODO: jam 20051230 Consider checking if the target is bound
1698
# It is debatable whether you should be able to bind to
1699
# a branch which is itself bound.
1700
# Committing is obviously forbidden,
1701
# but binding itself may not be.
1702
# Since we *have* to check at commit time, we don't
1703
# *need* to check here
1704
1705
# we want to raise diverged if:
1706
# last_rev is not in the other_last_rev history, AND
1707
# other_last_rev is not in our history, and do it without pulling
1708
# history around
1709
last_rev = self.last_revision()
1710
if last_rev is not None:
1711
other.lock_read()
1712
try:
1713
other_last_rev = other.last_revision()
1714
if other_last_rev is not None:
1715
# neither branch is new, we have to do some work to
1716
# ascertain diversion.
1717
remote_graph = other.repository.get_revision_graph(
1718
other_last_rev)
1719
local_graph = self.repository.get_revision_graph(last_rev)
1720
if (last_rev not in remote_graph and
1721
other_last_rev not in local_graph):
1722
raise errors.DivergedBranches(self, other)
1723
finally:
1724
other.unlock()
1725
self.set_bound_location(other.base)
1726
1727
@needs_write_lock
1728
def unbind(self):
1729
"""If bound, unbind"""
1730
return self.set_bound_location(None)
1731
1732
@needs_write_lock
1733
def update(self):
1734
"""Synchronise this branch with the master branch if any.
1735
1736
:return: None or the last_revision that was pivoted out during the
1737
update.
1738
"""
1739
master = self.get_master_branch()
1740
if master is not None:
1741
old_tip = self.last_revision()
1742
self.pull(master, overwrite=True)
1743
if old_tip in self.repository.get_ancestry(self.last_revision()):
1744
return None
1745
return old_tip
1746
return None
1747
1748
1749
class BzrBranchExperimental(BzrBranch5):
1750
"""Bzr experimental branch format
1751
1752
This format has:
1753
- a revision-history file.
1754
- a format string
1755
- a lock dir guarding the branch itself
1756
- all of this stored in a branch/ subdirectory
1757
- works with shared repositories.
1758
- a tag dictionary in the branch
1759
1760
This format is new in bzr 0.15, but shouldn't be used for real data,
1761
only for testing.
1762
1763
This class acts as it's own BranchFormat.
1764
"""
1765
1766
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1767
1768
@classmethod
1769
def get_format_string(cls):
1770
"""See BranchFormat.get_format_string()."""
1771
return "Bazaar-NG branch format experimental\n"
1772
1773
@classmethod
1774
def get_format_description(cls):
1775
"""See BranchFormat.get_format_description()."""
1776
return "Experimental branch format"
1777
1778
@classmethod
1779
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1780
lock_class):
1781
branch_transport = a_bzrdir.get_branch_transport(cls)
1782
control_files = lockable_files.LockableFiles(branch_transport,
1783
lock_filename, lock_class)
1784
control_files.create_lock()
1785
control_files.lock_write()
1786
try:
1787
for filename, content in utf8_files:
1788
control_files.put_utf8(filename, content)
1789
finally:
1790
control_files.unlock()
1791
1792
@classmethod
1793
def initialize(cls, a_bzrdir):
1794
"""Create a branch of this format in a_bzrdir."""
1795
utf8_files = [('format', cls.get_format_string()),
1796
('revision-history', ''),
1797
('branch-name', ''),
1798
('tags', ''),
1799
]
1800
cls._initialize_control_files(a_bzrdir, utf8_files,
1801
'lock', lockdir.LockDir)
1802
return cls.open(a_bzrdir, _found=True)
1803
1804
@classmethod
1805
def open(cls, a_bzrdir, _found=False):
1806
"""Return the branch object for a_bzrdir
1807
1808
_found is a private parameter, do not use it. It is used to indicate
1809
if format probing has already be done.
1810
"""
1811
if not _found:
1812
format = BranchFormat.find_format(a_bzrdir)
1813
assert format.__class__ == cls
1814
transport = a_bzrdir.get_branch_transport(None)
1815
control_files = lockable_files.LockableFiles(transport, 'lock',
1816
lockdir.LockDir)
1817
return cls(_format=cls,
1818
_control_files=control_files,
1819
a_bzrdir=a_bzrdir,
1820
_repository=a_bzrdir.find_repository())
1821
1822
@classmethod
1823
def is_supported(cls):
1824
return True
1825
1826
def _make_tags(self):
1827
return BasicTags(self)
1828
1829
@classmethod
1830
def supports_tags(cls):
1831
return True
1832
1833
1834
BranchFormat.register_format(BzrBranchExperimental)
1835
1836
1837
class BzrBranch6(BzrBranch5):
1838
1839
@needs_read_lock
1840
def last_revision_info(self):
1841
revision_string = self.control_files.get('last-revision').read()
1842
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1843
revision_id = cache_utf8.get_cached_utf8(revision_id)
1844
revno = int(revno)
1845
return revno, revision_id
1846
1847
def last_revision(self):
1848
"""Return last revision id, or None"""
1849
revision_id = self.last_revision_info()[1]
1850
if revision_id == _mod_revision.NULL_REVISION:
1851
revision_id = None
1852
return revision_id
1853
1854
def _write_last_revision_info(self, revno, revision_id):
1855
"""Simply write out the revision id, with no checks.
1856
1857
Use set_last_revision_info to perform this safely.
1858
1859
Does not update the revision_history cache.
1860
Intended to be called by set_last_revision_info and
1861
_write_revision_history.
1862
"""
1863
if revision_id is None:
1864
revision_id = 'null:'
1865
out_string = '%d %s\n' % (revno, revision_id)
1866
self.control_files.put_bytes('last-revision', out_string)
1867
1868
@needs_write_lock
1869
def set_last_revision_info(self, revno, revision_id):
1870
revision_id = osutils.safe_revision_id(revision_id)
1871
if self._get_append_revisions_only():
1872
self._check_history_violation(revision_id)
1873
self._write_last_revision_info(revno, revision_id)
1874
transaction = self.get_transaction()
1875
cached_history = transaction.map.find_revision_history()
1876
if cached_history is not None:
1877
transaction.map.remove_object(cached_history)
1878
1879
def _check_history_violation(self, revision_id):
1880
last_revision = self.last_revision()
1881
if last_revision is None:
1882
return
1883
if last_revision not in self._lefthand_history(revision_id):
1884
raise errors.AppendRevisionsOnlyViolation(self.base)
1885
1886
def _gen_revision_history(self):
1887
"""Generate the revision history from last revision
1888
"""
1889
history = list(self.repository.iter_reverse_revision_history(
1890
self.last_revision()))
1891
history.reverse()
1892
return history
1893
1894
def _write_revision_history(self, history):
1895
"""Factored out of set_revision_history.
1896
1897
This performs the actual writing to disk, with format-specific checks.
1898
It is intended to be called by BzrBranch5.set_revision_history.
1899
"""
1900
if len(history) == 0:
1901
last_revision = 'null:'
1902
else:
1903
if history != self._lefthand_history(history[-1]):
1904
raise errors.NotLefthandHistory(history)
1905
last_revision = history[-1]
1906
if self._get_append_revisions_only():
1907
self._check_history_violation(last_revision)
1908
self._write_last_revision_info(len(history), last_revision)
1909
1910
@needs_write_lock
1911
def append_revision(self, *revision_ids):
1912
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1913
if len(revision_ids) == 0:
1914
return
1915
prev_revno, prev_revision = self.last_revision_info()
1916
for revision in self.repository.get_revisions(revision_ids):
1917
if prev_revision == _mod_revision.NULL_REVISION:
1918
if revision.parent_ids != []:
1919
raise errors.NotLeftParentDescendant(self, prev_revision,
1920
revision.revision_id)
1921
else:
1922
if revision.parent_ids[0] != prev_revision:
1923
raise errors.NotLeftParentDescendant(self, prev_revision,
1924
revision.revision_id)
1925
prev_revision = revision.revision_id
1926
self.set_last_revision_info(prev_revno + len(revision_ids),
1927
revision_ids[-1])
1928
1929
def _set_config_location(self, name, url, config=None,
1930
make_relative=False):
1931
if config is None:
1932
config = self.get_config()
1933
if url is None:
1934
url = ''
1935
elif make_relative:
1936
url = urlutils.relative_url(self.base, url)
1937
config.set_user_option(name, url)
1938
1939
1940
def _get_config_location(self, name, config=None):
1941
if config is None:
1942
config = self.get_config()
1943
location = config.get_user_option(name)
1944
if location == '':
1945
location = None
1946
return location
1947
1948
@needs_write_lock
1949
def _set_parent_location(self, url):
1950
"""Set the parent branch"""
1951
self._set_config_location('parent_location', url, make_relative=True)
1952
1953
@needs_read_lock
1954
def _get_parent_location(self):
1955
"""Set the parent branch"""
1956
return self._get_config_location('parent_location')
1957
1958
def set_push_location(self, location):
1959
"""See Branch.set_push_location."""
1960
self._set_config_location('push_location', location)
1961
1962
def set_bound_location(self, location):
1963
"""See Branch.set_push_location."""
1964
result = None
1965
config = self.get_config()
1966
if location is None:
1967
if config.get_user_option('bound') != 'True':
1968
return False
1969
else:
1970
config.set_user_option('bound', 'False')
1971
return True
1972
else:
1973
self._set_config_location('bound_location', location,
1974
config=config)
1975
config.set_user_option('bound', 'True')
1976
return True
1977
1978
def _get_bound_location(self, bound):
1979
"""Return the bound location in the config file.
1980
1981
Return None if the bound parameter does not match"""
1982
config = self.get_config()
1983
config_bound = (config.get_user_option('bound') == 'True')
1984
if config_bound != bound:
1985
return None
1986
return self._get_config_location('bound_location', config=config)
1987
1988
def get_bound_location(self):
1989
"""See Branch.set_push_location."""
1990
return self._get_bound_location(True)
1991
1992
def get_old_bound_location(self):
1993
"""See Branch.get_old_bound_location"""
1994
return self._get_bound_location(False)
1995
1996
def set_append_revisions_only(self, enabled):
1997
if enabled:
1998
value = 'True'
1999
else:
2000
value = 'False'
2001
self.get_config().set_user_option('append_revisions_only', value)
2002
2003
def _get_append_revisions_only(self):
2004
value = self.get_config().get_user_option('append_revisions_only')
2005
return value == 'True'
2006
2007
def _synchronize_history(self, destination, revision_id):
2008
"""Synchronize last revision and revision history between branches.
2009
2010
This version is most efficient when the destination is also a
2011
BzrBranch6, but works for BzrBranch5, as long as the destination's
2012
repository contains all the lefthand ancestors of the intended
2013
last_revision. If not, set_last_revision_info will fail.
2014
2015
:param destination: The branch to copy the history into
2016
:param revision_id: The revision-id to truncate history at. May
2017
be None to copy complete history.
2018
"""
2019
if revision_id is None:
2020
revno, revision_id = self.last_revision_info()
2021
else:
2022
revno = self.revision_id_to_revno(revision_id)
2023
destination.set_last_revision_info(revno, revision_id)
2024
2025
def _make_tags(self):
2026
return BasicTags(self)
2027
2028
2029
class BranchTestProviderAdapter(object):
2030
"""A tool to generate a suite testing multiple branch formats at once.
2031
2032
This is done by copying the test once for each transport and injecting
2033
the transport_server, transport_readonly_server, and branch_format
2034
classes into each copy. Each copy is also given a new id() to make it
2035
easy to identify.
2036
"""
2037
2038
def __init__(self, transport_server, transport_readonly_server, formats):
2039
self._transport_server = transport_server
2040
self._transport_readonly_server = transport_readonly_server
2041
self._formats = formats
2042
2043
def adapt(self, test):
2044
result = TestSuite()
2045
for branch_format, bzrdir_format in self._formats:
2046
new_test = deepcopy(test)
2047
new_test.transport_server = self._transport_server
2048
new_test.transport_readonly_server = self._transport_readonly_server
2049
new_test.bzrdir_format = bzrdir_format
2050
new_test.branch_format = branch_format
2051
def make_new_test_id():
2052
# the format can be either a class or an instance
2053
name = getattr(branch_format, '__name__',
2054
branch_format.__class__.__name__)
2055
new_id = "%s(%s)" % (new_test.id(), name)
2056
return lambda: new_id
2057
new_test.id = make_new_test_id()
2058
result.addTest(new_test)
2059
return result
2060
2061
2062
######################################################################
2063
# results of operations
2064
2065
2066
class _Result(object):
2067
2068
def _show_tag_conficts(self, to_file):
2069
if not getattr(self, 'tag_conflicts', None):
2070
return
2071
to_file.write('Conflicting tags:\n')
2072
for name, value1, value2 in self.tag_conflicts:
2073
to_file.write(' %s\n' % (name, ))
2074
2075
2076
class PullResult(_Result):
2077
"""Result of a Branch.pull operation.
2078
2079
:ivar old_revno: Revision number before pull.
2080
:ivar new_revno: Revision number after pull.
2081
:ivar old_revid: Tip revision id before pull.
2082
:ivar new_revid: Tip revision id after pull.
2083
:ivar source_branch: Source (local) branch object.
2084
:ivar master_branch: Master branch of the target, or None.
2085
:ivar target_branch: Target/destination branch object.
2086
"""
2087
2088
def __int__(self):
2089
# DEPRECATED: pull used to return the change in revno
2090
return self.new_revno - self.old_revno
2091
2092
def report(self, to_file):
2093
if self.old_revid == self.new_revid:
2094
to_file.write('No revisions to pull.\n')
2095
else:
2096
to_file.write('Now on revision %d.\n' % self.new_revno)
2097
self._show_tag_conficts(to_file)
2098
2099
2100
class PushResult(_Result):
2101
"""Result of a Branch.push operation.
2102
2103
:ivar old_revno: Revision number before push.
2104
:ivar new_revno: Revision number after push.
2105
:ivar old_revid: Tip revision id before push.
2106
:ivar new_revid: Tip revision id after push.
2107
:ivar source_branch: Source branch object.
2108
:ivar master_branch: Master branch of the target, or None.
2109
:ivar target_branch: Target/destination branch object.
2110
"""
2111
2112
def __int__(self):
2113
# DEPRECATED: push used to return the change in revno
2114
return self.new_revno - self.old_revno
2115
2116
def report(self, to_file):
2117
"""Write a human-readable description of the result."""
2118
if self.old_revid == self.new_revid:
2119
to_file.write('No new revisions to push.\n')
2120
else:
2121
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2122
self._show_tag_conficts(to_file)
2123
2124
2125
class BranchCheckResult(object):
2126
"""Results of checking branch consistency.
2127
2128
:see: Branch.check
2129
"""
2130
2131
def __init__(self, branch):
2132
self.branch = branch
2133
2134
def report_results(self, verbose):
2135
"""Report the check results via trace.note.
2136
2137
:param verbose: Requests more detailed display of what was checked,
2138
if any.
2139
"""
2140
note('checked branch %s format %s',
2141
self.branch.base,
2142
self.branch._format)
2143
2144
2145
class Converter5to6(object):
2146
"""Perform an in-place upgrade of format 5 to format 6"""
2147
2148
def convert(self, branch):
2149
# Data for 5 and 6 can peacefully coexist.
2150
format = BzrBranchFormat6()
2151
new_branch = format.open(branch.bzrdir, _found=True)
2152
2153
# Copy source data into target
2154
new_branch.set_last_revision_info(*branch.last_revision_info())
2155
new_branch.set_parent(branch.get_parent())
2156
new_branch.set_bound_location(branch.get_bound_location())
2157
new_branch.set_push_location(branch.get_push_location())
2158
2159
# New branch has no tags by default
2160
new_branch.tags._set_tag_dict({})
2161
2162
# Copying done; now update target format
2163
new_branch.control_files.put_utf8('format',
2164
format.get_format_string())
2165
2166
# Clean up old files
2167
new_branch.control_files._transport.delete('revision-history')
2168
try:
2169
branch.set_parent(None)
2170
except NoSuchFile:
2171
pass
2172
branch.set_bound_location(None)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1