« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1399.1.6
- compare with another revision
- download diff
- download tarball
- view history from revision 1399.1.6
- Committer: Robert Collins
- Date: 2005-10-03 05:54:35 UTC
- mto: (1393.1.30)
- mto: This revision was merged to the branch mainline in revision 1400.
- Revision ID: robertc@robertcollins.net-20051003055434-c8ebd30d1de10247
move exporting functionality into inventory.py - uncovers bug in symlink support
- 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/branch_implementations/test_branch.py => bzrlib/selftest/testbranch.py
- bzrlib/tests/test_diff.py => bzrlib/selftest/testdiff.py
- bzrlib/tests/test_fetch.py => bzrlib/selftest/testfetch.py
- bzrlib/tests/test_graph.py => bzrlib/selftest/testgraph.py
- bzrlib/tests/test_hashcache.py => bzrlib/selftest/testhashcache.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_revision.py => bzrlib/selftest/testrevision.py
- bzrlib/tests/test_revisionnamespaces.py => bzrlib/selftest/testrevisionnamespaces.py
- bzrlib/tests/blackbox/test_status.py => bzrlib/selftest/teststatus.py
- bzrlib/tests/test_store.py => bzrlib/selftest/teststore.py
- bzrlib/tests/test_transport.py => bzrlib/selftest/testtransport.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
- bzr *
- setup.py *
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
32
import bzrlib.errors as errors
26
from bzrlib.inventory import InventoryEntry
27
from bzrlib.trace import mutter, note
28
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
29
rename, splitpath, sha_file, appendpath,
30
file_kind)
33
31
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
32
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
37
UnlistableStore,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
39
NoWorkingTree)
40
import bzrlib.inventory as inventory
33
DivergedBranches, LockError, UnlistableStore,
34
UnlistableBranch, NoSuchFile)
35
from bzrlib.textui import show_status
36
from bzrlib.revision import Revision, validate_revision_id, is_ancestor
37
from bzrlib.delta import compare_trees
38
from bzrlib.tree import EmptyTree, RevisionTree
41
39
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
40
from bzrlib.store import copy_all
60
from bzrlib.symbol_versioning import *
61
import bzrlib.transactions as transactions
41
from bzrlib.store.compressed_text import CompressedTextStore
42
from bzrlib.store.text import TextStore
43
from bzrlib.store.weave import WeaveStore
62
44
from bzrlib.transport import Transport, get_transport
63
from bzrlib.tree import EmptyTree, RevisionTree
45
import bzrlib.xml5
64
46
import bzrlib.ui
65
import bzrlib.xml5
66
47
67
48
68
49
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
50
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
71
72
73
# TODO: Maybe include checks for common corruption of newlines, etc?
51
## TODO: Maybe include checks for common corruption of newlines, etc?
52
74
53
75
54
# TODO: Some operations like log might retrieve the same revisions
76
55
# repeatedly to calculate deltas. We could perhaps have a weakref
77
56
# 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
57
# cached in memory between lock and unlock operations.
58
59
def find_branch(*ignored, **ignored_too):
60
# XXX: leave this here for about one release, then remove it
61
raise NotImplementedError('find_branch() is not supported anymore, '
62
'please use one of the new branch constructors')
63
def _relpath(base, path):
64
"""Return path relative to base, or raise exception.
65
66
The path may be either an absolute path or a path relative to the
67
current working directory.
68
69
Lifted out of Branch.relpath for ease of testing.
70
71
os.path.commonprefix (python2.4) has a bad bug that it works just
72
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
73
avoids that problem."""
74
rp = os.path.abspath(path)
75
76
s = []
77
head = rp
78
while len(head) >= len(base):
79
if head == base:
80
break
81
head, tail = os.path.split(head)
82
if tail:
83
s.insert(0, tail)
84
else:
85
raise NotBranchError("path %r is not within branch %r" % (rp, base))
86
87
return os.sep.join(s)
88
89
90
def find_branch_root(t):
91
"""Find the branch root enclosing the transport's base.
92
93
t is a Transport object.
94
95
It is not necessary that the base of t exists.
96
97
Basically we keep looking up until we find the control directory or
98
run into the root. If there isn't one, raises NotBranchError.
99
"""
100
orig_base = t.base
101
while True:
102
if t.has(bzrlib.BZRDIR):
103
return t
104
new_t = t.clone('..')
105
if new_t.base == t.base:
106
# reached the root, whatever that may be
107
raise NotBranchError('%s is not in a branch' % orig_base)
108
t = new_t
80
109
81
110
82
111
######################################################################
88
117
base
89
118
Base directory/url of the branch.
90
119
"""
91
# this is really an instance variable - FIXME move it there
92
# - RBC 20060112
93
120
base = None
94
121
95
122
def __init__(self, *ignored, **ignored_too):
96
123
raise NotImplementedError('The Branch class is abstract')
97
124
98
125
@staticmethod
99
@deprecated_method(zero_eight)
100
126
def open_downlevel(base):
101
"""Open a branch which may be of an old format."""
102
return Branch.open(base, _unsupported=True)
127
"""Open a branch which may be of an old format.
128
129
Only local branches are supported."""
130
return _Branch(get_transport(base), relax_version_check=True)
103
131
104
132
@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)
133
def open(base):
134
"""Open an existing branch, rooted at 'base' (url)"""
135
t = get_transport(base)
136
return _Branch(t)
113
137
114
138
@staticmethod
115
139
def open_containing(url):
116
140
"""Open an existing branch which contains url.
117
141
118
142
This probes for a branch at url, and searches upwards from there.
119
120
Basically we keep looking up until we find the control directory or
121
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
If there is one, it is returned, along with the unused portion of url.
125
143
"""
126
control, relpath = bzrdir.BzrDir.open_containing(url)
127
return control.open_branch(), relpath
144
t = get_transport(url)
145
t = find_branch_root(t)
146
return _Branch(t)
128
147
129
148
@staticmethod
130
@deprecated_function(zero_eight)
131
149
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
150
"""Create a new branch, rooted at 'base' (url)"""
151
t = get_transport(base)
152
return _Branch(t, init=True)
138
153
139
154
def setup_caching(self, cache_root):
140
155
"""Subclasses that care about caching should override this, and set
141
156
up cached stores located under cache_root.
142
157
"""
143
# seems to be unused, 2006-01-13 mbp
144
warn('%s is deprecated' % self.setup_caching)
145
self.cache_root = cache_root
146
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')
158
159
160
class _Branch(Branch):
161
"""A branch stored in the actual filesystem.
162
163
Note that it's "local" in the context of the filesystem; it doesn't
164
really matter if it's on an nfs/smb/afs/coda/... share, as long as
165
it's writable, and can be accessed via the normal filesystem API.
166
167
_lock_mode
168
None, or 'r' or 'w'
169
170
_lock_count
171
If _lock_mode is true, a positive count of the number of times the
172
lock has been taken.
173
174
_lock
175
Lock object from bzrlib.lock.
176
"""
177
# We actually expect this class to be somewhat short-lived; part of its
178
# purpose is to try to isolate what bits of the branch logic are tied to
179
# filesystem access, so that in a later step, we can extricate them to
180
# a separarte ("storage") class.
181
_lock_mode = None
182
_lock_count = None
183
_lock = None
184
_inventory_weave = None
185
186
# Map some sort of prefix into a namespace
187
# stuff like "revno:10", "revid:", etc.
188
# This should match a prefix with a function which accepts
189
REVISION_NAMESPACES = {}
190
191
def push_stores(self, branch_to):
192
"""Copy the content of this branches store to branch_to."""
193
if (self._branch_format != branch_to._branch_format
194
or self._branch_format != 4):
195
from bzrlib.fetch import greedy_fetch
196
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
197
self, self._branch_format, branch_to, branch_to._branch_format)
198
greedy_fetch(to_branch=branch_to, from_branch=self,
199
revision=self.last_revision())
200
return
201
202
store_pairs = ((self.text_store, branch_to.text_store),
203
(self.inventory_store, branch_to.inventory_store),
204
(self.revision_store, branch_to.revision_store))
205
try:
206
for from_store, to_store in store_pairs:
207
copy_all(from_store, to_store)
208
except UnlistableStore:
209
raise UnlistableBranch(from_store)
210
211
def __init__(self, transport, init=False,
212
relax_version_check=False):
213
"""Create new branch object at a particular location.
214
215
transport -- A Transport object, defining how to access files.
216
(If a string, transport.transport() will be used to
217
create a Transport object)
218
219
init -- If True, create new control files in a previously
220
unversioned directory. If False, the branch must already
221
be versioned.
222
223
relax_version_check -- If true, the usual check for the branch
224
version is not applied. This is intended only for
225
upgrade/recovery type use; it's not guaranteed that
226
all operations will work on old format branches.
227
228
In the test suite, creation of new trees is tested using the
229
`ScratchBranch` class.
230
"""
231
assert isinstance(transport, Transport), \
232
"%r is not a Transport" % transport
233
self._transport = transport
234
if init:
235
self._make_control()
236
self._check_format(relax_version_check)
237
238
def get_store(name, compressed=True):
239
relpath = self._rel_controlfilename(name)
240
if compressed:
241
store = CompressedTextStore(self._transport.clone(relpath))
242
else:
243
store = TextStore(self._transport.clone(relpath))
244
if self._transport.should_cache():
245
from meta_store import CachedStore
246
cache_path = os.path.join(self.cache_root, name)
247
os.mkdir(cache_path)
248
store = CachedStore(store, cache_path)
249
return store
250
def get_weave(name):
251
relpath = self._rel_controlfilename(name)
252
ws = WeaveStore(self._transport.clone(relpath))
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
266
def __str__(self):
267
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
268
269
270
__repr__ = __str__
271
272
273
def __del__(self):
274
if self._lock_mode or self._lock:
275
# XXX: This should show something every time, and be suitable for
276
# headless operation and embedding
277
warn("branch %r was not explicitly unlocked" % self)
278
self._lock.unlock()
279
280
# TODO: It might be best to do this somewhere else,
281
# but it is nice for a Branch object to automatically
282
# cache it's information.
283
# Alternatively, we could have the Transport objects cache requests
284
# See the earlier discussion about how major objects (like Branch)
285
# should never expect their __del__ function to run.
286
if hasattr(self, 'cache_root') and self.cache_root is not None:
287
try:
288
import shutil
289
shutil.rmtree(self.cache_root)
290
except:
291
pass
292
self.cache_root = None
293
294
def _get_base(self):
295
if self._transport:
296
return self._transport.base
297
return None
298
299
base = property(_get_base)
300
160
301
161
302
def lock_write(self):
162
raise NotImplementedError('lock_write is abstract')
303
# TODO: Upgrade locking to support using a Transport,
304
# and potentially a remote locking protocol
305
if self._lock_mode:
306
if self._lock_mode != 'w':
307
raise LockError("can't upgrade to a write lock from %r" %
308
self._lock_mode)
309
self._lock_count += 1
310
else:
311
self._lock = self._transport.lock_write(
312
self._rel_controlfilename('branch-lock'))
313
self._lock_mode = 'w'
314
self._lock_count = 1
315
163
316
164
317
def lock_read(self):
165
raise NotImplementedError('lock_read is abstract')
166
318
if self._lock_mode:
319
assert self._lock_mode in ('r', 'w'), \
320
"invalid lock mode %r" % self._lock_mode
321
self._lock_count += 1
322
else:
323
self._lock = self._transport.lock_read(
324
self._rel_controlfilename('branch-lock'))
325
self._lock_mode = 'r'
326
self._lock_count = 1
327
167
328
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')
329
if not self._lock_mode:
330
raise LockError('branch %r is not locked' % (self))
331
332
if self._lock_count > 1:
333
self._lock_count -= 1
334
else:
335
self._lock.unlock()
336
self._lock = None
337
self._lock_mode = self._lock_count = None
176
338
177
339
def abspath(self, name):
178
"""Return absolute filename for something in the branch
179
180
XXX: Robert Collins 20051017 what is this used for? why is it a branch
181
method and not a tree method.
182
"""
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
340
"""Return absolute filename for something in the branch"""
341
return self._transport.abspath(name)
342
343
def relpath(self, path):
344
"""Return path relative to this branch of something inside it.
345
346
Raises an error if path is not in this branch."""
347
return self._transport.relpath(path)
348
349
350
def _rel_controlfilename(self, file_or_path):
351
if isinstance(file_or_path, basestring):
352
file_or_path = [file_or_path]
353
return [bzrlib.BZRDIR] + file_or_path
354
355
def controlfilename(self, file_or_path):
356
"""Return location relative to branch."""
357
return self._transport.abspath(self._rel_controlfilename(file_or_path))
358
359
360
def controlfile(self, file_or_path, mode='r'):
361
"""Open a control file for this branch.
362
363
There are two classes of file in the control directory: text
364
and binary. binary files are untranslated byte streams. Text
365
control files are stored with Unix newlines and in UTF-8, even
366
if the platform or locale defaults are different.
367
368
Controlfiles should almost never be opened in write mode but
369
rather should be atomically copied and replaced using atomicfile.
370
"""
371
import codecs
372
373
relpath = self._rel_controlfilename(file_or_path)
374
#TODO: codecs.open() buffers linewise, so it was overloaded with
375
# a much larger buffer, do we need to do the same for getreader/getwriter?
376
if mode == 'rb':
377
return self._transport.get(relpath)
378
elif mode == 'wb':
379
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
380
elif mode == 'r':
381
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
382
elif mode == 'w':
383
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
210
384
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]
385
raise BzrError("invalid controlfile mode %r" % mode)
386
387
def put_controlfile(self, path, f, encode=True):
388
"""Write an entry as a controlfile.
389
390
:param path: The path to put the file, relative to the .bzr control
391
directory
392
:param f: A file-like or string object whose contents should be copied.
393
:param encode: If true, encode the contents as utf-8
394
"""
395
self.put_controlfiles([(path, f)], encode=encode)
396
397
def put_controlfiles(self, files, encode=True):
398
"""Write several entries as controlfiles.
399
400
:param files: A list of [(path, file)] pairs, where the path is the directory
401
underneath the bzr control directory
402
:param encode: If true, encode the contents as utf-8
403
"""
404
import codecs
405
ctrl_files = []
406
for path, f in files:
407
if encode:
408
if isinstance(f, basestring):
409
f = f.encode('utf-8', 'replace')
220
410
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.
411
f = codecs.getwriter('utf-8')(f, errors='replace')
412
path = self._rel_controlfilename(path)
413
ctrl_files.append((path, f))
414
self._transport.put_multi(ctrl_files)
415
416
def _make_control(self):
417
from bzrlib.inventory import Inventory
418
from bzrlib.weavefile import write_weave_v5
419
from bzrlib.weave import Weave
241
420
242
:return: Either a Branch, or None
421
# Create an empty inventory
422
sio = StringIO()
423
# if we want per-tree root ids then this is the place to set
424
# them; they're not needed for now and so ommitted for
425
# simplicity.
426
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
427
empty_inv = sio.getvalue()
428
sio = StringIO()
429
bzrlib.weavefile.write_weave_v5(Weave(), sio)
430
empty_weave = sio.getvalue()
431
432
dirs = [[], 'revision-store', 'weaves']
433
files = [('README',
434
"This is a Bazaar-NG control directory.\n"
435
"Do not change any files in this directory.\n"),
436
('branch-format', BZR_BRANCH_FORMAT_5),
437
('revision-history', ''),
438
('branch-name', ''),
439
('branch-lock', ''),
440
('pending-merges', ''),
441
('inventory', empty_inv),
442
('inventory.weave', empty_weave),
443
('ancestry.weave', empty_weave)
444
]
445
cfn = self._rel_controlfilename
446
self._transport.mkdir_multi([cfn(d) for d in dirs])
447
self.put_controlfiles(files)
448
mutter('created control directory in ' + self._transport.base)
449
450
def _check_format(self, relax_version_check):
451
"""Check this branch format is supported.
452
453
The format level is stored, as an integer, in
454
self._branch_format for code that needs to check it later.
455
456
In the future, we might need different in-memory Branch
457
classes to support downlevel branches. But not yet.
243
458
"""
244
return None
459
try:
460
fmt = self.controlfile('branch-format', 'r').read()
461
except NoSuchFile:
462
raise NotBranchError(self.base)
463
464
if fmt == BZR_BRANCH_FORMAT_5:
465
self._branch_format = 5
466
elif fmt == BZR_BRANCH_FORMAT_4:
467
self._branch_format = 4
468
469
if (not relax_version_check
470
and self._branch_format != 5):
471
raise BzrError('sorry, branch format %r not supported' % fmt,
472
['use a different bzr version',
473
'or remove the .bzr directory'
474
' and "bzr init" again'])
245
475
246
476
def get_root_id(self):
247
477
"""Return the id of this branches root"""
248
raise NotImplementedError('get_root_id is abstract')
249
250
def print_file(self, file, revision_id):
478
inv = self.read_working_inventory()
479
return inv.root.file_id
480
481
def set_root_id(self, file_id):
482
inv = self.read_working_inventory()
483
orig_root_id = inv.root.file_id
484
del inv._byid[inv.root.file_id]
485
inv.root.file_id = file_id
486
inv._byid[inv.root.file_id] = inv.root
487
for fid in inv:
488
entry = inv[fid]
489
if entry.parent_id in (None, orig_root_id):
490
entry.parent_id = inv.root.file_id
491
self._write_inventory(inv)
492
493
def read_working_inventory(self):
494
"""Read the working inventory."""
495
self.lock_read()
496
try:
497
# ElementTree does its own conversion from UTF-8, so open in
498
# binary.
499
f = self.controlfile('inventory', 'rb')
500
return bzrlib.xml5.serializer_v5.read_inventory(f)
501
finally:
502
self.unlock()
503
504
505
def _write_inventory(self, inv):
506
"""Update the working inventory.
507
508
That is to say, the inventory describing changes underway, that
509
will be committed to the next revision.
510
"""
511
from cStringIO import StringIO
512
self.lock_write()
513
try:
514
sio = StringIO()
515
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
516
sio.seek(0)
517
# Transport handles atomicity
518
self.put_controlfile('inventory', sio)
519
finally:
520
self.unlock()
521
522
mutter('wrote working inventory')
523
524
inventory = property(read_working_inventory, _write_inventory, None,
525
"""Inventory for the working copy.""")
526
527
def add(self, files, ids=None):
528
"""Make files versioned.
529
530
Note that the command line normally calls smart_add instead,
531
which can automatically recurse.
532
533
This puts the files in the Added state, so that they will be
534
recorded by the next commit.
535
536
files
537
List of paths to add, relative to the base of the tree.
538
539
ids
540
If set, use these instead of automatically generated ids.
541
Must be the same length as the list of files, but may
542
contain None for ids that are to be autogenerated.
543
544
TODO: Perhaps have an option to add the ids even if the files do
545
not (yet) exist.
546
547
TODO: Perhaps yield the ids and paths as they're added.
548
"""
549
# TODO: Re-adding a file that is removed in the working copy
550
# should probably put it back with the previous ID.
551
if isinstance(files, basestring):
552
assert(ids is None or isinstance(ids, basestring))
553
files = [files]
554
if ids is not None:
555
ids = [ids]
556
557
if ids is None:
558
ids = [None] * len(files)
559
else:
560
assert(len(ids) == len(files))
561
562
self.lock_write()
563
try:
564
inv = self.read_working_inventory()
565
for f,file_id in zip(files, ids):
566
if is_control_file(f):
567
raise BzrError("cannot add control file %s" % quotefn(f))
568
569
fp = splitpath(f)
570
571
if len(fp) == 0:
572
raise BzrError("cannot add top-level %r" % f)
573
574
fullpath = os.path.normpath(self.abspath(f))
575
576
try:
577
kind = file_kind(fullpath)
578
except OSError:
579
# maybe something better?
580
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
581
582
if not InventoryEntry.versionable_kind(kind):
583
raise BzrError('cannot add: not a versionable file ('
584
'i.e. regular file, symlink or directory): %s' % quotefn(f))
585
586
if file_id is None:
587
file_id = gen_file_id(f)
588
inv.add_path(f, kind=kind, file_id=file_id)
589
590
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
591
592
self._write_inventory(inv)
593
finally:
594
self.unlock()
595
596
597
def print_file(self, file, revno):
251
598
"""Print `file` to stdout."""
252
raise NotImplementedError('print_file is abstract')
599
self.lock_read()
600
try:
601
tree = self.revision_tree(self.get_rev_id(revno))
602
# use inventory as it was in that revision
603
file_id = tree.inventory.path2id(file)
604
if not file_id:
605
raise BzrError("%r is not present in revision %s" % (file, revno))
606
tree.print_file(file_id)
607
finally:
608
self.unlock()
609
610
611
def remove(self, files, verbose=False):
612
"""Mark nominated files for removal from the inventory.
613
614
This does not remove their text. This does not run on
615
616
TODO: Refuse to remove modified files unless --force is given?
617
618
TODO: Do something useful with directories.
619
620
TODO: Should this remove the text or not? Tough call; not
621
removing may be useful and the user can just use use rm, and
622
is the opposite of add. Removing it is consistent with most
623
other tools. Maybe an option.
624
"""
625
## TODO: Normalize names
626
## TODO: Remove nested loops; better scalability
627
if isinstance(files, basestring):
628
files = [files]
629
630
self.lock_write()
631
632
try:
633
tree = self.working_tree()
634
inv = tree.inventory
635
636
# do this before any modifications
637
for f in files:
638
fid = inv.path2id(f)
639
if not fid:
640
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
641
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
642
if verbose:
643
# having remove it, it must be either ignored or unknown
644
if tree.is_ignored(f):
645
new_status = 'I'
646
else:
647
new_status = '?'
648
show_status(new_status, inv[fid].kind, quotefn(f))
649
del inv[fid]
650
651
self._write_inventory(inv)
652
finally:
653
self.unlock()
654
655
# FIXME: this doesn't need to be a branch method
656
def set_inventory(self, new_inventory_list):
657
from bzrlib.inventory import Inventory, InventoryEntry
658
inv = Inventory(self.get_root_id())
659
for path, file_id, parent, kind in new_inventory_list:
660
name = os.path.basename(path)
661
if name == "":
662
continue
663
inv.add(InventoryEntry(file_id, name, kind, parent))
664
self._write_inventory(inv)
665
666
def unknowns(self):
667
"""Return all unknown files.
668
669
These are files in the working directory that are not versioned or
670
control files or ignored.
671
672
>>> b = ScratchBranch(files=['foo', 'foo~'])
673
>>> list(b.unknowns())
674
['foo']
675
>>> b.add('foo')
676
>>> list(b.unknowns())
677
[]
678
>>> b.remove('foo')
679
>>> list(b.unknowns())
680
['foo']
681
"""
682
return self.working_tree().unknowns()
683
253
684
254
685
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')
686
for revision_id in revision_ids:
687
mutter("add {%s} to revision-history" % revision_id)
688
self.lock_write()
689
try:
690
rev_history = self.revision_history()
691
rev_history.extend(revision_ids)
692
self.put_controlfile('revision-history', '\n'.join(rev_history))
693
finally:
694
self.unlock()
695
696
def has_revision(self, revision_id):
697
"""True if this branch has a copy of the revision.
698
699
This does not necessarily imply the revision is merge
700
or on the mainline."""
701
return (revision_id is None
702
or revision_id in self.revision_store)
703
704
def get_revision_xml_file(self, revision_id):
705
"""Return XML file object for revision object."""
706
if not revision_id or not isinstance(revision_id, basestring):
707
raise InvalidRevisionId(revision_id)
708
709
self.lock_read()
710
try:
711
try:
712
return self.revision_store[revision_id]
713
except (IndexError, KeyError):
714
raise bzrlib.errors.NoSuchRevision(self, revision_id)
715
finally:
716
self.unlock()
717
718
#deprecated
719
get_revision_xml = get_revision_xml_file
720
721
def get_revision_xml(self, revision_id):
722
return self.get_revision_xml_file(revision_id).read()
723
724
725
def get_revision(self, revision_id):
726
"""Return the Revision object for a named revision"""
727
xml_file = self.get_revision_xml_file(revision_id)
728
729
try:
730
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
731
except SyntaxError, e:
732
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
733
[revision_id,
734
str(e)])
735
736
assert r.revision_id == revision_id
737
return r
738
739
def get_revision_delta(self, revno):
740
"""Return the delta for one revision.
741
742
The delta is relative to its mainline predecessor, or the
743
empty tree for revision 1.
744
"""
745
assert isinstance(revno, int)
746
rh = self.revision_history()
747
if not (1 <= revno <= len(rh)):
748
raise InvalidRevisionNumber(revno)
749
750
# revno is 1-based; list is 0-based
751
752
new_tree = self.revision_tree(rh[revno-1])
753
if revno == 1:
754
old_tree = EmptyTree()
755
else:
756
old_tree = self.revision_tree(rh[revno-2])
757
758
return compare_trees(old_tree, new_tree)
759
760
def get_revision_sha1(self, revision_id):
761
"""Hash the stored value of a revision, and return it."""
762
# In the future, revision entries will be signed. At that
763
# point, it is probably best *not* to include the signature
764
# in the revision hash. Because that lets you re-sign
765
# the revision, (add signatures/remove signatures) and still
766
# have all hash pointers stay consistent.
767
# But for now, just hash the contents.
768
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
769
770
def _get_ancestry_weave(self):
771
return self.control_weaves.get_weave('ancestry')
772
773
def get_ancestry(self, revision_id):
774
"""Return a list of revision-ids integrated by a revision.
775
"""
776
# strip newlines
777
if revision_id is None:
778
return [None]
779
w = self._get_ancestry_weave()
780
return [None] + [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
781
782
def get_inventory_weave(self):
783
return self.control_weaves.get_weave('inventory')
784
785
def get_inventory(self, revision_id):
786
"""Get Inventory object by hash."""
787
xml = self.get_inventory_xml(revision_id)
788
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
789
790
def get_inventory_xml(self, revision_id):
791
"""Get inventory XML as a file object."""
792
try:
793
assert isinstance(revision_id, basestring), type(revision_id)
794
iw = self.get_inventory_weave()
795
return iw.get_text(iw.lookup(revision_id))
796
except IndexError:
797
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
798
799
def get_inventory_sha1(self, revision_id):
800
"""Return the sha1 hash of the inventory entry
801
"""
802
return self.get_revision(revision_id).inventory_sha1
803
804
def get_revision_inventory(self, revision_id):
805
"""Return inventory of a past revision."""
806
# TODO: Unify this with get_inventory()
807
# bzr 0.0.6 and later imposes the constraint that the inventory_id
808
# must be the same as its revision, so this is trivial.
809
if revision_id == None:
810
return Inventory(self.get_root_id())
811
else:
812
return self.get_inventory(revision_id)
259
813
260
814
def revision_history(self):
261
815
"""Return sequence of revision hashes on to this branch."""
262
raise NotImplementedError('revision_history is abstract')
816
self.lock_read()
817
try:
818
return [l.rstrip('\r\n') for l in
819
self.controlfile('revision-history', 'r').readlines()]
820
finally:
821
self.unlock()
822
823
def common_ancestor(self, other, self_revno=None, other_revno=None):
824
"""
825
>>> from bzrlib.commit import commit
826
>>> sb = ScratchBranch(files=['foo', 'foo~'])
827
>>> sb.common_ancestor(sb) == (None, None)
828
True
829
>>> commit(sb, "Committing first revision", verbose=False)
830
>>> sb.common_ancestor(sb)[0]
831
1
832
>>> clone = sb.clone()
833
>>> commit(sb, "Committing second revision", verbose=False)
834
>>> sb.common_ancestor(sb)[0]
835
2
836
>>> sb.common_ancestor(clone)[0]
837
1
838
>>> commit(clone, "Committing divergent second revision",
839
... verbose=False)
840
>>> sb.common_ancestor(clone)[0]
841
1
842
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
843
True
844
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
845
True
846
>>> clone2 = sb.clone()
847
>>> sb.common_ancestor(clone2)[0]
848
2
849
>>> sb.common_ancestor(clone2, self_revno=1)[0]
850
1
851
>>> sb.common_ancestor(clone2, other_revno=1)[0]
852
1
853
"""
854
my_history = self.revision_history()
855
other_history = other.revision_history()
856
if self_revno is None:
857
self_revno = len(my_history)
858
if other_revno is None:
859
other_revno = len(other_history)
860
indices = range(min((self_revno, other_revno)))
861
indices.reverse()
862
for r in indices:
863
if my_history[r] == other_history[r]:
864
return r+1, my_history[r]
865
return None, None
866
263
867
264
868
def revno(self):
265
869
"""Return current revision number for this branch.
269
873
"""
270
874
return len(self.revision_history())
271
875
272
def unbind(self):
273
"""Older format branches cannot bind or unbind."""
274
raise errors.UpgradeRequired(self.base)
275
876
276
877
def last_revision(self):
277
"""Return last patch hash, or None if no history."""
878
"""Return last patch hash, or None if no history.
879
"""
278
880
ph = self.revision_history()
279
881
if ph:
280
882
return ph[-1]
281
883
else:
282
884
return None
283
885
284
def missing_revisions(self, other, stop_revision=None):
886
887
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
285
888
"""Return a list of new revisions that would perfectly fit.
286
889
287
890
If self and other have not diverged, return a list of the revisions
288
891
present in other, but missing from self.
289
892
290
>>> from bzrlib.workingtree import WorkingTree
893
>>> from bzrlib.commit import commit
291
894
>>> 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()
895
>>> br1 = ScratchBranch()
896
>>> br2 = ScratchBranch()
298
897
>>> br1.missing_revisions(br2)
299
898
[]
300
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
899
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
301
900
>>> br1.missing_revisions(br2)
302
901
[u'REVISION-ID-1']
303
902
>>> br2.missing_revisions(br1)
304
903
[]
305
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
904
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
306
905
>>> br1.missing_revisions(br2)
307
906
[]
308
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
907
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
309
908
>>> br1.missing_revisions(br2)
310
909
[u'REVISION-ID-2A']
311
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
910
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
312
911
>>> br1.missing_revisions(br2)
313
912
Traceback (most recent call last):
314
DivergedBranches: These branches have diverged. Try merge.
913
DivergedBranches: These branches have diverged.
315
914
"""
915
# FIXME: If the branches have diverged, but the latest
916
# revision in this branch is completely merged into the other,
917
# then we should still be able to pull.
316
918
self_history = self.revision_history()
317
919
self_len = len(self_history)
318
920
other_history = other.revision_history()
331
933
return other_history[self_len:stop_revision]
332
934
333
935
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
936
"""Pull in new perfect-fit revisions."""
937
from bzrlib.fetch import greedy_fetch
938
from bzrlib.revision import get_intervening_revisions
939
if stop_revision is None:
940
stop_revision = other.last_revision()
941
greedy_fetch(to_branch=self, from_branch=other,
942
revision=stop_revision)
943
pullable_revs = self.missing_revisions(
944
other, other.revision_id_to_revno(stop_revision))
945
if pullable_revs:
946
greedy_fetch(to_branch=self,
947
from_branch=other,
948
revision=pullable_revs[-1])
949
self.append_revision(*pullable_revs)
950
951
952
def commit(self, *args, **kw):
953
from bzrlib.commit import Commit
954
Commit().commit(self, *args, **kw)
955
342
956
def revision_id_to_revno(self, revision_id):
343
957
"""Given a revision id, return its revno"""
344
958
if revision_id is None:
359
973
raise bzrlib.errors.NoSuchRevision(self, revno)
360
974
return history[revno - 1]
361
975
362
def pull(self, source, overwrite=False, stop_revision=None):
363
raise NotImplementedError('pull is abstract')
976
def revision_tree(self, revision_id):
977
"""Return Tree for a revision on this branch.
978
979
`revision_id` may be None for the null revision, in which case
980
an `EmptyTree` is returned."""
981
# TODO: refactor this to use an existing revision object
982
# so we don't need to read it in twice.
983
if revision_id == None:
984
return EmptyTree()
985
else:
986
inv = self.get_revision_inventory(revision_id)
987
return RevisionTree(self.weave_store, inv, revision_id)
988
989
990
def working_tree(self):
991
"""Return a `Tree` for the working copy."""
992
from bzrlib.workingtree import WorkingTree
993
# TODO: In the future, WorkingTree should utilize Transport
994
# RobertCollins 20051003 - I don't think it should - working trees are
995
# much more complex to keep consistent than our careful .bzr subset.
996
# instead, we should say that working trees are local only, and optimise
997
# for that.
998
return WorkingTree(self._transport.base, self.read_working_inventory())
999
364
1000
365
1001
def basis_tree(self):
366
1002
"""Return `Tree` object for last revision.
367
1003
368
1004
If there are no revisions yet, return an `EmptyTree`.
369
1005
"""
370
return self.repository.revision_tree(self.last_revision())
1006
return self.revision_tree(self.last_revision())
1007
371
1008
372
1009
def rename_one(self, from_rel, to_rel):
373
1010
"""Rename one file.
374
1011
375
1012
This can change the directory or the filename or both.
376
1013
"""
377
raise NotImplementedError('rename_one is abstract')
1014
self.lock_write()
1015
try:
1016
tree = self.working_tree()
1017
inv = tree.inventory
1018
if not tree.has_filename(from_rel):
1019
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1020
if tree.has_filename(to_rel):
1021
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1022
1023
file_id = inv.path2id(from_rel)
1024
if file_id == None:
1025
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1026
1027
if inv.path2id(to_rel):
1028
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1029
1030
to_dir, to_tail = os.path.split(to_rel)
1031
to_dir_id = inv.path2id(to_dir)
1032
if to_dir_id == None and to_dir != '':
1033
raise BzrError("can't determine destination directory id for %r" % to_dir)
1034
1035
mutter("rename_one:")
1036
mutter(" file_id {%s}" % file_id)
1037
mutter(" from_rel %r" % from_rel)
1038
mutter(" to_rel %r" % to_rel)
1039
mutter(" to_dir %r" % to_dir)
1040
mutter(" to_dir_id {%s}" % to_dir_id)
1041
1042
inv.rename(file_id, to_dir_id, to_tail)
1043
1044
from_abs = self.abspath(from_rel)
1045
to_abs = self.abspath(to_rel)
1046
try:
1047
rename(from_abs, to_abs)
1048
except OSError, e:
1049
raise BzrError("failed to rename %r to %r: %s"
1050
% (from_abs, to_abs, e[1]),
1051
["rename rolled back"])
1052
1053
self._write_inventory(inv)
1054
finally:
1055
self.unlock()
1056
378
1057
379
1058
def move(self, from_paths, to_name):
380
1059
"""Rename files.
390
1069
This returns a list of (from_path, to_path) pairs for each
391
1070
entry that is moved.
392
1071
"""
393
raise NotImplementedError('move is abstract')
1072
result = []
1073
self.lock_write()
1074
try:
1075
## TODO: Option to move IDs only
1076
assert not isinstance(from_paths, basestring)
1077
tree = self.working_tree()
1078
inv = tree.inventory
1079
to_abs = self.abspath(to_name)
1080
if not isdir(to_abs):
1081
raise BzrError("destination %r is not a directory" % to_abs)
1082
if not tree.has_filename(to_name):
1083
raise BzrError("destination %r not in working directory" % to_abs)
1084
to_dir_id = inv.path2id(to_name)
1085
if to_dir_id == None and to_name != '':
1086
raise BzrError("destination %r is not a versioned directory" % to_name)
1087
to_dir_ie = inv[to_dir_id]
1088
if to_dir_ie.kind not in ('directory', 'root_directory'):
1089
raise BzrError("destination %r is not a directory" % to_abs)
1090
1091
to_idpath = inv.get_idpath(to_dir_id)
1092
1093
for f in from_paths:
1094
if not tree.has_filename(f):
1095
raise BzrError("%r does not exist in working tree" % f)
1096
f_id = inv.path2id(f)
1097
if f_id == None:
1098
raise BzrError("%r is not versioned" % f)
1099
name_tail = splitpath(f)[-1]
1100
dest_path = appendpath(to_name, name_tail)
1101
if tree.has_filename(dest_path):
1102
raise BzrError("destination %r already exists" % dest_path)
1103
if f_id in to_idpath:
1104
raise BzrError("can't move %r to a subdirectory of itself" % f)
1105
1106
# OK, so there's a race here, it's possible that someone will
1107
# create a file in this interval and then the rename might be
1108
# left half-done. But we should have caught most problems.
1109
1110
for f in from_paths:
1111
name_tail = splitpath(f)[-1]
1112
dest_path = appendpath(to_name, name_tail)
1113
result.append((f, dest_path))
1114
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1115
try:
1116
rename(self.abspath(f), self.abspath(dest_path))
1117
except OSError, e:
1118
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1119
["rename rolled back"])
1120
1121
self._write_inventory(inv)
1122
finally:
1123
self.unlock()
1124
1125
return result
1126
1127
1128
def revert(self, filenames, old_tree=None, backups=True):
1129
"""Restore selected files to the versions from a previous tree.
1130
1131
backups
1132
If true (default) backups are made of files before
1133
they're renamed.
1134
"""
1135
from bzrlib.errors import NotVersionedError, BzrError
1136
from bzrlib.atomicfile import AtomicFile
1137
from bzrlib.osutils import backup_file
1138
1139
inv = self.read_working_inventory()
1140
if old_tree is None:
1141
old_tree = self.basis_tree()
1142
old_inv = old_tree.inventory
1143
1144
nids = []
1145
for fn in filenames:
1146
file_id = inv.path2id(fn)
1147
if not file_id:
1148
raise NotVersionedError("not a versioned file", fn)
1149
if not old_inv.has_id(file_id):
1150
raise BzrError("file not present in old tree", fn, file_id)
1151
nids.append((fn, file_id))
1152
1153
# TODO: Rename back if it was previously at a different location
1154
1155
# TODO: If given a directory, restore the entire contents from
1156
# the previous version.
1157
1158
# TODO: Make a backup to a temporary file.
1159
1160
# TODO: If the file previously didn't exist, delete it?
1161
for fn, file_id in nids:
1162
backup_file(fn)
1163
1164
f = AtomicFile(fn, 'wb')
1165
try:
1166
f.write(old_tree.get_file(file_id).read())
1167
f.commit()
1168
finally:
1169
f.close()
1170
1171
1172
def pending_merges(self):
1173
"""Return a list of pending merges.
1174
1175
These are revisions that have been merged into the working
1176
directory but not yet committed.
1177
"""
1178
cfn = self._rel_controlfilename('pending-merges')
1179
if not self._transport.has(cfn):
1180
return []
1181
p = []
1182
for l in self.controlfile('pending-merges', 'r').readlines():
1183
p.append(l.rstrip('\n'))
1184
return p
1185
1186
1187
def add_pending_merge(self, *revision_ids):
1188
# TODO: Perhaps should check at this point that the
1189
# history of the revision is actually present?
1190
for rev_id in revision_ids:
1191
validate_revision_id(rev_id)
1192
1193
p = self.pending_merges()
1194
updated = False
1195
for rev_id in revision_ids:
1196
if rev_id in p:
1197
continue
1198
p.append(rev_id)
1199
updated = True
1200
if updated:
1201
self.set_pending_merges(p)
1202
1203
def set_pending_merges(self, rev_list):
1204
self.lock_write()
1205
try:
1206
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1207
finally:
1208
self.unlock()
1209
394
1210
395
1211
def get_parent(self):
396
1212
"""Return the parent location of the branch.
399
1215
pattern is that the user can override it by specifying a
400
1216
location.
401
1217
"""
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')
1218
import errno
1219
_locs = ['parent', 'pull', 'x-pull']
1220
for l in _locs:
1221
try:
1222
return self.controlfile(l, 'r').read().strip('\n')
1223
except IOError, e:
1224
if e.errno != errno.ENOENT:
1225
raise
1226
return None
1227
411
1228
412
1229
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
1230
# TODO: Maybe delete old location files?
1231
from bzrlib.atomicfile import AtomicFile
1232
self.lock_write()
1233
try:
1234
f = AtomicFile(self.controlfilename('parent'))
1235
try:
1236
f.write(url + '\n')
1237
f.commit()
1238
finally:
1239
f.close()
1240
finally:
1241
self.unlock()
422
1242
423
1243
def check_revno(self, revno):
424
1244
"""\
435
1255
"""
436
1256
if revno < 1 or revno > self.revno():
437
1257
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
"""
1258
1259
1260
1261
1262
1263
class ScratchBranch(_Branch):
1264
"""Special test class: a branch that cleans up after itself.
1265
1266
>>> b = ScratchBranch()
1267
>>> isdir(b.base)
1268
True
1269
>>> bd = b.base
1270
>>> b.destroy()
1271
>>> isdir(bd)
1272
False
1273
"""
1274
def __init__(self, files=[], dirs=[], base=None):
1275
"""Make a test branch.
1276
1277
This creates a temporary directory and runs init-tree in it.
1278
1279
If any files are listed, they are created in the working copy.
1280
"""
1281
from tempfile import mkdtemp
1282
init = False
1283
if base is None:
1284
base = mkdtemp()
1285
init = True
1286
if isinstance(base, basestring):
1287
base = get_transport(base)
1288
_Branch.__init__(self, base, init=init)
1289
for d in dirs:
1290
self._transport.mkdir(d)
1291
1292
for f in files:
1293
self._transport.put(f, 'content of %s' % f)
1294
1295
1296
def clone(self):
1297
"""
1298
>>> orig = ScratchBranch(files=["file1", "file2"])
1299
>>> clone = orig.clone()
1300
>>> if os.name != 'nt':
1301
... os.path.samefile(orig.base, clone.base)
1302
... else:
1303
... orig.base == clone.base
1304
...
1305
False
1306
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1307
True
1308
"""
1309
from shutil import copytree
1310
from tempfile import mkdtemp
1311
base = mkdtemp()
1312
os.rmdir(base)
1313
copytree(self.base, base, symlinks=True)
1314
return ScratchBranch(base=base)
1315
1316
def __del__(self):
1317
self.destroy()
1318
1319
def destroy(self):
1320
"""Destroy the test branch, removing the scratch directory."""
1321
from shutil import rmtree
1322
try:
1323
if self.base:
1324
mutter("delete ScratchBranch %s" % self.base)
1325
rmtree(self.base)
1326
except OSError, e:
1327
# Work around for shutil.rmtree failing on Windows when
1328
# readonly files are encountered
1329
mutter("hit exception in destroying ScratchBranch: %s" % e)
1330
for root, dirs, files in os.walk(self.base, topdown=False):
1331
for name in files:
1332
os.chmod(os.path.join(root, name), 0700)
1333
rmtree(self.base)
1334
self._transport = None
1335
815
1336
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
1337
1338
######################################################################
1339
# predicates
1340
1341
1342
def is_control_file(filename):
1343
## FIXME: better check
1344
filename = os.path.normpath(filename)
1345
while filename != '':
1346
head, tail = os.path.split(filename)
1347
## mutter('check %r for control file' % ((head, tail), ))
1348
if tail == bzrlib.BZRDIR:
1241
1349
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)
1350
if filename == head:
1351
break
1352
filename = head
1353
return False
1354
1355
1356
1357
def gen_file_id(name):
1358
"""Return new file id.
1359
1360
This should probably generate proper UUIDs, but for the moment we
1361
cope with just randomness because running uuidgen every time is
1362
slow."""
1363
import re
1364
from binascii import hexlify
1365
from time import time
1366
1367
# get last component
1368
idx = name.rfind('/')
1369
if idx != -1:
1370
name = name[idx+1 : ]
1371
idx = name.rfind('\\')
1372
if idx != -1:
1373
name = name[idx+1 : ]
1374
1375
# make it not a hidden file
1376
name = name.lstrip('.')
1377
1378
# remove any wierd characters; we don't escape them but rather
1379
# just pull them out
1380
name = re.sub(r'[^\w.]', '', name)
1381
1382
s = hexlify(rand_bytes(8))
1383
return '-'.join((name, compact_date(time()), s))
1384
1385
1386
def gen_root_id():
1387
"""Return a new tree-root file id."""
1388
return gen_file_id('TREE_ROOT')
1389
1390
Loggerhead is a web-based interface for Breezy
Version: 2.0.1