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