« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1843.2.4
- compare with another revision
- download diff
- download tarball
- view history from revision 1843.2.4
- Committer: Aaron Bentley
- Date: 2006-07-10 19:23:53 UTC
- mto: This revision was merged to the branch mainline in revision 1848.
- Revision ID: abentley@panoramicfeedback.com-20060710192353-469477798c5c4139
Switch to John Meinel's _unescape_xml implementation
- files added:
- BRANCH.TODO
- bzrlib/benchmarks
- bzrlib/bundle
- bzrlib/bundle/old
- bzrlib/bundle/serializer
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins/launchpad
- bzrlib/store/revision
- bzrlib/store/versioned
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/tests/bzrdir_implementations
- bzrlib/tests/interrepository_implementations
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/repository_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/tests/test_patches_data
- bzrlib/tests/workingtree_implementations
- bzrlib/transport/http
- bzrlib/ui
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- tools/doc_generate
- files removed:
- bzrlib/clone.py
- notes
- patches
- files renamed:
- bzrlib/changeset.py => bzrlib/bundle/__init__.py
- bzrlib/store/weave.py => bzrlib/store/versioned/__init__.py
- bzrlib/selftest/ => bzrlib/tests/
- bzrlib/selftest/test_revision_info.py => bzrlib/tests/blackbox/test_revision_info.py
- bzrlib/selftest/teststatus.py => bzrlib/tests/blackbox/test_status.py
- bzrlib/selftest/blackbox.py => bzrlib/tests/blackbox/test_too_much.py
- bzrlib/selftest/versioning.py => bzrlib/tests/blackbox/test_versioning.py
- bzrlib/selftest/testbranch.py => bzrlib/tests/branch_implementations/test_branch.py
- bzrlib/selftest/test_parent.py => bzrlib/tests/branch_implementations/test_parent.py
- bzrlib/selftest/testdiff.py => bzrlib/tests/test_diff.py
- bzrlib/selftest/testfetch.py => bzrlib/tests/test_fetch.py
- bzrlib/selftest/testgraph.py => bzrlib/tests/test_graph.py
- bzrlib/selftest/testhashcache.py => bzrlib/tests/test_hashcache.py
- bzrlib/selftest/testinv.py => bzrlib/tests/test_inv.py
- bzrlib/selftest/testlog.py => bzrlib/tests/test_log.py
- bzrlib/selftest/testmerge.py => bzrlib/tests/test_merge.py
- bzrlib/selftest/testmerge3.py => bzrlib/tests/test_merge3.py
- bzrlib/selftest/plugins.py => bzrlib/tests/test_plugins.py
- bzrlib/selftest/testrevision.py => bzrlib/tests/test_revision.py
- bzrlib/selftest/testrevisionnamespaces.py => bzrlib/tests/test_revisionnamespaces.py
- bzrlib/selftest/teststore.py => bzrlib/tests/test_store.py
- bzrlib/selftest/testtransport.py => bzrlib/tests/test_transport.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- bzrlib/selftest/testworkingtree.py => bzrlib/tests/test_workingtree.py
- bzrlib/transport/http.py => bzrlib/transport/http/__init__.py
- bzrlib/ui.py => bzrlib/ui/__init__.py
- bzrlib/xml.py => bzrlib/xml_serializer.py
- tutorial.txt => doc/tutorial.txt
- bzr-man.py => tools/doc_generate/autodoc_man.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
2
1
# Copyright (C) 2005, 2006 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
import sys
19
import os
20
import errno
18
from copy import deepcopy
19
from cStringIO import StringIO
20
from unittest import TestSuite
21
21
from warnings import warn
22
from cStringIO import StringIO
23
24
22
25
23
import bzrlib
26
from bzrlib.inventory import InventoryEntry
27
import bzrlib.inventory as inventory
24
from bzrlib import bzrdir, errors, lockdir, osutils, revision, \
25
tree, \
26
ui, \
27
urlutils
28
from bzrlib.config import TreeConfig
29
from bzrlib.decorators import needs_read_lock, needs_write_lock
30
import bzrlib.errors as errors
31
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
32
HistoryMissing, InvalidRevisionId,
33
InvalidRevisionNumber, LockError, NoSuchFile,
34
NoSuchRevision, NoWorkingTree, NotVersionedError,
35
NotBranchError, UninitializableFormat,
36
UnlistableStore, UnlistableBranch,
37
)
38
from bzrlib.lockable_files import LockableFiles, TransportLock
39
from bzrlib.symbol_versioning import (deprecated_function,
40
deprecated_method,
41
DEPRECATED_PARAMETER,
42
deprecated_passed,
43
zero_eight, zero_nine,
44
)
28
45
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
30
rename, splitpath, sha_file, appendpath,
31
file_kind)
32
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
33
NoSuchRevision, HistoryMissing, NotBranchError,
34
DivergedBranches, LockError, UnlistableStore,
35
UnlistableBranch, NoSuchFile)
36
from bzrlib.textui import show_status
37
from bzrlib.revision import Revision, is_ancestor
38
from bzrlib.delta import compare_trees
39
from bzrlib.tree import EmptyTree, RevisionTree
40
from bzrlib.inventory import Inventory
41
from bzrlib.store import copy_all
42
from bzrlib.store.compressed_text import CompressedTextStore
43
from bzrlib.store.text import TextStore
44
from bzrlib.store.weave import WeaveStore
45
from bzrlib.transport import Transport, get_transport
46
import bzrlib.xml5
47
import bzrlib.ui
48
46
49
47
50
48
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
51
49
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
52
## TODO: Maybe include checks for common corruption of newlines, etc?
53
50
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
51
52
53
# TODO: Maybe include checks for common corruption of newlines, etc?
54
54
55
55
# TODO: Some operations like log might retrieve the same revisions
56
56
# repeatedly to calculate deltas. We could perhaps have a weakref
57
57
# cache in memory to make this faster. In general anything can be
58
# cached in memory between lock and unlock operations.
59
60
def find_branch(*ignored, **ignored_too):
61
# XXX: leave this here for about one release, then remove it
62
raise NotImplementedError('find_branch() is not supported anymore, '
63
'please use one of the new branch constructors')
64
def _relpath(base, path):
65
"""Return path relative to base, or raise exception.
66
67
The path may be either an absolute path or a path relative to the
68
current working directory.
69
70
Lifted out of Branch.relpath for ease of testing.
71
72
os.path.commonprefix (python2.4) has a bad bug that it works just
73
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
74
avoids that problem."""
75
rp = os.path.abspath(path)
76
77
s = []
78
head = rp
79
while len(head) >= len(base):
80
if head == base:
81
break
82
head, tail = os.path.split(head)
83
if tail:
84
s.insert(0, tail)
85
else:
86
raise NotBranchError("path %r is not within branch %r" % (rp, base))
87
88
return os.sep.join(s)
89
90
91
def find_branch_root(t):
92
"""Find the branch root enclosing the transport's base.
93
94
t is a Transport object.
95
96
It is not necessary that the base of t exists.
97
98
Basically we keep looking up until we find the control directory or
99
run into the root. If there isn't one, raises NotBranchError.
100
"""
101
orig_base = t.base
102
while True:
103
if t.has(bzrlib.BZRDIR):
104
return t
105
new_t = t.clone('..')
106
if new_t.base == t.base:
107
# reached the root, whatever that may be
108
raise NotBranchError('%s is not in a branch' % orig_base)
109
t = new_t
58
# cached in memory between lock and unlock operations. .. nb thats
59
# what the transaction identity map provides
110
60
111
61
112
62
######################################################################
118
68
base
119
69
Base directory/url of the branch.
120
70
"""
71
# this is really an instance variable - FIXME move it there
72
# - RBC 20060112
121
73
base = None
122
74
123
75
def __init__(self, *ignored, **ignored_too):
124
76
raise NotImplementedError('The Branch class is abstract')
125
77
78
def break_lock(self):
79
"""Break a lock if one is present from another instance.
80
81
Uses the ui factory to ask for confirmation if the lock may be from
82
an active process.
83
84
This will probe the repository for its lock as well.
85
"""
86
self.control_files.break_lock()
87
self.repository.break_lock()
88
master = self.get_master_branch()
89
if master is not None:
90
master.break_lock()
91
126
92
@staticmethod
93
@deprecated_method(zero_eight)
127
94
def open_downlevel(base):
128
"""Open a branch which may be of an old format.
129
130
Only local branches are supported."""
131
return _Branch(get_transport(base), relax_version_check=True)
95
"""Open a branch which may be of an old format."""
96
return Branch.open(base, _unsupported=True)
132
97
133
98
@staticmethod
134
def open(base):
135
"""Open an existing branch, rooted at 'base' (url)"""
136
t = get_transport(base)
137
return _Branch(t)
99
def open(base, _unsupported=False):
100
"""Open the branch rooted at base.
101
102
For instance, if the branch is at URL/.bzr/branch,
103
Branch.open(URL) -> a Branch instance.
104
"""
105
control = bzrdir.BzrDir.open(base, _unsupported)
106
return control.open_branch(_unsupported)
138
107
139
108
@staticmethod
140
109
def open_containing(url):
141
110
"""Open an existing branch which contains url.
142
111
143
112
This probes for a branch at url, and searches upwards from there.
113
114
Basically we keep looking up until we find the control directory or
115
run into the root. If there isn't one, raises NotBranchError.
116
If there is one and it is either an unrecognised format or an unsupported
117
format, UnknownFormatError or UnsupportedFormatError are raised.
118
If there is one, it is returned, along with the unused portion of url.
144
119
"""
145
t = get_transport(url)
146
t = find_branch_root(t)
147
return _Branch(t)
120
control, relpath = bzrdir.BzrDir.open_containing(url)
121
return control.open_branch(), relpath
148
122
149
123
@staticmethod
124
@deprecated_function(zero_eight)
150
125
def initialize(base):
151
"""Create a new branch, rooted at 'base' (url)"""
152
t = get_transport(base)
153
return _Branch(t, init=True)
126
"""Create a new working tree and branch, rooted at 'base' (url)
127
128
NOTE: This will soon be deprecated in favour of creation
129
through a BzrDir.
130
"""
131
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
154
132
155
133
def setup_caching(self, cache_root):
156
134
"""Subclasses that care about caching should override this, and set
157
135
up cached stores located under cache_root.
158
136
"""
137
# seems to be unused, 2006-01-13 mbp
138
warn('%s is deprecated' % self.setup_caching)
159
139
self.cache_root = cache_root
160
140
161
162
class _Branch(Branch):
163
"""A branch stored in the actual filesystem.
164
165
Note that it's "local" in the context of the filesystem; it doesn't
166
really matter if it's on an nfs/smb/afs/coda/... share, as long as
167
it's writable, and can be accessed via the normal filesystem API.
168
169
_lock_mode
170
None, or 'r' or 'w'
171
172
_lock_count
173
If _lock_mode is true, a positive count of the number of times the
174
lock has been taken.
175
176
_lock
177
Lock object from bzrlib.lock.
178
"""
179
# We actually expect this class to be somewhat short-lived; part of its
180
# purpose is to try to isolate what bits of the branch logic are tied to
181
# filesystem access, so that in a later step, we can extricate them to
182
# a separarte ("storage") class.
183
_lock_mode = None
184
_lock_count = None
185
_lock = None
186
_inventory_weave = None
187
188
# Map some sort of prefix into a namespace
189
# stuff like "revno:10", "revid:", etc.
190
# This should match a prefix with a function which accepts
191
REVISION_NAMESPACES = {}
192
193
def push_stores(self, branch_to):
194
"""Copy the content of this branches store to branch_to."""
195
if (self._branch_format != branch_to._branch_format
196
or self._branch_format != 4):
197
from bzrlib.fetch import greedy_fetch
198
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
199
self, self._branch_format, branch_to, branch_to._branch_format)
200
greedy_fetch(to_branch=branch_to, from_branch=self,
201
revision=self.last_revision())
202
return
203
204
store_pairs = ((self.text_store, branch_to.text_store),
205
(self.inventory_store, branch_to.inventory_store),
206
(self.revision_store, branch_to.revision_store))
207
try:
208
for from_store, to_store in store_pairs:
209
copy_all(from_store, to_store)
210
except UnlistableStore:
211
raise UnlistableBranch(from_store)
212
213
def __init__(self, transport, init=False,
214
relax_version_check=False):
215
"""Create new branch object at a particular location.
216
217
transport -- A Transport object, defining how to access files.
218
(If a string, transport.transport() will be used to
219
create a Transport object)
220
221
init -- If True, create new control files in a previously
222
unversioned directory. If False, the branch must already
223
be versioned.
224
225
relax_version_check -- If true, the usual check for the branch
226
version is not applied. This is intended only for
227
upgrade/recovery type use; it's not guaranteed that
228
all operations will work on old format branches.
229
230
In the test suite, creation of new trees is tested using the
231
`ScratchBranch` class.
232
"""
233
assert isinstance(transport, Transport), \
234
"%r is not a Transport" % transport
235
self._transport = transport
236
if init:
237
self._make_control()
238
self._check_format(relax_version_check)
239
240
def get_store(name, compressed=True):
241
# FIXME: This approach of assuming stores are all entirely compressed
242
# or entirely uncompressed is tidy, but breaks upgrade from
243
# some existing branches where there's a mixture; we probably
244
# still want the option to look for both.
245
relpath = self._rel_controlfilename(name)
246
if compressed:
247
store = CompressedTextStore(self._transport.clone(relpath))
248
else:
249
store = TextStore(self._transport.clone(relpath))
250
#if self._transport.should_cache():
251
# cache_path = os.path.join(self.cache_root, name)
252
# os.mkdir(cache_path)
253
# store = bzrlib.store.CachedStore(store, cache_path)
254
return store
255
def get_weave(name):
256
relpath = self._rel_controlfilename(name)
257
ws = WeaveStore(self._transport.clone(relpath))
258
if self._transport.should_cache():
259
ws.enable_cache = True
260
return ws
261
262
if self._branch_format == 4:
263
self.inventory_store = get_store('inventory-store')
264
self.text_store = get_store('text-store')
265
self.revision_store = get_store('revision-store')
266
elif self._branch_format == 5:
267
self.control_weaves = get_weave([])
268
self.weave_store = get_weave('weaves')
269
self.revision_store = get_store('revision-store', compressed=False)
270
271
def __str__(self):
272
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
273
274
275
__repr__ = __str__
276
277
278
def __del__(self):
279
if self._lock_mode or self._lock:
280
# XXX: This should show something every time, and be suitable for
281
# headless operation and embedding
282
warn("branch %r was not explicitly unlocked" % self)
283
self._lock.unlock()
284
285
# TODO: It might be best to do this somewhere else,
286
# but it is nice for a Branch object to automatically
287
# cache it's information.
288
# Alternatively, we could have the Transport objects cache requests
289
# See the earlier discussion about how major objects (like Branch)
290
# should never expect their __del__ function to run.
291
if hasattr(self, 'cache_root') and self.cache_root is not None:
292
try:
293
import shutil
294
shutil.rmtree(self.cache_root)
295
except:
296
pass
297
self.cache_root = None
298
299
def _get_base(self):
300
if self._transport:
301
return self._transport.base
302
return None
303
304
base = property(_get_base)
305
141
def get_config(self):
142
return bzrlib.config.BranchConfig(self)
143
144
def _get_nick(self):
145
return self.get_config().get_nickname()
146
147
def _set_nick(self, nick):
148
self.get_config().set_user_option('nickname', nick)
149
150
nick = property(_get_nick, _set_nick)
151
152
def is_locked(self):
153
raise NotImplementedError('is_locked is abstract')
306
154
307
155
def lock_write(self):
308
# TODO: Upgrade locking to support using a Transport,
309
# and potentially a remote locking protocol
310
if self._lock_mode:
311
if self._lock_mode != 'w':
312
raise LockError("can't upgrade to a write lock from %r" %
313
self._lock_mode)
314
self._lock_count += 1
315
else:
316
self._lock = self._transport.lock_write(
317
self._rel_controlfilename('branch-lock'))
318
self._lock_mode = 'w'
319
self._lock_count = 1
320
156
raise NotImplementedError('lock_write is abstract')
321
157
322
158
def lock_read(self):
323
if self._lock_mode:
324
assert self._lock_mode in ('r', 'w'), \
325
"invalid lock mode %r" % self._lock_mode
326
self._lock_count += 1
327
else:
328
self._lock = self._transport.lock_read(
329
self._rel_controlfilename('branch-lock'))
330
self._lock_mode = 'r'
331
self._lock_count = 1
332
159
raise NotImplementedError('lock_read is abstract')
160
333
161
def unlock(self):
334
if not self._lock_mode:
335
raise LockError('branch %r is not locked' % (self))
336
337
if self._lock_count > 1:
338
self._lock_count -= 1
339
else:
340
self._lock.unlock()
341
self._lock = None
342
self._lock_mode = self._lock_count = None
162
raise NotImplementedError('unlock is abstract')
163
164
def peek_lock_mode(self):
165
"""Return lock mode for the Branch: 'r', 'w' or None"""
166
raise NotImplementedError(self.peek_lock_mode)
167
168
def get_physical_lock_status(self):
169
raise NotImplementedError('get_physical_lock_status is abstract')
343
170
344
171
def abspath(self, name):
345
"""Return absolute filename for something in the branch"""
346
return self._transport.abspath(name)
347
348
def relpath(self, path):
349
"""Return path relative to this branch of something inside it.
350
351
Raises an error if path is not in this branch."""
352
return self._transport.relpath(path)
353
354
355
def _rel_controlfilename(self, file_or_path):
356
if isinstance(file_or_path, basestring):
357
file_or_path = [file_or_path]
358
return [bzrlib.BZRDIR] + file_or_path
359
360
def controlfilename(self, file_or_path):
361
"""Return location relative to branch."""
362
return self._transport.abspath(self._rel_controlfilename(file_or_path))
363
364
365
def controlfile(self, file_or_path, mode='r'):
366
"""Open a control file for this branch.
367
368
There are two classes of file in the control directory: text
369
and binary. binary files are untranslated byte streams. Text
370
control files are stored with Unix newlines and in UTF-8, even
371
if the platform or locale defaults are different.
372
373
Controlfiles should almost never be opened in write mode but
374
rather should be atomically copied and replaced using atomicfile.
375
"""
376
import codecs
377
378
relpath = self._rel_controlfilename(file_or_path)
379
#TODO: codecs.open() buffers linewise, so it was overloaded with
380
# a much larger buffer, do we need to do the same for getreader/getwriter?
381
if mode == 'rb':
382
return self._transport.get(relpath)
383
elif mode == 'wb':
384
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
385
elif mode == 'r':
386
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
387
elif mode == 'w':
388
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
172
"""Return absolute filename for something in the branch
173
174
XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
method and not a tree method.
176
"""
177
raise NotImplementedError('abspath is abstract')
178
179
def bind(self, other):
180
"""Bind the local branch the other branch.
181
182
:param other: The branch to bind to
183
:type other: Branch
184
"""
185
raise errors.UpgradeRequired(self.base)
186
187
@needs_write_lock
188
def fetch(self, from_branch, last_revision=None, pb=None):
189
"""Copy revisions from from_branch into this branch.
190
191
:param from_branch: Where to copy from.
192
:param last_revision: What revision to stop at (None for at the end
193
of the branch.
194
:param pb: An optional progress bar to use.
195
196
Returns the copied revision count and the failed revisions in a tuple:
197
(copied, failures).
198
"""
199
if self.base == from_branch.base:
200
return (0, [])
201
if pb is None:
202
nested_pb = ui.ui_factory.nested_progress_bar()
203
pb = nested_pb
389
204
else:
390
raise BzrError("invalid controlfile mode %r" % mode)
391
392
def put_controlfile(self, path, f, encode=True):
393
"""Write an entry as a controlfile.
394
395
:param path: The path to put the file, relative to the .bzr control
396
directory
397
:param f: A file-like or string object whose contents should be copied.
398
:param encode: If true, encode the contents as utf-8
399
"""
400
self.put_controlfiles([(path, f)], encode=encode)
401
402
def put_controlfiles(self, files, encode=True):
403
"""Write several entries as controlfiles.
404
405
:param files: A list of [(path, file)] pairs, where the path is the directory
406
underneath the bzr control directory
407
:param encode: If true, encode the contents as utf-8
408
"""
409
import codecs
410
ctrl_files = []
411
for path, f in files:
412
if encode:
413
if isinstance(f, basestring):
414
f = f.encode('utf-8', 'replace')
205
nested_pb = None
206
207
from_branch.lock_read()
208
try:
209
if last_revision is None:
210
pb.update('get source history')
211
from_history = from_branch.revision_history()
212
if from_history:
213
last_revision = from_history[-1]
415
214
else:
416
f = codecs.getwriter('utf-8')(f, errors='replace')
417
path = self._rel_controlfilename(path)
418
ctrl_files.append((path, f))
419
self._transport.put_multi(ctrl_files)
420
421
def _make_control(self):
422
from bzrlib.inventory import Inventory
423
from bzrlib.weavefile import write_weave_v5
424
from bzrlib.weave import Weave
425
426
# Create an empty inventory
427
sio = StringIO()
428
# if we want per-tree root ids then this is the place to set
429
# them; they're not needed for now and so ommitted for
430
# simplicity.
431
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
432
empty_inv = sio.getvalue()
433
sio = StringIO()
434
bzrlib.weavefile.write_weave_v5(Weave(), sio)
435
empty_weave = sio.getvalue()
436
437
dirs = [[], 'revision-store', 'weaves']
438
files = [('README',
439
"This is a Bazaar-NG control directory.\n"
440
"Do not change any files in this directory.\n"),
441
('branch-format', BZR_BRANCH_FORMAT_5),
442
('revision-history', ''),
443
('branch-name', ''),
444
('branch-lock', ''),
445
('pending-merges', ''),
446
('inventory', empty_inv),
447
('inventory.weave', empty_weave),
448
('ancestry.weave', empty_weave)
449
]
450
cfn = self._rel_controlfilename
451
self._transport.mkdir_multi([cfn(d) for d in dirs])
452
self.put_controlfiles(files)
453
mutter('created control directory in ' + self._transport.base)
454
455
def _check_format(self, relax_version_check):
456
"""Check this branch format is supported.
457
458
The format level is stored, as an integer, in
459
self._branch_format for code that needs to check it later.
460
461
In the future, we might need different in-memory Branch
462
classes to support downlevel branches. But not yet.
463
"""
464
try:
465
fmt = self.controlfile('branch-format', 'r').read()
466
except NoSuchFile:
467
raise NotBranchError(self.base)
468
469
if fmt == BZR_BRANCH_FORMAT_5:
470
self._branch_format = 5
471
elif fmt == BZR_BRANCH_FORMAT_4:
472
self._branch_format = 4
473
474
if (not relax_version_check
475
and self._branch_format != 5):
476
raise BzrError('sorry, branch format %r not supported' % fmt,
477
['use a different bzr version',
478
'or remove the .bzr directory'
479
' and "bzr init" again'])
480
481
def get_root_id(self):
482
"""Return the id of this branches root"""
483
inv = self.read_working_inventory()
484
return inv.root.file_id
485
486
def set_root_id(self, file_id):
487
inv = self.read_working_inventory()
488
orig_root_id = inv.root.file_id
489
del inv._byid[inv.root.file_id]
490
inv.root.file_id = file_id
491
inv._byid[inv.root.file_id] = inv.root
492
for fid in inv:
493
entry = inv[fid]
494
if entry.parent_id in (None, orig_root_id):
495
entry.parent_id = inv.root.file_id
496
self._write_inventory(inv)
497
498
def read_working_inventory(self):
499
"""Read the working inventory."""
500
self.lock_read()
501
try:
502
# ElementTree does its own conversion from UTF-8, so open in
503
# binary.
504
f = self.controlfile('inventory', 'rb')
505
return bzrlib.xml5.serializer_v5.read_inventory(f)
506
finally:
507
self.unlock()
508
509
510
def _write_inventory(self, inv):
511
"""Update the working inventory.
512
513
That is to say, the inventory describing changes underway, that
514
will be committed to the next revision.
515
"""
516
from cStringIO import StringIO
517
self.lock_write()
518
try:
519
sio = StringIO()
520
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
521
sio.seek(0)
522
# Transport handles atomicity
523
self.put_controlfile('inventory', sio)
524
finally:
525
self.unlock()
526
527
mutter('wrote working inventory')
528
529
inventory = property(read_working_inventory, _write_inventory, None,
530
"""Inventory for the working copy.""")
531
532
def add(self, files, ids=None):
533
"""Make files versioned.
534
535
Note that the command line normally calls smart_add instead,
536
which can automatically recurse.
537
538
This puts the files in the Added state, so that they will be
539
recorded by the next commit.
540
541
files
542
List of paths to add, relative to the base of the tree.
543
544
ids
545
If set, use these instead of automatically generated ids.
546
Must be the same length as the list of files, but may
547
contain None for ids that are to be autogenerated.
548
549
TODO: Perhaps have an option to add the ids even if the files do
550
not (yet) exist.
551
552
TODO: Perhaps yield the ids and paths as they're added.
553
"""
554
# TODO: Re-adding a file that is removed in the working copy
555
# should probably put it back with the previous ID.
556
if isinstance(files, basestring):
557
assert(ids is None or isinstance(ids, basestring))
558
files = [files]
559
if ids is not None:
560
ids = [ids]
561
562
if ids is None:
563
ids = [None] * len(files)
564
else:
565
assert(len(ids) == len(files))
566
567
self.lock_write()
568
try:
569
inv = self.read_working_inventory()
570
for f,file_id in zip(files, ids):
571
if is_control_file(f):
572
raise BzrError("cannot add control file %s" % quotefn(f))
573
574
fp = splitpath(f)
575
576
if len(fp) == 0:
577
raise BzrError("cannot add top-level %r" % f)
578
579
fullpath = os.path.normpath(self.abspath(f))
580
581
try:
582
kind = file_kind(fullpath)
583
except OSError:
584
# maybe something better?
585
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
586
587
if not InventoryEntry.versionable_kind(kind):
588
raise BzrError('cannot add: not a versionable file ('
589
'i.e. regular file, symlink or directory): %s' % quotefn(f))
590
591
if file_id is None:
592
file_id = gen_file_id(f)
593
inv.add_path(f, kind=kind, file_id=file_id)
594
595
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
596
597
self._write_inventory(inv)
598
finally:
599
self.unlock()
600
601
602
def print_file(self, file, revno):
603
"""Print `file` to stdout."""
604
self.lock_read()
605
try:
606
tree = self.revision_tree(self.get_rev_id(revno))
607
# use inventory as it was in that revision
608
file_id = tree.inventory.path2id(file)
609
if not file_id:
610
raise BzrError("%r is not present in revision %s" % (file, revno))
611
tree.print_file(file_id)
612
finally:
613
self.unlock()
614
615
616
def remove(self, files, verbose=False):
617
"""Mark nominated files for removal from the inventory.
618
619
This does not remove their text. This does not run on
620
621
TODO: Refuse to remove modified files unless --force is given?
622
623
TODO: Do something useful with directories.
624
625
TODO: Should this remove the text or not? Tough call; not
626
removing may be useful and the user can just use use rm, and
627
is the opposite of add. Removing it is consistent with most
628
other tools. Maybe an option.
629
"""
630
## TODO: Normalize names
631
## TODO: Remove nested loops; better scalability
632
if isinstance(files, basestring):
633
files = [files]
634
635
self.lock_write()
636
637
try:
638
tree = self.working_tree()
639
inv = tree.inventory
640
641
# do this before any modifications
642
for f in files:
643
fid = inv.path2id(f)
644
if not fid:
645
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
646
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
647
if verbose:
648
# having remove it, it must be either ignored or unknown
649
if tree.is_ignored(f):
650
new_status = 'I'
651
else:
652
new_status = '?'
653
show_status(new_status, inv[fid].kind, quotefn(f))
654
del inv[fid]
655
656
self._write_inventory(inv)
657
finally:
658
self.unlock()
659
660
# FIXME: this doesn't need to be a branch method
661
def set_inventory(self, new_inventory_list):
662
from bzrlib.inventory import Inventory, InventoryEntry
663
inv = Inventory(self.get_root_id())
664
for path, file_id, parent, kind in new_inventory_list:
665
name = os.path.basename(path)
666
if name == "":
667
continue
668
# fixme, there should be a factory function inv,add_??
669
if kind == 'directory':
670
inv.add(inventory.InventoryDirectory(file_id, name, parent))
671
elif kind == 'file':
672
inv.add(inventory.InventoryFile(file_id, name, parent))
673
elif kind == 'symlink':
674
inv.add(inventory.InventoryLink(file_id, name, parent))
675
else:
676
raise BzrError("unknown kind %r" % kind)
677
self._write_inventory(inv)
678
679
def unknowns(self):
680
"""Return all unknown files.
681
682
These are files in the working directory that are not versioned or
683
control files or ignored.
684
685
>>> b = ScratchBranch(files=['foo', 'foo~'])
686
>>> list(b.unknowns())
687
['foo']
688
>>> b.add('foo')
689
>>> list(b.unknowns())
690
[]
691
>>> b.remove('foo')
692
>>> list(b.unknowns())
693
['foo']
694
"""
695
return self.working_tree().unknowns()
696
697
698
def append_revision(self, *revision_ids):
699
for revision_id in revision_ids:
700
mutter("add {%s} to revision-history" % revision_id)
701
self.lock_write()
702
try:
703
rev_history = self.revision_history()
704
rev_history.extend(revision_ids)
705
self.put_controlfile('revision-history', '\n'.join(rev_history))
706
finally:
707
self.unlock()
708
709
def has_revision(self, revision_id):
710
"""True if this branch has a copy of the revision.
711
712
This does not necessarily imply the revision is merge
713
or on the mainline."""
714
return (revision_id is None
715
or revision_id in self.revision_store)
716
717
def get_revision_xml_file(self, revision_id):
718
"""Return XML file object for revision object."""
719
if not revision_id or not isinstance(revision_id, basestring):
720
raise InvalidRevisionId(revision_id)
721
722
self.lock_read()
723
try:
724
try:
725
return self.revision_store[revision_id]
726
except (IndexError, KeyError):
727
raise bzrlib.errors.NoSuchRevision(self, revision_id)
728
finally:
729
self.unlock()
730
731
#deprecated
732
get_revision_xml = get_revision_xml_file
733
734
def get_revision_xml(self, revision_id):
735
return self.get_revision_xml_file(revision_id).read()
736
737
738
def get_revision(self, revision_id):
739
"""Return the Revision object for a named revision"""
740
xml_file = self.get_revision_xml_file(revision_id)
741
742
try:
743
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
744
except SyntaxError, e:
745
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
746
[revision_id,
747
str(e)])
748
749
assert r.revision_id == revision_id
750
return r
215
# no history in the source branch
216
last_revision = revision.NULL_REVISION
217
return self.repository.fetch(from_branch.repository,
218
revision_id=last_revision,
219
pb=nested_pb)
220
finally:
221
if nested_pb is not None:
222
nested_pb.finished()
223
from_branch.unlock()
224
225
def get_bound_location(self):
226
"""Return the URL of the branch we are bound to.
227
228
Older format branches cannot bind, please be sure to use a metadir
229
branch.
230
"""
231
return None
232
233
def get_commit_builder(self, parents, config=None, timestamp=None,
234
timezone=None, committer=None, revprops=None,
235
revision_id=None):
236
"""Obtain a CommitBuilder for this branch.
237
238
:param parents: Revision ids of the parents of the new revision.
239
:param config: Optional configuration to use.
240
:param timestamp: Optional timestamp recorded for commit.
241
:param timezone: Optional timezone for timestamp.
242
:param committer: Optional committer to set for commit.
243
:param revprops: Optional dictionary of revision properties.
244
:param revision_id: Optional revision id.
245
"""
246
247
if config is None:
248
config = self.get_config()
249
250
return self.repository.get_commit_builder(self, parents, config,
251
timestamp, timezone, committer, revprops, revision_id)
252
253
def get_master_branch(self):
254
"""Return the branch we are bound to.
255
256
:return: Either a Branch, or None
257
"""
258
return None
751
259
752
260
def get_revision_delta(self, revno):
753
261
"""Return the delta for one revision.
759
267
rh = self.revision_history()
760
268
if not (1 <= revno <= len(rh)):
761
269
raise InvalidRevisionNumber(revno)
762
763
# revno is 1-based; list is 0-based
764
765
new_tree = self.revision_tree(rh[revno-1])
766
if revno == 1:
767
old_tree = EmptyTree()
768
else:
769
old_tree = self.revision_tree(rh[revno-2])
770
771
return compare_trees(old_tree, new_tree)
772
773
def get_revision_sha1(self, revision_id):
774
"""Hash the stored value of a revision, and return it."""
775
# In the future, revision entries will be signed. At that
776
# point, it is probably best *not* to include the signature
777
# in the revision hash. Because that lets you re-sign
778
# the revision, (add signatures/remove signatures) and still
779
# have all hash pointers stay consistent.
780
# But for now, just hash the contents.
781
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
782
783
def _get_ancestry_weave(self):
784
return self.control_weaves.get_weave('ancestry')
785
786
def get_ancestry(self, revision_id):
787
"""Return a list of revision-ids integrated by a revision."""
788
if revision_id is None:
789
return [None]
790
w = self._get_ancestry_weave()
791
return [None] + [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
792
793
def get_inventory_weave(self):
794
return self.control_weaves.get_weave('inventory')
795
796
def get_inventory(self, revision_id):
797
"""Get Inventory object by hash."""
798
xml = self.get_inventory_xml(revision_id)
799
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
800
801
def get_inventory_xml(self, revision_id):
802
"""Get inventory XML as a file object."""
803
try:
804
assert isinstance(revision_id, basestring), type(revision_id)
805
iw = self.get_inventory_weave()
806
return iw.get_text(iw.lookup(revision_id))
807
except IndexError:
808
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
809
810
def get_inventory_sha1(self, revision_id):
811
"""Return the sha1 hash of the inventory entry
812
"""
813
return self.get_revision(revision_id).inventory_sha1
814
815
def get_revision_inventory(self, revision_id):
816
"""Return inventory of a past revision."""
817
# TODO: Unify this with get_inventory()
818
# bzr 0.0.6 and later imposes the constraint that the inventory_id
819
# must be the same as its revision, so this is trivial.
820
if revision_id == None:
821
return Inventory(self.get_root_id())
822
else:
823
return self.get_inventory(revision_id)
270
return self.repository.get_revision_delta(rh[revno-1])
271
272
def get_root_id(self):
273
"""Return the id of this branches root"""
274
raise NotImplementedError('get_root_id is abstract')
275
276
def print_file(self, file, revision_id):
277
"""Print `file` to stdout."""
278
raise NotImplementedError('print_file is abstract')
279
280
def append_revision(self, *revision_ids):
281
raise NotImplementedError('append_revision is abstract')
282
283
def set_revision_history(self, rev_history):
284
raise NotImplementedError('set_revision_history is abstract')
824
285
825
286
def revision_history(self):
826
287
"""Return sequence of revision hashes on to this branch."""
827
self.lock_read()
828
try:
829
return [l.rstrip('\r\n') for l in
830
self.controlfile('revision-history', 'r').readlines()]
831
finally:
832
self.unlock()
833
834
def common_ancestor(self, other, self_revno=None, other_revno=None):
835
"""
836
>>> from bzrlib.commit import commit
837
>>> sb = ScratchBranch(files=['foo', 'foo~'])
838
>>> sb.common_ancestor(sb) == (None, None)
839
True
840
>>> commit(sb, "Committing first revision", verbose=False)
841
>>> sb.common_ancestor(sb)[0]
842
1
843
>>> clone = sb.clone()
844
>>> commit(sb, "Committing second revision", verbose=False)
845
>>> sb.common_ancestor(sb)[0]
846
2
847
>>> sb.common_ancestor(clone)[0]
848
1
849
>>> commit(clone, "Committing divergent second revision",
850
... verbose=False)
851
>>> sb.common_ancestor(clone)[0]
852
1
853
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
854
True
855
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
856
True
857
>>> clone2 = sb.clone()
858
>>> sb.common_ancestor(clone2)[0]
859
2
860
>>> sb.common_ancestor(clone2, self_revno=1)[0]
861
1
862
>>> sb.common_ancestor(clone2, other_revno=1)[0]
863
1
864
"""
865
my_history = self.revision_history()
866
other_history = other.revision_history()
867
if self_revno is None:
868
self_revno = len(my_history)
869
if other_revno is None:
870
other_revno = len(other_history)
871
indices = range(min((self_revno, other_revno)))
872
indices.reverse()
873
for r in indices:
874
if my_history[r] == other_history[r]:
875
return r+1, my_history[r]
876
return None, None
877
288
raise NotImplementedError('revision_history is abstract')
878
289
879
290
def revno(self):
880
291
"""Return current revision number for this branch.
884
295
"""
885
296
return len(self.revision_history())
886
297
298
def unbind(self):
299
"""Older format branches cannot bind or unbind."""
300
raise errors.UpgradeRequired(self.base)
887
301
888
302
def last_revision(self):
889
"""Return last patch hash, or None if no history.
890
"""
303
"""Return last patch hash, or None if no history."""
891
304
ph = self.revision_history()
892
305
if ph:
893
306
return ph[-1]
894
307
else:
895
308
return None
896
309
897
898
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
310
def missing_revisions(self, other, stop_revision=None):
899
311
"""Return a list of new revisions that would perfectly fit.
900
312
901
313
If self and other have not diverged, return a list of the revisions
902
314
present in other, but missing from self.
903
904
>>> from bzrlib.commit import commit
905
>>> bzrlib.trace.silent = True
906
>>> br1 = ScratchBranch()
907
>>> br2 = ScratchBranch()
908
>>> br1.missing_revisions(br2)
909
[]
910
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
911
>>> br1.missing_revisions(br2)
912
[u'REVISION-ID-1']
913
>>> br2.missing_revisions(br1)
914
[]
915
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
916
>>> br1.missing_revisions(br2)
917
[]
918
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
919
>>> br1.missing_revisions(br2)
920
[u'REVISION-ID-2A']
921
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
922
>>> br1.missing_revisions(br2)
923
Traceback (most recent call last):
924
DivergedBranches: These branches have diverged.
925
315
"""
926
# FIXME: If the branches have diverged, but the latest
927
# revision in this branch is completely merged into the other,
928
# then we should still be able to pull.
929
316
self_history = self.revision_history()
930
317
self_len = len(self_history)
931
318
other_history = other.revision_history()
940
327
else:
941
328
assert isinstance(stop_revision, int)
942
329
if stop_revision > other_len:
943
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
330
raise errors.NoSuchRevision(self, stop_revision)
944
331
return other_history[self_len:stop_revision]
945
332
946
333
def update_revisions(self, other, stop_revision=None):
947
"""Pull in new perfect-fit revisions."""
948
from bzrlib.fetch import greedy_fetch
949
from bzrlib.revision import get_intervening_revisions
950
if stop_revision is None:
951
stop_revision = other.last_revision()
952
greedy_fetch(to_branch=self, from_branch=other,
953
revision=stop_revision)
954
pullable_revs = self.missing_revisions(
955
other, other.revision_id_to_revno(stop_revision))
956
if pullable_revs:
957
greedy_fetch(to_branch=self,
958
from_branch=other,
959
revision=pullable_revs[-1])
960
self.append_revision(*pullable_revs)
961
962
963
def commit(self, *args, **kw):
964
from bzrlib.commit import Commit
965
Commit().commit(self, *args, **kw)
966
334
"""Pull in new perfect-fit revisions.
335
336
:param other: Another Branch to pull from
337
:param stop_revision: Updated until the given revision
338
:return: None
339
"""
340
raise NotImplementedError('update_revisions is abstract')
341
967
342
def revision_id_to_revno(self, revision_id):
968
343
"""Given a revision id, return its revno"""
969
344
if revision_id is None:
984
359
raise bzrlib.errors.NoSuchRevision(self, revno)
985
360
return history[revno - 1]
986
361
987
def revision_tree(self, revision_id):
988
"""Return Tree for a revision on this branch.
989
990
`revision_id` may be None for the null revision, in which case
991
an `EmptyTree` is returned."""
992
# TODO: refactor this to use an existing revision object
993
# so we don't need to read it in twice.
994
if revision_id == None:
995
return EmptyTree()
996
else:
997
inv = self.get_revision_inventory(revision_id)
998
return RevisionTree(self.weave_store, inv, revision_id)
999
1000
1001
def working_tree(self):
1002
"""Return a `Tree` for the working copy."""
1003
from bzrlib.workingtree import WorkingTree
1004
# TODO: In the future, WorkingTree should utilize Transport
1005
# RobertCollins 20051003 - I don't think it should - working trees are
1006
# much more complex to keep consistent than our careful .bzr subset.
1007
# instead, we should say that working trees are local only, and optimise
1008
# for that.
1009
return WorkingTree(self._transport.base, self.read_working_inventory())
1010
362
def pull(self, source, overwrite=False, stop_revision=None):
363
raise NotImplementedError('pull is abstract')
1011
364
1012
365
def basis_tree(self):
1013
366
"""Return `Tree` object for last revision.
1014
367
1015
368
If there are no revisions yet, return an `EmptyTree`.
1016
369
"""
1017
return self.revision_tree(self.last_revision())
1018
370
return self.repository.revision_tree(self.last_revision())
1019
371
1020
372
def rename_one(self, from_rel, to_rel):
1021
373
"""Rename one file.
1022
374
1023
375
This can change the directory or the filename or both.
1024
376
"""
1025
self.lock_write()
1026
try:
1027
tree = self.working_tree()
1028
inv = tree.inventory
1029
if not tree.has_filename(from_rel):
1030
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1031
if tree.has_filename(to_rel):
1032
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1033
1034
file_id = inv.path2id(from_rel)
1035
if file_id == None:
1036
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1037
1038
if inv.path2id(to_rel):
1039
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1040
1041
to_dir, to_tail = os.path.split(to_rel)
1042
to_dir_id = inv.path2id(to_dir)
1043
if to_dir_id == None and to_dir != '':
1044
raise BzrError("can't determine destination directory id for %r" % to_dir)
1045
1046
mutter("rename_one:")
1047
mutter(" file_id {%s}" % file_id)
1048
mutter(" from_rel %r" % from_rel)
1049
mutter(" to_rel %r" % to_rel)
1050
mutter(" to_dir %r" % to_dir)
1051
mutter(" to_dir_id {%s}" % to_dir_id)
1052
1053
inv.rename(file_id, to_dir_id, to_tail)
1054
1055
from_abs = self.abspath(from_rel)
1056
to_abs = self.abspath(to_rel)
1057
try:
1058
rename(from_abs, to_abs)
1059
except OSError, e:
1060
raise BzrError("failed to rename %r to %r: %s"
1061
% (from_abs, to_abs, e[1]),
1062
["rename rolled back"])
1063
1064
self._write_inventory(inv)
1065
finally:
1066
self.unlock()
1067
377
raise NotImplementedError('rename_one is abstract')
1068
378
1069
379
def move(self, from_paths, to_name):
1070
380
"""Rename files.
1080
390
This returns a list of (from_path, to_path) pairs for each
1081
391
entry that is moved.
1082
392
"""
1083
result = []
1084
self.lock_write()
1085
try:
1086
## TODO: Option to move IDs only
1087
assert not isinstance(from_paths, basestring)
1088
tree = self.working_tree()
1089
inv = tree.inventory
1090
to_abs = self.abspath(to_name)
1091
if not isdir(to_abs):
1092
raise BzrError("destination %r is not a directory" % to_abs)
1093
if not tree.has_filename(to_name):
1094
raise BzrError("destination %r not in working directory" % to_abs)
1095
to_dir_id = inv.path2id(to_name)
1096
if to_dir_id == None and to_name != '':
1097
raise BzrError("destination %r is not a versioned directory" % to_name)
1098
to_dir_ie = inv[to_dir_id]
1099
if to_dir_ie.kind not in ('directory', 'root_directory'):
1100
raise BzrError("destination %r is not a directory" % to_abs)
1101
1102
to_idpath = inv.get_idpath(to_dir_id)
1103
1104
for f in from_paths:
1105
if not tree.has_filename(f):
1106
raise BzrError("%r does not exist in working tree" % f)
1107
f_id = inv.path2id(f)
1108
if f_id == None:
1109
raise BzrError("%r is not versioned" % f)
1110
name_tail = splitpath(f)[-1]
1111
dest_path = appendpath(to_name, name_tail)
1112
if tree.has_filename(dest_path):
1113
raise BzrError("destination %r already exists" % dest_path)
1114
if f_id in to_idpath:
1115
raise BzrError("can't move %r to a subdirectory of itself" % f)
1116
1117
# OK, so there's a race here, it's possible that someone will
1118
# create a file in this interval and then the rename might be
1119
# left half-done. But we should have caught most problems.
1120
1121
for f in from_paths:
1122
name_tail = splitpath(f)[-1]
1123
dest_path = appendpath(to_name, name_tail)
1124
result.append((f, dest_path))
1125
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1126
try:
1127
rename(self.abspath(f), self.abspath(dest_path))
1128
except OSError, e:
1129
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1130
["rename rolled back"])
1131
1132
self._write_inventory(inv)
1133
finally:
1134
self.unlock()
1135
1136
return result
1137
1138
1139
def revert(self, filenames, old_tree=None, backups=True):
1140
"""Restore selected files to the versions from a previous tree.
1141
1142
backups
1143
If true (default) backups are made of files before
1144
they're renamed.
1145
"""
1146
from bzrlib.errors import NotVersionedError, BzrError
1147
from bzrlib.atomicfile import AtomicFile
1148
from bzrlib.osutils import backup_file
1149
1150
inv = self.read_working_inventory()
1151
if old_tree is None:
1152
old_tree = self.basis_tree()
1153
old_inv = old_tree.inventory
1154
1155
nids = []
1156
for fn in filenames:
1157
file_id = inv.path2id(fn)
1158
if not file_id:
1159
raise NotVersionedError("not a versioned file", fn)
1160
if not old_inv.has_id(file_id):
1161
raise BzrError("file not present in old tree", fn, file_id)
1162
nids.append((fn, file_id))
1163
1164
# TODO: Rename back if it was previously at a different location
1165
1166
# TODO: If given a directory, restore the entire contents from
1167
# the previous version.
1168
1169
# TODO: Make a backup to a temporary file.
1170
1171
# TODO: If the file previously didn't exist, delete it?
1172
for fn, file_id in nids:
1173
backup_file(fn)
1174
1175
f = AtomicFile(fn, 'wb')
1176
try:
1177
f.write(old_tree.get_file(file_id).read())
1178
f.commit()
1179
finally:
1180
f.close()
1181
1182
1183
def pending_merges(self):
1184
"""Return a list of pending merges.
1185
1186
These are revisions that have been merged into the working
1187
directory but not yet committed.
1188
"""
1189
cfn = self._rel_controlfilename('pending-merges')
1190
if not self._transport.has(cfn):
1191
return []
1192
p = []
1193
for l in self.controlfile('pending-merges', 'r').readlines():
1194
p.append(l.rstrip('\n'))
1195
return p
1196
1197
1198
def add_pending_merge(self, *revision_ids):
1199
# TODO: Perhaps should check at this point that the
1200
# history of the revision is actually present?
1201
p = self.pending_merges()
1202
updated = False
1203
for rev_id in revision_ids:
1204
if rev_id in p:
1205
continue
1206
p.append(rev_id)
1207
updated = True
1208
if updated:
1209
self.set_pending_merges(p)
1210
1211
def set_pending_merges(self, rev_list):
1212
self.lock_write()
1213
try:
1214
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1215
finally:
1216
self.unlock()
1217
393
raise NotImplementedError('move is abstract')
1218
394
1219
395
def get_parent(self):
1220
396
"""Return the parent location of the branch.
1223
399
pattern is that the user can override it by specifying a
1224
400
location.
1225
401
"""
1226
import errno
1227
_locs = ['parent', 'pull', 'x-pull']
1228
for l in _locs:
1229
try:
1230
return self.controlfile(l, 'r').read().strip('\n')
1231
except IOError, e:
1232
if e.errno != errno.ENOENT:
1233
raise
402
raise NotImplementedError('get_parent is abstract')
403
404
def get_submit_branch(self):
405
"""Return the submit location of the branch.
406
407
This is the default location for bundle. The usual
408
pattern is that the user can override it by specifying a
409
location.
410
"""
411
return self.get_config().get_user_option('submit_branch')
412
413
def set_submit_branch(self, location):
414
"""Return the submit location of the branch.
415
416
This is the default location for bundle. The usual
417
pattern is that the user can override it by specifying a
418
location.
419
"""
420
self.get_config().set_user_option('submit_branch', location)
421
422
def get_push_location(self):
423
"""Return the None or the location to push this branch to."""
424
raise NotImplementedError('get_push_location is abstract')
425
426
def set_push_location(self, location):
427
"""Set a new push location for this branch."""
428
raise NotImplementedError('set_push_location is abstract')
429
430
def set_parent(self, url):
431
raise NotImplementedError('set_parent is abstract')
432
433
@needs_write_lock
434
def update(self):
435
"""Synchronise this branch with the master branch if any.
436
437
:return: None or the last_revision pivoted out during the update.
438
"""
1234
439
return None
1235
440
1236
1237
def set_parent(self, url):
1238
# TODO: Maybe delete old location files?
1239
from bzrlib.atomicfile import AtomicFile
1240
self.lock_write()
1241
try:
1242
f = AtomicFile(self.controlfilename('parent'))
1243
try:
1244
f.write(url + '\n')
1245
f.commit()
1246
finally:
1247
f.close()
1248
finally:
1249
self.unlock()
1250
1251
441
def check_revno(self, revno):
1252
442
"""\
1253
443
Check whether a revno corresponds to any revision.
1263
453
"""
1264
454
if revno < 1 or revno > self.revno():
1265
455
raise InvalidRevisionNumber(revno)
1266
1267
1268
1269
1270
1271
class ScratchBranch(_Branch):
1272
"""Special test class: a branch that cleans up after itself.
1273
1274
>>> b = ScratchBranch()
1275
>>> isdir(b.base)
1276
True
1277
>>> bd = b.base
1278
>>> b.destroy()
1279
>>> isdir(bd)
1280
False
1281
"""
1282
def __init__(self, files=[], dirs=[], base=None):
1283
"""Make a test branch.
1284
1285
This creates a temporary directory and runs init-tree in it.
1286
1287
If any files are listed, they are created in the working copy.
1288
"""
1289
from tempfile import mkdtemp
1290
init = False
1291
if base is None:
1292
base = mkdtemp()
1293
init = True
1294
if isinstance(base, basestring):
1295
base = get_transport(base)
1296
_Branch.__init__(self, base, init=init)
1297
for d in dirs:
1298
self._transport.mkdir(d)
1299
1300
for f in files:
1301
self._transport.put(f, 'content of %s' % f)
1302
1303
1304
def clone(self):
1305
"""
1306
>>> orig = ScratchBranch(files=["file1", "file2"])
1307
>>> clone = orig.clone()
1308
>>> if os.name != 'nt':
1309
... os.path.samefile(orig.base, clone.base)
1310
... else:
1311
... orig.base == clone.base
1312
...
1313
False
1314
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1315
True
1316
"""
1317
from shutil import copytree
1318
from tempfile import mkdtemp
1319
base = mkdtemp()
1320
os.rmdir(base)
1321
copytree(self.base, base, symlinks=True)
1322
return ScratchBranch(base=base)
456
457
@needs_read_lock
458
def clone(self, *args, **kwargs):
459
"""Clone this branch into to_bzrdir preserving all semantic values.
460
461
revision_id: if not None, the revision history in the new branch will
462
be truncated to end with revision_id.
463
"""
464
# for API compatibility, until 0.8 releases we provide the old api:
465
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
466
# after 0.8 releases, the *args and **kwargs should be changed:
467
# def clone(self, to_bzrdir, revision_id=None):
468
if (kwargs.get('to_location', None) or
469
kwargs.get('revision', None) or
470
kwargs.get('basis_branch', None) or
471
(len(args) and isinstance(args[0], basestring))):
472
# backwards compatibility api:
473
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
474
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
475
# get basis_branch
476
if len(args) > 2:
477
basis_branch = args[2]
478
else:
479
basis_branch = kwargs.get('basis_branch', None)
480
if basis_branch:
481
basis = basis_branch.bzrdir
482
else:
483
basis = None
484
# get revision
485
if len(args) > 1:
486
revision_id = args[1]
487
else:
488
revision_id = kwargs.get('revision', None)
489
# get location
490
if len(args):
491
url = args[0]
492
else:
493
# no default to raise if not provided.
494
url = kwargs.get('to_location')
495
return self.bzrdir.clone(url,
496
revision_id=revision_id,
497
basis=basis).open_branch()
498
# new cleaner api.
499
# generate args by hand
500
if len(args) > 1:
501
revision_id = args[1]
502
else:
503
revision_id = kwargs.get('revision_id', None)
504
if len(args):
505
to_bzrdir = args[0]
506
else:
507
# no default to raise if not provided.
508
to_bzrdir = kwargs.get('to_bzrdir')
509
result = self._format.initialize(to_bzrdir)
510
self.copy_content_into(result, revision_id=revision_id)
511
return result
512
513
@needs_read_lock
514
def sprout(self, to_bzrdir, revision_id=None):
515
"""Create a new line of development from the branch, into to_bzrdir.
516
517
revision_id: if not None, the revision history in the new branch will
518
be truncated to end with revision_id.
519
"""
520
result = self._format.initialize(to_bzrdir)
521
self.copy_content_into(result, revision_id=revision_id)
522
result.set_parent(self.bzrdir.root_transport.base)
523
return result
524
525
@needs_read_lock
526
def copy_content_into(self, destination, revision_id=None):
527
"""Copy the content of self into destination.
528
529
revision_id: if not None, the revision history in the new branch will
530
be truncated to end with revision_id.
531
"""
532
new_history = self.revision_history()
533
if revision_id is not None:
534
try:
535
new_history = new_history[:new_history.index(revision_id) + 1]
536
except ValueError:
537
rev = self.repository.get_revision(revision_id)
538
new_history = rev.get_history(self.repository)[1:]
539
destination.set_revision_history(new_history)
540
parent = self.get_parent()
541
if parent:
542
destination.set_parent(parent)
543
544
@needs_read_lock
545
def check(self):
546
"""Check consistency of the branch.
547
548
In particular this checks that revisions given in the revision-history
549
do actually match up in the revision graph, and that they're all
550
present in the repository.
551
552
Callers will typically also want to check the repository.
553
554
:return: A BranchCheckResult.
555
"""
556
mainline_parent_id = None
557
for revision_id in self.revision_history():
558
try:
559
revision = self.repository.get_revision(revision_id)
560
except errors.NoSuchRevision, e:
561
raise errors.BzrCheckError("mainline revision {%s} not in repository"
562
% revision_id)
563
# In general the first entry on the revision history has no parents.
564
# But it's not illegal for it to have parents listed; this can happen
565
# in imports from Arch when the parents weren't reachable.
566
if mainline_parent_id is not None:
567
if mainline_parent_id not in revision.parent_ids:
568
raise errors.BzrCheckError("previous revision {%s} not listed among "
569
"parents of {%s}"
570
% (mainline_parent_id, revision_id))
571
mainline_parent_id = revision_id
572
return BranchCheckResult(self)
573
574
575
class BranchFormat(object):
576
"""An encapsulation of the initialization and open routines for a format.
577
578
Formats provide three things:
579
* An initialization routine,
580
* a format string,
581
* an open routine.
582
583
Formats are placed in an dict by their format string for reference
584
during branch opening. Its not required that these be instances, they
585
can be classes themselves with class methods - it simply depends on
586
whether state is needed for a given format or not.
587
588
Once a format is deprecated, just deprecate the initialize and open
589
methods on the format class. Do not deprecate the object, as the
590
object will be created every time regardless.
591
"""
592
593
_default_format = None
594
"""The default format used for new branches."""
595
596
_formats = {}
597
"""The known formats."""
598
599
@classmethod
600
def find_format(klass, a_bzrdir):
601
"""Return the format for the branch object in a_bzrdir."""
602
try:
603
transport = a_bzrdir.get_branch_transport(None)
604
format_string = transport.get("format").read()
605
return klass._formats[format_string]
606
except NoSuchFile:
607
raise NotBranchError(path=transport.base)
608
except KeyError:
609
raise errors.UnknownFormatError(format=format_string)
610
611
@classmethod
612
def get_default_format(klass):
613
"""Return the current default format."""
614
return klass._default_format
615
616
def get_format_string(self):
617
"""Return the ASCII format string that identifies this format."""
618
raise NotImplementedError(self.get_format_string)
619
620
def get_format_description(self):
621
"""Return the short format description for this format."""
622
raise NotImplementedError(self.get_format_string)
623
624
def initialize(self, a_bzrdir):
625
"""Create a branch of this format in a_bzrdir."""
626
raise NotImplementedError(self.initialize)
627
628
def is_supported(self):
629
"""Is this format supported?
630
631
Supported formats can be initialized and opened.
632
Unsupported formats may not support initialization or committing or
633
some other features depending on the reason for not being supported.
634
"""
635
return True
636
637
def open(self, a_bzrdir, _found=False):
638
"""Return the branch object for a_bzrdir
639
640
_found is a private parameter, do not use it. It is used to indicate
641
if format probing has already be done.
642
"""
643
raise NotImplementedError(self.open)
644
645
@classmethod
646
def register_format(klass, format):
647
klass._formats[format.get_format_string()] = format
648
649
@classmethod
650
def set_default_format(klass, format):
651
klass._default_format = format
652
653
@classmethod
654
def unregister_format(klass, format):
655
assert klass._formats[format.get_format_string()] is format
656
del klass._formats[format.get_format_string()]
657
658
def __str__(self):
659
return self.get_format_string().rstrip()
660
661
662
class BzrBranchFormat4(BranchFormat):
663
"""Bzr branch format 4.
664
665
This format has:
666
- a revision-history file.
667
- a branch-lock lock file [ to be shared with the bzrdir ]
668
"""
669
670
def get_format_description(self):
671
"""See BranchFormat.get_format_description()."""
672
return "Branch format 4"
673
674
def initialize(self, a_bzrdir):
675
"""Create a branch of this format in a_bzrdir."""
676
mutter('creating branch in %s', a_bzrdir.transport.base)
677
branch_transport = a_bzrdir.get_branch_transport(self)
678
utf8_files = [('revision-history', ''),
679
('branch-name', ''),
680
]
681
control_files = LockableFiles(branch_transport, 'branch-lock',
682
TransportLock)
683
control_files.create_lock()
684
control_files.lock_write()
685
try:
686
for file, content in utf8_files:
687
control_files.put_utf8(file, content)
688
finally:
689
control_files.unlock()
690
return self.open(a_bzrdir, _found=True)
691
692
def __init__(self):
693
super(BzrBranchFormat4, self).__init__()
694
self._matchingbzrdir = bzrdir.BzrDirFormat6()
695
696
def open(self, a_bzrdir, _found=False):
697
"""Return the branch object for a_bzrdir
698
699
_found is a private parameter, do not use it. It is used to indicate
700
if format probing has already be done.
701
"""
702
if not _found:
703
# we are being called directly and must probe.
704
raise NotImplementedError
705
return BzrBranch(_format=self,
706
_control_files=a_bzrdir._control_files,
707
a_bzrdir=a_bzrdir,
708
_repository=a_bzrdir.open_repository())
709
710
def __str__(self):
711
return "Bazaar-NG branch format 4"
712
713
714
class BzrBranchFormat5(BranchFormat):
715
"""Bzr branch format 5.
716
717
This format has:
718
- a revision-history file.
719
- a format string
720
- a lock dir guarding the branch itself
721
- all of this stored in a branch/ subdirectory
722
- works with shared repositories.
723
724
This format is new in bzr 0.8.
725
"""
726
727
def get_format_string(self):
728
"""See BranchFormat.get_format_string()."""
729
return "Bazaar-NG branch format 5\n"
730
731
def get_format_description(self):
732
"""See BranchFormat.get_format_description()."""
733
return "Branch format 5"
734
735
def initialize(self, a_bzrdir):
736
"""Create a branch of this format in a_bzrdir."""
737
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
738
branch_transport = a_bzrdir.get_branch_transport(self)
739
utf8_files = [('revision-history', ''),
740
('branch-name', ''),
741
]
742
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
743
control_files.create_lock()
744
control_files.lock_write()
745
control_files.put_utf8('format', self.get_format_string())
746
try:
747
for file, content in utf8_files:
748
control_files.put_utf8(file, content)
749
finally:
750
control_files.unlock()
751
return self.open(a_bzrdir, _found=True, )
752
753
def __init__(self):
754
super(BzrBranchFormat5, self).__init__()
755
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
756
757
def open(self, a_bzrdir, _found=False):
758
"""Return the branch object for a_bzrdir
759
760
_found is a private parameter, do not use it. It is used to indicate
761
if format probing has already be done.
762
"""
763
if not _found:
764
format = BranchFormat.find_format(a_bzrdir)
765
assert format.__class__ == self.__class__
766
transport = a_bzrdir.get_branch_transport(None)
767
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
768
return BzrBranch5(_format=self,
769
_control_files=control_files,
770
a_bzrdir=a_bzrdir,
771
_repository=a_bzrdir.find_repository())
772
773
def __str__(self):
774
return "Bazaar-NG Metadir branch format 5"
775
776
777
class BranchReferenceFormat(BranchFormat):
778
"""Bzr branch reference format.
779
780
Branch references are used in implementing checkouts, they
781
act as an alias to the real branch which is at some other url.
782
783
This format has:
784
- A location file
785
- a format string
786
"""
787
788
def get_format_string(self):
789
"""See BranchFormat.get_format_string()."""
790
return "Bazaar-NG Branch Reference Format 1\n"
791
792
def get_format_description(self):
793
"""See BranchFormat.get_format_description()."""
794
return "Checkout reference format 1"
795
796
def initialize(self, a_bzrdir, target_branch=None):
797
"""Create a branch of this format in a_bzrdir."""
798
if target_branch is None:
799
# this format does not implement branch itself, thus the implicit
800
# creation contract must see it as uninitializable
801
raise errors.UninitializableFormat(self)
802
mutter('creating branch reference in %s', a_bzrdir.transport.base)
803
branch_transport = a_bzrdir.get_branch_transport(self)
804
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
805
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
806
branch_transport.put('format', StringIO(self.get_format_string()))
807
return self.open(a_bzrdir, _found=True)
808
809
def __init__(self):
810
super(BranchReferenceFormat, self).__init__()
811
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
812
813
def _make_reference_clone_function(format, a_branch):
814
"""Create a clone() routine for a branch dynamically."""
815
def clone(to_bzrdir, revision_id=None):
816
"""See Branch.clone()."""
817
return format.initialize(to_bzrdir, a_branch)
818
# cannot obey revision_id limits when cloning a reference ...
819
# FIXME RBC 20060210 either nuke revision_id for clone, or
820
# emit some sort of warning/error to the caller ?!
821
return clone
822
823
def open(self, a_bzrdir, _found=False):
824
"""Return the branch that the branch reference in a_bzrdir points at.
825
826
_found is a private parameter, do not use it. It is used to indicate
827
if format probing has already be done.
828
"""
829
if not _found:
830
format = BranchFormat.find_format(a_bzrdir)
831
assert format.__class__ == self.__class__
832
transport = a_bzrdir.get_branch_transport(None)
833
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
834
result = real_bzrdir.open_branch()
835
# this changes the behaviour of result.clone to create a new reference
836
# rather than a copy of the content of the branch.
837
# I did not use a proxy object because that needs much more extensive
838
# testing, and we are only changing one behaviour at the moment.
839
# If we decide to alter more behaviours - i.e. the implicit nickname
840
# then this should be refactored to introduce a tested proxy branch
841
# and a subclass of that for use in overriding clone() and ....
842
# - RBC 20060210
843
result.clone = self._make_reference_clone_function(result)
844
return result
845
846
847
# formats which have no format string are not discoverable
848
# and not independently creatable, so are not registered.
849
__default_format = BzrBranchFormat5()
850
BranchFormat.register_format(__default_format)
851
BranchFormat.register_format(BranchReferenceFormat())
852
BranchFormat.set_default_format(__default_format)
853
_legacy_formats = [BzrBranchFormat4(),
854
]
855
856
class BzrBranch(Branch):
857
"""A branch stored in the actual filesystem.
858
859
Note that it's "local" in the context of the filesystem; it doesn't
860
really matter if it's on an nfs/smb/afs/coda/... share, as long as
861
it's writable, and can be accessed via the normal filesystem API.
862
"""
863
864
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
865
relax_version_check=DEPRECATED_PARAMETER, _format=None,
866
_control_files=None, a_bzrdir=None, _repository=None):
867
"""Create new branch object at a particular location.
868
869
transport -- A Transport object, defining how to access files.
870
871
init -- If True, create new control files in a previously
872
unversioned directory. If False, the branch must already
873
be versioned.
874
875
relax_version_check -- If true, the usual check for the branch
876
version is not applied. This is intended only for
877
upgrade/recovery type use; it's not guaranteed that
878
all operations will work on old format branches.
879
"""
880
if a_bzrdir is None:
881
self.bzrdir = bzrdir.BzrDir.open(transport.base)
882
else:
883
self.bzrdir = a_bzrdir
884
self._transport = self.bzrdir.transport.clone('..')
885
self._base = self._transport.base
886
self._format = _format
887
if _control_files is None:
888
raise ValueError('BzrBranch _control_files is None')
889
self.control_files = _control_files
890
if deprecated_passed(init):
891
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
892
"deprecated as of bzr 0.8. Please use Branch.create().",
893
DeprecationWarning,
894
stacklevel=2)
895
if init:
896
# this is slower than before deprecation, oh well never mind.
897
# -> its deprecated.
898
self._initialize(transport.base)
899
self._check_format(_format)
900
if deprecated_passed(relax_version_check):
901
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
902
"relax_version_check parameter is deprecated as of bzr 0.8. "
903
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
904
"open() method.",
905
DeprecationWarning,
906
stacklevel=2)
907
if (not relax_version_check
908
and not self._format.is_supported()):
909
raise errors.UnsupportedFormatError(format=fmt)
910
if deprecated_passed(transport):
911
warn("BzrBranch.__init__(transport=XXX...): The transport "
912
"parameter is deprecated as of bzr 0.8. "
913
"Please use Branch.open, or bzrdir.open_branch().",
914
DeprecationWarning,
915
stacklevel=2)
916
self.repository = _repository
917
918
def __str__(self):
919
return '%s(%r)' % (self.__class__.__name__, self.base)
920
921
__repr__ = __str__
1323
922
1324
923
def __del__(self):
1325
self.destroy()
1326
1327
def destroy(self):
1328
"""Destroy the test branch, removing the scratch directory."""
1329
from shutil import rmtree
1330
try:
1331
if self.base:
1332
mutter("delete ScratchBranch %s" % self.base)
1333
rmtree(self.base)
1334
except OSError, e:
1335
# Work around for shutil.rmtree failing on Windows when
1336
# readonly files are encountered
1337
mutter("hit exception in destroying ScratchBranch: %s" % e)
1338
for root, dirs, files in os.walk(self.base, topdown=False):
1339
for name in files:
1340
os.chmod(os.path.join(root, name), 0700)
1341
rmtree(self.base)
1342
self._transport = None
1343
924
# TODO: It might be best to do this somewhere else,
925
# but it is nice for a Branch object to automatically
926
# cache it's information.
927
# Alternatively, we could have the Transport objects cache requests
928
# See the earlier discussion about how major objects (like Branch)
929
# should never expect their __del__ function to run.
930
# XXX: cache_root seems to be unused, 2006-01-13 mbp
931
if hasattr(self, 'cache_root') and self.cache_root is not None:
932
try:
933
osutils.rmtree(self.cache_root)
934
except:
935
pass
936
self.cache_root = None
937
938
def _get_base(self):
939
return self._base
940
941
base = property(_get_base, doc="The URL for the root of this branch.")
942
943
def _finish_transaction(self):
944
"""Exit the current transaction."""
945
return self.control_files._finish_transaction()
946
947
def get_transaction(self):
948
"""Return the current active transaction.
949
950
If no transaction is active, this returns a passthrough object
951
for which all data is immediately flushed and no caching happens.
952
"""
953
# this is an explicit function so that we can do tricky stuff
954
# when the storage in rev_storage is elsewhere.
955
# we probably need to hook the two 'lock a location' and
956
# 'have a transaction' together more delicately, so that
957
# we can have two locks (branch and storage) and one transaction
958
# ... and finishing the transaction unlocks both, but unlocking
959
# does not. - RBC 20051121
960
return self.control_files.get_transaction()
961
962
def _set_transaction(self, transaction):
963
"""Set a new active transaction."""
964
return self.control_files._set_transaction(transaction)
965
966
def abspath(self, name):
967
"""See Branch.abspath."""
968
return self.control_files._transport.abspath(name)
969
970
def _check_format(self, format):
971
"""Identify the branch format if needed.
972
973
The format is stored as a reference to the format object in
974
self._format for code that needs to check it later.
975
976
The format parameter is either None or the branch format class
977
used to open this branch.
978
979
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
980
"""
981
if format is None:
982
format = BranchFormat.find_format(self.bzrdir)
983
self._format = format
984
mutter("got branch format %s", self._format)
985
986
@needs_read_lock
987
def get_root_id(self):
988
"""See Branch.get_root_id."""
989
tree = self.repository.revision_tree(self.last_revision())
990
return tree.inventory.root.file_id
991
992
def is_locked(self):
993
return self.control_files.is_locked()
994
995
def lock_write(self):
996
# TODO: test for failed two phase locks. This is known broken.
997
self.control_files.lock_write()
998
self.repository.lock_write()
999
1000
def lock_read(self):
1001
# TODO: test for failed two phase locks. This is known broken.
1002
self.control_files.lock_read()
1003
self.repository.lock_read()
1004
1005
def unlock(self):
1006
# TODO: test for failed two phase locks. This is known broken.
1007
try:
1008
self.repository.unlock()
1009
finally:
1010
self.control_files.unlock()
1011
1012
def peek_lock_mode(self):
1013
if self.control_files._lock_count == 0:
1014
return None
1015
else:
1016
return self.control_files._lock_mode
1017
1018
def get_physical_lock_status(self):
1019
return self.control_files.get_physical_lock_status()
1020
1021
@needs_read_lock
1022
def print_file(self, file, revision_id):
1023
"""See Branch.print_file."""
1024
return self.repository.print_file(file, revision_id)
1025
1026
@needs_write_lock
1027
def append_revision(self, *revision_ids):
1028
"""See Branch.append_revision."""
1029
for revision_id in revision_ids:
1030
mutter("add {%s} to revision-history" % revision_id)
1031
rev_history = self.revision_history()
1032
rev_history.extend(revision_ids)
1033
self.set_revision_history(rev_history)
1034
1035
@needs_write_lock
1036
def set_revision_history(self, rev_history):
1037
"""See Branch.set_revision_history."""
1038
self.control_files.put_utf8(
1039
'revision-history', '\n'.join(rev_history))
1040
transaction = self.get_transaction()
1041
history = transaction.map.find_revision_history()
1042
if history is not None:
1043
# update the revision history in the identity map.
1044
history[:] = list(rev_history)
1045
# this call is disabled because revision_history is
1046
# not really an object yet, and the transaction is for objects.
1047
# transaction.register_dirty(history)
1048
else:
1049
transaction.map.add_revision_history(rev_history)
1050
# this call is disabled because revision_history is
1051
# not really an object yet, and the transaction is for objects.
1052
# transaction.register_clean(history)
1053
1054
@needs_read_lock
1055
def revision_history(self):
1056
"""See Branch.revision_history."""
1057
transaction = self.get_transaction()
1058
history = transaction.map.find_revision_history()
1059
if history is not None:
1060
mutter("cache hit for revision-history in %s", self)
1061
return list(history)
1062
history = [l.rstrip('\r\n') for l in
1063
self.control_files.get_utf8('revision-history').readlines()]
1064
transaction.map.add_revision_history(history)
1065
# this call is disabled because revision_history is
1066
# not really an object yet, and the transaction is for objects.
1067
# transaction.register_clean(history, precious=True)
1068
return list(history)
1069
1070
@needs_write_lock
1071
def generate_revision_history(self, revision_id, last_rev=None,
1072
other_branch=None):
1073
"""Create a new revision history that will finish with revision_id.
1074
1075
:param revision_id: the new tip to use.
1076
:param last_rev: The previous last_revision. If not None, then this
1077
must be a ancestory of revision_id, or DivergedBranches is raised.
1078
:param other_branch: The other branch that DivergedBranches should
1079
raise with respect to.
1080
"""
1081
# stop_revision must be a descendant of last_revision
1082
stop_graph = self.repository.get_revision_graph(revision_id)
1083
if last_rev is not None and last_rev not in stop_graph:
1084
# our previous tip is not merged into stop_revision
1085
raise errors.DivergedBranches(self, other_branch)
1086
# make a new revision history from the graph
1087
current_rev_id = revision_id
1088
new_history = []
1089
while current_rev_id not in (None, revision.NULL_REVISION):
1090
new_history.append(current_rev_id)
1091
current_rev_id_parents = stop_graph[current_rev_id]
1092
try:
1093
current_rev_id = current_rev_id_parents[0]
1094
except IndexError:
1095
current_rev_id = None
1096
new_history.reverse()
1097
self.set_revision_history(new_history)
1098
1099
@needs_write_lock
1100
def update_revisions(self, other, stop_revision=None):
1101
"""See Branch.update_revisions."""
1102
other.lock_read()
1103
try:
1104
if stop_revision is None:
1105
stop_revision = other.last_revision()
1106
if stop_revision is None:
1107
# if there are no commits, we're done.
1108
return
1109
# whats the current last revision, before we fetch [and change it
1110
# possibly]
1111
last_rev = self.last_revision()
1112
# we fetch here regardless of whether we need to so that we pickup
1113
# filled in ghosts.
1114
self.fetch(other, stop_revision)
1115
my_ancestry = self.repository.get_ancestry(last_rev)
1116
if stop_revision in my_ancestry:
1117
# last_revision is a descendant of stop_revision
1118
return
1119
self.generate_revision_history(stop_revision, last_rev=last_rev,
1120
other_branch=other)
1121
finally:
1122
other.unlock()
1123
1124
def basis_tree(self):
1125
"""See Branch.basis_tree."""
1126
return self.repository.revision_tree(self.last_revision())
1127
1128
@deprecated_method(zero_eight)
1129
def working_tree(self):
1130
"""Create a Working tree object for this branch."""
1131
1132
from bzrlib.transport.local import LocalTransport
1133
if (self.base.find('://') != -1 or
1134
not isinstance(self._transport, LocalTransport)):
1135
raise NoWorkingTree(self.base)
1136
return self.bzrdir.open_workingtree()
1137
1138
@needs_write_lock
1139
def pull(self, source, overwrite=False, stop_revision=None):
1140
"""See Branch.pull."""
1141
source.lock_read()
1142
try:
1143
old_count = len(self.revision_history())
1144
try:
1145
self.update_revisions(source,stop_revision)
1146
except DivergedBranches:
1147
if not overwrite:
1148
raise
1149
if overwrite:
1150
self.set_revision_history(source.revision_history())
1151
new_count = len(self.revision_history())
1152
return new_count - old_count
1153
finally:
1154
source.unlock()
1155
1156
def get_parent(self):
1157
"""See Branch.get_parent."""
1158
1159
_locs = ['parent', 'pull', 'x-pull']
1160
assert self.base[-1] == '/'
1161
for l in _locs:
1162
try:
1163
parent = self.control_files.get(l).read().strip('\n')
1164
except NoSuchFile:
1165
continue
1166
# This is an old-format absolute path to a local branch
1167
# turn it into a url
1168
if parent.startswith('/'):
1169
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1170
return urlutils.join(self.base[:-1], parent)
1171
return None
1172
1173
def get_push_location(self):
1174
"""See Branch.get_push_location."""
1175
push_loc = self.get_config().get_user_option('push_location')
1176
return push_loc
1177
1178
def set_push_location(self, location):
1179
"""See Branch.set_push_location."""
1180
self.get_config().set_user_option('push_location', location,
1181
local=True)
1182
1183
@needs_write_lock
1184
def set_parent(self, url):
1185
"""See Branch.set_parent."""
1186
# TODO: Maybe delete old location files?
1187
# URLs should never be unicode, even on the local fs,
1188
# FIXUP this and get_parent in a future branch format bump:
1189
# read and rewrite the file, and have the new format code read
1190
# using .get not .get_utf8. RBC 20060125
1191
if url is None:
1192
self.control_files._transport.delete('parent')
1193
else:
1194
if isinstance(url, unicode):
1195
try:
1196
url = url.encode('ascii')
1197
except UnicodeEncodeError:
1198
raise bzrlib.errors.InvalidURL(url,
1199
"Urls must be 7-bit ascii, "
1200
"use bzrlib.urlutils.escape")
1201
1202
url = urlutils.relative_url(self.base, url)
1203
self.control_files.put('parent', url + '\n')
1204
1205
@deprecated_function(zero_nine)
1206
def tree_config(self):
1207
"""DEPRECATED; call get_config instead.
1208
TreeConfig has become part of BranchConfig."""
1209
return TreeConfig(self)
1210
1211
1212
class BzrBranch5(BzrBranch):
1213
"""A format 5 branch. This supports new features over plan branches.
1214
1215
It has support for a master_branch which is the data for bound branches.
1216
"""
1217
1218
def __init__(self,
1219
_format,
1220
_control_files,
1221
a_bzrdir,
1222
_repository):
1223
super(BzrBranch5, self).__init__(_format=_format,
1224
_control_files=_control_files,
1225
a_bzrdir=a_bzrdir,
1226
_repository=_repository)
1227
1228
@needs_write_lock
1229
def pull(self, source, overwrite=False, stop_revision=None):
1230
"""Updates branch.pull to be bound branch aware."""
1231
bound_location = self.get_bound_location()
1232
if source.base != bound_location:
1233
# not pulling from master, so we need to update master.
1234
master_branch = self.get_master_branch()
1235
if master_branch:
1236
master_branch.pull(source)
1237
source = master_branch
1238
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1239
1240
def get_bound_location(self):
1241
try:
1242
return self.control_files.get_utf8('bound').read()[:-1]
1243
except errors.NoSuchFile:
1244
return None
1245
1246
@needs_read_lock
1247
def get_master_branch(self):
1248
"""Return the branch we are bound to.
1249
1250
:return: Either a Branch, or None
1251
1252
This could memoise the branch, but if thats done
1253
it must be revalidated on each new lock.
1254
So for now we just don't memoise it.
1255
# RBC 20060304 review this decision.
1256
"""
1257
bound_loc = self.get_bound_location()
1258
if not bound_loc:
1259
return None
1260
try:
1261
return Branch.open(bound_loc)
1262
except (errors.NotBranchError, errors.ConnectionError), e:
1263
raise errors.BoundBranchConnectionFailure(
1264
self, bound_loc, e)
1265
1266
@needs_write_lock
1267
def set_bound_location(self, location):
1268
"""Set the target where this branch is bound to.
1269
1270
:param location: URL to the target branch
1271
"""
1272
if location:
1273
self.control_files.put_utf8('bound', location+'\n')
1274
else:
1275
try:
1276
self.control_files._transport.delete('bound')
1277
except NoSuchFile:
1278
return False
1279
return True
1280
1281
@needs_write_lock
1282
def bind(self, other):
1283
"""Bind the local branch the other branch.
1284
1285
:param other: The branch to bind to
1286
:type other: Branch
1287
"""
1288
# TODO: jam 20051230 Consider checking if the target is bound
1289
# It is debatable whether you should be able to bind to
1290
# a branch which is itself bound.
1291
# Committing is obviously forbidden,
1292
# but binding itself may not be.
1293
# Since we *have* to check at commit time, we don't
1294
# *need* to check here
1295
self.pull(other)
1296
1297
# we are now equal to or a suffix of other.
1298
1299
# Since we have 'pulled' from the remote location,
1300
# now we should try to pull in the opposite direction
1301
# in case the local tree has more revisions than the
1302
# remote one.
1303
# There may be a different check you could do here
1304
# rather than actually trying to install revisions remotely.
1305
# TODO: capture an exception which indicates the remote branch
1306
# is not writable.
1307
# If it is up-to-date, this probably should not be a failure
1308
1309
# lock other for write so the revision-history syncing cannot race
1310
other.lock_write()
1311
try:
1312
other.pull(self)
1313
# if this does not error, other now has the same last rev we do
1314
# it can only error if the pull from other was concurrent with
1315
# a commit to other from someone else.
1316
1317
# until we ditch revision-history, we need to sync them up:
1318
self.set_revision_history(other.revision_history())
1319
# now other and self are up to date with each other and have the
1320
# same revision-history.
1321
finally:
1322
other.unlock()
1323
1324
self.set_bound_location(other.base)
1325
1326
@needs_write_lock
1327
def unbind(self):
1328
"""If bound, unbind"""
1329
return self.set_bound_location(None)
1330
1331
@needs_write_lock
1332
def update(self):
1333
"""Synchronise this branch with the master branch if any.
1334
1335
:return: None or the last_revision that was pivoted out during the
1336
update.
1337
"""
1338
master = self.get_master_branch()
1339
if master is not None:
1340
old_tip = self.last_revision()
1341
self.pull(master, overwrite=True)
1342
if old_tip in self.repository.get_ancestry(self.last_revision()):
1343
return None
1344
return old_tip
1345
return None
1346
1347
1348
class BranchTestProviderAdapter(object):
1349
"""A tool to generate a suite testing multiple branch formats at once.
1350
1351
This is done by copying the test once for each transport and injecting
1352
the transport_server, transport_readonly_server, and branch_format
1353
classes into each copy. Each copy is also given a new id() to make it
1354
easy to identify.
1355
"""
1356
1357
def __init__(self, transport_server, transport_readonly_server, formats):
1358
self._transport_server = transport_server
1359
self._transport_readonly_server = transport_readonly_server
1360
self._formats = formats
1344
1361
1362
def adapt(self, test):
1363
result = TestSuite()
1364
for branch_format, bzrdir_format in self._formats:
1365
new_test = deepcopy(test)
1366
new_test.transport_server = self._transport_server
1367
new_test.transport_readonly_server = self._transport_readonly_server
1368
new_test.bzrdir_format = bzrdir_format
1369
new_test.branch_format = branch_format
1370
def make_new_test_id():
1371
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1372
return lambda: new_id
1373
new_test.id = make_new_test_id()
1374
result.addTest(new_test)
1375
return result
1376
1377
1378
class BranchCheckResult(object):
1379
"""Results of checking branch consistency.
1380
1381
:see: Branch.check
1382
"""
1383
1384
def __init__(self, branch):
1385
self.branch = branch
1386
1387
def report_results(self, verbose):
1388
"""Report the check results via trace.note.
1389
1390
:param verbose: Requests more detailed display of what was checked,
1391
if any.
1392
"""
1393
note('checked branch %s format %s',
1394
self.branch.base,
1395
self.branch._format)
1396
1345
1397
1346
1398
######################################################################
1347
1399
# predicates
1348
1400
1349
1401
1350
def is_control_file(filename):
1351
## FIXME: better check
1352
filename = os.path.normpath(filename)
1353
while filename != '':
1354
head, tail = os.path.split(filename)
1355
## mutter('check %r for control file' % ((head, tail), ))
1356
if tail == bzrlib.BZRDIR:
1357
return True
1358
if filename == head:
1359
break
1360
filename = head
1361
return False
1362
1363
1364
1365
def gen_file_id(name):
1366
"""Return new file id.
1367
1368
This should probably generate proper UUIDs, but for the moment we
1369
cope with just randomness because running uuidgen every time is
1370
slow."""
1371
import re
1372
from binascii import hexlify
1373
from time import time
1374
1375
# get last component
1376
idx = name.rfind('/')
1377
if idx != -1:
1378
name = name[idx+1 : ]
1379
idx = name.rfind('\\')
1380
if idx != -1:
1381
name = name[idx+1 : ]
1382
1383
# make it not a hidden file
1384
name = name.lstrip('.')
1385
1386
# remove any wierd characters; we don't escape them but rather
1387
# just pull them out
1388
name = re.sub(r'[^\w.]', '', name)
1389
1390
s = hexlify(rand_bytes(8))
1391
return '-'.join((name, compact_date(time()), s))
1392
1393
1394
def gen_root_id():
1395
"""Return a new tree-root file id."""
1396
return gen_file_id('TREE_ROOT')
1397
1398
1402
@deprecated_function(zero_eight)
1403
def is_control_file(*args, **kwargs):
1404
"""See bzrlib.workingtree.is_control_file."""
1405
return bzrlib.workingtree.is_control_file(*args, **kwargs)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1