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