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