« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1553.2.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1553.2.1
- Committer: Erik Bågfors
- Date: 2006-02-03 19:50:59 UTC
- mto: (1185.50.77 bzr-jam-integration)
- mto: This revision was merged to the branch mainline in revision 1554.
- Revision ID: erik@bagfors.nu-20060203195059-1cf8ff5aa68de0ea
Support for plugins to register log formatters and set default formatter
Also, change one command line option for "log"
Also, change one command line option for "log"
- 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
- contrib/emacs
- files removed:
- bzrlib/mdiff.py
- plugins/changeset
- files renamed:
- bzr-man.py => bzr_man.py
- 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/testhashcache.py => bzrlib/tests/test_hashcache.py
- bzrlib/selftest/testinv.py => bzrlib/tests/test_inv.py
- bzrlib/selftest/testmerge3.py => bzrlib/tests/test_merge3.py
- bzrlib/selftest/plugins.py => bzrlib/tests/test_plugins.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
- 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
import sys, os
18
from copy import deepcopy
19
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
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
19
35
20
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
21
57
from bzrlib.trace import mutter, note
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
23
sha_file, appendpath, file_kind
24
from bzrlib.errors import BzrError
25
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
## TODO: Maybe include checks for common corruption of newlines, etc?
28
29
30
31
def find_branch(f, **args):
32
if f and (f.startswith('http://') or f.startswith('https://')):
33
import remotebranch
34
return remotebranch.RemoteBranch(f, **args)
35
else:
36
return Branch(f, **args)
37
38
39
def find_cached_branch(f, cache_root, **args):
40
from remotebranch import RemoteBranch
41
br = find_branch(f, **args)
42
def cacheify(br, store_name):
43
from meta_store import CachedStore
44
cache_path = os.path.join(cache_root, store_name)
45
os.mkdir(cache_path)
46
new_store = CachedStore(getattr(br, store_name), cache_path)
47
setattr(br, store_name, new_store)
48
49
if isinstance(br, RemoteBranch):
50
cacheify(br, 'inventory_store')
51
cacheify(br, 'text_store')
52
cacheify(br, 'revision_store')
53
return br
54
55
56
def _relpath(base, path):
57
"""Return path relative to base, or raise exception.
58
59
The path may be either an absolute path or a path relative to the
60
current working directory.
61
62
Lifted out of Branch.relpath for ease of testing.
63
64
os.path.commonprefix (python2.4) has a bad bug that it works just
65
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
66
avoids that problem."""
67
rp = os.path.abspath(path)
68
69
s = []
70
head = rp
71
while len(head) >= len(base):
72
if head == base:
73
break
74
head, tail = os.path.split(head)
75
if tail:
76
s.insert(0, tail)
77
else:
78
from errors import NotBranchError
79
raise NotBranchError("path %r is not within branch %r" % (rp, base))
80
81
return os.sep.join(s)
82
83
84
def find_branch_root(f=None):
85
"""Find the branch root enclosing f, or pwd.
86
87
f may be a filename or a URL.
88
89
It is not necessary that f exists.
90
91
Basically we keep looking up until we find the control directory or
92
run into the root."""
93
if f == None:
94
f = os.getcwd()
95
elif hasattr(os.path, 'realpath'):
96
f = os.path.realpath(f)
97
else:
98
f = os.path.abspath(f)
99
if not os.path.exists(f):
100
raise BzrError('%r does not exist' % f)
101
102
103
orig_f = f
104
105
while True:
106
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
107
return f
108
head, tail = os.path.split(f)
109
if head == f:
110
# reached the root, whatever that may be
111
raise BzrError('%r is not in a branch' % orig_f)
112
f = head
113
114
class DivergedBranches(Exception):
115
def __init__(self, branch1, branch2):
116
self.branch1 = branch1
117
self.branch2 = branch2
118
Exception.__init__(self, "These branches have diverged.")
119
120
121
class NoSuchRevision(BzrError):
122
def __init__(self, branch, revision):
123
self.branch = branch
124
self.revision = revision
125
msg = "Branch %s has no revision %d" % (branch, revision)
126
BzrError.__init__(self, msg)
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?
76
77
# TODO: Some operations like log might retrieve the same revisions
78
# repeatedly to calculate deltas. We could perhaps have a weakref
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
127
82
128
83
129
84
######################################################################
133
88
"""Branch holding a history of revisions.
134
89
135
90
base
136
Base directory of the branch.
137
138
_lock_mode
139
None, or 'r' or 'w'
140
141
_lock_count
142
If _lock_mode is true, a positive count of the number of times the
143
lock has been taken.
144
145
_lock
146
Lock object from bzrlib.lock.
91
Base directory/url of the branch.
147
92
"""
93
# this is really an instance variable - FIXME move it there
94
# - RBC 20060112
148
95
base = None
149
_lock_mode = None
150
_lock_count = None
151
_lock = None
152
153
# Map some sort of prefix into a namespace
154
# stuff like "revno:10", "revid:", etc.
155
# This should match a prefix with a function which accepts
156
REVISION_NAMESPACES = {}
157
158
def __init__(self, base, init=False, find_root=True):
159
"""Create new branch object at a particular location.
160
161
base -- Base directory for the branch.
162
163
init -- If True, create new control files in a previously
164
unversioned directory. If False, the branch must already
165
be versioned.
166
167
find_root -- If true and init is false, find the root of the
168
existing branch containing base.
169
170
In the test suite, creation of new trees is tested using the
171
`ScratchBranch` class.
172
"""
173
from bzrlib.store import ImmutableStore
174
if init:
175
self.base = os.path.realpath(base)
176
self._make_control()
177
elif find_root:
178
self.base = find_branch_root(base)
179
else:
180
self.base = os.path.realpath(base)
181
if not isdir(self.controlfilename('.')):
182
from errors import NotBranchError
183
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
184
['use "bzr init" to initialize a new working tree',
185
'current bzr can only operate from top-of-tree'])
186
self._check_format()
187
188
self.text_store = ImmutableStore(self.controlfilename('text-store'))
189
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
190
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
191
192
193
def __str__(self):
194
return '%s(%r)' % (self.__class__.__name__, self.base)
195
196
197
__repr__ = __str__
198
199
200
def __del__(self):
201
if self._lock_mode or self._lock:
202
from warnings import warn
203
warn("branch %r was not explicitly unlocked" % self)
204
self._lock.unlock()
205
206
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')
207
206
208
207
def lock_write(self):
209
if self._lock_mode:
210
if self._lock_mode != 'w':
211
from errors import LockError
212
raise LockError("can't upgrade to a write lock from %r" %
213
self._lock_mode)
214
self._lock_count += 1
215
else:
216
from bzrlib.lock import WriteLock
217
218
self._lock = WriteLock(self.controlfilename('branch-lock'))
219
self._lock_mode = 'w'
220
self._lock_count = 1
221
222
223
208
raise NotImplementedError('lock_write is abstract')
209
224
210
def lock_read(self):
225
if self._lock_mode:
226
assert self._lock_mode in ('r', 'w'), \
227
"invalid lock mode %r" % self._lock_mode
228
self._lock_count += 1
229
else:
230
from bzrlib.lock import ReadLock
231
232
self._lock = ReadLock(self.controlfilename('branch-lock'))
233
self._lock_mode = 'r'
234
self._lock_count = 1
235
236
237
211
raise NotImplementedError('lock_read is abstract')
212
238
213
def unlock(self):
239
if not self._lock_mode:
240
from errors import LockError
241
raise LockError('branch %r is not locked' % (self))
242
243
if self._lock_count > 1:
244
self._lock_count -= 1
245
else:
246
self._lock.unlock()
247
self._lock = None
248
self._lock_mode = self._lock_count = None
249
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)
250
219
251
220
def abspath(self, name):
252
"""Return absolute filename for something in the branch"""
253
return os.path.join(self.base, name)
254
255
256
def relpath(self, path):
257
"""Return path relative to this branch of something inside it.
258
259
Raises an error if path is not in this branch."""
260
return _relpath(self.base, path)
261
262
263
def controlfilename(self, file_or_path):
264
"""Return location relative to branch."""
265
if isinstance(file_or_path, basestring):
266
file_or_path = [file_or_path]
267
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
268
269
270
def controlfile(self, file_or_path, mode='r'):
271
"""Open a control file for this branch.
272
273
There are two classes of file in the control directory: text
274
and binary. binary files are untranslated byte streams. Text
275
control files are stored with Unix newlines and in UTF-8, even
276
if the platform or locale defaults are different.
277
278
Controlfiles should almost never be opened in write mode but
279
rather should be atomically copied and replaced using atomicfile.
280
"""
281
282
fn = self.controlfilename(file_or_path)
283
284
if mode == 'rb' or mode == 'wb':
285
return file(fn, mode)
286
elif mode == 'r' or mode == 'w':
287
# open in binary mode anyhow so there's no newline translation;
288
# codecs uses line buffering by default; don't want that.
289
import codecs
290
return codecs.open(fn, mode + 'b', 'utf-8',
291
buffering=60000)
292
else:
293
raise BzrError("invalid controlfile mode %r" % mode)
294
295
296
297
def _make_control(self):
298
from bzrlib.inventory import Inventory
299
from bzrlib.xml import pack_xml
221
"""Return absolute filename for something in the branch
300
222
301
os.mkdir(self.controlfilename([]))
302
self.controlfile('README', 'w').write(
303
"This is a Bazaar-NG control directory.\n"
304
"Do not change any files in this directory.\n")
305
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
306
for d in ('text-store', 'inventory-store', 'revision-store'):
307
os.mkdir(self.controlfilename(d))
308
for f in ('revision-history', 'merged-patches',
309
'pending-merged-patches', 'branch-name',
310
'branch-lock',
311
'pending-merges'):
312
self.controlfile(f, 'w').write('')
313
mutter('created control directory in ' + self.base)
314
315
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
316
317
318
def _check_format(self):
319
"""Check this branch format is supported.
320
321
The current tool only supports the current unstable format.
322
323
In the future, we might need different in-memory Branch
324
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.
325
225
"""
326
# This ignores newlines so that we can open branches created
327
# on Windows from Linux and so on. I think it might be better
328
# to always make all internal files in unix format.
329
fmt = self.controlfile('branch-format', 'r').read()
330
fmt.replace('\r\n', '')
331
if fmt != BZR_BRANCH_FORMAT:
332
raise BzrError('sorry, branch format %r not supported' % fmt,
333
['use a different bzr version',
334
'or remove the .bzr directory and "bzr init" again'])
226
raise NotImplementedError('abspath is abstract')
335
227
336
228
def get_root_id(self):
337
229
"""Return the id of this branches root"""
338
inv = self.read_working_inventory()
339
return inv.root.file_id
340
341
def set_root_id(self, file_id):
342
inv = self.read_working_inventory()
343
orig_root_id = inv.root.file_id
344
del inv._byid[inv.root.file_id]
345
inv.root.file_id = file_id
346
inv._byid[inv.root.file_id] = inv.root
347
for fid in inv:
348
entry = inv[fid]
349
if entry.parent_id in (None, orig_root_id):
350
entry.parent_id = inv.root.file_id
351
self._write_inventory(inv)
352
353
def read_working_inventory(self):
354
"""Read the working inventory."""
355
from bzrlib.inventory import Inventory
356
from bzrlib.xml import unpack_xml
357
from time import time
358
before = time()
359
self.lock_read()
360
try:
361
# ElementTree does its own conversion from UTF-8, so open in
362
# binary.
363
inv = unpack_xml(Inventory,
364
self.controlfile('inventory', 'rb'))
365
mutter("loaded inventory of %d items in %f"
366
% (len(inv), time() - before))
367
return inv
368
finally:
369
self.unlock()
370
371
372
def _write_inventory(self, inv):
373
"""Update the working inventory.
374
375
That is to say, the inventory describing changes underway, that
376
will be committed to the next revision.
377
"""
378
from bzrlib.atomicfile import AtomicFile
379
from bzrlib.xml import pack_xml
380
381
self.lock_write()
382
try:
383
f = AtomicFile(self.controlfilename('inventory'), 'wb')
384
try:
385
pack_xml(inv, f)
386
f.commit()
387
finally:
388
f.close()
389
finally:
390
self.unlock()
391
392
mutter('wrote working inventory')
393
394
395
inventory = property(read_working_inventory, _write_inventory, None,
396
"""Inventory for the working copy.""")
397
398
399
def add(self, files, verbose=False, ids=None):
400
"""Make files versioned.
401
402
Note that the command line normally calls smart_add instead.
403
404
This puts the files in the Added state, so that they will be
405
recorded by the next commit.
406
407
files
408
List of paths to add, relative to the base of the tree.
409
410
ids
411
If set, use these instead of automatically generated ids.
412
Must be the same length as the list of files, but may
413
contain None for ids that are to be autogenerated.
414
415
TODO: Perhaps have an option to add the ids even if the files do
416
not (yet) exist.
417
418
TODO: Perhaps return the ids of the files? But then again it
419
is easy to retrieve them if they're needed.
420
421
TODO: Adding a directory should optionally recurse down and
422
add all non-ignored children. Perhaps do that in a
423
higher-level method.
424
"""
425
from bzrlib.textui import show_status
426
# TODO: Re-adding a file that is removed in the working copy
427
# should probably put it back with the previous ID.
428
if isinstance(files, basestring):
429
assert(ids is None or isinstance(ids, basestring))
430
files = [files]
431
if ids is not None:
432
ids = [ids]
433
434
if ids is None:
435
ids = [None] * len(files)
436
else:
437
assert(len(ids) == len(files))
438
439
self.lock_write()
440
try:
441
inv = self.read_working_inventory()
442
for f,file_id in zip(files, ids):
443
if is_control_file(f):
444
raise BzrError("cannot add control file %s" % quotefn(f))
445
446
fp = splitpath(f)
447
448
if len(fp) == 0:
449
raise BzrError("cannot add top-level %r" % f)
450
451
fullpath = os.path.normpath(self.abspath(f))
452
453
try:
454
kind = file_kind(fullpath)
455
except OSError:
456
# maybe something better?
457
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
458
459
if kind != 'file' and kind != 'directory':
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
462
if file_id is None:
463
file_id = gen_file_id(f)
464
inv.add_path(f, kind=kind, file_id=file_id)
465
466
if verbose:
467
print 'added', quotefn(f)
468
469
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
470
471
self._write_inventory(inv)
472
finally:
473
self.unlock()
474
475
476
def print_file(self, file, revno):
230
raise NotImplementedError('get_root_id is abstract')
231
232
def print_file(self, file, revision_id):
477
233
"""Print `file` to stdout."""
478
self.lock_read()
479
try:
480
tree = self.revision_tree(self.lookup_revision(revno))
481
# use inventory as it was in that revision
482
file_id = tree.inventory.path2id(file)
483
if not file_id:
484
raise BzrError("%r is not present in revision %s" % (file, revno))
485
tree.print_file(file_id)
486
finally:
487
self.unlock()
488
489
490
def remove(self, files, verbose=False):
491
"""Mark nominated files for removal from the inventory.
492
493
This does not remove their text. This does not run on
494
495
TODO: Refuse to remove modified files unless --force is given?
496
497
TODO: Do something useful with directories.
498
499
TODO: Should this remove the text or not? Tough call; not
500
removing may be useful and the user can just use use rm, and
501
is the opposite of add. Removing it is consistent with most
502
other tools. Maybe an option.
503
"""
504
from bzrlib.textui import show_status
505
## TODO: Normalize names
506
## TODO: Remove nested loops; better scalability
507
if isinstance(files, basestring):
508
files = [files]
509
510
self.lock_write()
511
512
try:
513
tree = self.working_tree()
514
inv = tree.inventory
515
516
# do this before any modifications
517
for f in files:
518
fid = inv.path2id(f)
519
if not fid:
520
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
521
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
522
if verbose:
523
# having remove it, it must be either ignored or unknown
524
if tree.is_ignored(f):
525
new_status = 'I'
526
else:
527
new_status = '?'
528
show_status(new_status, inv[fid].kind, quotefn(f))
529
del inv[fid]
530
531
self._write_inventory(inv)
532
finally:
533
self.unlock()
534
535
536
# FIXME: this doesn't need to be a branch method
537
def set_inventory(self, new_inventory_list):
538
from bzrlib.inventory import Inventory, InventoryEntry
539
inv = Inventory(self.get_root_id())
540
for path, file_id, parent, kind in new_inventory_list:
541
name = os.path.basename(path)
542
if name == "":
543
continue
544
inv.add(InventoryEntry(file_id, name, kind, parent))
545
self._write_inventory(inv)
546
547
548
def unknowns(self):
549
"""Return all unknown files.
550
551
These are files in the working directory that are not versioned or
552
control files or ignored.
553
554
>>> b = ScratchBranch(files=['foo', 'foo~'])
555
>>> list(b.unknowns())
556
['foo']
557
>>> b.add('foo')
558
>>> list(b.unknowns())
559
[]
560
>>> b.remove('foo')
561
>>> list(b.unknowns())
562
['foo']
563
"""
564
return self.working_tree().unknowns()
565
234
raise NotImplementedError('print_file is abstract')
566
235
567
236
def append_revision(self, *revision_ids):
568
from bzrlib.atomicfile import AtomicFile
569
570
for revision_id in revision_ids:
571
mutter("add {%s} to revision-history" % revision_id)
572
573
rev_history = self.revision_history()
574
rev_history.extend(revision_ids)
575
576
f = AtomicFile(self.controlfilename('revision-history'))
577
try:
578
for rev_id in rev_history:
579
print >>f, rev_id
580
f.commit()
581
finally:
582
f.close()
583
584
585
def get_revision(self, revision_id):
586
"""Return the Revision object for a named revision"""
587
from bzrlib.revision import Revision
588
from bzrlib.xml import unpack_xml
589
590
self.lock_read()
591
try:
592
if not revision_id or not isinstance(revision_id, basestring):
593
raise ValueError('invalid revision-id: %r' % revision_id)
594
r = unpack_xml(Revision, self.revision_store[revision_id])
595
finally:
596
self.unlock()
597
598
assert r.revision_id == revision_id
599
return r
600
601
602
def get_revision_sha1(self, revision_id):
603
"""Hash the stored value of a revision, and return it."""
604
# In the future, revision entries will be signed. At that
605
# point, it is probably best *not* to include the signature
606
# in the revision hash. Because that lets you re-sign
607
# the revision, (add signatures/remove signatures) and still
608
# have all hash pointers stay consistent.
609
# But for now, just hash the contents.
610
return sha_file(self.revision_store[revision_id])
611
612
613
def get_inventory(self, inventory_id):
614
"""Get Inventory object by hash.
615
616
TODO: Perhaps for this and similar methods, take a revision
617
parameter which can be either an integer revno or a
618
string hash."""
619
from bzrlib.inventory import Inventory
620
from bzrlib.xml import unpack_xml
621
622
return unpack_xml(Inventory, self.inventory_store[inventory_id])
623
624
625
def get_inventory_sha1(self, inventory_id):
626
"""Return the sha1 hash of the inventory entry
627
"""
628
return sha_file(self.inventory_store[inventory_id])
629
630
631
def get_revision_inventory(self, revision_id):
632
"""Return inventory of a past revision."""
633
# bzr 0.0.6 imposes the constraint that the inventory_id
634
# must be the same as its revision, so this is trivial.
635
if revision_id == None:
636
from bzrlib.inventory import Inventory
637
return Inventory(self.get_root_id())
638
else:
639
return self.get_inventory(revision_id)
640
237
raise NotImplementedError('append_revision is abstract')
238
239
def set_revision_history(self, rev_history):
240
raise NotImplementedError('set_revision_history is abstract')
641
241
642
242
def revision_history(self):
643
"""Return sequence of revision hashes on to this branch.
644
645
>>> ScratchBranch().revision_history()
646
[]
647
"""
648
self.lock_read()
649
try:
650
return [l.rstrip('\r\n') for l in
651
self.controlfile('revision-history', 'r').readlines()]
652
finally:
653
self.unlock()
654
655
656
def common_ancestor(self, other, self_revno=None, other_revno=None):
657
"""
658
>>> import commit
659
>>> sb = ScratchBranch(files=['foo', 'foo~'])
660
>>> sb.common_ancestor(sb) == (None, None)
661
True
662
>>> commit.commit(sb, "Committing first revision", verbose=False)
663
>>> sb.common_ancestor(sb)[0]
664
1
665
>>> clone = sb.clone()
666
>>> commit.commit(sb, "Committing second revision", verbose=False)
667
>>> sb.common_ancestor(sb)[0]
668
2
669
>>> sb.common_ancestor(clone)[0]
670
1
671
>>> commit.commit(clone, "Committing divergent second revision",
672
... verbose=False)
673
>>> sb.common_ancestor(clone)[0]
674
1
675
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
676
True
677
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
678
True
679
>>> clone2 = sb.clone()
680
>>> sb.common_ancestor(clone2)[0]
681
2
682
>>> sb.common_ancestor(clone2, self_revno=1)[0]
683
1
684
>>> sb.common_ancestor(clone2, other_revno=1)[0]
685
1
686
"""
687
my_history = self.revision_history()
688
other_history = other.revision_history()
689
if self_revno is None:
690
self_revno = len(my_history)
691
if other_revno is None:
692
other_revno = len(other_history)
693
indices = range(min((self_revno, other_revno)))
694
indices.reverse()
695
for r in indices:
696
if my_history[r] == other_history[r]:
697
return r+1, my_history[r]
698
return None, None
699
700
def enum_history(self, direction):
701
"""Return (revno, revision_id) for history of branch.
702
703
direction
704
'forward' is from earliest to latest
705
'reverse' is from latest to earliest
706
"""
707
rh = self.revision_history()
708
if direction == 'forward':
709
i = 1
710
for rid in rh:
711
yield i, rid
712
i += 1
713
elif direction == 'reverse':
714
i = len(rh)
715
while i > 0:
716
yield i, rh[i-1]
717
i -= 1
718
else:
719
raise ValueError('invalid history direction', direction)
720
243
"""Return sequence of revision hashes on to this branch."""
244
raise NotImplementedError('revision_history is abstract')
721
245
722
246
def revno(self):
723
247
"""Return current revision number for this branch.
727
251
"""
728
252
return len(self.revision_history())
729
253
730
731
def last_patch(self):
732
"""Return last patch hash, or None if no history.
733
"""
254
def last_revision(self):
255
"""Return last patch hash, or None if no history."""
734
256
ph = self.revision_history()
735
257
if ph:
736
258
return ph[-1]
737
259
else:
738
260
return None
739
261
740
741
def missing_revisions(self, other, stop_revision=None):
742
"""
262
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
263
"""Return a list of new revisions that would perfectly fit.
264
743
265
If self and other have not diverged, return a list of the revisions
744
266
present in other, but missing from self.
745
267
746
>>> from bzrlib.commit import commit
747
268
>>> bzrlib.trace.silent = True
748
269
>>> br1 = ScratchBranch()
749
270
>>> br2 = ScratchBranch()
750
271
>>> br1.missing_revisions(br2)
751
272
[]
752
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
273
>>> br2.working_tree().commit("lala!", rev_id="REVISION-ID-1")
753
274
>>> br1.missing_revisions(br2)
754
275
[u'REVISION-ID-1']
755
276
>>> br2.missing_revisions(br1)
756
277
[]
757
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
278
>>> br1.working_tree().commit("lala!", rev_id="REVISION-ID-1")
758
279
>>> br1.missing_revisions(br2)
759
280
[]
760
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
281
>>> br2.working_tree().commit("lala!", rev_id="REVISION-ID-2A")
761
282
>>> br1.missing_revisions(br2)
762
283
[u'REVISION-ID-2A']
763
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
284
>>> br1.working_tree().commit("lala!", rev_id="REVISION-ID-2B")
764
285
>>> br1.missing_revisions(br2)
765
286
Traceback (most recent call last):
766
DivergedBranches: These branches have diverged.
287
DivergedBranches: These branches have diverged. Try merge.
767
288
"""
768
289
self_history = self.revision_history()
769
290
self_len = len(self_history)
776
297
777
298
if stop_revision is None:
778
299
stop_revision = other_len
779
elif stop_revision > other_len:
780
raise NoSuchRevision(self, stop_revision)
781
300
else:
301
assert isinstance(stop_revision, int)
302
if stop_revision > other_len:
303
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
782
304
return other_history[self_len:stop_revision]
783
305
784
785
306
def update_revisions(self, other, stop_revision=None):
786
"""Pull in all new revisions from other branch.
787
788
>>> from bzrlib.commit import commit
789
>>> bzrlib.trace.silent = True
790
>>> br1 = ScratchBranch(files=['foo', 'bar'])
791
>>> br1.add('foo')
792
>>> br1.add('bar')
793
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
794
>>> br2 = ScratchBranch()
795
>>> br2.update_revisions(br1)
796
Added 2 texts.
797
Added 1 inventories.
798
Added 1 revisions.
799
>>> br2.revision_history()
800
[u'REVISION-ID-1']
801
>>> br2.update_revisions(br1)
802
Added 0 texts.
803
Added 0 inventories.
804
Added 0 revisions.
805
>>> br1.text_store.total_size() == br2.text_store.total_size()
806
True
807
"""
808
from bzrlib.progress import ProgressBar
809
810
pb = ProgressBar()
811
812
pb.update('comparing histories')
813
revision_ids = self.missing_revisions(other, stop_revision)
814
815
if hasattr(other.revision_store, "prefetch"):
816
other.revision_store.prefetch(revision_ids)
817
if hasattr(other.inventory_store, "prefetch"):
818
inventory_ids = [other.get_revision(r).inventory_id
819
for r in revision_ids]
820
other.inventory_store.prefetch(inventory_ids)
821
822
revisions = []
823
needed_texts = set()
824
i = 0
825
for rev_id in revision_ids:
826
i += 1
827
pb.update('fetching revision', i, len(revision_ids))
828
rev = other.get_revision(rev_id)
829
revisions.append(rev)
830
inv = other.get_inventory(str(rev.inventory_id))
831
for key, entry in inv.iter_entries():
832
if entry.text_id is None:
833
continue
834
if entry.text_id not in self.text_store:
835
needed_texts.add(entry.text_id)
836
837
pb.clear()
838
839
count = self.text_store.copy_multi(other.text_store, needed_texts)
840
print "Added %d texts." % count
841
inventory_ids = [ f.inventory_id for f in revisions ]
842
count = self.inventory_store.copy_multi(other.inventory_store,
843
inventory_ids)
844
print "Added %d inventories." % count
845
revision_ids = [ f.revision_id for f in revisions]
846
count = self.revision_store.copy_multi(other.revision_store,
847
revision_ids)
848
for revision_id in revision_ids:
849
self.append_revision(revision_id)
850
print "Added %d revisions." % count
851
852
853
def commit(self, *args, **kw):
854
from bzrlib.commit import commit
855
commit(self, *args, **kw)
856
857
858
def lookup_revision(self, revision):
859
"""Return the revision identifier for a given revision information."""
860
revno, info = self.get_revision_info(revision)
861
return info
862
863
def get_revision_info(self, revision):
864
"""Return (revno, revision id) for revision identifier.
865
866
revision can be an integer, in which case it is assumed to be revno (though
867
this will translate negative values into positive ones)
868
revision can also be a string, in which case it is parsed for something like
869
'date:' or 'revid:' etc.
870
"""
871
if revision is None:
872
return 0, None
873
revno = None
874
try:# Convert to int if possible
875
revision = int(revision)
876
except ValueError:
877
pass
878
revs = self.revision_history()
879
if isinstance(revision, int):
880
if revision == 0:
881
return 0, None
882
# Mabye we should do this first, but we don't need it if revision == 0
883
if revision < 0:
884
revno = len(revs) + revision + 1
885
else:
886
revno = revision
887
elif isinstance(revision, basestring):
888
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
889
if revision.startswith(prefix):
890
revno = func(self, revs, revision)
891
break
892
else:
893
raise BzrError('No namespace registered for string: %r' % revision)
894
895
if revno is None or revno <= 0 or revno > len(revs):
896
raise BzrError("no such revision %s" % revision)
897
return revno, revs[revno-1]
898
899
def _namespace_revno(self, revs, revision):
900
"""Lookup a revision by revision number"""
901
assert revision.startswith('revno:')
902
try:
903
return int(revision[6:])
904
except ValueError:
905
return None
906
REVISION_NAMESPACES['revno:'] = _namespace_revno
907
908
def _namespace_revid(self, revs, revision):
909
assert revision.startswith('revid:')
910
try:
911
return revs.index(revision[6:]) + 1
912
except ValueError:
913
return None
914
REVISION_NAMESPACES['revid:'] = _namespace_revid
915
916
def _namespace_last(self, revs, revision):
917
assert revision.startswith('last:')
918
try:
919
offset = int(revision[5:])
920
except ValueError:
921
return None
922
else:
923
if offset <= 0:
924
raise BzrError('You must supply a positive value for --revision last:XXX')
925
return len(revs) - offset + 1
926
REVISION_NAMESPACES['last:'] = _namespace_last
927
928
def _namespace_tag(self, revs, revision):
929
assert revision.startswith('tag:')
930
raise BzrError('tag: namespace registered, but not implemented.')
931
REVISION_NAMESPACES['tag:'] = _namespace_tag
932
933
def _namespace_date(self, revs, revision):
934
assert revision.startswith('date:')
935
import datetime
936
# Spec for date revisions:
937
# date:value
938
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
939
# it can also start with a '+/-/='. '+' says match the first
940
# entry after the given date. '-' is match the first entry before the date
941
# '=' is match the first entry after, but still on the given date.
942
#
943
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
944
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
945
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
946
# May 13th, 2005 at 0:00
947
#
948
# So the proper way of saying 'give me all entries for today' is:
949
# -r {date:+today}:{date:-tomorrow}
950
# The default is '=' when not supplied
951
val = revision[5:]
952
match_style = '='
953
if val[:1] in ('+', '-', '='):
954
match_style = val[:1]
955
val = val[1:]
956
957
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
958
if val.lower() == 'yesterday':
959
dt = today - datetime.timedelta(days=1)
960
elif val.lower() == 'today':
961
dt = today
962
elif val.lower() == 'tomorrow':
963
dt = today + datetime.timedelta(days=1)
964
else:
965
import re
966
# This should be done outside the function to avoid recompiling it.
967
_date_re = re.compile(
968
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
969
r'(,|T)?\s*'
970
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
971
)
972
m = _date_re.match(val)
973
if not m or (not m.group('date') and not m.group('time')):
974
raise BzrError('Invalid revision date %r' % revision)
975
976
if m.group('date'):
977
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
978
else:
979
year, month, day = today.year, today.month, today.day
980
if m.group('time'):
981
hour = int(m.group('hour'))
982
minute = int(m.group('minute'))
983
if m.group('second'):
984
second = int(m.group('second'))
985
else:
986
second = 0
987
else:
988
hour, minute, second = 0,0,0
989
990
dt = datetime.datetime(year=year, month=month, day=day,
991
hour=hour, minute=minute, second=second)
992
first = dt
993
last = None
994
reversed = False
995
if match_style == '-':
996
reversed = True
997
elif match_style == '=':
998
last = dt + datetime.timedelta(days=1)
999
1000
if reversed:
1001
for i in range(len(revs)-1, -1, -1):
1002
r = self.get_revision(revs[i])
1003
# TODO: Handle timezone.
1004
dt = datetime.datetime.fromtimestamp(r.timestamp)
1005
if first >= dt and (last is None or dt >= last):
1006
return i+1
1007
else:
1008
for i in range(len(revs)):
1009
r = self.get_revision(revs[i])
1010
# TODO: Handle timezone.
1011
dt = datetime.datetime.fromtimestamp(r.timestamp)
1012
if first <= dt and (last is None or dt <= last):
1013
return i+1
1014
REVISION_NAMESPACES['date:'] = _namespace_date
1015
1016
def revision_tree(self, revision_id):
1017
"""Return Tree for a revision on this branch.
1018
1019
`revision_id` may be None for the null revision, in which case
1020
an `EmptyTree` is returned."""
1021
from bzrlib.tree import EmptyTree, RevisionTree
1022
# TODO: refactor this to use an existing revision object
1023
# so we don't need to read it in twice.
1024
if revision_id == None:
1025
return EmptyTree(self.get_root_id())
1026
else:
1027
inv = self.get_revision_inventory(revision_id)
1028
return RevisionTree(self.text_store, inv)
1029
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]
1030
332
1031
333
def working_tree(self):
1032
"""Return a `Tree` for the working copy."""
1033
from workingtree import WorkingTree
1034
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')
1035
336
337
def pull(self, source, overwrite=False):
338
raise NotImplementedError('pull is abstract')
1036
339
1037
340
def basis_tree(self):
1038
341
"""Return `Tree` object for last revision.
1039
342
1040
343
If there are no revisions yet, return an `EmptyTree`.
1041
344
"""
1042
from bzrlib.tree import EmptyTree, RevisionTree
1043
r = self.last_patch()
1044
if r == None:
1045
return EmptyTree(self.get_root_id())
1046
else:
1047
return RevisionTree(self.text_store, self.get_revision_inventory(r))
1048
1049
345
return self.repository.revision_tree(self.last_revision())
1050
346
1051
347
def rename_one(self, from_rel, to_rel):
1052
348
"""Rename one file.
1053
349
1054
350
This can change the directory or the filename or both.
1055
351
"""
1056
self.lock_write()
1057
try:
1058
tree = self.working_tree()
1059
inv = tree.inventory
1060
if not tree.has_filename(from_rel):
1061
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1062
if tree.has_filename(to_rel):
1063
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1064
1065
file_id = inv.path2id(from_rel)
1066
if file_id == None:
1067
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1068
1069
if inv.path2id(to_rel):
1070
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1071
1072
to_dir, to_tail = os.path.split(to_rel)
1073
to_dir_id = inv.path2id(to_dir)
1074
if to_dir_id == None and to_dir != '':
1075
raise BzrError("can't determine destination directory id for %r" % to_dir)
1076
1077
mutter("rename_one:")
1078
mutter(" file_id {%s}" % file_id)
1079
mutter(" from_rel %r" % from_rel)
1080
mutter(" to_rel %r" % to_rel)
1081
mutter(" to_dir %r" % to_dir)
1082
mutter(" to_dir_id {%s}" % to_dir_id)
1083
1084
inv.rename(file_id, to_dir_id, to_tail)
1085
1086
print "%s => %s" % (from_rel, to_rel)
1087
1088
from_abs = self.abspath(from_rel)
1089
to_abs = self.abspath(to_rel)
1090
try:
1091
os.rename(from_abs, to_abs)
1092
except OSError, e:
1093
raise BzrError("failed to rename %r to %r: %s"
1094
% (from_abs, to_abs, e[1]),
1095
["rename rolled back"])
1096
1097
self._write_inventory(inv)
1098
finally:
1099
self.unlock()
1100
352
raise NotImplementedError('rename_one is abstract')
1101
353
1102
354
def move(self, from_paths, to_name):
1103
355
"""Rename files.
1109
361
1110
362
Note that to_name is only the last component of the new name;
1111
363
this doesn't change the directory.
1112
"""
1113
self.lock_write()
1114
try:
1115
## TODO: Option to move IDs only
1116
assert not isinstance(from_paths, basestring)
1117
tree = self.working_tree()
1118
inv = tree.inventory
1119
to_abs = self.abspath(to_name)
1120
if not isdir(to_abs):
1121
raise BzrError("destination %r is not a directory" % to_abs)
1122
if not tree.has_filename(to_name):
1123
raise BzrError("destination %r not in working directory" % to_abs)
1124
to_dir_id = inv.path2id(to_name)
1125
if to_dir_id == None and to_name != '':
1126
raise BzrError("destination %r is not a versioned directory" % to_name)
1127
to_dir_ie = inv[to_dir_id]
1128
if to_dir_ie.kind not in ('directory', 'root_directory'):
1129
raise BzrError("destination %r is not a directory" % to_abs)
1130
1131
to_idpath = inv.get_idpath(to_dir_id)
1132
1133
for f in from_paths:
1134
if not tree.has_filename(f):
1135
raise BzrError("%r does not exist in working tree" % f)
1136
f_id = inv.path2id(f)
1137
if f_id == None:
1138
raise BzrError("%r is not versioned" % f)
1139
name_tail = splitpath(f)[-1]
1140
dest_path = appendpath(to_name, name_tail)
1141
if tree.has_filename(dest_path):
1142
raise BzrError("destination %r already exists" % dest_path)
1143
if f_id in to_idpath:
1144
raise BzrError("can't move %r to a subdirectory of itself" % f)
1145
1146
# OK, so there's a race here, it's possible that someone will
1147
# create a file in this interval and then the rename might be
1148
# left half-done. But we should have caught most problems.
1149
1150
for f in from_paths:
1151
name_tail = splitpath(f)[-1]
1152
dest_path = appendpath(to_name, name_tail)
1153
print "%s => %s" % (f, dest_path)
1154
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1155
try:
1156
os.rename(self.abspath(f), self.abspath(dest_path))
1157
except OSError, e:
1158
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1159
["rename rolled back"])
1160
1161
self._write_inventory(inv)
1162
finally:
1163
self.unlock()
1164
1165
1166
def revert(self, filenames, old_tree=None, backups=True):
1167
"""Restore selected files to the versions from a previous tree.
1168
1169
backups
1170
If true (default) backups are made of files before
1171
they're renamed.
1172
"""
1173
from bzrlib.errors import NotVersionedError, BzrError
1174
from bzrlib.atomicfile import AtomicFile
1175
from bzrlib.osutils import backup_file
1176
1177
inv = self.read_working_inventory()
1178
if old_tree is None:
1179
old_tree = self.basis_tree()
1180
old_inv = old_tree.inventory
1181
1182
nids = []
1183
for fn in filenames:
1184
file_id = inv.path2id(fn)
1185
if not file_id:
1186
raise NotVersionedError("not a versioned file", fn)
1187
if not old_inv.has_id(file_id):
1188
raise BzrError("file not present in old tree", fn, file_id)
1189
nids.append((fn, file_id))
1190
1191
# TODO: Rename back if it was previously at a different location
1192
1193
# TODO: If given a directory, restore the entire contents from
1194
# the previous version.
1195
1196
# TODO: Make a backup to a temporary file.
1197
1198
# TODO: If the file previously didn't exist, delete it?
1199
for fn, file_id in nids:
1200
backup_file(fn)
1201
1202
f = AtomicFile(fn, 'wb')
1203
try:
1204
f.write(old_tree.get_file(file_id).read())
1205
f.commit()
1206
finally:
1207
f.close()
1208
1209
1210
def pending_merges(self):
1211
"""Return a list of pending merges.
1212
1213
These are revisions that have been merged into the working
1214
directory but not yet committed.
1215
"""
1216
cfn = self.controlfilename('pending-merges')
1217
if not os.path.exists(cfn):
1218
return []
1219
p = []
1220
for l in self.controlfile('pending-merges', 'r').readlines():
1221
p.append(l.rstrip('\n'))
1222
return p
1223
1224
1225
def add_pending_merge(self, revision_id):
1226
from bzrlib.revision import validate_revision_id
1227
1228
validate_revision_id(revision_id)
1229
1230
p = self.pending_merges()
1231
if revision_id in p:
1232
return
1233
p.append(revision_id)
1234
self.set_pending_merges(p)
1235
1236
1237
def set_pending_merges(self, rev_list):
1238
from bzrlib.atomicfile import AtomicFile
1239
self.lock_write()
1240
try:
1241
f = AtomicFile(self.controlfilename('pending-merges'))
1242
try:
1243
for l in rev_list:
1244
print >>f, l
1245
f.commit()
1246
finally:
1247
f.close()
1248
finally:
1249
self.unlock()
1250
1251
1252
1253
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):
1254
1216
"""Special test class: a branch that cleans up after itself.
1255
1217
1256
1218
>>> b = ScratchBranch()
1257
1219
>>> isdir(b.base)
1258
1220
True
1259
1221
>>> bd = b.base
1260
>>> b.destroy()
1222
>>> b._transport.__del__()
1261
1223
>>> isdir(bd)
1262
1224
False
1263
1225
"""
1264
def __init__(self, files=[], dirs=[], base=None):
1226
1227
def __init__(self, files=[], dirs=[], transport=None):
1265
1228
"""Make a test branch.
1266
1229
1267
1230
This creates a temporary directory and runs init-tree in it.
1268
1231
1269
1232
If any files are listed, they are created in the working copy.
1270
1233
"""
1271
from tempfile import mkdtemp
1272
init = False
1273
if base is None:
1274
base = mkdtemp()
1275
init = True
1276
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
1277
1249
for d in dirs:
1278
os.mkdir(self.abspath(d))
1250
self._transport.mkdir(d)
1279
1251
1280
1252
for f in files:
1281
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1282
1253
self._transport.put(f, 'content of %s' % f)
1283
1254
1284
1255
def clone(self):
1285
1256
"""
1286
1257
>>> orig = ScratchBranch(files=["file1", "file2"])
1258
>>> os.listdir(orig.base)
1259
[u'.bzr', u'file1', u'file2']
1287
1260
>>> clone = orig.clone()
1288
>>> 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
...
1289
1266
False
1290
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1291
True
1267
>>> os.listdir(clone.base)
1268
[u'.bzr', u'file1', u'file2']
1292
1269
"""
1293
1270
from shutil import copytree
1294
from tempfile import mkdtemp
1271
from bzrlib.osutils import mkdtemp
1295
1272
base = mkdtemp()
1296
1273
os.rmdir(base)
1297
1274
copytree(self.base, base, symlinks=True)
1298
return ScratchBranch(base=base)
1299
1300
def __del__(self):
1301
self.destroy()
1302
1303
def destroy(self):
1304
"""Destroy the test branch, removing the scratch directory."""
1305
from shutil import rmtree
1306
try:
1307
if self.base:
1308
mutter("delete ScratchBranch %s" % self.base)
1309
rmtree(self.base)
1310
except OSError, e:
1311
# Work around for shutil.rmtree failing on Windows when
1312
# readonly files are encountered
1313
mutter("hit exception in destroying ScratchBranch: %s" % e)
1314
for root, dirs, files in os.walk(self.base, topdown=False):
1315
for name in files:
1316
os.chmod(os.path.join(root, name), 0700)
1317
rmtree(self.base)
1318
self.base = None
1319
1275
return ScratchBranch(
1276
transport=bzrlib.transport.local.ScratchTransport(base))
1320
1277
1321
1278
1322
1279
######################################################################
1325
1282
1326
1283
def is_control_file(filename):
1327
1284
## FIXME: better check
1328
filename = os.path.normpath(filename)
1285
filename = normpath(filename)
1329
1286
while filename != '':
1330
1287
head, tail = os.path.split(filename)
1331
## mutter('check %r for control file' % ((head, tail), ))
1288
## mutter('check %r for control file' % ((head, tail),))
1332
1289
if tail == bzrlib.BZRDIR:
1333
1290
return True
1334
1291
if filename == head:
1335
1292
break
1336
1293
filename = head
1337
1294
return False
1338
1339
1340
1341
def gen_file_id(name):
1342
"""Return new file id.
1343
1344
This should probably generate proper UUIDs, but for the moment we
1345
cope with just randomness because running uuidgen every time is
1346
slow."""
1347
import re
1348
from binascii import hexlify
1349
from time import time
1350
1351
# get last component
1352
idx = name.rfind('/')
1353
if idx != -1:
1354
name = name[idx+1 : ]
1355
idx = name.rfind('\\')
1356
if idx != -1:
1357
name = name[idx+1 : ]
1358
1359
# make it not a hidden file
1360
name = name.lstrip('.')
1361
1362
# remove any wierd characters; we don't escape them but rather
1363
# just pull them out
1364
name = re.sub(r'[^\w.]', '', name)
1365
1366
s = hexlify(rand_bytes(8))
1367
return '-'.join((name, compact_date(time()), s))
1368
1369
1370
def gen_root_id():
1371
"""Return a new tree-root file id."""
1372
return gen_file_id('TREE_ROOT')
1373
Loggerhead is a web-based interface for Breezy
Version: 2.0.1