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