« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1553.5.4
- compare with another revision
- download diff
- download tarball
- view history from revision 1553.5.4
- Committer: Martin Pool
- Date: 2006-02-10 00:39:25 UTC
- mto: (1540.3.6 bzr.dev (Main development branch))
- mto: This revision was merged to the branch mainline in revision 1569.
- Revision ID: mbp@sourcefrog.net-20060210003925-8c64dd0c0a16d177
[patch] better formatting for 'bzr help commands' (Matthew D Fuller)
- files added:
- BRANCH.TODO
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/store
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- tools/doc_generate
- files removed:
- bzrlib/mdiff.py
- plugins/changeset
- files renamed:
- bzrlib/changeset.py => bzrlib/_changeset.py
- bzrlib/merge_core.py => bzrlib/_merge_core.py
- plugins/ => bzrlib/plugins/
- bzrlib/store.py => bzrlib/store/__init__.py
- bzrlib/selftest/ => bzrlib/tests/
- bzrlib/selftest/teststatus.py => bzrlib/tests/blackbox/test_status.py
- bzrlib/selftest/blackbox.py => bzrlib/tests/blackbox/test_too_much.py
- bzrlib/selftest/versioning.py => bzrlib/tests/blackbox/test_versioning.py
- bzrlib/selftest/testbranch.py => bzrlib/tests/branch_implementations/test_branch.py
- bzrlib/selftest/testdiff.py => bzrlib/tests/test_diff.py
- bzrlib/selftest/testhashcache.py => bzrlib/tests/test_hashcache.py
- bzrlib/selftest/testinv.py => bzrlib/tests/test_inv.py
- bzrlib/selftest/testlog.py => bzrlib/tests/test_log.py
- bzrlib/selftest/testmerge3.py => bzrlib/tests/test_merge3.py
- bzrlib/selftest/plugins.py => bzrlib/tests/test_plugins.py
- bzrlib/selftest/testrevision.py => bzrlib/tests/test_revision.py
- bzrlib/selftest/testrevisionnamespaces.py => bzrlib/tests/test_revisionnamespaces.py
- tools/testweave.py => bzrlib/tests/test_weave.py
- bzrlib/selftest/whitebox.py => bzrlib/tests/test_whitebox.py
- effbot/ => bzrlib/util/effbot/
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- bzrlib/newinventory.py => contrib/newinventory.py
- bzr-man.py => tools/doc_generate/autodoc_man.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
18
from copy import deepcopy
19
from cStringIO import StringIO
20
import errno
21
import os
22
import shutil
18
23
import sys
19
import os
24
from unittest import TestSuite
25
from warnings import warn
26
try:
27
import xml.sax.saxutils
28
except ImportError:
29
raise ImportError("We were unable to import 'xml.sax.saxutils',"
30
" most likely you have an xml.pyc or xml.pyo file"
31
" lying around in your bzrlib directory."
32
" Please remove it.")
33
from cStringIO import StringIO
34
20
35
21
36
import bzrlib
37
from bzrlib.config import TreeConfig
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
from bzrlib.delta import compare_trees
40
import bzrlib.errors as errors
41
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
42
NoSuchRevision, HistoryMissing, NotBranchError,
43
DivergedBranches, LockError,
44
UninitializableFormat,
45
UnlistableStore,
46
UnlistableBranch, NoSuchFile, NotVersionedError,
47
NoWorkingTree)
48
import bzrlib.inventory as inventory
49
from bzrlib.inventory import Inventory
50
from bzrlib.lockable_files import LockableFiles
51
from bzrlib.osutils import (isdir, quotefn,
52
rename, splitpath, sha_file,
53
file_kind, abspath, normpath, pathjoin,
54
safe_unicode,
55
)
56
from bzrlib.textui import show_status
22
57
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
splitpath, \
25
sha_file, appendpath, file_kind
26
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
27
import bzrlib.errors
28
from bzrlib.textui import show_status
29
from bzrlib.revision import Revision
30
from bzrlib.xml import unpack_xml
31
from bzrlib.delta import compare_trees
32
from bzrlib.tree import EmptyTree, RevisionTree
33
34
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
35
## TODO: Maybe include checks for common corruption of newlines, etc?
36
58
from bzrlib.tree import EmptyTree, RevisionTree
59
from bzrlib.repository import Repository
60
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions)
61
from bzrlib.store import copy_all
62
from bzrlib.symbol_versioning import *
63
import bzrlib.transactions as transactions
64
from bzrlib.transport import Transport, get_transport
65
from bzrlib.tree import EmptyTree, RevisionTree
66
import bzrlib.ui
67
import bzrlib.xml5
68
69
70
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
71
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
72
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
73
74
75
# TODO: Maybe include checks for common corruption of newlines, etc?
37
76
38
77
# TODO: Some operations like log might retrieve the same revisions
39
78
# repeatedly to calculate deltas. We could perhaps have a weakref
40
# cache in memory to make this faster.
41
42
43
def find_branch(f, **args):
44
if f and (f.startswith('http://') or f.startswith('https://')):
45
import remotebranch
46
return remotebranch.RemoteBranch(f, **args)
47
else:
48
return Branch(f, **args)
49
50
51
def find_cached_branch(f, cache_root, **args):
52
from remotebranch import RemoteBranch
53
br = find_branch(f, **args)
54
def cacheify(br, store_name):
55
from meta_store import CachedStore
56
cache_path = os.path.join(cache_root, store_name)
57
os.mkdir(cache_path)
58
new_store = CachedStore(getattr(br, store_name), cache_path)
59
setattr(br, store_name, new_store)
60
61
if isinstance(br, RemoteBranch):
62
cacheify(br, 'inventory_store')
63
cacheify(br, 'text_store')
64
cacheify(br, 'revision_store')
65
return br
66
67
68
def _relpath(base, path):
69
"""Return path relative to base, or raise exception.
70
71
The path may be either an absolute path or a path relative to the
72
current working directory.
73
74
Lifted out of Branch.relpath for ease of testing.
75
76
os.path.commonprefix (python2.4) has a bad bug that it works just
77
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
78
avoids that problem."""
79
rp = os.path.abspath(path)
80
81
s = []
82
head = rp
83
while len(head) >= len(base):
84
if head == base:
85
break
86
head, tail = os.path.split(head)
87
if tail:
88
s.insert(0, tail)
89
else:
90
from errors import NotBranchError
91
raise NotBranchError("path %r is not within branch %r" % (rp, base))
92
93
return os.sep.join(s)
94
95
96
def find_branch_root(f=None):
97
"""Find the branch root enclosing f, or pwd.
98
99
f may be a filename or a URL.
100
101
It is not necessary that f exists.
102
103
Basically we keep looking up until we find the control directory or
104
run into the root."""
105
if f == None:
106
f = os.getcwd()
107
elif hasattr(os.path, 'realpath'):
108
f = os.path.realpath(f)
109
else:
110
f = os.path.abspath(f)
111
if not os.path.exists(f):
112
raise BzrError('%r does not exist' % f)
113
114
115
orig_f = f
116
117
while True:
118
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
119
return f
120
head, tail = os.path.split(f)
121
if head == f:
122
# reached the root, whatever that may be
123
raise BzrError('%r is not in a branch' % orig_f)
124
f = head
125
126
class DivergedBranches(Exception):
127
def __init__(self, branch1, branch2):
128
self.branch1 = branch1
129
self.branch2 = branch2
130
Exception.__init__(self, "These branches have diverged.")
79
# cache in memory to make this faster. In general anything can be
80
# cached in memory between lock and unlock operations. .. nb thats
81
# what the transaction identity map provides
131
82
132
83
133
84
######################################################################
137
88
"""Branch holding a history of revisions.
138
89
139
90
base
140
Base directory of the branch.
141
142
_lock_mode
143
None, or 'r' or 'w'
144
145
_lock_count
146
If _lock_mode is true, a positive count of the number of times the
147
lock has been taken.
148
149
_lock
150
Lock object from bzrlib.lock.
91
Base directory/url of the branch.
151
92
"""
93
# this is really an instance variable - FIXME move it there
94
# - RBC 20060112
152
95
base = None
153
_lock_mode = None
154
_lock_count = None
155
_lock = None
156
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
161
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
164
165
base -- Base directory for the branch.
166
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
169
be versioned.
170
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
173
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
176
"""
177
from bzrlib.store import ImmutableStore
178
if init:
179
self.base = os.path.realpath(base)
180
self._make_control()
181
elif find_root:
182
self.base = find_branch_root(base)
183
else:
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
190
self._check_format()
191
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
195
196
197
def __str__(self):
198
return '%s(%r)' % (self.__class__.__name__, self.base)
199
200
201
__repr__ = __str__
202
203
204
def __del__(self):
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
208
self._lock.unlock()
209
210
96
97
_default_initializer = None
98
"""The default initializer for making new branches."""
99
100
def __init__(self, *ignored, **ignored_too):
101
raise NotImplementedError('The Branch class is abstract')
102
103
@staticmethod
104
def open_downlevel(base):
105
"""Open a branch which may be of an old format."""
106
return Branch.open(base, _unsupported=True)
107
108
@staticmethod
109
def open(base, _unsupported=False):
110
"""Open an existing branch, rooted at 'base' (url)
111
112
_unsupported is a private parameter to the Branch class.
113
"""
114
t = get_transport(base)
115
mutter("trying to open %r with transport %r", base, t)
116
format = BzrBranchFormat.find_format(t)
117
if not _unsupported and not format.is_supported():
118
# see open_downlevel to open legacy branches.
119
raise errors.UnsupportedFormatError(
120
'sorry, branch format %s not supported' % format,
121
['use a different bzr version',
122
'or remove the .bzr directory'
123
' and "bzr init" again'])
124
return format.open(t)
125
126
@staticmethod
127
def open_containing(url):
128
"""Open an existing branch which contains url.
129
130
This probes for a branch at url, and searches upwards from there.
131
132
Basically we keep looking up until we find the control directory or
133
run into the root. If there isn't one, raises NotBranchError.
134
If there is one and it is either an unrecognised format or an unsupported
135
format, UnknownFormatError or UnsupportedFormatError are raised.
136
If there is one, it is returned, along with the unused portion of url.
137
"""
138
t = get_transport(url)
139
# this gets the normalised url back. I.e. '.' -> the full path.
140
url = t.base
141
while True:
142
try:
143
format = BzrBranchFormat.find_format(t)
144
return format.open(t), t.relpath(url)
145
except NotBranchError, e:
146
mutter('not a branch in: %r %s', t.base, e)
147
new_t = t.clone('..')
148
if new_t.base == t.base:
149
# reached the root, whatever that may be
150
raise NotBranchError(path=url)
151
t = new_t
152
153
@staticmethod
154
def create(base):
155
"""Create a new Branch at the url 'bzr'.
156
157
This will call the current default initializer with base
158
as the only parameter.
159
"""
160
return Branch._default_initializer(safe_unicode(base))
161
162
@staticmethod
163
@deprecated_function(zero_eight)
164
def initialize(base):
165
"""Create a new working tree and branch, rooted at 'base' (url)
166
167
NOTE: This will soon be deprecated in favour of creation
168
through a BzrDir.
169
"""
170
# imported here to prevent scope creep as this is going.
171
from bzrlib.workingtree import WorkingTree
172
return WorkingTree.create_standalone(safe_unicode(base)).branch
173
174
@staticmethod
175
def get_default_initializer():
176
"""Return the initializer being used for new branches."""
177
return Branch._default_initializer
178
179
@staticmethod
180
def set_default_initializer(initializer):
181
"""Set the initializer to be used for new branches."""
182
Branch._default_initializer = staticmethod(initializer)
183
184
def setup_caching(self, cache_root):
185
"""Subclasses that care about caching should override this, and set
186
up cached stores located under cache_root.
187
"""
188
# seems to be unused, 2006-01-13 mbp
189
warn('%s is deprecated' % self.setup_caching)
190
self.cache_root = cache_root
191
192
def _get_nick(self):
193
cfg = self.tree_config()
194
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
195
196
def _set_nick(self, nick):
197
cfg = self.tree_config()
198
cfg.set_option(nick, "nickname")
199
assert cfg.get_option("nickname") == nick
200
201
nick = property(_get_nick, _set_nick)
202
203
def push_stores(self, branch_to):
204
"""Copy the content of this branches store to branch_to."""
205
raise NotImplementedError('push_stores is abstract')
211
206
212
207
def lock_write(self):
213
if self._lock_mode:
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
217
self._lock_mode)
218
self._lock_count += 1
219
else:
220
from bzrlib.lock import WriteLock
221
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
224
self._lock_count = 1
225
226
227
208
raise NotImplementedError('lock_write is abstract')
209
228
210
def lock_read(self):
229
if self._lock_mode:
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
233
else:
234
from bzrlib.lock import ReadLock
235
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
238
self._lock_count = 1
239
240
241
211
raise NotImplementedError('lock_read is abstract')
212
242
213
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
246
247
if self._lock_count > 1:
248
self._lock_count -= 1
249
else:
250
self._lock.unlock()
251
self._lock = None
252
self._lock_mode = self._lock_count = None
253
214
raise NotImplementedError('unlock is abstract')
215
216
def peek_lock_mode(self):
217
"""Return lock mode for the Branch: 'r', 'w' or None"""
218
raise NotImplementedError(self.peek_lock_mode)
254
219
255
220
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
258
259
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
262
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
265
266
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
272
273
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
276
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
281
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
284
"""
285
286
fn = self.controlfilename(file_or_path)
287
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
293
import codecs
294
return codecs.open(fn, mode + 'b', 'utf-8',
295
buffering=60000)
296
else:
297
raise BzrError("invalid controlfile mode %r" % mode)
298
299
300
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
221
"""Return absolute filename for something in the branch
304
222
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
314
'branch-lock',
315
'pending-merges'):
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
318
319
# if we want per-tree root ids then this is the place to set
320
# them; they're not needed for now and so ommitted for
321
# simplicity.
322
pack_xml(Inventory(), self.controlfile('inventory','w'))
323
324
325
def _check_format(self):
326
"""Check this branch format is supported.
327
328
The current tool only supports the current unstable format.
329
330
In the future, we might need different in-memory Branch
331
classes to support downlevel branches. But not yet.
223
XXX: Robert Collins 20051017 what is this used for? why is it a branch
224
method and not a tree method.
332
225
"""
333
# This ignores newlines so that we can open branches created
334
# on Windows from Linux and so on. I think it might be better
335
# to always make all internal files in unix format.
336
fmt = self.controlfile('branch-format', 'r').read()
337
fmt.replace('\r\n', '')
338
if fmt != BZR_BRANCH_FORMAT:
339
raise BzrError('sorry, branch format %r not supported' % fmt,
340
['use a different bzr version',
341
'or remove the .bzr directory and "bzr init" again'])
226
raise NotImplementedError('abspath is abstract')
342
227
343
228
def get_root_id(self):
344
229
"""Return the id of this branches root"""
345
inv = self.read_working_inventory()
346
return inv.root.file_id
347
348
def set_root_id(self, file_id):
349
inv = self.read_working_inventory()
350
orig_root_id = inv.root.file_id
351
del inv._byid[inv.root.file_id]
352
inv.root.file_id = file_id
353
inv._byid[inv.root.file_id] = inv.root
354
for fid in inv:
355
entry = inv[fid]
356
if entry.parent_id in (None, orig_root_id):
357
entry.parent_id = inv.root.file_id
358
self._write_inventory(inv)
359
360
def read_working_inventory(self):
361
"""Read the working inventory."""
362
from bzrlib.inventory import Inventory
363
from bzrlib.xml import unpack_xml
364
from time import time
365
before = time()
366
self.lock_read()
367
try:
368
# ElementTree does its own conversion from UTF-8, so open in
369
# binary.
370
inv = unpack_xml(Inventory,
371
self.controlfile('inventory', 'rb'))
372
mutter("loaded inventory of %d items in %f"
373
% (len(inv), time() - before))
374
return inv
375
finally:
376
self.unlock()
377
378
379
def _write_inventory(self, inv):
380
"""Update the working inventory.
381
382
That is to say, the inventory describing changes underway, that
383
will be committed to the next revision.
384
"""
385
from bzrlib.atomicfile import AtomicFile
386
from bzrlib.xml import pack_xml
387
388
self.lock_write()
389
try:
390
f = AtomicFile(self.controlfilename('inventory'), 'wb')
391
try:
392
pack_xml(inv, f)
393
f.commit()
394
finally:
395
f.close()
396
finally:
397
self.unlock()
398
399
mutter('wrote working inventory')
400
401
402
inventory = property(read_working_inventory, _write_inventory, None,
403
"""Inventory for the working copy.""")
404
405
406
def add(self, files, verbose=False, ids=None):
407
"""Make files versioned.
408
409
Note that the command line normally calls smart_add instead.
410
411
This puts the files in the Added state, so that they will be
412
recorded by the next commit.
413
414
files
415
List of paths to add, relative to the base of the tree.
416
417
ids
418
If set, use these instead of automatically generated ids.
419
Must be the same length as the list of files, but may
420
contain None for ids that are to be autogenerated.
421
422
TODO: Perhaps have an option to add the ids even if the files do
423
not (yet) exist.
424
425
TODO: Perhaps return the ids of the files? But then again it
426
is easy to retrieve them if they're needed.
427
428
TODO: Adding a directory should optionally recurse down and
429
add all non-ignored children. Perhaps do that in a
430
higher-level method.
431
"""
432
# TODO: Re-adding a file that is removed in the working copy
433
# should probably put it back with the previous ID.
434
if isinstance(files, basestring):
435
assert(ids is None or isinstance(ids, basestring))
436
files = [files]
437
if ids is not None:
438
ids = [ids]
439
440
if ids is None:
441
ids = [None] * len(files)
442
else:
443
assert(len(ids) == len(files))
444
445
self.lock_write()
446
try:
447
inv = self.read_working_inventory()
448
for f,file_id in zip(files, ids):
449
if is_control_file(f):
450
raise BzrError("cannot add control file %s" % quotefn(f))
451
452
fp = splitpath(f)
453
454
if len(fp) == 0:
455
raise BzrError("cannot add top-level %r" % f)
456
457
fullpath = os.path.normpath(self.abspath(f))
458
459
try:
460
kind = file_kind(fullpath)
461
except OSError:
462
# maybe something better?
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
465
if kind != 'file' and kind != 'directory':
466
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
467
468
if file_id is None:
469
file_id = gen_file_id(f)
470
inv.add_path(f, kind=kind, file_id=file_id)
471
472
if verbose:
473
print 'added', quotefn(f)
474
475
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
476
477
self._write_inventory(inv)
478
finally:
479
self.unlock()
480
481
482
def print_file(self, file, revno):
230
raise NotImplementedError('get_root_id is abstract')
231
232
def print_file(self, file, revision_id):
483
233
"""Print `file` to stdout."""
484
self.lock_read()
485
try:
486
tree = self.revision_tree(self.lookup_revision(revno))
487
# use inventory as it was in that revision
488
file_id = tree.inventory.path2id(file)
489
if not file_id:
490
raise BzrError("%r is not present in revision %s" % (file, revno))
491
tree.print_file(file_id)
492
finally:
493
self.unlock()
494
495
496
def remove(self, files, verbose=False):
497
"""Mark nominated files for removal from the inventory.
498
499
This does not remove their text. This does not run on
500
501
TODO: Refuse to remove modified files unless --force is given?
502
503
TODO: Do something useful with directories.
504
505
TODO: Should this remove the text or not? Tough call; not
506
removing may be useful and the user can just use use rm, and
507
is the opposite of add. Removing it is consistent with most
508
other tools. Maybe an option.
509
"""
510
## TODO: Normalize names
511
## TODO: Remove nested loops; better scalability
512
if isinstance(files, basestring):
513
files = [files]
514
515
self.lock_write()
516
517
try:
518
tree = self.working_tree()
519
inv = tree.inventory
520
521
# do this before any modifications
522
for f in files:
523
fid = inv.path2id(f)
524
if not fid:
525
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
526
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
527
if verbose:
528
# having remove it, it must be either ignored or unknown
529
if tree.is_ignored(f):
530
new_status = 'I'
531
else:
532
new_status = '?'
533
show_status(new_status, inv[fid].kind, quotefn(f))
534
del inv[fid]
535
536
self._write_inventory(inv)
537
finally:
538
self.unlock()
539
540
541
# FIXME: this doesn't need to be a branch method
542
def set_inventory(self, new_inventory_list):
543
from bzrlib.inventory import Inventory, InventoryEntry
544
inv = Inventory(self.get_root_id())
545
for path, file_id, parent, kind in new_inventory_list:
546
name = os.path.basename(path)
547
if name == "":
548
continue
549
inv.add(InventoryEntry(file_id, name, kind, parent))
550
self._write_inventory(inv)
551
552
553
def unknowns(self):
554
"""Return all unknown files.
555
556
These are files in the working directory that are not versioned or
557
control files or ignored.
558
559
>>> b = ScratchBranch(files=['foo', 'foo~'])
560
>>> list(b.unknowns())
561
['foo']
562
>>> b.add('foo')
563
>>> list(b.unknowns())
564
[]
565
>>> b.remove('foo')
566
>>> list(b.unknowns())
567
['foo']
568
"""
569
return self.working_tree().unknowns()
570
234
raise NotImplementedError('print_file is abstract')
571
235
572
236
def append_revision(self, *revision_ids):
573
from bzrlib.atomicfile import AtomicFile
574
575
for revision_id in revision_ids:
576
mutter("add {%s} to revision-history" % revision_id)
577
578
rev_history = self.revision_history()
579
rev_history.extend(revision_ids)
580
581
f = AtomicFile(self.controlfilename('revision-history'))
582
try:
583
for rev_id in rev_history:
584
print >>f, rev_id
585
f.commit()
586
finally:
587
f.close()
588
589
590
def get_revision_xml(self, revision_id):
591
"""Return XML file object for revision object."""
592
if not revision_id or not isinstance(revision_id, basestring):
593
raise InvalidRevisionId(revision_id)
594
595
self.lock_read()
596
try:
597
try:
598
return self.revision_store[revision_id]
599
except IndexError:
600
raise bzrlib.errors.NoSuchRevision(self, revision_id)
601
finally:
602
self.unlock()
603
604
605
def get_revision(self, revision_id):
606
"""Return the Revision object for a named revision"""
607
xml_file = self.get_revision_xml(revision_id)
608
609
try:
610
r = unpack_xml(Revision, xml_file)
611
except SyntaxError, e:
612
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
[revision_id,
614
str(e)])
615
616
assert r.revision_id == revision_id
617
return r
618
619
620
def get_revision_delta(self, revno):
621
"""Return the delta for one revision.
622
623
The delta is relative to its mainline predecessor, or the
624
empty tree for revision 1.
625
"""
626
assert isinstance(revno, int)
627
rh = self.revision_history()
628
if not (1 <= revno <= len(rh)):
629
raise InvalidRevisionNumber(revno)
630
631
# revno is 1-based; list is 0-based
632
633
new_tree = self.revision_tree(rh[revno-1])
634
if revno == 1:
635
old_tree = EmptyTree()
636
else:
637
old_tree = self.revision_tree(rh[revno-2])
638
639
return compare_trees(old_tree, new_tree)
640
641
642
643
def get_revision_sha1(self, revision_id):
644
"""Hash the stored value of a revision, and return it."""
645
# In the future, revision entries will be signed. At that
646
# point, it is probably best *not* to include the signature
647
# in the revision hash. Because that lets you re-sign
648
# the revision, (add signatures/remove signatures) and still
649
# have all hash pointers stay consistent.
650
# But for now, just hash the contents.
651
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
652
653
654
def get_inventory(self, inventory_id):
655
"""Get Inventory object by hash.
656
657
TODO: Perhaps for this and similar methods, take a revision
658
parameter which can be either an integer revno or a
659
string hash."""
660
from bzrlib.inventory import Inventory
661
from bzrlib.xml import unpack_xml
662
663
return unpack_xml(Inventory, self.inventory_store[inventory_id])
664
665
666
def get_inventory_sha1(self, inventory_id):
667
"""Return the sha1 hash of the inventory entry
668
"""
669
return sha_file(self.inventory_store[inventory_id])
670
671
672
def get_revision_inventory(self, revision_id):
673
"""Return inventory of a past revision."""
674
# bzr 0.0.6 imposes the constraint that the inventory_id
675
# must be the same as its revision, so this is trivial.
676
if revision_id == None:
677
from bzrlib.inventory import Inventory
678
return Inventory(self.get_root_id())
679
else:
680
return self.get_inventory(revision_id)
681
237
raise NotImplementedError('append_revision is abstract')
238
239
def set_revision_history(self, rev_history):
240
raise NotImplementedError('set_revision_history is abstract')
682
241
683
242
def revision_history(self):
684
"""Return sequence of revision hashes on to this branch.
685
686
>>> ScratchBranch().revision_history()
687
[]
688
"""
689
self.lock_read()
690
try:
691
return [l.rstrip('\r\n') for l in
692
self.controlfile('revision-history', 'r').readlines()]
693
finally:
694
self.unlock()
695
696
697
def common_ancestor(self, other, self_revno=None, other_revno=None):
698
"""
699
>>> import commit
700
>>> sb = ScratchBranch(files=['foo', 'foo~'])
701
>>> sb.common_ancestor(sb) == (None, None)
702
True
703
>>> commit.commit(sb, "Committing first revision", verbose=False)
704
>>> sb.common_ancestor(sb)[0]
705
1
706
>>> clone = sb.clone()
707
>>> commit.commit(sb, "Committing second revision", verbose=False)
708
>>> sb.common_ancestor(sb)[0]
709
2
710
>>> sb.common_ancestor(clone)[0]
711
1
712
>>> commit.commit(clone, "Committing divergent second revision",
713
... verbose=False)
714
>>> sb.common_ancestor(clone)[0]
715
1
716
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
717
True
718
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
719
True
720
>>> clone2 = sb.clone()
721
>>> sb.common_ancestor(clone2)[0]
722
2
723
>>> sb.common_ancestor(clone2, self_revno=1)[0]
724
1
725
>>> sb.common_ancestor(clone2, other_revno=1)[0]
726
1
727
"""
728
my_history = self.revision_history()
729
other_history = other.revision_history()
730
if self_revno is None:
731
self_revno = len(my_history)
732
if other_revno is None:
733
other_revno = len(other_history)
734
indices = range(min((self_revno, other_revno)))
735
indices.reverse()
736
for r in indices:
737
if my_history[r] == other_history[r]:
738
return r+1, my_history[r]
739
return None, None
740
243
"""Return sequence of revision hashes on to this branch."""
244
raise NotImplementedError('revision_history is abstract')
741
245
742
246
def revno(self):
743
247
"""Return current revision number for this branch.
747
251
"""
748
252
return len(self.revision_history())
749
253
750
751
def last_patch(self):
752
"""Return last patch hash, or None if no history.
753
"""
254
def last_revision(self):
255
"""Return last patch hash, or None if no history."""
754
256
ph = self.revision_history()
755
257
if ph:
756
258
return ph[-1]
757
259
else:
758
260
return None
759
261
760
761
def missing_revisions(self, other, stop_revision=None):
762
"""
262
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
263
"""Return a list of new revisions that would perfectly fit.
264
763
265
If self and other have not diverged, return a list of the revisions
764
266
present in other, but missing from self.
765
267
766
>>> from bzrlib.commit import commit
767
268
>>> bzrlib.trace.silent = True
768
269
>>> br1 = ScratchBranch()
769
270
>>> br2 = ScratchBranch()
770
271
>>> br1.missing_revisions(br2)
771
272
[]
772
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
273
>>> br2.working_tree().commit("lala!", rev_id="REVISION-ID-1")
773
274
>>> br1.missing_revisions(br2)
774
275
[u'REVISION-ID-1']
775
276
>>> br2.missing_revisions(br1)
776
277
[]
777
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
278
>>> br1.working_tree().commit("lala!", rev_id="REVISION-ID-1")
778
279
>>> br1.missing_revisions(br2)
779
280
[]
780
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
281
>>> br2.working_tree().commit("lala!", rev_id="REVISION-ID-2A")
781
282
>>> br1.missing_revisions(br2)
782
283
[u'REVISION-ID-2A']
783
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
284
>>> br1.working_tree().commit("lala!", rev_id="REVISION-ID-2B")
784
285
>>> br1.missing_revisions(br2)
785
286
Traceback (most recent call last):
786
DivergedBranches: These branches have diverged.
287
DivergedBranches: These branches have diverged. Try merge.
787
288
"""
788
289
self_history = self.revision_history()
789
290
self_len = len(self_history)
796
297
797
298
if stop_revision is None:
798
299
stop_revision = other_len
799
elif stop_revision > other_len:
800
raise NoSuchRevision(self, stop_revision)
801
300
else:
301
assert isinstance(stop_revision, int)
302
if stop_revision > other_len:
303
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
802
304
return other_history[self_len:stop_revision]
803
305
804
805
306
def update_revisions(self, other, stop_revision=None):
806
"""Pull in all new revisions from other branch.
807
808
>>> from bzrlib.commit import commit
809
>>> bzrlib.trace.silent = True
810
>>> br1 = ScratchBranch(files=['foo', 'bar'])
811
>>> br1.add('foo')
812
>>> br1.add('bar')
813
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
814
>>> br2 = ScratchBranch()
815
>>> br2.update_revisions(br1)
816
Added 2 texts.
817
Added 1 inventories.
818
Added 1 revisions.
819
>>> br2.revision_history()
820
[u'REVISION-ID-1']
821
>>> br2.update_revisions(br1)
822
Added 0 texts.
823
Added 0 inventories.
824
Added 0 revisions.
825
>>> br1.text_store.total_size() == br2.text_store.total_size()
826
True
827
"""
828
from bzrlib.progress import ProgressBar
829
830
pb = ProgressBar()
831
832
pb.update('comparing histories')
833
revision_ids = self.missing_revisions(other, stop_revision)
834
835
if hasattr(other.revision_store, "prefetch"):
836
other.revision_store.prefetch(revision_ids)
837
if hasattr(other.inventory_store, "prefetch"):
838
inventory_ids = [other.get_revision(r).inventory_id
839
for r in revision_ids]
840
other.inventory_store.prefetch(inventory_ids)
841
842
revisions = []
843
needed_texts = set()
844
i = 0
845
for rev_id in revision_ids:
846
i += 1
847
pb.update('fetching revision', i, len(revision_ids))
848
rev = other.get_revision(rev_id)
849
revisions.append(rev)
850
inv = other.get_inventory(str(rev.inventory_id))
851
for key, entry in inv.iter_entries():
852
if entry.text_id is None:
853
continue
854
if entry.text_id not in self.text_store:
855
needed_texts.add(entry.text_id)
856
857
pb.clear()
858
859
count = self.text_store.copy_multi(other.text_store, needed_texts)
860
print "Added %d texts." % count
861
inventory_ids = [ f.inventory_id for f in revisions ]
862
count = self.inventory_store.copy_multi(other.inventory_store,
863
inventory_ids)
864
print "Added %d inventories." % count
865
revision_ids = [ f.revision_id for f in revisions]
866
count = self.revision_store.copy_multi(other.revision_store,
867
revision_ids)
868
for revision_id in revision_ids:
869
self.append_revision(revision_id)
870
print "Added %d revisions." % count
871
872
873
def commit(self, *args, **kw):
874
from bzrlib.commit import commit
875
commit(self, *args, **kw)
876
877
878
def lookup_revision(self, revision):
879
"""Return the revision identifier for a given revision information."""
880
revno, info = self.get_revision_info(revision)
881
return info
882
883
def get_revision_info(self, revision):
884
"""Return (revno, revision id) for revision identifier.
885
886
revision can be an integer, in which case it is assumed to be revno (though
887
this will translate negative values into positive ones)
888
revision can also be a string, in which case it is parsed for something like
889
'date:' or 'revid:' etc.
890
"""
891
if revision is None:
892
return 0, None
893
revno = None
894
try:# Convert to int if possible
895
revision = int(revision)
896
except ValueError:
897
pass
898
revs = self.revision_history()
899
if isinstance(revision, int):
900
if revision == 0:
901
return 0, None
902
# Mabye we should do this first, but we don't need it if revision == 0
903
if revision < 0:
904
revno = len(revs) + revision + 1
905
else:
906
revno = revision
907
elif isinstance(revision, basestring):
908
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
909
if revision.startswith(prefix):
910
revno = func(self, revs, revision)
911
break
912
else:
913
raise BzrError('No namespace registered for string: %r' % revision)
914
915
if revno is None or revno <= 0 or revno > len(revs):
916
raise BzrError("no such revision %s" % revision)
917
return revno, revs[revno-1]
918
919
def _namespace_revno(self, revs, revision):
920
"""Lookup a revision by revision number"""
921
assert revision.startswith('revno:')
922
try:
923
return int(revision[6:])
924
except ValueError:
925
return None
926
REVISION_NAMESPACES['revno:'] = _namespace_revno
927
928
def _namespace_revid(self, revs, revision):
929
assert revision.startswith('revid:')
930
try:
931
return revs.index(revision[6:]) + 1
932
except ValueError:
933
return None
934
REVISION_NAMESPACES['revid:'] = _namespace_revid
935
936
def _namespace_last(self, revs, revision):
937
assert revision.startswith('last:')
938
try:
939
offset = int(revision[5:])
940
except ValueError:
941
return None
942
else:
943
if offset <= 0:
944
raise BzrError('You must supply a positive value for --revision last:XXX')
945
return len(revs) - offset + 1
946
REVISION_NAMESPACES['last:'] = _namespace_last
947
948
def _namespace_tag(self, revs, revision):
949
assert revision.startswith('tag:')
950
raise BzrError('tag: namespace registered, but not implemented.')
951
REVISION_NAMESPACES['tag:'] = _namespace_tag
952
953
def _namespace_date(self, revs, revision):
954
assert revision.startswith('date:')
955
import datetime
956
# Spec for date revisions:
957
# date:value
958
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
959
# it can also start with a '+/-/='. '+' says match the first
960
# entry after the given date. '-' is match the first entry before the date
961
# '=' is match the first entry after, but still on the given date.
962
#
963
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
964
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
965
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
966
# May 13th, 2005 at 0:00
967
#
968
# So the proper way of saying 'give me all entries for today' is:
969
# -r {date:+today}:{date:-tomorrow}
970
# The default is '=' when not supplied
971
val = revision[5:]
972
match_style = '='
973
if val[:1] in ('+', '-', '='):
974
match_style = val[:1]
975
val = val[1:]
976
977
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
978
if val.lower() == 'yesterday':
979
dt = today - datetime.timedelta(days=1)
980
elif val.lower() == 'today':
981
dt = today
982
elif val.lower() == 'tomorrow':
983
dt = today + datetime.timedelta(days=1)
984
else:
985
import re
986
# This should be done outside the function to avoid recompiling it.
987
_date_re = re.compile(
988
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
989
r'(,|T)?\s*'
990
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
991
)
992
m = _date_re.match(val)
993
if not m or (not m.group('date') and not m.group('time')):
994
raise BzrError('Invalid revision date %r' % revision)
995
996
if m.group('date'):
997
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
998
else:
999
year, month, day = today.year, today.month, today.day
1000
if m.group('time'):
1001
hour = int(m.group('hour'))
1002
minute = int(m.group('minute'))
1003
if m.group('second'):
1004
second = int(m.group('second'))
1005
else:
1006
second = 0
1007
else:
1008
hour, minute, second = 0,0,0
1009
1010
dt = datetime.datetime(year=year, month=month, day=day,
1011
hour=hour, minute=minute, second=second)
1012
first = dt
1013
last = None
1014
reversed = False
1015
if match_style == '-':
1016
reversed = True
1017
elif match_style == '=':
1018
last = dt + datetime.timedelta(days=1)
1019
1020
if reversed:
1021
for i in range(len(revs)-1, -1, -1):
1022
r = self.get_revision(revs[i])
1023
# TODO: Handle timezone.
1024
dt = datetime.datetime.fromtimestamp(r.timestamp)
1025
if first >= dt and (last is None or dt >= last):
1026
return i+1
1027
else:
1028
for i in range(len(revs)):
1029
r = self.get_revision(revs[i])
1030
# TODO: Handle timezone.
1031
dt = datetime.datetime.fromtimestamp(r.timestamp)
1032
if first <= dt and (last is None or dt <= last):
1033
return i+1
1034
REVISION_NAMESPACES['date:'] = _namespace_date
1035
1036
def revision_tree(self, revision_id):
1037
"""Return Tree for a revision on this branch.
1038
1039
`revision_id` may be None for the null revision, in which case
1040
an `EmptyTree` is returned."""
1041
# TODO: refactor this to use an existing revision object
1042
# so we don't need to read it in twice.
1043
if revision_id == None:
1044
return EmptyTree()
1045
else:
1046
inv = self.get_revision_inventory(revision_id)
1047
return RevisionTree(self.text_store, inv)
1048
307
"""Pull in new perfect-fit revisions."""
308
raise NotImplementedError('update_revisions is abstract')
309
310
def pullable_revisions(self, other, stop_revision):
311
raise NotImplementedError('pullable_revisions is abstract')
312
313
def revision_id_to_revno(self, revision_id):
314
"""Given a revision id, return its revno"""
315
if revision_id is None:
316
return 0
317
history = self.revision_history()
318
try:
319
return history.index(revision_id) + 1
320
except ValueError:
321
raise bzrlib.errors.NoSuchRevision(self, revision_id)
322
323
def get_rev_id(self, revno, history=None):
324
"""Find the revision id of the specified revno."""
325
if revno == 0:
326
return None
327
if history is None:
328
history = self.revision_history()
329
elif revno <= 0 or revno > len(history):
330
raise bzrlib.errors.NoSuchRevision(self, revno)
331
return history[revno - 1]
1049
332
1050
333
def working_tree(self):
1051
"""Return a `Tree` for the working copy."""
1052
from workingtree import WorkingTree
1053
return WorkingTree(self.base, self.read_working_inventory())
334
"""Return a `Tree` for the working copy if this is a local branch."""
335
raise NotImplementedError('working_tree is abstract')
1054
336
337
def pull(self, source, overwrite=False):
338
raise NotImplementedError('pull is abstract')
1055
339
1056
340
def basis_tree(self):
1057
341
"""Return `Tree` object for last revision.
1058
342
1059
343
If there are no revisions yet, return an `EmptyTree`.
1060
344
"""
1061
r = self.last_patch()
1062
if r == None:
1063
return EmptyTree()
1064
else:
1065
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1066
1067
345
return self.repository.revision_tree(self.last_revision())
1068
346
1069
347
def rename_one(self, from_rel, to_rel):
1070
348
"""Rename one file.
1071
349
1072
350
This can change the directory or the filename or both.
1073
351
"""
1074
self.lock_write()
1075
try:
1076
tree = self.working_tree()
1077
inv = tree.inventory
1078
if not tree.has_filename(from_rel):
1079
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1080
if tree.has_filename(to_rel):
1081
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1082
1083
file_id = inv.path2id(from_rel)
1084
if file_id == None:
1085
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1086
1087
if inv.path2id(to_rel):
1088
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1089
1090
to_dir, to_tail = os.path.split(to_rel)
1091
to_dir_id = inv.path2id(to_dir)
1092
if to_dir_id == None and to_dir != '':
1093
raise BzrError("can't determine destination directory id for %r" % to_dir)
1094
1095
mutter("rename_one:")
1096
mutter(" file_id {%s}" % file_id)
1097
mutter(" from_rel %r" % from_rel)
1098
mutter(" to_rel %r" % to_rel)
1099
mutter(" to_dir %r" % to_dir)
1100
mutter(" to_dir_id {%s}" % to_dir_id)
1101
1102
inv.rename(file_id, to_dir_id, to_tail)
1103
1104
print "%s => %s" % (from_rel, to_rel)
1105
1106
from_abs = self.abspath(from_rel)
1107
to_abs = self.abspath(to_rel)
1108
try:
1109
os.rename(from_abs, to_abs)
1110
except OSError, e:
1111
raise BzrError("failed to rename %r to %r: %s"
1112
% (from_abs, to_abs, e[1]),
1113
["rename rolled back"])
1114
1115
self._write_inventory(inv)
1116
finally:
1117
self.unlock()
1118
352
raise NotImplementedError('rename_one is abstract')
1119
353
1120
354
def move(self, from_paths, to_name):
1121
355
"""Rename files.
1127
361
1128
362
Note that to_name is only the last component of the new name;
1129
363
this doesn't change the directory.
1130
"""
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
print "%s => %s" % (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
1184
def revert(self, filenames, old_tree=None, backups=True):
1185
"""Restore selected files to the versions from a previous tree.
1186
1187
backups
1188
If true (default) backups are made of files before
1189
they're renamed.
1190
"""
1191
from bzrlib.errors import NotVersionedError, BzrError
1192
from bzrlib.atomicfile import AtomicFile
1193
from bzrlib.osutils import backup_file
1194
1195
inv = self.read_working_inventory()
1196
if old_tree is None:
1197
old_tree = self.basis_tree()
1198
old_inv = old_tree.inventory
1199
1200
nids = []
1201
for fn in filenames:
1202
file_id = inv.path2id(fn)
1203
if not file_id:
1204
raise NotVersionedError("not a versioned file", fn)
1205
if not old_inv.has_id(file_id):
1206
raise BzrError("file not present in old tree", fn, file_id)
1207
nids.append((fn, file_id))
1208
1209
# TODO: Rename back if it was previously at a different location
1210
1211
# TODO: If given a directory, restore the entire contents from
1212
# the previous version.
1213
1214
# TODO: Make a backup to a temporary file.
1215
1216
# TODO: If the file previously didn't exist, delete it?
1217
for fn, file_id in nids:
1218
backup_file(fn)
1219
1220
f = AtomicFile(fn, 'wb')
1221
try:
1222
f.write(old_tree.get_file(file_id).read())
1223
f.commit()
1224
finally:
1225
f.close()
1226
1227
1228
def pending_merges(self):
1229
"""Return a list of pending merges.
1230
1231
These are revisions that have been merged into the working
1232
directory but not yet committed.
1233
"""
1234
cfn = self.controlfilename('pending-merges')
1235
if not os.path.exists(cfn):
1236
return []
1237
p = []
1238
for l in self.controlfile('pending-merges', 'r').readlines():
1239
p.append(l.rstrip('\n'))
1240
return p
1241
1242
1243
def add_pending_merge(self, revision_id):
1244
from bzrlib.revision import validate_revision_id
1245
1246
validate_revision_id(revision_id)
1247
1248
p = self.pending_merges()
1249
if revision_id in p:
1250
return
1251
p.append(revision_id)
1252
self.set_pending_merges(p)
1253
1254
1255
def set_pending_merges(self, rev_list):
1256
from bzrlib.atomicfile import AtomicFile
1257
self.lock_write()
1258
try:
1259
f = AtomicFile(self.controlfilename('pending-merges'))
1260
try:
1261
for l in rev_list:
1262
print >>f, l
1263
f.commit()
1264
finally:
1265
f.close()
1266
finally:
1267
self.unlock()
1268
1269
1270
1271
class ScratchBranch(Branch):
364
365
This returns a list of (from_path, to_path) pairs for each
366
entry that is moved.
367
"""
368
raise NotImplementedError('move is abstract')
369
370
def get_parent(self):
371
"""Return the parent location of the branch.
372
373
This is the default location for push/pull/missing. The usual
374
pattern is that the user can override it by specifying a
375
location.
376
"""
377
raise NotImplementedError('get_parent is abstract')
378
379
def get_push_location(self):
380
"""Return the None or the location to push this branch to."""
381
raise NotImplementedError('get_push_location is abstract')
382
383
def set_push_location(self, location):
384
"""Set a new push location for this branch."""
385
raise NotImplementedError('set_push_location is abstract')
386
387
def set_parent(self, url):
388
raise NotImplementedError('set_parent is abstract')
389
390
def check_revno(self, revno):
391
"""\
392
Check whether a revno corresponds to any revision.
393
Zero (the NULL revision) is considered valid.
394
"""
395
if revno != 0:
396
self.check_real_revno(revno)
397
398
def check_real_revno(self, revno):
399
"""\
400
Check whether a revno corresponds to a real revision.
401
Zero (the NULL revision) is considered invalid
402
"""
403
if revno < 1 or revno > self.revno():
404
raise InvalidRevisionNumber(revno)
405
406
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
407
"""Copy this branch into the existing directory to_location.
408
409
Returns the newly created branch object.
410
411
revision
412
If not None, only revisions up to this point will be copied.
413
The head of the new branch will be that revision. Must be a
414
revid or None.
415
416
to_location -- The destination directory; must either exist and be
417
empty, or not exist, in which case it is created.
418
419
basis_branch
420
A local branch to copy revisions from, related to this branch.
421
This is used when branching from a remote (slow) branch, and we have
422
a local branch that might contain some relevant revisions.
423
424
to_branch_type
425
Branch type of destination branch
426
"""
427
from bzrlib.workingtree import WorkingTree
428
assert isinstance(to_location, basestring)
429
if not bzrlib.osutils.lexists(to_location):
430
os.mkdir(to_location)
431
if to_branch_type is None:
432
to_branch_type = BzrBranch
433
print "FIXME use a branch format here"
434
br_to = to_branch_type.initialize(to_location)
435
mutter("copy branch from %s to %s", self, br_to)
436
if basis_branch is not None:
437
basis_branch.push_stores(br_to)
438
if revision is None:
439
revision = self.last_revision()
440
br_to.update_revisions(self, stop_revision=revision)
441
br_to.set_parent(self.base)
442
WorkingTree.create(br_to, to_location).set_root_id(self.get_root_id())
443
mutter("copied")
444
return br_to
445
446
def fileid_involved_between_revs(self, from_revid, to_revid):
447
""" This function returns the file_id(s) involved in the
448
changes between the from_revid revision and the to_revid
449
revision
450
"""
451
raise NotImplementedError('fileid_involved_between_revs is abstract')
452
453
def fileid_involved(self, last_revid=None):
454
""" This function returns the file_id(s) involved in the
455
changes up to the revision last_revid
456
If no parametr is passed, then all file_id[s] present in the
457
repository are returned
458
"""
459
raise NotImplementedError('fileid_involved is abstract')
460
461
def fileid_involved_by_set(self, changes):
462
""" This function returns the file_id(s) involved in the
463
changes present in the set 'changes'
464
"""
465
raise NotImplementedError('fileid_involved_by_set is abstract')
466
467
def fileid_involved_between_revs(self, from_revid, to_revid):
468
""" This function returns the file_id(s) involved in the
469
changes between the from_revid revision and the to_revid
470
revision
471
"""
472
raise NotImplementedError('fileid_involved_between_revs is abstract')
473
474
def fileid_involved(self, last_revid=None):
475
""" This function returns the file_id(s) involved in the
476
changes up to the revision last_revid
477
If no parametr is passed, then all file_id[s] present in the
478
repository are returned
479
"""
480
raise NotImplementedError('fileid_involved is abstract')
481
482
def fileid_involved_by_set(self, changes):
483
""" This function returns the file_id(s) involved in the
484
changes present in the set 'changes'
485
"""
486
raise NotImplementedError('fileid_involved_by_set is abstract')
487
488
class BzrBranchFormat(object):
489
"""An encapsulation of the initialization and open routines for a format.
490
491
Formats provide three things:
492
* An initialization routine,
493
* a format string,
494
* an open routine.
495
496
Formats are placed in an dict by their format string for reference
497
during branch opening. Its not required that these be instances, they
498
can be classes themselves with class methods - it simply depends on
499
whether state is needed for a given format or not.
500
501
Once a format is deprecated, just deprecate the initialize and open
502
methods on the format class. Do not deprecate the object, as the
503
object will be created every time regardless.
504
"""
505
506
_formats = {}
507
"""The known formats."""
508
509
@classmethod
510
def find_format(klass, transport):
511
"""Return the format registered for URL."""
512
try:
513
format_string = transport.get(".bzr/branch-format").read()
514
return klass._formats[format_string]
515
except NoSuchFile:
516
raise NotBranchError(path=transport.base)
517
except KeyError:
518
raise errors.UnknownFormatError(format_string)
519
520
def get_format_string(self):
521
"""Return the ASCII format string that identifies this format."""
522
raise NotImplementedError(self.get_format_string)
523
524
def _find_modes(self, t):
525
"""Determine the appropriate modes for files and directories.
526
527
FIXME: When this merges into, or from storage,
528
this code becomes delgatable to a LockableFiles instance.
529
530
For now its cribbed and returns (dir_mode, file_mode)
531
"""
532
try:
533
st = t.stat('.')
534
except errors.TransportNotPossible:
535
dir_mode = 0755
536
file_mode = 0644
537
else:
538
dir_mode = st.st_mode & 07777
539
# Remove the sticky and execute bits for files
540
file_mode = dir_mode & ~07111
541
if not BzrBranch._set_dir_mode:
542
dir_mode = None
543
if not BzrBranch._set_file_mode:
544
file_mode = None
545
return dir_mode, file_mode
546
547
def initialize(self, url):
548
"""Create a branch of this format at url and return an open branch."""
549
t = get_transport(url)
550
from bzrlib.weavefile import write_weave_v5
551
from bzrlib.weave import Weave
552
553
# Create an empty weave
554
sio = StringIO()
555
bzrlib.weavefile.write_weave_v5(Weave(), sio)
556
empty_weave = sio.getvalue()
557
558
# Since we don't have a .bzr directory, inherit the
559
# mode from the root directory
560
temp_control = LockableFiles(t, '')
561
temp_control._transport.mkdir('.bzr',
562
mode=temp_control._dir_mode)
563
file_mode = temp_control._file_mode
564
del temp_control
565
mutter('created control directory in ' + t.base)
566
control = t.clone('.bzr')
567
dirs = ['revision-store', 'weaves']
568
lock_file = 'branch-lock'
569
utf8_files = [('README',
570
"This is a Bazaar-NG control directory.\n"
571
"Do not change any files in this directory.\n"),
572
('branch-format', self.get_format_string()),
573
('revision-history', ''),
574
('branch-name', ''),
575
]
576
files = [('inventory.weave', StringIO(empty_weave)),
577
]
578
579
# FIXME: RBC 20060125 dont peek under the covers
580
# NB: no need to escape relative paths that are url safe.
581
control.put(lock_file, StringIO(), mode=file_mode)
582
control_files = LockableFiles(control, lock_file)
583
control_files.lock_write()
584
control_files._transport.mkdir_multi(dirs,
585
mode=control_files._dir_mode)
586
try:
587
for file, content in utf8_files:
588
control_files.put_utf8(file, content)
589
for file, content in files:
590
control_files.put(file, content)
591
finally:
592
control_files.unlock()
593
return BzrBranch(t, _format=self, _control_files=control_files)
594
595
def is_supported(self):
596
"""Is this format supported?
597
598
Supported formats can be initialized and opened.
599
Unsupported formats may not support initialization or committing or
600
some other features depending on the reason for not being supported.
601
"""
602
return True
603
604
def open(self, transport):
605
"""Fill out the data in branch for the branch at url."""
606
return BzrBranch(transport, _format=self)
607
608
@classmethod
609
def register_format(klass, format):
610
klass._formats[format.get_format_string()] = format
611
612
@classmethod
613
def unregister_format(klass, format):
614
assert klass._formats[format.get_format_string()] is format
615
del klass._formats[format.get_format_string()]
616
617
618
class BzrBranchFormat4(BzrBranchFormat):
619
"""Bzr branch format 4.
620
621
This format has:
622
- flat stores
623
- TextStores for texts, inventories,revisions.
624
625
This format is deprecated: it indexes texts using a text it which is
626
removed in format 5; write support for this format has been removed.
627
"""
628
629
def get_format_string(self):
630
"""See BzrBranchFormat.get_format_string()."""
631
return BZR_BRANCH_FORMAT_4
632
633
def initialize(self, url):
634
"""Format 4 branches cannot be created."""
635
raise UninitializableFormat(self)
636
637
def is_supported(self):
638
"""Format 4 is not supported.
639
640
It is not supported because the model changed from 4 to 5 and the
641
conversion logic is expensive - so doing it on the fly was not
642
feasible.
643
"""
644
return False
645
646
647
class BzrBranchFormat5(BzrBranchFormat):
648
"""Bzr branch format 5.
649
650
This format has:
651
- weaves for file texts and inventory
652
- flat stores
653
- TextStores for revisions and signatures.
654
"""
655
656
def get_format_string(self):
657
"""See BzrBranchFormat.get_format_string()."""
658
return BZR_BRANCH_FORMAT_5
659
660
661
class BzrBranchFormat6(BzrBranchFormat):
662
"""Bzr branch format 6.
663
664
This format has:
665
- weaves for file texts and inventory
666
- hash subdirectory based stores.
667
- TextStores for revisions and signatures.
668
"""
669
670
def get_format_string(self):
671
"""See BzrBranchFormat.get_format_string()."""
672
return BZR_BRANCH_FORMAT_6
673
674
675
BzrBranchFormat.register_format(BzrBranchFormat4())
676
BzrBranchFormat.register_format(BzrBranchFormat5())
677
BzrBranchFormat.register_format(BzrBranchFormat6())
678
679
# TODO: jam 20060108 Create a new branch format, and as part of upgrade
680
# make sure that ancestry.weave is deleted (it is never used, but
681
# used to be created)
682
683
684
class BzrBranch(Branch):
685
"""A branch stored in the actual filesystem.
686
687
Note that it's "local" in the context of the filesystem; it doesn't
688
really matter if it's on an nfs/smb/afs/coda/... share, as long as
689
it's writable, and can be accessed via the normal filesystem API.
690
691
"""
692
# We actually expect this class to be somewhat short-lived; part of its
693
# purpose is to try to isolate what bits of the branch logic are tied to
694
# filesystem access, so that in a later step, we can extricate them to
695
# a separarte ("storage") class.
696
_inventory_weave = None
697
698
# Map some sort of prefix into a namespace
699
# stuff like "revno:10", "revid:", etc.
700
# This should match a prefix with a function which accepts
701
REVISION_NAMESPACES = {}
702
703
def push_stores(self, branch_to):
704
"""See Branch.push_stores."""
705
if (not isinstance(self._branch_format, BzrBranchFormat4) or
706
self._branch_format != branch_to._branch_format):
707
from bzrlib.fetch import greedy_fetch
708
mutter("Using fetch logic to push between %s(%s) and %s(%s)",
709
self, self._branch_format, branch_to, branch_to._branch_format)
710
greedy_fetch(to_branch=branch_to, from_branch=self,
711
revision=self.last_revision())
712
return
713
714
# format 4 to format 4 logic only.
715
store_pairs = ((self.text_store, branch_to.text_store),
716
(self.inventory_store, branch_to.inventory_store),
717
(self.revision_store, branch_to.revision_store))
718
try:
719
for from_store, to_store in store_pairs:
720
copy_all(from_store, to_store)
721
except UnlistableStore:
722
raise UnlistableBranch(from_store)
723
724
def __init__(self, transport, init=DEPRECATED_PARAMETER,
725
relax_version_check=DEPRECATED_PARAMETER, _format=None,
726
_control_files=None):
727
"""Create new branch object at a particular location.
728
729
transport -- A Transport object, defining how to access files.
730
731
init -- If True, create new control files in a previously
732
unversioned directory. If False, the branch must already
733
be versioned.
734
735
relax_version_check -- If true, the usual check for the branch
736
version is not applied. This is intended only for
737
upgrade/recovery type use; it's not guaranteed that
738
all operations will work on old format branches.
739
740
In the test suite, creation of new trees is tested using the
741
`ScratchBranch` class.
742
"""
743
assert isinstance(transport, Transport), \
744
"%r is not a Transport" % transport
745
self._transport = transport
746
self._base = self._transport.base
747
if _control_files is None:
748
_control_files = LockableFiles(self._transport.clone(bzrlib.BZRDIR),
749
'branch-lock')
750
self.control_files = _control_files
751
if deprecated_passed(init):
752
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
753
"deprecated as of bzr 0.8. Please use Branch.create().",
754
DeprecationWarning,
755
stacklevel=2)
756
if init:
757
# this is slower than before deprecation, oh well never mind.
758
# -> its deprecated.
759
self._initialize(transport.base)
760
self._check_format(_format)
761
if deprecated_passed(relax_version_check):
762
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
763
"relax_version_check parameter is deprecated as of bzr 0.8. "
764
"Please use Branch.open_downlevel, or a BzrBranchFormat's "
765
"open() method.",
766
DeprecationWarning,
767
stacklevel=2)
768
if (not relax_version_check
769
and not self._branch_format.is_supported()):
770
raise errors.UnsupportedFormatError(
771
'sorry, branch format %r not supported' % fmt,
772
['use a different bzr version',
773
'or remove the .bzr directory'
774
' and "bzr init" again'])
775
self.repository = Repository(transport, self._branch_format)
776
777
778
@staticmethod
779
def _initialize(base):
780
"""Create a bzr branch in the latest format."""
781
return BzrBranchFormat6().initialize(base)
782
783
def __str__(self):
784
return '%s(%r)' % (self.__class__.__name__, self.base)
785
786
__repr__ = __str__
787
788
def __del__(self):
789
# TODO: It might be best to do this somewhere else,
790
# but it is nice for a Branch object to automatically
791
# cache it's information.
792
# Alternatively, we could have the Transport objects cache requests
793
# See the earlier discussion about how major objects (like Branch)
794
# should never expect their __del__ function to run.
795
# XXX: cache_root seems to be unused, 2006-01-13 mbp
796
if hasattr(self, 'cache_root') and self.cache_root is not None:
797
try:
798
shutil.rmtree(self.cache_root)
799
except:
800
pass
801
self.cache_root = None
802
803
def _get_base(self):
804
return self._base
805
806
base = property(_get_base, doc="The URL for the root of this branch.")
807
808
def _finish_transaction(self):
809
"""Exit the current transaction."""
810
return self.control_files._finish_transaction()
811
812
def get_transaction(self):
813
"""Return the current active transaction.
814
815
If no transaction is active, this returns a passthrough object
816
for which all data is immediately flushed and no caching happens.
817
"""
818
# this is an explicit function so that we can do tricky stuff
819
# when the storage in rev_storage is elsewhere.
820
# we probably need to hook the two 'lock a location' and
821
# 'have a transaction' together more delicately, so that
822
# we can have two locks (branch and storage) and one transaction
823
# ... and finishing the transaction unlocks both, but unlocking
824
# does not. - RBC 20051121
825
return self.control_files.get_transaction()
826
827
def _set_transaction(self, transaction):
828
"""Set a new active transaction."""
829
return self.control_files._set_transaction(transaction)
830
831
def abspath(self, name):
832
"""See Branch.abspath."""
833
return self.control_files._transport.abspath(name)
834
835
def _check_format(self, format):
836
"""Identify the branch format if needed.
837
838
The format is stored as a reference to the format object in
839
self._branch_format for code that needs to check it later.
840
841
The format parameter is either None or the branch format class
842
used to open this branch.
843
"""
844
if format is None:
845
format = BzrBranchFormat.find_format(self._transport)
846
self._branch_format = format
847
mutter("got branch format %s", self._branch_format)
848
849
@needs_read_lock
850
def get_root_id(self):
851
"""See Branch.get_root_id."""
852
tree = self.repository.revision_tree(self.last_revision())
853
return tree.inventory.root.file_id
854
855
def lock_write(self):
856
# TODO: test for failed two phase locks. This is known broken.
857
self.control_files.lock_write()
858
self.repository.lock_write()
859
860
def lock_read(self):
861
# TODO: test for failed two phase locks. This is known broken.
862
self.control_files.lock_read()
863
self.repository.lock_read()
864
865
def unlock(self):
866
# TODO: test for failed two phase locks. This is known broken.
867
self.repository.unlock()
868
self.control_files.unlock()
869
870
def peek_lock_mode(self):
871
if self.control_files._lock_count == 0:
872
return None
873
else:
874
return self.control_files._lock_mode
875
876
@needs_read_lock
877
def print_file(self, file, revision_id):
878
"""See Branch.print_file."""
879
return self.repository.print_file(file, revision_id)
880
881
@needs_write_lock
882
def append_revision(self, *revision_ids):
883
"""See Branch.append_revision."""
884
for revision_id in revision_ids:
885
mutter("add {%s} to revision-history" % revision_id)
886
rev_history = self.revision_history()
887
rev_history.extend(revision_ids)
888
self.set_revision_history(rev_history)
889
890
@needs_write_lock
891
def set_revision_history(self, rev_history):
892
"""See Branch.set_revision_history."""
893
self.control_files.put_utf8(
894
'revision-history', '\n'.join(rev_history))
895
896
def get_revision_delta(self, revno):
897
"""Return the delta for one revision.
898
899
The delta is relative to its mainline predecessor, or the
900
empty tree for revision 1.
901
"""
902
assert isinstance(revno, int)
903
rh = self.revision_history()
904
if not (1 <= revno <= len(rh)):
905
raise InvalidRevisionNumber(revno)
906
907
# revno is 1-based; list is 0-based
908
909
new_tree = self.repository.revision_tree(rh[revno-1])
910
if revno == 1:
911
old_tree = EmptyTree()
912
else:
913
old_tree = self.repository.revision_tree(rh[revno-2])
914
return compare_trees(old_tree, new_tree)
915
916
@needs_read_lock
917
def revision_history(self):
918
"""See Branch.revision_history."""
919
# FIXME are transactions bound to control files ? RBC 20051121
920
transaction = self.get_transaction()
921
history = transaction.map.find_revision_history()
922
if history is not None:
923
mutter("cache hit for revision-history in %s", self)
924
return list(history)
925
history = [l.rstrip('\r\n') for l in
926
self.control_files.get_utf8('revision-history').readlines()]
927
transaction.map.add_revision_history(history)
928
# this call is disabled because revision_history is
929
# not really an object yet, and the transaction is for objects.
930
# transaction.register_clean(history, precious=True)
931
return list(history)
932
933
def update_revisions(self, other, stop_revision=None):
934
"""See Branch.update_revisions."""
935
from bzrlib.fetch import greedy_fetch
936
if stop_revision is None:
937
stop_revision = other.last_revision()
938
### Should this be checking is_ancestor instead of revision_history?
939
if (stop_revision is not None and
940
stop_revision in self.revision_history()):
941
return
942
greedy_fetch(to_branch=self, from_branch=other,
943
revision=stop_revision)
944
pullable_revs = self.pullable_revisions(other, stop_revision)
945
if len(pullable_revs) > 0:
946
self.append_revision(*pullable_revs)
947
948
def pullable_revisions(self, other, stop_revision):
949
"""See Branch.pullable_revisions."""
950
other_revno = other.revision_id_to_revno(stop_revision)
951
try:
952
return self.missing_revisions(other, other_revno)
953
except DivergedBranches, e:
954
try:
955
pullable_revs = get_intervening_revisions(self.last_revision(),
956
stop_revision,
957
self.repository)
958
assert self.last_revision() not in pullable_revs
959
return pullable_revs
960
except bzrlib.errors.NotAncestor:
961
if is_ancestor(self.last_revision(), stop_revision, self):
962
return []
963
else:
964
raise e
965
966
def basis_tree(self):
967
"""See Branch.basis_tree."""
968
try:
969
revision_id = self.revision_history()[-1]
970
# FIXME: This is an abstraction violation, the basis tree
971
# here as defined is on the working tree, the method should
972
# be too. The basis tree for a branch can be different than
973
# that for a working tree. RBC 20051207
974
xml = self.working_tree().read_basis_inventory(revision_id)
975
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
976
return RevisionTree(self.repository, inv, revision_id)
977
except (IndexError, NoSuchFile, NoWorkingTree), e:
978
return self.repository.revision_tree(self.last_revision())
979
980
def working_tree(self):
981
"""See Branch.working_tree."""
982
from bzrlib.workingtree import WorkingTree
983
from bzrlib.transport.local import LocalTransport
984
if (self.base.find('://') != -1 or
985
not isinstance(self._transport, LocalTransport)):
986
raise NoWorkingTree(self.base)
987
return WorkingTree(self.base, branch=self)
988
989
@needs_write_lock
990
def pull(self, source, overwrite=False):
991
"""See Branch.pull."""
992
source.lock_read()
993
try:
994
old_count = len(self.revision_history())
995
try:
996
self.update_revisions(source)
997
except DivergedBranches:
998
if not overwrite:
999
raise
1000
if overwrite:
1001
self.set_revision_history(source.revision_history())
1002
new_count = len(self.revision_history())
1003
return new_count - old_count
1004
finally:
1005
source.unlock()
1006
1007
def get_parent(self):
1008
"""See Branch.get_parent."""
1009
import errno
1010
_locs = ['parent', 'pull', 'x-pull']
1011
for l in _locs:
1012
try:
1013
return self.control_files.get_utf8(l).read().strip('\n')
1014
except NoSuchFile:
1015
pass
1016
return None
1017
1018
def get_push_location(self):
1019
"""See Branch.get_push_location."""
1020
config = bzrlib.config.BranchConfig(self)
1021
push_loc = config.get_user_option('push_location')
1022
return push_loc
1023
1024
def set_push_location(self, location):
1025
"""See Branch.set_push_location."""
1026
config = bzrlib.config.LocationConfig(self.base)
1027
config.set_user_option('push_location', location)
1028
1029
@needs_write_lock
1030
def set_parent(self, url):
1031
"""See Branch.set_parent."""
1032
# TODO: Maybe delete old location files?
1033
# URLs should never be unicode, even on the local fs,
1034
# FIXUP this and get_parent in a future branch format bump:
1035
# read and rewrite the file, and have the new format code read
1036
# using .get not .get_utf8. RBC 20060125
1037
self.control_files.put_utf8('parent', url + '\n')
1038
1039
def tree_config(self):
1040
return TreeConfig(self)
1041
1042
def _get_truncated_history(self, revision_id):
1043
history = self.revision_history()
1044
if revision_id is None:
1045
return history
1046
try:
1047
idx = history.index(revision_id)
1048
except ValueError:
1049
raise InvalidRevisionId(revision_id=revision, branch=self)
1050
return history[:idx+1]
1051
1052
@needs_read_lock
1053
def _clone_weave(self, to_location, revision=None, basis_branch=None):
1054
# prevent leakage
1055
from bzrlib.workingtree import WorkingTree
1056
assert isinstance(to_location, basestring)
1057
if basis_branch is not None:
1058
note("basis_branch is not supported for fast weave copy yet.")
1059
1060
history = self._get_truncated_history(revision)
1061
if not bzrlib.osutils.lexists(to_location):
1062
os.mkdir(to_location)
1063
branch_to = Branch.initialize(to_location)
1064
mutter("copy branch from %s to %s", self, branch_to)
1065
1066
self.repository.copy(branch_to.repository)
1067
1068
# must be done *after* history is copied across
1069
# FIXME duplicate code with base .clone().
1070
# .. would template method be useful here? RBC 20051207
1071
branch_to.set_parent(self.base)
1072
branch_to.append_revision(*history)
1073
# FIXME: this should be in workingtree.clone
1074
WorkingTree.create(branch_to, to_location).set_root_id(self.get_root_id())
1075
mutter("copied")
1076
return branch_to
1077
1078
def clone(self, to_location, revision=None, basis_branch=None, to_branch_type=None):
1079
print "FIXME: clone via create and fetch is probably faster when versioned file comes in."
1080
if to_branch_type is None:
1081
to_branch_type = BzrBranch
1082
1083
if to_branch_type == BzrBranch \
1084
and self.repository.weave_store.listable() \
1085
and self.repository.revision_store.listable():
1086
return self._clone_weave(to_location, revision, basis_branch)
1087
1088
return Branch.clone(self, to_location, revision, basis_branch, to_branch_type)
1089
1090
def fileid_involved_between_revs(self, from_revid, to_revid):
1091
"""Find file_id(s) which are involved in the changes between revisions.
1092
1093
This determines the set of revisions which are involved, and then
1094
finds all file ids affected by those revisions.
1095
"""
1096
# TODO: jam 20060119 This code assumes that w.inclusions will
1097
# always be correct. But because of the presence of ghosts
1098
# it is possible to be wrong.
1099
# One specific example from Robert Collins:
1100
# Two branches, with revisions ABC, and AD
1101
# C is a ghost merge of D.
1102
# Inclusions doesn't recognize D as an ancestor.
1103
# If D is ever merged in the future, the weave
1104
# won't be fixed, because AD never saw revision C
1105
# to cause a conflict which would force a reweave.
1106
w = self.repository.get_inventory_weave()
1107
from_set = set(w.inclusions([w.lookup(from_revid)]))
1108
to_set = set(w.inclusions([w.lookup(to_revid)]))
1109
included = to_set.difference(from_set)
1110
changed = map(w.idx_to_name, included)
1111
return self._fileid_involved_by_set(changed)
1112
1113
def fileid_involved(self, last_revid=None):
1114
"""Find all file_ids modified in the ancestry of last_revid.
1115
1116
:param last_revid: If None, last_revision() will be used.
1117
"""
1118
w = self.repository.get_inventory_weave()
1119
if not last_revid:
1120
changed = set(w._names)
1121
else:
1122
included = w.inclusions([w.lookup(last_revid)])
1123
changed = map(w.idx_to_name, included)
1124
return self._fileid_involved_by_set(changed)
1125
1126
def fileid_involved_by_set(self, changes):
1127
"""Find all file_ids modified by the set of revisions passed in.
1128
1129
:param changes: A set() of revision ids
1130
"""
1131
# TODO: jam 20060119 This line does *nothing*, remove it.
1132
# or better yet, change _fileid_involved_by_set so
1133
# that it takes the inventory weave, rather than
1134
# pulling it out by itself.
1135
w = self.repository.get_inventory_weave()
1136
return self._fileid_involved_by_set(changes)
1137
1138
def _fileid_involved_by_set(self, changes):
1139
"""Find the set of file-ids affected by the set of revisions.
1140
1141
:param changes: A set() of revision ids.
1142
:return: A set() of file ids.
1143
1144
This peaks at the Weave, interpreting each line, looking to
1145
see if it mentions one of the revisions. And if so, includes
1146
the file id mentioned.
1147
This expects both the Weave format, and the serialization
1148
to have a single line per file/directory, and to have
1149
fileid="" and revision="" on that line.
1150
"""
1151
assert (isinstance(self._branch_format, BzrBranchFormat5) or
1152
isinstance(self._branch_format, BzrBranchFormat6)), \
1153
"fileid_involved only supported for branches which store inventory as xml"
1154
1155
w = self.repository.get_inventory_weave()
1156
file_ids = set()
1157
for line in w._weave:
1158
1159
# it is ugly, but it is due to the weave structure
1160
if not isinstance(line, basestring): continue
1161
1162
start = line.find('file_id="')+9
1163
if start < 9: continue
1164
end = line.find('"', start)
1165
assert end>= 0
1166
file_id = xml.sax.saxutils.unescape(line[start:end])
1167
1168
# check if file_id is already present
1169
if file_id in file_ids: continue
1170
1171
start = line.find('revision="')+10
1172
if start < 10: continue
1173
end = line.find('"', start)
1174
assert end>= 0
1175
revision_id = xml.sax.saxutils.unescape(line[start:end])
1176
1177
if revision_id in changes:
1178
file_ids.add(file_id)
1179
1180
return file_ids
1181
1182
1183
Branch.set_default_initializer(BzrBranch._initialize)
1184
1185
1186
class BranchTestProviderAdapter(object):
1187
"""A tool to generate a suite testing multiple branch formats at once.
1188
1189
This is done by copying the test once for each transport and injecting
1190
the transport_server, transport_readonly_server, and branch_format
1191
classes into each copy. Each copy is also given a new id() to make it
1192
easy to identify.
1193
"""
1194
1195
def __init__(self, transport_server, transport_readonly_server, formats):
1196
self._transport_server = transport_server
1197
self._transport_readonly_server = transport_readonly_server
1198
self._formats = formats
1199
1200
def adapt(self, test):
1201
result = TestSuite()
1202
for format in self._formats:
1203
new_test = deepcopy(test)
1204
new_test.transport_server = self._transport_server
1205
new_test.transport_readonly_server = self._transport_readonly_server
1206
new_test.branch_format = format
1207
def make_new_test_id():
1208
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1209
return lambda: new_id
1210
new_test.id = make_new_test_id()
1211
result.addTest(new_test)
1212
return result
1213
1214
1215
class ScratchBranch(BzrBranch):
1272
1216
"""Special test class: a branch that cleans up after itself.
1273
1217
1274
1218
>>> b = ScratchBranch()
1275
1219
>>> isdir(b.base)
1276
1220
True
1277
1221
>>> bd = b.base
1278
>>> b.destroy()
1222
>>> b._transport.__del__()
1279
1223
>>> isdir(bd)
1280
1224
False
1281
1225
"""
1282
def __init__(self, files=[], dirs=[], base=None):
1226
1227
def __init__(self, files=[], dirs=[], transport=None):
1283
1228
"""Make a test branch.
1284
1229
1285
1230
This creates a temporary directory and runs init-tree in it.
1286
1231
1287
1232
If any files are listed, they are created in the working copy.
1288
1233
"""
1289
from tempfile import mkdtemp
1290
init = False
1291
if base is None:
1292
base = mkdtemp()
1293
init = True
1294
Branch.__init__(self, base, init=init)
1234
if transport is None:
1235
transport = bzrlib.transport.local.ScratchTransport()
1236
# local import for scope restriction
1237
from bzrlib.workingtree import WorkingTree
1238
WorkingTree.create_standalone(transport.base)
1239
super(ScratchBranch, self).__init__(transport)
1240
else:
1241
super(ScratchBranch, self).__init__(transport)
1242
1243
# BzrBranch creates a clone to .bzr and then forgets about the
1244
# original transport. A ScratchTransport() deletes itself and
1245
# everything underneath it when it goes away, so we need to
1246
# grab a local copy to prevent that from happening
1247
self._transport = transport
1248
1295
1249
for d in dirs:
1296
os.mkdir(self.abspath(d))
1250
self._transport.mkdir(d)
1297
1251
1298
1252
for f in files:
1299
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1300
1253
self._transport.put(f, 'content of %s' % f)
1301
1254
1302
1255
def clone(self):
1303
1256
"""
1304
1257
>>> orig = ScratchBranch(files=["file1", "file2"])
1258
>>> os.listdir(orig.base)
1259
[u'.bzr', u'file1', u'file2']
1305
1260
>>> clone = orig.clone()
1306
>>> os.path.samefile(orig.base, clone.base)
1261
>>> if os.name != 'nt':
1262
... os.path.samefile(orig.base, clone.base)
1263
... else:
1264
... orig.base == clone.base
1265
...
1307
1266
False
1308
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1309
True
1267
>>> os.listdir(clone.base)
1268
[u'.bzr', u'file1', u'file2']
1310
1269
"""
1311
1270
from shutil import copytree
1312
from tempfile import mkdtemp
1271
from bzrlib.osutils import mkdtemp
1313
1272
base = mkdtemp()
1314
1273
os.rmdir(base)
1315
1274
copytree(self.base, base, symlinks=True)
1316
return ScratchBranch(base=base)
1317
1318
def __del__(self):
1319
self.destroy()
1320
1321
def destroy(self):
1322
"""Destroy the test branch, removing the scratch directory."""
1323
from shutil import rmtree
1324
try:
1325
if self.base:
1326
mutter("delete ScratchBranch %s" % self.base)
1327
rmtree(self.base)
1328
except OSError, e:
1329
# Work around for shutil.rmtree failing on Windows when
1330
# readonly files are encountered
1331
mutter("hit exception in destroying ScratchBranch: %s" % e)
1332
for root, dirs, files in os.walk(self.base, topdown=False):
1333
for name in files:
1334
os.chmod(os.path.join(root, name), 0700)
1335
rmtree(self.base)
1336
self.base = None
1337
1275
return ScratchBranch(
1276
transport=bzrlib.transport.local.ScratchTransport(base))
1338
1277
1339
1278
1340
1279
######################################################################
1343
1282
1344
1283
def is_control_file(filename):
1345
1284
## FIXME: better check
1346
filename = os.path.normpath(filename)
1285
filename = normpath(filename)
1347
1286
while filename != '':
1348
1287
head, tail = os.path.split(filename)
1349
## mutter('check %r for control file' % ((head, tail), ))
1288
## mutter('check %r for control file' % ((head, tail),))
1350
1289
if tail == bzrlib.BZRDIR:
1351
1290
return True
1352
1291
if filename == head:
1353
1292
break
1354
1293
filename = head
1355
1294
return False
1356
1357
1358
1359
def gen_file_id(name):
1360
"""Return new file id.
1361
1362
This should probably generate proper UUIDs, but for the moment we
1363
cope with just randomness because running uuidgen every time is
1364
slow."""
1365
import re
1366
from binascii import hexlify
1367
from time import time
1368
1369
# get last component
1370
idx = name.rfind('/')
1371
if idx != -1:
1372
name = name[idx+1 : ]
1373
idx = name.rfind('\\')
1374
if idx != -1:
1375
name = name[idx+1 : ]
1376
1377
# make it not a hidden file
1378
name = name.lstrip('.')
1379
1380
# remove any wierd characters; we don't escape them but rather
1381
# just pull them out
1382
name = re.sub(r'[^\w.]', '', name)
1383
1384
s = hexlify(rand_bytes(8))
1385
return '-'.join((name, compact_date(time()), s))
1386
1387
1388
def gen_root_id():
1389
"""Return a new tree-root file id."""
1390
return gen_file_id('TREE_ROOT')
1391
Loggerhead is a web-based interface for Breezy
Version: 2.0.1